UFT Mobile API Reference

Devices : REST APIs for devices

post /rest/device/reconnect/{deviceId}

Reconnect device

Implementation Notes

reconnect operation is valid for admins and for allowed users

Response Class (Status 200)

{
  "data": {},
  "error": true,
  "message": "string",
  "messageCode": 0
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
deviceId	deviceId	path	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request | Failed to reconnect device

get /rest/deviceContent

Get all devices

Response Class (Status 200)

Response Class[data field]

[
  {
    "apiLevel": "string",
    "connected": true,
    "connectorName": "string",
    "currentReservation": {
      "endTime": 0,
      "owner": "string",
      "startTime": 0,
      "status": "string"
    },
    "deviceHostingType": "string",
    "deviceName": "string",
    "deviceType": "string",
    "formFactor": "string",
    "healthStatus": {
      "error": true,
      "message": [
        "string"
      ]
    },
    "localCountry": "string",
    "localLanguage": "string",
    "nickName": "string",
    "platformName": "string",
    "platformVersion": "string",
    "udid": "string",
    "workspaceName": "string"
  }
]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string

post /rest/v2/awsDevices

Connect a device from Amazon device farm.

Implementation Notes

Request connecting a Amazon Device Farm(ADF) instance to Lab. Note: Need enable ADF integration first from Admin setting. For each Device maximum test timeout is 300 minutes.

Response Class (Status 200)

Device request accepted and in connecting.

{
  "application": {
    "appActivity": "string",
    "appBuildVersion": "string",
    "appPackage": "string",
    "appUdid": "string",
    "appVersion": "string",
    "applicationExist": true,
    "bundleId": "string",
    "comment": "string",
    "counter": 0,
    "dateTime": 0,
    "deviceFamily": "string",
    "fileName": "string",
    "icon": "string",
    "iconUrl": "string",
    "id": "string",
    "identifier": "string",
    "instrumentationFailureCode": 0,
    "instrumentationFailureReason": "string",
    "instrumentationStatus": "string",
    "instrumented": true,
    "instrumentedApplicationExist": true,
    "iosagent": true,
    "launchActivity": "string",
    "minimumOsVersion": "string",
    "name": "string",
    "provisionedDevices": [
      "string"
    ],
    "source": "string",
    "svInstrumented": true,
    "type": "string",
    "urlScheme": "string",
    "version": "string",
    "workspaces": [
      {
        "description": "string",
        "name": "string",
        "uuid": "string"
      }
    ]
  },
  "capableDeviceFilterDetails": {
    "browserName": "string",
    "deviceHostingType": "string",
    "deviceName": "string",
    "deviceNameNotEmpty": true,
    "fleetType": "string",
    "jobId": "string",
    "location": "string",
    "namespace": "string",
    "platform": "string",
    "platformName": "string",
    "platformVersion": "string",
    "source": "string",
    "svEnabled": false,
    "templateId": "string",
    "tenantIdCapability": "string",
    "tool": "string",
    "udid": "string",
    "uftmtool": "string",
    "version": "string"
  },
  "devices": [
    {
      "agentVersion": "string",
      "apiLevel": "string",
      "captureAudioEnabled": true,
      "connectedBy": "string",
      "connectionIssues": [
        "string"
      ],
      "connectionType": "string",
      "connectorID": 0,
      "connectorIP": "string",
      "connectorLocation": "string",
      "connectorName": "string",
      "connectorNamespace": "string",
      "connectorPort": "string",
      "connectorProtocol": "string",
      "customerName": "string",
      "deviceComment": "string",
      "deviceHostingType": "string",
      "deviceID": "string",
      "deviceIP": "string",
      "deviceStatus": "string",
      "deviceStatusWithReservation": "string",
      "deviceType": "string",
      "deviceWiFiIP": "string",
      "dpcReady": true,
      "extraInformation": "string",
      "family": "string",
      "fleetType": "string",
      "healthStatus": {
        "error": true,
        "message": [
          "string"
        ]
      },
      "imei": "string",
      "isDevTunneled": true,
      "lastUsedTime": 0,
      "localCountry": "string",
      "localLanguage": "string",
      "logicName": "string",
      "macAddress": "string",
      "maintenanceModeEnabled": true,
      "manufacturer": "string",
      "mobileType": "string",
      "mode": "string",
      "model": "string",
      "nextReservationTimeStart": 0,
      "osType": "string",
      "osVersion": "string",
      "publicHosted": true,
      "queue": 0,
      "requestId": "string",
      "requestTime": 0,
      "reservationCustomerName": "string",
      "reservationStartTime": 0,
      "reservationTimeFinish": 0,
      "reservedByMe": true,
      "serialNumber": "string",
      "settingBlockFailed": true,
      "source": "string",
      "startTime": 0,
      "statusChangeTime": 0,
      "svEnabled": true,
      "tenantId": 0,
      "workspaces": [
        {
          "description": "string",
          "name": "string",
          "uuid": "string"
        }
      ]
    }
  ],
  "endpoints": [
    {
      "websocket": {}
    }
  ],
  "externalId": "string",
  "extraApps": [
    {
      "appActivity": "string",
      "appBuildVersion": "string",
      "appPackage": "string",
      "appUdid": "string",
      "appVersion": "string",
      "applicationExist": true,
      "bundleId": "string",
      "comment": "string",
      "counter": 0,
      "dateTime": 0,
      "deviceFamily": "string",
      "fileName": "string",
      "icon": "string",
      "iconUrl": "string",
      "id": "string",
      "identifier": "string",
      "instrumentationFailureCode": 0,
      "instrumentationFailureReason": "string",
      "instrumentationStatus": "string",
      "instrumented": true,
      "instrumentedApplicationExist": true,
      "iosagent": true,
      "launchActivity": "string",
      "minimumOsVersion": "string",
      "name": "string",
      "provisionedDevices": [
        "string"
      ],
      "source": "string",
      "svInstrumented": true,
      "type": "string",
      "urlScheme": "string",
      "version": "string",
      "workspaces": [
        {
          "description": "string",
          "name": "string",
          "uuid": "string"
        }
      ]
    }
  ],
  "header": "string",
  "id": "string",
  "lastExecuteDateTime": "2025-03-24T09:20:31.904Z",
  "name": "string",
  "status": "string",
  "tool": "string",
  "viewUrl": "string"
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
jobDescriptionDetails	Parameter content type:	jobDescriptionDetails	body	Model Example Value JobDescriptionDetails { application (ApplicationDetails, optional), capableDeviceFilterDetails (CapabilitiesDetails, optional), devices (Array[DeviceDetails], optional), endpoints (Array[EndpointDetails], optional), externalId (string, optional), extraApps (Array[ApplicationDetails], optional), header (string, optional), id (string, optional), lastExecuteDateTime (string, optional), name (string, optional), status (string, optional), tool (string, optional), viewUrl (string, optional) } ApplicationDetails { appActivity (string, optional), appBuildVersion (string, optional), appPackage (string, optional), appUdid (string, optional), appVersion (string, optional), applicationExist (boolean, optional), bundleId (string, optional), comment (string, optional), counter (integer, optional), dateTime (integer, optional), deviceFamily (string, optional), fileName (string, optional), icon (string, optional), iconUrl (string, optional), id (string, optional), identifier (string, optional), instrumentationFailureCode (integer, optional), instrumentationFailureReason (string, optional), instrumentationStatus (string, optional), instrumented (boolean, optional), instrumentedApplicationExist (boolean, optional), iosagent (boolean, optional), launchActivity (string, optional), minimumOsVersion (string, optional), name (string, optional), provisionedDevices (Array[string], optional), source (string, optional), svInstrumented (boolean, optional), type (string, optional), urlScheme (string, optional), version (string, optional), workspaces (Array[WorkspaceBaseDetails], optional) } CapabilitiesDetails { browserName (string, optional), deviceHostingType (string, optional): PrivateOnPremise (UFT Mobile default value) \| PrivateHosting \| Public , deviceName (string, optional): Emulator support - If only deviceName contains "simulator" or "emulator" so only device (deviceType=emulator) will be returned In the mean time, all sub-string delimited by space in deviceName (after removing simulator/emulator) should be contained in any of manufacturer, model or logicName For non-emulator (physical) devices, all sub-string delimited by space in deviceName should be contained in any of manufacturer, model or logicName Refined query support – if deviceName value is enclosed with double-quotes, the value inside the double-quotes is a refined result matching exactly (manufacturer model) with space in between , deviceNameNotEmpty (boolean, optional), fleetType (string, optional), jobId (string, optional), location (string, optional): US \| GERMANY \| or ANY (US/GERMANY) -- represents the location of device , namespace (string, optional), platform (string, optional), platformName (string, optional): iOS \| Android , platformVersion (string, optional), source (string, optional): AWS \| UFTM \| HOSTED \| GENYCLOUD \| WETEST or ANY (AWS/UFTM/GENYCLOUD/HOSTED/WETEST) -- represents the source of device , svEnabled (boolean, optional): svEnabled (True \| False (default value)) , templateId (string, optional): For selecting specific public device template, NULL value for any matching device template , tenantIdCapability (string, optional), tool (string, optional), udid (string, optional), uftmtool (string, optional), version (string, optional) } DeviceDetails { agentVersion (string, optional), apiLevel (string, optional), captureAudioEnabled (boolean, optional), connectedBy (string, optional), connectionIssues (Array[string], optional), connectionType (string, optional), connectorID (integer, optional), connectorIP (string, optional), connectorLocation (string, optional), connectorName (string, optional), connectorNamespace (string, optional), connectorPort (string, optional), connectorProtocol (string, optional), customerName (string, optional), deviceComment (string, optional), deviceHostingType (string, optional), deviceID (string, optional), deviceIP (string, optional), deviceStatus (string, optional), deviceStatusWithReservation (string, optional), deviceType (string, optional), deviceWiFiIP (string, optional), dpcReady (boolean, optional), extraInformation (string, optional), family (string, optional), fleetType (string, optional), healthStatus (HealthStatus, optional), imei (string, optional), isDevTunneled (boolean, optional), lastUsedTime (integer, optional), localCountry (string, optional), localLanguage (string, optional), logicName (string, optional), macAddress (string, optional), maintenanceModeEnabled (boolean, optional), manufacturer (string, optional), mobileType (string, optional), mode (string, optional), model (string, optional), nextReservationTimeStart (integer, optional), osType (string, optional), osVersion (string, optional), publicHosted (boolean, optional), queue (integer, optional), requestId (string, optional), requestTime (integer, optional), reservationCustomerName (string, optional), reservationStartTime (integer, optional), reservationTimeFinish (integer, optional), reservedByMe (boolean, optional), serialNumber (string, optional), settingBlockFailed (boolean, optional), source (string, optional), startTime (integer, optional), statusChangeTime (integer, optional), svEnabled (boolean, optional), tenantId (integer, optional), workspaces (Array[WorkspaceBaseDetails], optional) } EndpointDetails { websocket (inline_model, optional) } WorkspaceBaseDetails { description (string, optional), name (string, optional), uuid (string, optional) } HealthStatus { error (boolean, optional), message (Array[string], optional) } inline_model {} { "application": { "appActivity": "string", "appBuildVersion": "string", "appPackage": "string", "appUdid": "string", "appVersion": "string", "applicationExist": true, "bundleId": "string", "comment": "string", "counter": 0, "dateTime": 0, "deviceFamily": "string", "fileName": "string", "icon": "string", "iconUrl": "string", "id": "string", "identifier": "string", "instrumentationFailureCode": 0, "instrumentationFailureReason": "string", "instrumentationStatus": "string", "instrumented": true, "instrumentedApplicationExist": true, "iosagent": true, "launchActivity": "string", "minimumOsVersion": "string", "name": "string", "provisionedDevices": [ "string" ], "source": "string", "svInstrumented": true, "type": "string", "urlScheme": "string", "version": "string", "workspaces": [ { "description": "string", "name": "string", "uuid": "string" } ] }, "capableDeviceFilterDetails": { "browserName": "string", "deviceHostingType": "string", "deviceName": "string", "deviceNameNotEmpty": true, "fleetType": "string", "jobId": "string", "location": "string", "namespace": "string", "platform": "string", "platformName": "string", "platformVersion": "string", "source": "string", "svEnabled": false, "templateId": "string", "tenantIdCapability": "string", "tool": "string", "udid": "string", "uftmtool": "string", "version": "string" }, "devices": [ { "agentVersion": "string", "apiLevel": "string", "captureAudioEnabled": true, "connectedBy": "string", "connectionIssues": [ "string" ], "connectionType": "string", "connectorID": 0, "connectorIP": "string", "connectorLocation": "string", "connectorName": "string", "connectorNamespace": "string", "connectorPort": "string", "connectorProtocol": "string", "customerName": "string", "deviceComment": "string", "deviceHostingType": "string", "deviceID": "string", "deviceIP": "string", "deviceStatus": "string", "deviceStatusWithReservation": "string", "deviceType": "string", "deviceWiFiIP": "string", "dpcReady": true, "extraInformation": "string", "family": "string", "fleetType": "string", "healthStatus": { "error": true, "message": [ "string" ] }, "imei": "string", "isDevTunneled": true, "lastUsedTime": 0, "localCountry": "string", "localLanguage": "string", "logicName": "string", "macAddress": "string", "maintenanceModeEnabled": true, "manufacturer": "string", "mobileType": "string", "mode": "string", "model": "string", "nextReservationTimeStart": 0, "osType": "string", "osVersion": "string", "publicHosted": true, "queue": 0, "requestId": "string", "requestTime": 0, "reservationCustomerName": "string", "reservationStartTime": 0, "reservationTimeFinish": 0, "reservedByMe": true, "serialNumber": "string", "settingBlockFailed": true, "source": "string", "startTime": 0, "statusChangeTime": 0, "svEnabled": true, "tenantId": 0, "workspaces": [ { "description": "string", "name": "string", "uuid": "string" } ] } ], "endpoints": [ { "websocket": {} } ], "externalId": "string", "extraApps": [ { "appActivity": "string", "appBuildVersion": "string", "appPackage": "string", "appUdid": "string", "appVersion": "string", "applicationExist": true, "bundleId": "string", "comment": "string", "counter": 0, "dateTime": 0, "deviceFamily": "string", "fileName": "string", "icon": "string", "iconUrl": "string", "id": "string", "identifier": "string", "instrumentationFailureCode": 0, "instrumentationFailureReason": "string", "instrumentationStatus": "string", "instrumented": true, "instrumentedApplicationExist": true, "iosagent": true, "launchActivity": "string", "minimumOsVersion": "string", "name": "string", "provisionedDevices": [ "string" ], "source": "string", "svInstrumented": true, "type": "string", "urlScheme": "string", "version": "string", "workspaces": [ { "description": "string", "name": "string", "uuid": "string" } ] } ], "header": "string", "id": "string", "lastExecuteDateTime": "2025-03-24T09:20:31.917Z", "name": "string", "status": "string", "tool": "string", "viewUrl": "string" }

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Device request invalid for acquire a DeviceFarm instance.

delete /rest/v2/awsDevices/{deviceId}

Delete a ADF device from Lab.

Implementation Notes

After delete, the ADF device will be recycled and stop costing on ADF.

Response Class (Status 200)

Device deleted from Lab and recycled.

ResponseEntity {

body (object, optional),

statusCode (string, optional) = ['100 CONTINUE', '101 SWITCHING_PROTOCOLS', '102 PROCESSING', '103 CHECKPOINT', '200 OK', '201 CREATED', '202 ACCEPTED', '203 NON_AUTHORITATIVE_INFORMATION', '204 NO_CONTENT', '205 RESET_CONTENT', '206 PARTIAL_CONTENT', '207 MULTI_STATUS', '208 ALREADY_REPORTED', '226 IM_USED', '300 MULTIPLE_CHOICES', '301 MOVED_PERMANENTLY', '302 FOUND', '302 MOVED_TEMPORARILY', '303 SEE_OTHER', '304 NOT_MODIFIED', '305 USE_PROXY', '307 TEMPORARY_REDIRECT', '308 PERMANENT_REDIRECT', '400 BAD_REQUEST', '401 UNAUTHORIZED', '402 PAYMENT_REQUIRED', '403 FORBIDDEN', '404 NOT_FOUND', '405 METHOD_NOT_ALLOWED', '406 NOT_ACCEPTABLE', '407 PROXY_AUTHENTICATION_REQUIRED', '408 REQUEST_TIMEOUT', '409 CONFLICT', '410 GONE', '411 LENGTH_REQUIRED', '412 PRECONDITION_FAILED', '413 PAYLOAD_TOO_LARGE', '413 REQUEST_ENTITY_TOO_LARGE', '414 URI_TOO_LONG', '414 REQUEST_URI_TOO_LONG', '415 UNSUPPORTED_MEDIA_TYPE', '416 REQUESTED_RANGE_NOT_SATISFIABLE', '417 EXPECTATION_FAILED', '418 I_AM_A_TEAPOT', '419 INSUFFICIENT_SPACE_ON_RESOURCE', '420 METHOD_FAILURE', '421 DESTINATION_LOCKED', '422 UNPROCESSABLE_ENTITY', '423 LOCKED', '424 FAILED_DEPENDENCY', '425 TOO_EARLY', '426 UPGRADE_REQUIRED', '428 PRECONDITION_REQUIRED', '429 TOO_MANY_REQUESTS', '431 REQUEST_HEADER_FIELDS_TOO_LARGE', '451 UNAVAILABLE_FOR_LEGAL_REASONS', '500 INTERNAL_SERVER_ERROR', '501 NOT_IMPLEMENTED', '502 BAD_GATEWAY', '503 SERVICE_UNAVAILABLE', '504 GATEWAY_TIMEOUT', '505 HTTP_VERSION_NOT_SUPPORTED', '506 VARIANT_ALSO_NEGOTIATES', '507 INSUFFICIENT_STORAGE', '508 LOOP_DETECTED', '509 BANDWIDTH_LIMIT_EXCEEDED', '510 NOT_EXTENDED', '511 NETWORK_AUTHENTICATION_REQUIRED']

string
Enum:	"100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "425 TOO_EARLY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED"

string

Enum:

"100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "425 TOO_EARLY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED"

statusCodeValue (integer, optional)

}

{
  "body": {},
  "statusCode": "100 CONTINUE",
  "statusCodeValue": 0
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
deviceId	deviceId	path	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

The Device id is invalid for deleting an ADF device from lab.

post /rest/v2/device/restart/{deviceId}

Restart device

Implementation Notes

restart operation is valid for admins and for allowed users

Response Class (Status 200)

{
  "agentVersion": "string",
  "apiLevel": "string",
  "captureAudioEnabled": true,
  "connectedBy": "string",
  "connectionIssues": [
    "string"
  ],
  "connectionType": "string",
  "connectorID": 0,
  "connectorIP": "string",
  "connectorLocation": "string",
  "connectorName": "string",
  "connectorNamespace": "string",
  "connectorPort": "string",
  "connectorProtocol": "string",
  "customerName": "string",
  "deviceComment": "string",
  "deviceHostingType": "string",
  "deviceID": "string",
  "deviceIP": "string",
  "deviceStatus": "string",
  "deviceStatusWithReservation": "string",
  "deviceType": "string",
  "deviceWiFiIP": "string",
  "dpcReady": true,
  "extraInformation": "string",
  "family": "string",
  "fleetType": "string",
  "healthStatus": {
    "error": true,
    "message": [
      "string"
    ]
  },
  "imei": "string",
  "isDevTunneled": true,
  "lastUsedTime": 0,
  "localCountry": "string",
  "localLanguage": "string",
  "logicName": "string",
  "macAddress": "string",
  "maintenanceModeEnabled": true,
  "manufacturer": "string",
  "mobileType": "string",
  "mode": "string",
  "model": "string",
  "nextReservationTimeStart": 0,
  "osType": "string",
  "osVersion": "string",
  "publicHosted": true,
  "queue": 0,
  "requestId": "string",
  "requestTime": 0,
  "reservationCustomerName": "string",
  "reservationStartTime": 0,
  "reservationTimeFinish": 0,
  "reservedByMe": true,
  "serialNumber": "string",
  "settingBlockFailed": true,
  "source": "string",
  "startTime": 0,
  "statusChangeTime": 0,
  "svEnabled": true,
  "tenantId": 0,
  "workspaces": [
    {
      "description": "string",
      "name": "string",
      "uuid": "string"
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
deviceId	deviceId	path	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request | Failed to restart device

get /rest/v2/device/{deviceId}

Get device

Response Class (Status 200)

{
  "agentVersion": "string",
  "apiLevel": "string",
  "captureAudioEnabled": true,
  "connectedBy": "string",
  "connectionIssues": [
    "string"
  ],
  "connectionType": "string",
  "connectorID": 0,
  "connectorIP": "string",
  "connectorLocation": "string",
  "connectorName": "string",
  "connectorNamespace": "string",
  "connectorPort": "string",
  "connectorProtocol": "string",
  "customerName": "string",
  "deviceComment": "string",
  "deviceHostingType": "string",
  "deviceID": "string",
  "deviceIP": "string",
  "deviceStatus": "string",
  "deviceStatusWithReservation": "string",
  "deviceType": "string",
  "deviceWiFiIP": "string",
  "dpcReady": true,
  "extraInformation": "string",
  "family": "string",
  "fleetType": "string",
  "healthStatus": {
    "error": true,
    "message": [
      "string"
    ]
  },
  "imei": "string",
  "isDevTunneled": true,
  "lastUsedTime": 0,
  "localCountry": "string",
  "localLanguage": "string",
  "logicName": "string",
  "macAddress": "string",
  "maintenanceModeEnabled": true,
  "manufacturer": "string",
  "mobileType": "string",
  "mode": "string",
  "model": "string",
  "nextReservationTimeStart": 0,
  "osType": "string",
  "osVersion": "string",
  "publicHosted": true,
  "queue": 0,
  "requestId": "string",
  "requestTime": 0,
  "reservationCustomerName": "string",
  "reservationStartTime": 0,
  "reservationTimeFinish": 0,
  "reservedByMe": true,
  "serialNumber": "string",
  "settingBlockFailed": true,
  "source": "string",
  "startTime": 0,
  "statusChangeTime": 0,
  "svEnabled": true,
  "tenantId": 0,
  "workspaces": [
    {
      "description": "string",
      "name": "string",
      "uuid": "string"
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
deviceId	deviceId	path	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

404

Device not found

get /rest/v2/device/{deviceId}/logs

Get device logs

Implementation Notes

Return the device log file, currently only available for Android and Ios devices, not available for the ADF devices. The log file will be automatically deleted by the device unlock or reservation release. Before being able to get logs, API /device/{deviceId}/logs/collection has to be called with appropriate payload ("enabled": true). Note: device log collection is taking expensive overhead, please make sure to use it while really needed.

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
deviceId	deviceId	path	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

200

406

The device is not available for the moment for getting device logs.

put /rest/v2/device/{deviceId}/logs/collection

Start or Stop device logs collection

Implementation Notes

Start or Stop the collection of device logs. This method is only supported for Android and iOS devices - not ADF devices. Note: device log collection is taking expensive overhead, please make sure to use it while really needed.

Response Class (Status 200)

{
  "message": "string",
  "messageCode": 0
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
deviceId		deviceId	path	string
collectLogsDetails	Parameter content type:	collectLogsDetails	body	Model Example Value CollectLogsDetails { enabled (boolean): True/False to start/stop log collection } `{ "enabled": false }`

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request for start/stop logs collection

406

The device is currently not available for the start/stop logs collection API.

get /rest/v2/device/{deviceId}/states{?type}

Get details for device metrics.

Response Class (Status 200)

OK | Succeeded to get details of device metrics.

{
  "battery": {
    "health": "string",
    "temperature": 0
  },
  "screen": {
    "brightness": 0,
    "resolution": "string"
  },
  "storage": {
    "free": "string",
    "total": "string"
  },
  "thermal": {
    "thermalStateInt": 0,
    "thermalStateStr": "string"
  },
  "wifi": {
    "isConnected": false,
    "signalStrength": 0,
    "ssid": "string"
  }
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
deviceId	deviceId	path	string
type	type	query	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad Request: Passed metrics type is invalid.

404

Given device ID is not existing or device is offline.

500

Internal server error

put /rest/v2/locking/unlockDevice/{deviceId}

Unlock a device by deviceId

User Management : REST APIs for user management

delete /rest/v2/multi-users

Delete multiple users by their user ID list

Response Class (Status 200)

Response Class

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
userIdList	Parameter content type:	userIdList	body	Array[string]

Response Messages

HTTP Status Code Reason Response Model Headers

207

Response Class

{
  "description": "string",
  "failedList": [
    {
      "failedReason": "string",
      "userId": "string"
    }
  ],
  "succeededList": [
    "string"
  ]
}

400

Bad request - Invalid arguments. | Invalid operation.

post /rest/v2/multi-users{?destProjectId}

Create new user for multiple workspaces

Implementation Notes

When using shared spaces (multitenancy) with UFT Mobile, the created user will be assigned to a shared space.
Operators can create users in a specific shared space by setting the tenant-id header to 0, which is the Operator console, and adding a destProjectId query parameter with the desired shared space ID.
When destProjectId is missing, the user will be assigned to the shared space in context (tenant-id header).

Response Class (Status 200)

Response Class

{
  "id": "string",
  "isAdmin": true,
  "isUser": true,
  "isWorkspaceAdmin": true,
  "ldapGroups": [
    "string"
  ],
  "ldapServerId": "string",
  "locale": "string",
  "messages": [
    "string"
  ],
  "name": "string",
  "roles": [
    {
      "description": "string",
      "name": "string"
    }
  ],
  "workspaces": [
    {
      "description": "string",
      "name": "string",
      "uuid": "string"
    }
  ]
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
createUserDetailsForBulk	Parameter content type:	createUserDetailsForBulk	body	Model Example Value CreateUserDetailsForBulk { name (string, optional): The name of the user to be created. , password (string, optional): The password of the user to be created. , roles (Array[string], optional): The roles of the user to be created. , workspaceUuidList (Array[string], optional): The workspaces that user will be assigned. } `{ "name": "string", "password": "string", "roles": [ "string" ], "workspaceUuidList": [ "string" ] }`
destProjectId		Shared space ID to assign the new user to.	query	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request - User already exists | Shared space doesn't exist

403

Forbidden - Creating operator user is allowed only in operator context |Only operator can create user in different shared space

get /rest/v2/users

Get all users

Response Class (Status 200)

Response Class

[
  {
    "id": "string",
    "isAdmin": true,
    "isUser": true,
    "isWorkspaceAdmin": true,
    "ldapGroups": [
      "string"
    ],
    "ldapServerId": "string",
    "locale": "string",
    "messages": [
      "string"
    ],
    "name": "string",
    "roles": [
      {
        "description": "string",
        "name": "string"
      }
    ],
    "workspaces": [
      {
        "description": "string",
        "name": "string",
        "uuid": "string"
      }
    ]
  }
]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Invalid arguments. | Invalid operation. | Invalid user or password.

get /rest/v2/users/currentUser

Get the current user

Response Class (Status 200)

Response Class

{
  "id": "string",
  "isAdmin": true,
  "isUser": true,
  "isWorkspaceAdmin": true,
  "ldapGroups": [
    "string"
  ],
  "ldapServerId": "string",
  "locale": "string",
  "messages": [
    "string"
  ],
  "name": "string",
  "roles": [
    {
      "description": "string",
      "name": "string"
    }
  ],
  "workspaces": [
    {
      "description": "string",
      "name": "string",
      "uuid": "string"
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Invalid arguments. | Invalid operation. | Invalid user or password.

get /rest/v2/users/download

exportUsersToCsv

Response Class (Status 200)

{
  "description": "string",
  "filename": "string",
  "inputStream": {},
  "open": true,
  "readable": true,
  "uri": {
    "absolute": true,
    "authority": "string",
    "fragment": "string",
    "host": "string",
    "opaque": true,
    "path": "string",
    "port": 0,
    "query": "string",
    "rawAuthority": "string",
    "rawFragment": "string",
    "rawPath": "string",
    "rawQuery": "string",
    "rawSchemeSpecificPart": "string",
    "rawUserInfo": "string",
    "scheme": "string",
    "schemeSpecificPart": "string",
    "userInfo": "string"
  },
  "url": {
    "authority": "string",
    "content": {},
    "defaultPort": 0,
    "file": "string",
    "host": "string",
    "path": "string",
    "port": 0,
    "protocol": "string",
    "query": "string",
    "ref": "string",
    "userInfo": "string"
  }
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Invalid arguments. | Invalid operation. | Invalid user or password.

get /rest/v2/users/pageable{?roles,name}

getUsers

get /rest/v2/users/roles

Retrieve the roles information

Response Class (Status 200)

Response Class

[
  {
    "description": "string",
    "name": "string"
  }
]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Invalid arguments. | Invalid operation. | Invalid user or password.

put /rest/v2/users/sync

syncUsers

get /rest/v2/users/userName/{userName}

Get user details by username

Implementation Notes

When using shared spaces (multitenancy) with UFT Mobile and the user is not assigned to the requested shared space, user details with empty roles and empty isAdmin will be returned.

Response Class (Status 200)

Response Class

{
  "id": "string",
  "isAdmin": true,
  "isUser": true,
  "isWorkspaceAdmin": true,
  "ldapGroups": [
    "string"
  ],
  "ldapServerId": "string",
  "locale": "string",
  "messages": [
    "string"
  ],
  "name": "string",
  "roles": [
    {
      "description": "string",
      "name": "string"
    }
  ],
  "workspaces": [
    {
      "description": "string",
      "name": "string",
      "uuid": "string"
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
userName	userName	path	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Invalid arguments. | Invalid operation. | Invalid user or password.

delete /rest/v2/users/{userId}

Delete a specific user by their userId

get /rest/v2/users/{userId}

Get a specific user by their userId

Response Class (Status 200)

Response Class

{
  "id": "string",
  "isAdmin": true,
  "isUser": true,
  "isWorkspaceAdmin": true,
  "ldapGroups": [
    "string"
  ],
  "ldapServerId": "string",
  "locale": "string",
  "messages": [
    "string"
  ],
  "name": "string",
  "roles": [
    {
      "description": "string",
      "name": "string"
    }
  ],
  "workspaces": [
    {
      "description": "string",
      "name": "string",
      "uuid": "string"
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
userId	userId	path	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Invalid arguments. | Invalid operation. | Invalid user or password.

put /rest/v2/users/{userId}/password

Update a password for the user

Response Class (Status 200)

{}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
changePasswordDetailsV2	Parameter content type:	changePasswordDetailsV2	body	Model Example Value ChangePasswordDetailsV2 { password (string, optional), updatedPassword (string, optional) } `{ "password": "string", "updatedPassword": "string" }`
userId		userId	path	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Invalid arguments. | Invalid operation. | Invalid user or password.

put /rest/v2/users/{userId}/roles{?destProjectId}

Update roles for user

Implementation Notes

This API updates role for the user indicated by userId.

When using shared spaces (multitenancy) with UFT Mobile, it updates the role and assigns the user to a shared space.
An empty value for roles in the request body unassigns the user from a shared space.
destProjectId query parameter is optional and can be used by the operator to update user roles in a specific shared space. When not sent, the shared space in context is used.

Response Class (Status 200)

OK | User assignment to tenant removed successfully

{
  "id": "string",
  "isAdmin": true,
  "isUser": true,
  "isWorkspaceAdmin": true,
  "ldapGroups": [
    "string"
  ],
  "ldapServerId": "string",
  "locale": "string",
  "messages": [
    "string"
  ],
  "name": "string",
  "roles": [
    {
      "description": "string",
      "name": "string"
    }
  ],
  "workspaces": [
    {
      "description": "string",
      "name": "string",
      "uuid": "string"
    }
  ]
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
changeRoleDetailsV2	Parameter content type:	changeRoleDetailsV2	body	Model Example Value ChangeRoleDetailsV2 { name (string, optional), password (string, optional), roles (Array[string], optional), workspaceUuid (string, optional) } `{ "name": "string", "password": "string", "roles": [ "string" ], "workspaceUuid": "string" }`
userId		userId	path	string
destProjectId		Shared space ID to update the user role in.	query	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request - User doesn't exist

403

Forbidden - Assigning operator user is allowed only in operator context | Shared space doesn't exist | Ldap user cannot be removed when Allow access to all LDAP users is enabled

500

Internal server error

post /rest/v2/users{?destProjectId}

Create new user

Implementation Notes

Response Class (Status 200)

Response Class

{
  "id": "string",
  "isAdmin": true,
  "isUser": true,
  "isWorkspaceAdmin": true,
  "ldapGroups": [
    "string"
  ],
  "ldapServerId": "string",
  "locale": "string",
  "messages": [
    "string"
  ],
  "name": "string",
  "roles": [
    {
      "description": "string",
      "name": "string"
    }
  ],
  "workspaces": [
    {
      "description": "string",
      "name": "string",
      "uuid": "string"
    }
  ]
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
createUserDetailsV2	Parameter content type:	createUserDetailsV2	body	Model Example Value CreateUserDetailsV2 { name (string, optional), password (string, optional), roles (Array[string], optional), workspaceUuid (string, optional) } `{ "name": "string", "password": "string", "roles": [ "string" ], "workspaceUuid": "string" }`
destProjectId		Shared space ID to assign the new user to.	query	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request - User already exists | Shared space doesn't exist

403

Forbidden - Creating operator user is allowed only in operator context |Only operator can create user in different shared space

post /rest/v2/users{?overwrite}

createUsersFromCsv

Authentication : REST APIs for Login | Logout | OAuth2 Access Token Request

post /rest/client/login

Implementation Notes

Logs in and returns the authentication cookie.

Response Class (Status 200)

Successfully authenticated.
The session ID is returned in a cookie named JSESSIONID. You need to include this cookie in subsequent requests.
A CSRF token is returned in a response header named x-hp4msecret. You need to include this header in subsequent requests.

{
  "data": {},
  "error": true,
  "message": "string",
  "messageCode": 0
}

Response Content Type

Headers

Header	Description	Type	Other
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests.	string
Set-Cookie: JSESSIONID	Universally unique session ID to authenticate the client requests.	string

Parameters

Parameter	Value	Description	Parameter Type	Data Type
customerDetails	Parameter content type:	customerDetails	body	Model Example Value ApiDocCustomerDetails { name (string), password (string) } `{ "name": "string", "password": "string" }`

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

The client failed to login | The client has missing details. | Your UFT Mobile license has expired. Contact your administrator.

post /rest/client/logout

Log out

post /rest/oauth2/credentials

OAuth2 client credentials Request

Implementation Notes

Create Connector or Execution client credentials. The client credentials can be used to connect devices to or to execute tests in the UFT Mobile.

Response Class (Status 200)

Client Credentials Response

{
  "activationDate": "1597338299646",
  "clientId": "oauth2-L7tbS3uAtXCYxQR4f7Lw@default.com",
  "creator": "admin@default.com",
  "description": "John's credentials for CI execution",
  "expirationDate": "1660411510000",
  "name": "John's credentials",
  "secret": "M77VBhhcimNiHc2w5bfv",
  "tenant": 999999999,
  "type": "EXECUTION"
}

Response Content Type

Parameters

Parameter Value Description Parameter Type Data Type

Authorization

Standard Authorization header using the Bearer scheme. Example: "Bearer {token}".
See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.

header

string

JSESSIONID

Deprecated, use the appropriate Authorization header instead.
The session ID as returned by /rest/client/login operation in a cookie named JSESSIONID.

header

string

x-hp4msecret

Universally unique CSRF token to avoid external malicious requests.
The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named x-hp4msecret.

header

string

tenant-id

The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.

header

string

clientCredentialsDetails

Parameter content type:

clientCredentialsDetails

body

{
  "activationDate": "1597338299646",
  "clientId": "oauth2-L7tbS3uAtXCYxQR4f7Lw@default.com",
  "creator": "admin@default.com",
  "description": "John's credentials for CI execution",
  "expirationDate": "1660411510000",
  "name": "John's credentials",
  "secret": "M77VBhhcimNiHc2w5bfv",
  "tenant": 999999999,
  "type": "EXECUTION"
}

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request

401

Unauthorized

500

Internal server error

post /rest/oauth2/token

OAuth2 Access Token Request

Implementation Notes

Acquire an OAuth2 Access Token to be used to authorize other API calls.
All other API calls require OAuth2 Bearer token authentication, using the obtained access token
Oauth2 access token operates under the same user privileges as the user who generated the execution key (OAuth2 client credentials)
Tokens issued expires in 3 hours. Token expiration is reflected in the expires_in property of the response.
It is possible to request a new access token before the current token expires.

Response Class (Status 200)

Access Token Response

{
  "access_token": "zk18Y0V3CWPqagl6rdv64XMbQK8ydRmdY9lZ0uU0yFj04A02HlB6zFlYQ64IEHezmwPdZTq18a4IJEiWLwISvnQEzBeTf2KFzpnrSyyh0LLoOH4A5CeV4CdI0iQ4ovXNykUsxKqllP23qk3H01XGxKxr857ucxJgh2ovlfjg5SWl8vGjewWbWvWb8RkR1YyZLPH4vtTD61uNNhE0oysLSpneTiUtP8LrxCo8IeGg5haUYYtAWyDZoc3e0kTdFvZ",
  "expires_in": 10800,
  "token_type": "Bearer"
}

Response Content Type

Headers

Header	Description	Type	Other
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests.	string

Parameters

Parameter	Value	Description	Parameter Type	Data Type
oAuth2Client	Parameter content type:	oAuth2Client	body	Model Example Value OAuth2Client { client (string): Client ID as provided by UFT Mobile when an access key is generated , secret (string): Client Secret as provided by UFT Mobile when an access key is generated , tenant (integer): Tenant ID as provided by UFT Mobile when an access key is generated } `{ "client": "oauth2-DYoB9zWWjA0InHEffWbH@microfocus.com", "secret": "9JtkheIvd1MKv2QjDrby", "tenant": 999999999 }`

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request

401

Unauthorized

500

Internal server error

Application Operation : REST APIs for application

post /rest/apps/install

Install application on device

Response Class (Status 200)

Response for success

{
  "app": {
    "counter": 0,
    "id": "string",
    "instrumented": true,
    "name": "string",
    "uuid": "string",
    "version": "string"
  },
  "content": {},
  "devices": {
    "failure": [
      {
        "code": 0,
        "reason": "string",
        "udid": "string"
      }
    ],
    "success": [
      {
        "udid": "string"
      }
    ]
  },
  "status": true,
  "translation": "string"
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
installationDetails	Parameter content type:	Install an application onto a device. To install a specific application, you must provide a value for either the "uuid" parameter or a combination of the "identifier", "counter", and "instrumented" parameters. If you omit the “instrumented” parameter, the default behavior will be to use the instrumented version. If it cannot find the instrumented version, it will use the non-instrumented version.	body	Model Example Value InstallationDetails { app (AppParameters, optional), deviceCapabilities (ApiDocCapabilitiesDetails), jobId (string): Enable to install application in existing job if it's the same user. If job does not exist we creates one behind the scene and remove it after the operation is finished. If job exist and you do not supply it, your api call to install will fail. If job exist and you supply jobId then it install the app. } AppParameters { counter (integer): The application upload number. , id (string): The application identifier , instrumented (boolean): Flag that decide whether to install instrumented or non-instrumented version of the application. If do not supply the instrumented flag, the default behavior will try to find the instrumented version, If it fails to find the instrumented version, it will use the non-instrumented version. , uuid (string): The UUID identifier of the application as assigned by UFT Mobile } ApiDocCapabilitiesDetails { deviceHostingType (string, optional): PrivateOnPremise (UFT Mobile default value) \| PrivateHosting \| Public , deviceName (string, optional): Emulator support - If only deviceName contains "simulator" or "emulator" so only device (deviceType=emulator) will be returned In the mean time, all sub-string delimited by space in deviceName (after removing simulator/emulator) should be contained in any of manufacturer, model or logicName For non-emulator (physical) devices, all sub-string delimited by space in deviceName should be contained in any of manufacturer, model or logicName Refined query support – if deviceName value is enclosed with double-quotes, the value inside the double-quotes is a refined result matching exactly (manufacturer model) with space in between , location (string, optional): US \| GERMANY \| or ANY (US/GERMANY) -- represents the location of device , platformName (string, optional): iOS \| Android , platformVersion (string, optional), source (string, optional): AWS \| UFTM \| HOSTED \| GENYCLOUD \| WETEST or ANY (AWS/UFTM/GENYCLOUD/HOSTED/WETEST) -- represents the source of device , svEnabled (boolean, optional): svEnabled (True \| False (default value)) , templateId (string, optional): For selecting specific public device template, NULL value for any matching device template , udid (string, optional) } `{ "app": { "counter": 0, "id": "string", "instrumented": false, "uuid": "string" }, "deviceCapabilities": { "deviceHostingType": "string", "deviceName": "string", "location": "string", "platformName": "string", "platformVersion": "string", "source": "string", "svEnabled": false, "templateId": "string", "udid": "string" }, "jobId": "string" }`

Response Messages

HTTP Status Code Reason Response Model Headers

400

Bad request

{
  "message": "string",
  "messageCode": 0
}

403

Forbid to get device

500

Internal server error

post /rest/apps/uninstall{?includeNonMc}

Uninstall application from device

Response Class (Status 200)

Response for success

{
  "app": {
    "counter": 0,
    "id": "string",
    "instrumented": true,
    "name": "string",
    "uuid": "string",
    "version": "string"
  },
  "content": {},
  "devices": {
    "failure": [
      {
        "code": 0,
        "reason": "string",
        "udid": "string"
      }
    ],
    "success": [
      {
        "udid": "string"
      }
    ]
  },
  "status": true,
  "translation": "string"
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
uninstallDetails	Parameter content type:	Uninstall an application from a device. To uninstall a specific application, you must provide either a "uuid" or "id" value as an “app” property. You must also specify a device using "deviceName" or "udid" parameter as shown in the sample schema.	body	Model Example Value UninstallApplicationModel { app (AppParametersForUninstall), deviceCapabilities (DeviceCapabilities), jobId (string): Enable to install application in existing job if it's the same user. If job does not exist we creates one behind the scene and remove it after the operation is finished. If job exist and you do not supply it, your api call to install will fail. If job exist and you supply jobId then it install the app. } AppParametersForUninstall { id (string): The application identifier , uuid (string): The UUID identifier of the application as assigned by UFT Mobile } DeviceCapabilities { deviceName (string): The device model name , udid (string): The UDID identifier of the device as assigned by UFT Mobile } `{ "app": { "id": "string", "uuid": "string" }, "deviceCapabilities": { "deviceName": "string", "udid": "string" }, "jobId": "string" }`
includeNonMc		includeNonMc	query	boolean

Response Messages

HTTP Status Code Reason Response Model Headers

400

Bad request

{
  "message": "string",
  "messageCode": 0
}

403

Forbid to get device

500

Internal server error

post /rest/apps{?workspaceId,package,resign}

Upload application

Response Class (Status 200)

Response Class

{
  "counter": 0,
  "id": "string",
  "instrumentationStatus": "string",
  "name": "string",
  "uuid": "string",
  "version": "string"
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
request	Parameter content type:	file to upload	body	file
workspaceId		workspaceId is used to upload an app to a specific workspace. This option is supported only with an Enterprise or Ultimate license	query	string
package		the upload app needs to be packaged or not	query	boolean
resign		only for ios apps. It's default value is TRUE.	query	boolean

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

The application {0} could not be uploaded. | The application {0} couldn't be uploaded because the application file name contains one or more of the following invalid characters: "&<;/"

500

Internal Server Error

Connectors Management : REST APIs for connectors management

get /rest/connector{?requiredStatus}

Get list of connectors

Response Class (Status 200)

Success

[
  {
    "agents": [
      {
        "name": "string",
        "uuid": "string",
        "version": "string"
      }
    ],
    "connectivityChanged": 0,
    "deviceCount": 0,
    "externalUrl": "string",
    "id": 0,
    "location": "string",
    "name": "string",
    "nameSpace": "string",
    "notificationDetails": {
      "upgradeState": "string"
    },
    "oauth2TokenName": "string",
    "owner": "string",
    "private": false,
    "runningJobs": 0,
    "srfHosted": false,
    "status": "CONNECTED",
    "versions": {
      "downloadedConnector": "string",
      "guiVersion": "string",
      "runningConnector": "string"
    }
  }
]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
requiredStatus	Filter the connector list by the connectivity state (optional). By default, the list is filtered by CONNECTED, only returning the connected devices.	query	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

403

Forbidden

Reservation : REST APIs for device reservation

get /rest/v2/public/reservation

get all reservation

Response Class (Status 200)

Response for success

[
  {
    "reservationUid": "string",
    "startTime": "string",
    "endTime": "string",
    "releaseOnJobCompletion": false,
    "deviceCapabilities": {
      "deviceName": "string",
      "udid": "string"
    },
    "reservedForUser": {
      "id": "string",
      "name": "string"
    }
  }
]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

500

Internal server error

post /rest/v2/public/reservation

create reservation

Response Class (Status 200)

Response for success

{
  "errorMessages": [
    {
      "message": "string",
      "messageCode": 0
    }
  ],
  "reservationUid": "string"
}

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
reservationDetails	Parameter content type:	Create reservation for device by capabilities. The reservation date and time format as represented by the RFC3339 standard, in ANY time zone, "yyyy-MM-dd'T'HH:mm:ssXXX", Where y - Year M - Month in year d - Day in month H - Hour in day (0-23) m - Minute in hour s - Second in minute S - Millisecond X - Time zone ISO 8601 time zone. i.e: 1996-12-19T16:39:57-08:00 This represents 39 minutes and 57 seconds after the 16th hour of December 19th, 1996 with an offset of -08:00 from UTC (Pacific Standard Time).	body	Model Example Value CreateReservationModel { startTime (string): Start time in RFC3339 format, in ANY time zone , endTime (string, optional): End time in RFC3339 format, in ANY time zone. The default end time is 30 minutes. For unlimited reservation insert -1. , releaseOnJobCompletion (boolean, optional): Release the reservation when the job completed. The default value is false. , deviceCapabilities (DeviceCapabilities) } DeviceCapabilities { deviceName (string): The device model name , udid (string): The UDID identifier of the device as assigned by UFT Mobile } `{ "startTime": "string", "endTime": "string", "releaseOnJobCompletion": false, "deviceCapabilities": { "deviceName": "string", "udid": "string" } }`

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request

404

Not found

500

Internal server error

delete /rest/v2/public/reservation/{uid}

delete reservation

get /rest/v2/public/reservation/{uid}

get reservation

Response Class (Status 200)

Response for success

{
  "reservationUid": "string",
  "startTime": "string",
  "endTime": "string",
  "releaseOnJobCompletion": false,
  "deviceCapabilities": {
    "deviceName": "string",
    "udid": "string"
  },
  "reservedForUser": {
    "id": "string",
    "name": "string"
  }
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
uid	uid	path	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request

404

Not found

Genymotion cloud : REST APIs for Genymotion cloud

Data Usage : REST APIs for product data usage

get /rest/datausage{?TENANTID}

Get usage data audit files

Implementation Notes

Returns data usage files in CSV format. This operation requires an Admin role.When using shared spaces (multitenancy) with UFT Mobile, the operator can use this operation by setting the tenant-id header to 0 to get operational console data usage.

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
TENANTID	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	query	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

200

403

Operation requires the collect usage data flag to be enabled and an Admin role

404

usage data files cannot be found

Workspace Management : REST APIs for workspace management

put /rest/v2/workspaces/users

Assign or remove users to or from workspace

Response Class (Status 200)

OK | Users are assigned or removed to or from Workspace successfully

[
  {
    "applications": [
      {
        "appActivity": "string",
        "appBuildVersion": "string",
        "appPackage": "string",
        "appUdid": "string",
        "appVersion": "string",
        "applicationExist": true,
        "bundleId": "string",
        "comment": "string",
        "counter": 0,
        "dateTime": 0,
        "deviceFamily": "string",
        "fileName": "string",
        "icon": "string",
        "iconUrl": "string",
        "id": "string",
        "identifier": "string",
        "instrumentationFailureCode": 0,
        "instrumentationFailureReason": "string",
        "instrumentationStatus": "string",
        "instrumented": true,
        "instrumentedApplicationExist": true,
        "iosagent": true,
        "launchActivity": "string",
        "minimumOsVersion": "string",
        "name": "string",
        "provisionedDevices": [
          "string"
        ],
        "source": "string",
        "svInstrumented": true,
        "type": "string",
        "urlScheme": "string",
        "version": "string",
        "workspaces": [
          {
            "description": "string",
            "name": "string",
            "uuid": "string"
          }
        ]
      }
    ],
    "description": "string",
    "devices": [
      {
        "agentVersion": "string",
        "apiLevel": "string",
        "captureAudioEnabled": true,
        "connectedBy": "string",
        "connectionIssues": [
          "string"
        ],
        "connectionType": "string",
        "connectorID": 0,
        "connectorIP": "string",
        "connectorLocation": "string",
        "connectorName": "string",
        "connectorNamespace": "string",
        "connectorPort": "string",
        "connectorProtocol": "string",
        "customerName": "string",
        "deviceComment": "string",
        "deviceHostingType": "string",
        "deviceID": "string",
        "deviceIP": "string",
        "deviceStatus": "string",
        "deviceStatusWithReservation": "string",
        "deviceType": "string",
        "deviceWiFiIP": "string",
        "dpcReady": true,
        "extraInformation": "string",
        "family": "string",
        "fleetType": "string",
        "healthStatus": {
          "error": true,
          "message": [
            "string"
          ]
        },
        "imei": "string",
        "isDevTunneled": true,
        "lastUsedTime": 0,
        "localCountry": "string",
        "localLanguage": "string",
        "logicName": "string",
        "macAddress": "string",
        "maintenanceModeEnabled": true,
        "manufacturer": "string",
        "mobileType": "string",
        "mode": "string",
        "model": "string",
        "nextReservationTimeStart": 0,
        "osType": "string",
        "osVersion": "string",
        "publicHosted": true,
        "queue": 0,
        "requestId": "string",
        "requestTime": 0,
        "reservationCustomerName": "string",
        "reservationStartTime": 0,
        "reservationTimeFinish": 0,
        "reservedByMe": true,
        "serialNumber": "string",
        "settingBlockFailed": true,
        "source": "string",
        "startTime": 0,
        "statusChangeTime": 0,
        "svEnabled": true,
        "tenantId": 0,
        "workspaces": [
          {
            "description": "string",
            "name": "string",
            "uuid": "string"
          }
        ]
      }
    ],
    "isDefault": true,
    "isPrivate": true,
    "isShared": true,
    "ldapEntityAssigned": true,
    "ldapServerGroups": [
      {
        "displayName": "string",
        "ldapGroups": "string",
        "ldapServerConfigurationName": "string",
        "ldapServerConfigurationUuid": "string",
        "uuid": "string",
        "workspaces": [
          {
            "description": "string",
            "name": "string",
            "uuid": "string"
          }
        ]
      }
    ],
    "name": "string",
    "privateConnectorId": 0,
    "users": [
      {
        "id": "string",
        "isAdmin": true,
        "isUser": true,
        "isWorkspaceAdmin": true,
        "messages": [
          "string"
        ],
        "name": "string",
        "roles": [
          {
            "description": "string",
            "name": "string"
          }
        ],
        "workspaces": [
          {
            "description": "string",
            "name": "string",
            "uuid": "string"
          }
        ]
      }
    ],
    "uuid": "string"
  }
]

Response Content Type

Parameters

Parameter	Value	Description	Parameter Type	Data Type
Authorization		Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID		Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret		Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id		The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
usersWorkspacesMultiOperationDetail	Parameter content type:	usersWorkspacesMultiOperationDetail	body	Model Example Value UsersWorkspacesMultiOperationDetail { userList (Array[string], optional): The user uuid list we need to operate on. , workspaceBulkDetailsList (Array[WorkspaceBulkDetails], optional): The workspace list we need to operate on. } WorkspaceBulkDetails { operation (string, optional): The operation for this workspace.ADD_USER \| DELETE_USER , workSpaceId (string, optional): The workspaceId. } `{ "userList": [ "string" ], "workspaceBulkDetailsList": [ { "operation": "string", "workSpaceId": "string" } ] }`

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Bad request - User or workspace doesn't exist

403

Only admin can do this operation

500

Internal server error

get /rest/v2/workspaces/{workspaceUuid}/apps

Get workspace applications

Response Class (Status 200)

[
  {
    "appActivity": "string",
    "appBuildVersion": "string",
    "appPackage": "string",
    "appUdid": "string",
    "appVersion": "string",
    "applicationExist": true,
    "bundleId": "string",
    "comment": "string",
    "counter": 0,
    "dateTime": 0,
    "deviceFamily": "string",
    "fileName": "string",
    "icon": "string",
    "iconUrl": "string",
    "id": "string",
    "identifier": "string",
    "instrumentationFailureCode": 0,
    "instrumentationFailureReason": "string",
    "instrumentationStatus": "string",
    "instrumented": true,
    "instrumentedApplicationExist": true,
    "iosagent": true,
    "launchActivity": "string",
    "minimumOsVersion": "string",
    "name": "string",
    "provisionedDevices": [
      "string"
    ],
    "source": "string",
    "svInstrumented": true,
    "type": "string",
    "urlScheme": "string",
    "version": "string",
    "workspaces": [
      {
        "description": "string",
        "name": "string",
        "uuid": "string"
      }
    ]
  }
]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
workspaceUuid	workspaceUuid	path	string

get /rest/v2/workspaces/{workspaceUuid}/devices

Get workspace devices

Response Class (Status 200)

[
  {
    "agentVersion": "string",
    "apiLevel": "string",
    "captureAudioEnabled": true,
    "connectedBy": "string",
    "connectionIssues": [
      "string"
    ],
    "connectionType": "string",
    "connectorID": 0,
    "connectorIP": "string",
    "connectorLocation": "string",
    "connectorName": "string",
    "connectorNamespace": "string",
    "connectorPort": "string",
    "connectorProtocol": "string",
    "customerName": "string",
    "deviceComment": "string",
    "deviceHostingType": "string",
    "deviceID": "string",
    "deviceIP": "string",
    "deviceStatus": "string",
    "deviceStatusWithReservation": "string",
    "deviceType": "string",
    "deviceWiFiIP": "string",
    "dpcReady": true,
    "extraInformation": "string",
    "family": "string",
    "fleetType": "string",
    "healthStatus": {
      "error": true,
      "message": [
        "string"
      ]
    },
    "imei": "string",
    "isDevTunneled": true,
    "lastUsedTime": 0,
    "localCountry": "string",
    "localLanguage": "string",
    "logicName": "string",
    "macAddress": "string",
    "maintenanceModeEnabled": true,
    "manufacturer": "string",
    "mobileType": "string",
    "mode": "string",
    "model": "string",
    "nextReservationTimeStart": 0,
    "osType": "string",
    "osVersion": "string",
    "publicHosted": true,
    "queue": 0,
    "requestId": "string",
    "requestTime": 0,
    "reservationCustomerName": "string",
    "reservationStartTime": 0,
    "reservationTimeFinish": 0,
    "reservedByMe": true,
    "serialNumber": "string",
    "settingBlockFailed": true,
    "source": "string",
    "startTime": 0,
    "statusChangeTime": 0,
    "svEnabled": true,
    "tenantId": 0,
    "workspaces": [
      {
        "description": "string",
        "name": "string",
        "uuid": "string"
      }
    ]
  }
]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
workspaceUuid	workspaceUuid	path	string

get /rest/v2/workspaces/{workspaceUuid}/users/pageable{?page,size,name,roles}

Get workspace users

Response Class (Status 200)

{
  "id": "string",
  "isAdmin": true,
  "isUser": true,
  "isWorkspaceAdmin": true,
  "ldapGroups": [
    "string"
  ],
  "ldapServerId": "string",
  "locale": "string",
  "messages": [
    "string"
  ],
  "name": "string",
  "roles": [
    {
      "description": "string",
      "name": "string"
    }
  ],
  "workspaces": [
    {
      "description": "string",
      "name": "string",
      "uuid": "string"
    }
  ]
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
page	The zero-based page index	query	undefined
size	The size of the page	query	undefined
workspaceUuid	workspaceUuid	path	string
name	name	query	string
roles	roles	query	Array[string]

get /rest/v2/workspaces{?includeRelations,includeSharedAssets,lastAppVersion,isSummary}

Get all workspaces

Response Class (Status 200)

[
  {
    "applications": [
      {
        "appActivity": "string",
        "appBuildVersion": "string",
        "appPackage": "string",
        "appUdid": "string",
        "appVersion": "string",
        "applicationExist": true,
        "bundleId": "string",
        "comment": "string",
        "counter": 0,
        "dateTime": 0,
        "deviceFamily": "string",
        "fileName": "string",
        "icon": "string",
        "iconUrl": "string",
        "id": "string",
        "identifier": "string",
        "instrumentationFailureCode": 0,
        "instrumentationFailureReason": "string",
        "instrumentationStatus": "string",
        "instrumented": true,
        "instrumentedApplicationExist": true,
        "iosagent": true,
        "launchActivity": "string",
        "minimumOsVersion": "string",
        "name": "string",
        "provisionedDevices": [
          "string"
        ],
        "source": "string",
        "svInstrumented": true,
        "type": "string",
        "urlScheme": "string",
        "version": "string",
        "workspaces": [
          {
            "description": "string",
            "name": "string",
            "uuid": "string"
          }
        ]
      }
    ],
    "description": "string",
    "devices": [
      {
        "agentVersion": "string",
        "apiLevel": "string",
        "captureAudioEnabled": true,
        "connectedBy": "string",
        "connectionIssues": [
          "string"
        ],
        "connectionType": "string",
        "connectorID": 0,
        "connectorIP": "string",
        "connectorLocation": "string",
        "connectorName": "string",
        "connectorNamespace": "string",
        "connectorPort": "string",
        "connectorProtocol": "string",
        "customerName": "string",
        "deviceComment": "string",
        "deviceHostingType": "string",
        "deviceID": "string",
        "deviceIP": "string",
        "deviceStatus": "string",
        "deviceStatusWithReservation": "string",
        "deviceType": "string",
        "deviceWiFiIP": "string",
        "dpcReady": true,
        "extraInformation": "string",
        "family": "string",
        "fleetType": "string",
        "healthStatus": {
          "error": true,
          "message": [
            "string"
          ]
        },
        "imei": "string",
        "isDevTunneled": true,
        "lastUsedTime": 0,
        "localCountry": "string",
        "localLanguage": "string",
        "logicName": "string",
        "macAddress": "string",
        "maintenanceModeEnabled": true,
        "manufacturer": "string",
        "mobileType": "string",
        "mode": "string",
        "model": "string",
        "nextReservationTimeStart": 0,
        "osType": "string",
        "osVersion": "string",
        "publicHosted": true,
        "queue": 0,
        "requestId": "string",
        "requestTime": 0,
        "reservationCustomerName": "string",
        "reservationStartTime": 0,
        "reservationTimeFinish": 0,
        "reservedByMe": true,
        "serialNumber": "string",
        "settingBlockFailed": true,
        "source": "string",
        "startTime": 0,
        "statusChangeTime": 0,
        "svEnabled": true,
        "tenantId": 0,
        "workspaces": [
          {
            "description": "string",
            "name": "string",
            "uuid": "string"
          }
        ]
      }
    ],
    "isDefault": true,
    "isPrivate": true,
    "isShared": true,
    "ldapEntityAssigned": true,
    "ldapServerGroups": [
      {
        "displayName": "string",
        "ldapGroups": "string",
        "ldapServerConfigurationName": "string",
        "ldapServerConfigurationUuid": "string",
        "uuid": "string",
        "workspaces": [
          {
            "description": "string",
            "name": "string",
            "uuid": "string"
          }
        ]
      }
    ],
    "name": "string",
    "privateConnectorId": 0,
    "users": [
      {
        "id": "string",
        "isAdmin": true,
        "isUser": true,
        "isWorkspaceAdmin": true,
        "messages": [
          "string"
        ],
        "name": "string",
        "roles": [
          {
            "description": "string",
            "name": "string"
          }
        ],
        "workspaces": [
          {
            "description": "string",
            "name": "string",
            "uuid": "string"
          }
        ]
      }
    ],
    "uuid": "string"
  }
]

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
includeRelations	includeRelations	query	boolean
includeSharedAssets	includeSharedAssets	query	boolean
lastAppVersion	lastAppVersion	query	boolean
isSummary	isSummary	query	boolean

Response Messages

HTTP Status Code

Reason

Response Model

Headers

403

Only admin can do this operation

404

Workspace not found

High Availability : REST APIs for high availability

Get cloud device template list : REST APIs for cloud device types

get /rest/v2/deviceAAS/types{?source}

Get cloud device template list

Response Class (Status 200)

Response Class

{
  "availability": "string",
  "fleetType": "string",
  "formFactor": "string",
  "manufacturer": "string",
  "model": "string",
  "osType": "string",
  "osVersion": "string",
  "templateId": "string"
}

Response Content Type

Parameters

Parameter	Description	Parameter Type	Data Type
Authorization	Standard Authorization header using the Bearer scheme. Example: "Bearer {token}". See "OAuth2 Access Token Request" REST API, under the Authentication Operations, for token URL and required parameters.	header	string
JSESSIONID	Deprecated, use the appropriate `Authorization` header instead. The session ID as returned by /rest/client/login operation in a cookie named `JSESSIONID`.	header	string
x-hp4msecret	Universally unique CSRF token to avoid external malicious requests. The CSRF token as returned by /rest/oauth2/token or /rest/client/login operations in a response header named `x-hp4msecret`.	header	string
tenant-id	The shared space ID. Required when using shared spaces (multitenancy) with UFT Mobile.	header	string
source	AWS for ADF, GENYCLOUD for Genymotion.	query	string

Response Messages

HTTP Status Code

Reason

Response Model

Headers

400

Invalid arguments. | Invalid operation.

Devices : REST APIs for devices

Implementation Notes

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Curl

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Implementation Notes

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Response Messages

Curl

Request URL

Response Body

Response Code

Response Headers

Response Class (Status 200)

Parameters

Response Messages