Skip to content

Mobile Devices

Get Mobile Device Details

/api/v2/mobiledevices/{id} 📋 Copied! ▼

Role: Guest and above.

Parameters

Name Description
id * Numeric ID of the Mobile Device.
Type: integer (path)

Responses

Code Description
200

Mobile Device data.

Media type: application/json

Example Value:

{
"id": 0,
"name": "string",
"msisdn": "string",
"imsi": "string",
"imei": "string",
"ranType": "_LTE_3G_2G_AUTO",
"testNodeId": 0,
"testNodeName": "string",
"testNodeInternalName": "string",
"deviceModelId": 0,
"deviceModelName": "string",
"subscriptionType": "string",
"platformName": "string",
"deviceId": "string",
"nationalFormat": "string",
"internationalFormat": "string",
"iccid": "string",
"eid": "string",
"projects": [
    {
        "id": 0,
        "name": "string"
    }
]
}
404

Resource was not found.

Update a Mobile Device

/api/v2/mobiledevices/{id} 📋 Copied! ▼

Role: Admin, or the user who created the Mobile Device.

name (at least 5 characters) and ranType are required; on create also testNodeId, deviceModelId, platformName and deviceId. msisdn is 9-16 characters, imsi 5-15, imei 15-17. ranType is one of _2G, _3G, _3G_2G_AUTO, _LTE, _LTE_3G_2G_AUTO, _5G, VOLTE, VOWIFI. platformName must match the platform of the device model.

Parameters

Name Description
id * Numeric ID of the Mobile Device.
Type: integer (path)

Request body *

{
"name": "string",
"msisdn": "string",
"imsi": "string",
"imei": "string",
"ranType": "_LTE_3G_2G_AUTO",
"testNodeId": 0,
"deviceModelId": 0,
"subscriptionType": "string",
"platformName": "string",
"deviceId": "string",
"nationalFormat": "string",
"internationalFormat": "string",
"iccid": "string",
"eid": "string"
}

Responses

Code Description
200

Mobile Device was updated successfully.
400

The body is invalid, or the platform does not match the device model.
404

Resource was not found.
409

Another Mobile Device already has this name, MSISDN or Device ID.

Delete a Mobile Device

/api/v2/mobiledevices/{id} 📋 Copied! ▼

Role: Admin, or the user who created the Mobile Device.

Parameters

Name Description
id * Numeric ID of the Mobile Device.
Type: integer (path)

Responses

Code Description
200

Mobile Device was deleted successfully.
404

Resource was not found.
409

The Mobile Device is used by a Test Case.

Execute Action on a Mobile Device

/api/v2/mobiledevices/{id}/action 📋 Copied! ▼

Role: Standard and above.

command is PREPARE (Phone Preparation, Android only) or REBOOT.

Parameters

Name Description
id * Numeric ID of the Mobile Device.
Type: integer (path)

Request body *

{
"command": "PREPARE",
"params": "string"
}

Responses

Code Description
200

The command was carried out. status is 200 on success and 500 on failure; result and error carry the device's answer.

Media type: application/json

Example Value:

{
"status": 200,
"result": {
},
"error": {
}
}
404

Resource was not found.
500

The command could not be sent.

List Mobile Devices

/api/v2/mobiledevices 📋 Copied! ▼

Role: Guest and above.

Parameters

Name Description
page Zero-based page number. Default 0.
Type: integer (query)
size Page size. Default 20.
Type: integer (query)
sort <field>,asc or <field>,desc.
Type: string (query)
prj Only return items assigned to these projects: comma-separated project IDs.
Type: string (query)
filterName text to search by name.
Type: string (query)
filterValue The search text.
Type: string (query)

Responses

Code Description
200

A page of Mobile Devices.

Media type: application/json

Example Value:

{
"content": [
    {
        "id": 0,
        "name": "string",
        "msisdn": "string",
        "imsi": "string",
        "imei": "string",
        "ranType": "_LTE_3G_2G_AUTO",
        "testNodeId": 0,
        "testNodeName": "string",
        "testNodeInternalName": "string",
        "deviceModelId": 0,
        "deviceModelName": "string",
        "subscriptionType": "string",
        "platformName": "string",
        "deviceId": "string",
        "nationalFormat": "string",
        "internationalFormat": "string",
        "iccid": "string",
        "eid": "string",
        "projects": [
            {
                "id": 0,
                "name": "string"
            }
        ]
    }
],
"totalElements": 0,
"totalPages": 0,
"number": 0,
"size": 20
}

Create a Mobile Device

/api/v2/mobiledevices 📋 Copied! ▼

Role: Standard and above.

name (at least 5 characters) and ranType are required; on create also testNodeId, deviceModelId, platformName and deviceId. msisdn is 9-16 characters, imsi 5-15, imei 15-17. ranType is one of _2G, _3G, _3G_2G_AUTO, _LTE, _LTE_3G_2G_AUTO, _5G, VOLTE, VOWIFI. platformName must match the platform of the device model.

Request body *

{
"name": "string",
"msisdn": "string",
"imsi": "string",
"imei": "string",
"ranType": "_LTE_3G_2G_AUTO",
"testNodeId": 0,
"deviceModelId": 0,
"subscriptionType": "string",
"platformName": "string",
"deviceId": "string",
"nationalFormat": "string",
"internationalFormat": "string",
"iccid": "string",
"eid": "string"
}

Responses

Code Description
201

ID of the Mobile Device.

Media type: application/json

Example Value:

{
"id": 0
}
400

The body is invalid, or the platform does not match the device model.
409

Another Mobile Device already has this name, MSISDN or Device ID.

List Test Cases using the Mobile Device

/api/v2/mobiledevices/{id}/testcases 📋 Copied! ▼

Parameters

Name Description
id * Numeric ID of the Mobile Device.
Type: integer (path)
page The page to list entries. Default value: 0.
Type: string (query)
size The page size for listing entries. Default value: 20.
Type: string (query)
sort The sort type for listing entries.
Type: string (query)

Responses

Code Description
200

OK

Media type: application/json

Example Value:

{
  "totalElements": 0,
  "totalPages": 0,
  "number": 0,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 0,
  "content": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "first": true,
  "last": true,
  "pageable": {
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 0,
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "empty": true
}

Check Status of Mobile Device

/api/v2/mobiledevices/{id}/status 📋 Copied! ▼

Role: Standard and above.

The node briefly reserves the device to check it.

Parameters

Name Description
id * Numeric ID of the Mobile Device.
Type: integer (path)

Responses

Code Description
200

What the node reports about the device: whether Appium is up, the device's states and its device information.

Media type: application/json

Example Value:

{
"appiumUp": true,
"states": {
},
"deviceInfo": {
}
}
404

Resource was not found.

Get Mobile Device uptime

/api/v2/mobiledevices/{id}/uptime 📋 Copied! ▼

Role: Guest and above.

Parameters

Name Description
id * Numeric ID of the Mobile Device.
Type: integer (path)

Responses

Code Description
200

The device's current state and how long it has been in it. status is UP, DOWN or UNKNOWN; time is a human-readable duration, for example 1 day 3 minutes.

Media type: application/json

Example Value:

{
"status": "UP",
"time": "1 day 3 minutes"
}
404

Resource was not found.

Get the uptime of all Mobile Devices

/api/v2/mobiledevices/uptime 📋 Copied! ▼

Role: Guest and above.

Responses

Code Description
200

One entry per Mobile Device. status is UP, DOWN or UNKNOWN; time is a human-readable duration, for example 1 day 3 minutes.

Media type: application/json

Example Value:

{
"data": [
    {
        "id": 0,
        "name": "string",
        "status": "UP",
        "time": "1 day 3 minutes"
    }
]
}