Запросіть дію

POST 
/devices/:id/actions

Викликати дію для пристрою

Request

Path Parameters

id integerrequired

Ідентифікатор пристрою

application/json

Body

Дія пристрою

oneOf

DeviceSingleActionCall

methodstringrequired

Назва дії, яку слід викликати

params

object

Аргументи дії, які повинні бути передані в дію. Викличте GET /devices/{id}/actions, щоб отримати список доступних дій та їх аргументів.

oneOf

title

DeviceMultiActionCall

Array [

methodstringrequired

Назва дії, яку слід викликати

params

object

Аргументи дії, які повинні бути передані в дію. Викличте GET /devices/{id}/actions, щоб отримати список доступних дій та їх аргументів.

oneOf

title

]

Responses

200

Дія розпочалася

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

results

object[]

Масив результатів дій виклику

Array [

oneOf

MOD1

deviceIdinteger

Ідентифікатор пристрою

Example: 1

pendingboolean

Статус очікування

Example: true

actionIdinteger

Ідентифікатор виклику дії

Example: 213

MOD2

deviceIdinteger

Ідентифікатор пристрою

Example: 1

pendingboolean

Статус очікування

Example: false

]

Example (from schema)

{
  "success": true,
  "results": [
    {
      "deviceId": 1,
      "pending": true,
      "actionId": 213
    },
    {
      "deviceId": 1,
      "pending": false
    }
  ]
}

401

Користувач не має дозволу.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4131,
  "errorMessage": "User not authorized",
  "errorParameters": "Not authorized"
}

403

Відмовлено в доступі

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4132,
  "errorMessage": "Access denied",
  "errorParameters": "Access denied"
}

404

Потрібний пристрій не знайдено.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4128,
  "errorMessage": "Not found",
  "errorParameters": {
    "type": "device",
    "id": 11
  }
}