Створити шаблон пристрою

GET 
/devices/:id/generate_template

Створіть шаблон пристрою, який може служити вихідною точкою для впровадження повної підтримки будь-якого пристрою стороннього виробника.

Request

Path Parameters

id integerrequired

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

Responses

200

Згенерований шаблон пристрою

application/json

Schema

Schema

successbooleanrequired

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

Example (from schema)

{
  "success": true
}

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
  }
}