Создать устройство

POST

https://one.digicert.com/iot/api/v1/device

Добавить устройство для управления.

bash

{
  "division_id": "fd5faa1e-623a-47a9-831b-b9397c33395f",
  "device_identifier": "New Device",
  "device_profile_id": "a81a431a-be7b-4f2e-8afd-b2778491511f",
  "fields": [
    {
      "id": "417c328e-604c-4e94-9112-ee58f12277fb",
      "value": "mandatory value"
    },
    {
      "id": "90eb4de2-ae8a-48a0-a904-d30c5ab6e1de",
      "value": "optional value"
    }
  ]
}

201 Created

{
  "id": "64c02969-3890-4da8-a5ef-b574fd72887e",
  "account_id": "1d1ec1ec-6502-11e9-a923-1681be663d3e",
  "division": {
    "id": "fd5faa1e-623a-47a9-831b-b9397c33395f",
    "name": "Mock Division 1"
  },
  "device_identifier": "New Device",
  "device_profile": {
    "id": "a81a431a-be7b-4f2e-8afd-b2778491511f",
    "name": "Device Profile"
  },
  "created": "2020-04-22T07:13:20Z",
  "updated": "2020-04-22T07:13:20Z",
  "status": "ACTIVE",
  "fields": [
    {
      "id": "417c328e-604c-4e94-9112-ee58f12277fb",
      "name": "Mandatory Field",
      "value": "mandatory value",
      "mandatory": true
    },
    {
      "id": "90eb4de2-ae8a-48a0-a904-d30c5ab6e1de",
      "name": "Optional Field",
      "value": "optional value",
      "mandatory": false
    }
  ]
}

400 Bad Request

{
  "errors": [
    {
      "code": "invalid_input",
      "message": "Device with division fd5faa1e-623a-47a9-831b-b9397c33395f and identifier New Device already exist"
    }
  ]
}

Параметры запроса

Имя	Обязательный/Необязательный	Тип	Описание
division_id		string	Идентификатор подразделения
device_identifier		string	Идентификатор устройства Не должен быть пустым, макс. 255. Должен быть уникальным внутри подразделения
device_profile_id	обязательный	string	Идентификатор профиля устройства, используемого в качестве шаблона при создании устройства
fields		array	Матрица полей
.. id		string	Идентификатор поля (соответствует идентификатору поля профиля устройства)
.. value		string	Значение поля. Обязательность определяется профилем устройства. Макс. 1024 символа

Параметры ответного сообщения

Имя	Тип	Описание
id	string	Уникальный идентификатор устройства
account_id	string	Идентификатор учетной записи
division	object	Контейнер подразделения
.. id	string	Идентификатор подразделения
.. name	string	Имя подразделения
device_identifier	string	Идентификатор устройства
device_profile	object	Контейнер профиля устройства
.. id	string	Идентификатор профиля устройства
.. name	string	Имя профиля устройства
created	string	Дата и время создания (UTC)
updated	string	Дата и время последнего обновления (UTC)
status	string	Статус (для вновь созданного устройства всегда АКТИВНЫЙ)
fields	array	Матрица полей
.. id	string	Идентификатор поля
.. name	string	Имя поля (из профиля устройства)
.. value	string	Значение поля
.. mandatory	boolean	Является ли поле обязательным? (истина или ложь, в зависимости от профиля устройства)

Параметры запроса

Параметры ответного сообщения

О проекте