Legacy | Start New Execution

Starts a new execution, and returns the executionId and reportKey.

Request syntax

Copy
https://mycloud.perfectomobile.com/services/executions?operation=start&securityToken=value[&optionalParameters=value]
Important: All REST API commands require authentication through the Perfecto security token. See also Authentication in new APIs.

Parameters

Name

Type

Default

Description

securityToken*

string


A unique cryptographic key assigned to an authorized user.

scriptName 

string


Defines a name for the script. This name is used for the report folder name and report key.

output.report

boolean

true

true to generate a report containing the execution commands.

output.video

boolean

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

string

private

The repository section where the report will be stored. The section determines the access to the report. Possible values: private, group, public.

responseFormat

string

json

The format to use for the response. Possible values: xml, json.

* Mandatory parameter

Response

Name Description
executionId The unique identifier that you can use to execute Perfecto commands and to end the execution. The execution id is valid until sending the end execution request or the execution is expired, due to inactivity.
reportKey  The identifier used to download the execution report from the repository. This is valid for the legacy formatted report. The key is only valid only after ending the execution. For example, PRIVATE:reportName.xml.
testGridReportUrl The Perfecto report library URL.
singleTestReportUrl The single test report URL.
reportPdfUrl URL to download a PDF formatted version of the Execution Summary Report.

Examples

Request with default json format response

This example shows the request and response for starting a new execution without specifying any optional parameters.

Copy
Request
https://mycloud.perfectomobile.com/services/executions?operation=start&securityToken=<your_token>
Copy

Response

{
    "reportPdfUrl":"https://reporting.aws-stg.perfectomobile.com/export/api/v1/test-executions/pdf?externalId[0]=johnp@perfectomobile.com_controller_17-02-16_13_13_52_6",
    "executionId":"johnp@perfectomobile.com_controller_17-02-16_13_13_52_6",
    "testGridReportUrl":"https://mycloud.reporting-stg.perfectomobile.com?externalId[0]=johnp@perfectomobile.com_controller_17-02-16_13_13_52_6",
    "singleTestReportUrl":"https://mycloud.perfectomobile.com/nexperience/singletest/report/?reportRepositoryKey=PRIVATE:controller/170216/controller_17-02-16_13_13_52_6.xml&ownerId=johnp@perfectomobile.com&sharingCode=d996b557-b108-48ed-99ca-476902694fa9",
    "reportKey":"PRIVATE:controller/170216/controller_17-02-16_13_13_52_6.xml"}