Start new script execution

Starts a new asynchronous execution of the specified script.

Request syntax

Copy

https://mycloud.perfectomobile.com/services/executions?operation=execute&scriptKey=value&securityToken=mySecurityToken[&optionalParameter=value]

Important: All REST API commands require authentication. See the general authentication methods in Authentication and authorization.

Parameters

Name	Default	Description
ScriptKey^*		The repository key of the automation script file stored in the scripts repository area. For example, PUBLIC:deviceMonitoring.xml or PRIVATE:android/test.xml.
param.<name>		The name and value of one or more run-time parameters for the script, each prefixed with `param.` For example, to specify an integer parameter called timeout with the value 10, add `param.timeout=10` to the URL. When using an API call to invoke Scriptless Mobile tests, make sure the Device parameter is set. If the Device parameter is not set, the API call will pass, but the test will not start. You can set the Device parameter through the Scriptless Mobile UI or in the API call. To hard-code the parameter in Scriptless Mobile, on the top toolbar, use the Configure test variables button . To learn more, see Configure test variables.
securedParam.<name>		The name and value of one or more secured run-time parameters for the script, each prefixed with `securedParam.` For example, to specify a string parameter called `password` with the value `z5VwobV/vjZYZKt6Lu6IOQ`, add `securedParam.password=z5VwobV/vjZYZKt6Lu6IOQ` to the URL.
output.report	true	`true` to generate a report containing the execution commands.
output.video	true	`true` to record a video of the device screen during the execution. This value applies to all devices used in the execution. Applicable only when the output.report is not sepcified as `false`.
output.visibility	private	The repository section where the report will be stored. The section determines the access to the report. Possible values: `private`, `group`, `public`.
responseFormat	json	The format to use for the response. Possible values: `xml`, `json.`
handset.allocation.timeout		Maximal duration to retry allocating a handset in script execution (in milliseconds). The default equals 90 minutes. To fail the script sooner when the device cannot be allocated, you can overwrite this parameter value with a shorter duration.
handset.allocation.retryInterval		Frequency of attempts to allocate a handset in script execution (in milliseconds). The default equals 1 minute.

^* Mandatory

Response

Name	Description
executionId	The unique identifier that you can use to get the status of the running script or abort it. The identifier is only valid during, and for a short period after, the script execution.
reportKey	The identifier that you can use to download the execution report from the repository. The key is only valid once the script execution completes and does not expire. For example, PRIVATE:reportName.xml.
testGridReportUrl	The Perfecto report library URL.
singleTestReportUrl	The single test report URL.

Example

This example shows the request and response for starting the execution of a script called simpleTest.xml located in the PRIVATE media repository without specifying any optional parameters.

Copy

Request

https://mycloud.perfectomobile.com/services/executions?operation=execute&scriptKey=PRIVATE:simpleTest.xml&securityToken=eyJhbGciOiJSUzI...6CO6fQ

Copy

JSON response

{
    "executionId":"samb@perfectomobile.com_simpleTest_16-11-08_12_17_17_1013",
    "testGridReportUrl":"https://mycloud.reporting-stg.perfectomobile.com?externalId[0]=samb@perfectomobile.com_simpleTest_16-11-08_12_17_17_1013",
    "singleTestReportUrl":"https://mycloud.perfectomobile.com/nexperience/singletest/report/?reportRepositoryKey=PRIVATE:161108/simpleTest_16-11-08_12_17_17_1013.xml&ownerId=samb@perfectomobile.com&sharingCode=8c5aace9-1233-4c6d-af6f-1a1b19443276",
    "reportKey":"PRIVATE:161108/simpleTest_16-11-08_12_17_17_1013.xml"}