Devices | Parallels REST API

List

Retrieve Criteria Device List of a session server with the specified ID.

GET/api/PubItems/{id}/Rules/{ruleId}/Criteria/Devices

Path parameters

id*integer (int32)

The ID of a session server for which to retrieve the Criteria settings.

ruleId*integer (int32)

The ID of the Rule to retrieve.

Response

Success

Body

clientnullable string

The name of the client device.

Request

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/Devices', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "client": "text"
  }
]

Add

Add a device to the Device List of the Criteria settings.

POST/api/PubItems/{id}/Rules/{ruleId}/Criteria/Devices

Path parameters

id*integer (int32)

The ID of a session server for which to modify the Criteria settings.

ruleId*integer (int32)

The ID of the Rule to retrieve.

Body

Device configuration.

clientDeviceName*nullable string

The name of the client device to add to the Criteria.

Response

Created

Request

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/Devices', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "clientDeviceName": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Remove

Remove a device from the Device List of the Criteria settings.

DELETE/api/PubItems/{id}/Rules/{ruleId}/Criteria/Devices

Path parameters

id*integer (int32)

The ID of a session server for which to modify the Criteria settings.

ruleId*integer (int32)

The ID of the Rule to retrieve.

Body

Device configuration.

clientDeviceName*nullable string

The name of the client device to remove from the Criteria.

Response

No Content

Request

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/Devices', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "clientDeviceName": "text"
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}