Devices - Create Or Update

Ссылка

Служба:: Azure Data Manager for Agriculture

Версия API:: 2023-11-01-preview

Создание сущности устройства.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/devices/{deviceId}?api-version=2023-11-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
deviceId	path	True	string	Идентификатор ресурса устройства.
endpoint	path	True	string (uri)	Имя узла пространства имен, например admaInstanceName.farmbeats.azure.net
sensorPartnerId	path	True	string	Идентификатор партнера датчика.
api-version	query	True	string	Запрошенная версия API

Заголовок запроса

Media Types: "application/merge-patch+json"

Имя	Обязательно	Тип	Описание
Authorization	True	string	Укажите действительный маркер носителя для авторизованных вызовов API. Обратите внимание, что может потребоваться очистить кэш браузера, если вы ранее попытались отменить проверку подлинности вызовов.

Текст запроса

Media Types: "application/merge-patch+json"

Имя	Тип	Описание
description	string minLength: 0 maxLength: 500	Текстовое описание ресурса.
deviceDataModelId	string	Идентификатор связанной модели данных устройства.
hardwareId	string minLength: 0 maxLength: 100	Аппаратный идентификатор устройства.
integrationId	string	Идентификатор интеграции для устройства.
location	Location	Класс модели расположения.
name	string minLength: 0 maxLength: 100	Имя для идентификации ресурса.
parentDeviceId	string	Родительский идентификатор устройства для этого устройства.
properties		Коллекция пар значений ключей, принадлежащих ресурсу. Каждая пара не должна иметь ключ больше 50 символов и не должна иметь значение больше 150 символов. Примечание. Поддерживаются не более 25 пар значений ключей для ресурса и только строк, числовых и датовых значений (гггг-ММ-ддTHH:мм:ssZ).
reportingIntervalInSeconds	integer (int32)	Интервал, с которым устройство отправляет данные в секунды.
status	string minLength: 0 maxLength: 100	Состояние ресурса.
type	string minLength: 0 maxLength: 100	Тип устройства.

Ответы

Имя	Тип	Описание
200 OK	Device	Успех
201 Created	Device	Создано
Other Status Codes	ErrorResponse	Ошибка Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

Device

Успех

201 Created

Device

Создано

Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

Безопасность

Authorization

Укажите действительный маркер носителя для авторизованных вызовов API. Обратите внимание, что может потребоваться очистить кэш браузера, если вы ранее попытались отменить проверку подлинности вызовов.

Тип: apiKey
В: header

Примеры

Devices_CreateOrUpdate

Образец запроса

HTTP

PATCH {endpoint}/sensor-partners/sp1/devices/d124?api-version=2023-11-01-preview

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "status": "new device",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Пример ответа

Код состояния:: 200

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:21:07Z",
  "eTag": "0401a5cc-0000-0700-0000-61ee45540000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Код состояния:: 201

{
  "deviceDataModelId": "ddm124",
  "integrationId": "string",
  "type": "device",
  "hardwareId": "HD156",
  "reportingIntervalInSeconds": 10,
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "sensorPartnerId": "sp1",
  "id": "d123",
  "status": "new device",
  "createdDateTime": "2022-01-24T06:20:47Z",
  "modifiedDateTime": "2022-01-24T06:20:47Z",
  "eTag": "0401baca-0000-0700-0000-61ee453f0000",
  "name": "my device",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Определения

Имя	Описание
Device	Модель API устройства.
Error	Ошибка из службы Azure AgPlatform.
ErrorResponse	Ответ об ошибке службы Azure AgPlatform. Справочный документ ErrorResponse см. в https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
Location	Класс модели расположения.

Device

Object

Модель API устройства.

Имя	Тип	Описание
createdBy	string	Создан идентификатором пользователя или клиента.
createdDateTime	string (date-time)	Дата создания ресурса, пример формата: гггг-ММ-ддTHH:мм:ssZ.
description	string minLength: 0 maxLength: 500	Текстовое описание ресурса.
deviceDataModelId	string	Идентификатор связанной модели данных устройства.
eTag	string	Значение ETag для реализации оптимистического параллелизма.
hardwareId	string minLength: 0 maxLength: 100	Аппаратный идентификатор устройства.
id	string	Идентификатор ресурса.
integrationId	string	Идентификатор интеграции для устройства.
location	Location	Класс модели расположения.
modifiedBy	string	Изменен идентификатором пользователя или клиента.
modifiedDateTime	string (date-time)	Дата и время последнего изменения ресурса: формат yy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Имя для идентификации ресурса.
parentDeviceId	string	Родительский идентификатор устройства для этого устройства.
properties		Коллекция пар значений ключей, принадлежащих ресурсу. Каждая пара не должна иметь ключ больше 50 символов и не должна иметь значение больше 150 символов. Примечание. Поддерживаются не более 25 пар значений ключей для ресурса и только строк, числовых и датовых значений (гггг-ММ-ддTHH:мм:ssZ).
reportingIntervalInSeconds	integer (int32)	Интервал, с которым устройство отправляет данные в секунды.
sensorPartnerId	string	Идентификатор связанного партнера датчика.
status	string minLength: 0 maxLength: 100	Состояние ресурса.
type	string minLength: 0 maxLength: 100	Тип устройства.

Error

Object

Ошибка из службы Azure AgPlatform.

Имя	Тип	Описание
code	string minLength: 1	Определяемый сервером набор кодов ошибок.
details	Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
message	string minLength: 1	Читаемое человеком представление ошибки.
target	string	Цель ошибки.

ErrorResponse

Object

Ответ об ошибке службы Azure AgPlatform. Справочный документ ErrorResponse см. в https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
error	Error	Ошибка из службы Azure AgPlatform.
traceId	string	Уникальный идентификатор трассировки.

InnerError

Object

Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.

Имя	Тип	Описание
code	string	Определенный код ошибки, чем был предоставлен содержащей ошибкой.
innererror	InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.

Location

Object

Класс модели расположения.

Имя	Тип	Описание
latitude	number (double) minimum: -90 maximum: 90	Широта расположения.
longitude	number (double) minimum: -180 maximum: 180	Долгота расположения.

Поделиться через

Devices - Create Or Update

Параметры URI

Заголовок запроса

Текст запроса

Ответы

Безопасность

Authorization

Примеры

Devices_CreateOrUpdate

Образец запроса

Пример ответа

Определения

Device

Error

ErrorResponse

InnerError

Location

Дополнительные ресурсы