Legacy | Home

  • Command: device

  • Subcommand: ready

  • Supported Platforms: Native (legacy), UFT (legacy), Selenium, Appium

    All commands must be executed using the same framework. Sharing the execution ID between different frameworks is not possible. This means that if you work with a Selenium/Appium driver, you need to call the commands using the Selenium/Appium driver (or, in the case of Reporting commands, through the Reporting SDK that works with the driver) and not as part of a UFT test or another framework.

  • Supported OS: Android, iOS

Description

Brings the device to its idle/home screen.

For iOS and Android devices, the device is unlocked and returned to its default rotate orientation. For example, iOS devices are returned to portrait mode and iPad devices to landscape mode.

Use this function at the beginning of a script to ensure a known starting point for the user.

Parameters

Name Value Default Description
deviceID*     The device for this command.
target

all (All)

menu (Menu)

position (Position)

 All

All - Reset both location in the navigation tree (device menus to IDLE state) and device state to default (rotate / flip state)

Menu - Reset the location in the navigation tree

Position - Reset the device state (rotate / flip) to default position

* Mandatory parameter

Request & Response

Copy

Request

https://mycloud.perfectomobile.com/services/executions/john@perfectomobile.com_controller_16-11-02_06_50_26_680?operation=command&securityToken=<your_token>&command=device&subcommand=ready&param.deviceId=6370E775
Copy

JSON Request

{
    "executionId":"john@perfectomobile.com_controller_16-11-02_06_50_26_680",
    "reason":"Success",
    "timer.elapsed":"6938",
    "testGridReportUrl":"https://mycloud.reporting-stg.perfectomobile.com?externalId[0]=john@perfectomobile.com_controller_16-11-02_06_50_26_680",
    "timer.ux":"6938",
    "singleTestReportUrl":"https://mycloud.perfectomobile.com/nexperience/singletest/report/?reportRepositoryKey=PRIVATE:controller/161102/controller_16-11-02_06_50_26_680.xml&ownerId=john@perfectomobile.com&sharingCode=234ff841-f54e-4e3c-95a8-246443d7b8b6",
    "description":"Success",
    "timer.system":"0",
    "reportKey":"PRIVATE:controller/161102/controller_16-11-02_06_50_26_680.xml",
    "completed":"true",
    "flowEndCode":"SUCCEEDED",
    "timer.device":"6938"}