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	Текстовое описание ресурса.
deviceDataModelId	string	Идентификатор связанной модели данных устройства.
hardwareId	string	HardwareId устройства.
integrationId	string	Идентификатор интеграции для устройства.
location	Location	Класс модели расположения.
name	string	Имя для идентификации ресурса.
parentDeviceId	string	Родительский идентификатор устройства для этого устройства.
properties		Коллекция пар "ключ-значение", принадлежащих ресурсу. Каждая пара не должна содержать ключ, превышающий 50 символов, и значение не должно превышать 150 символов. Примечание. Для ресурса можно указать не более 25 пар ключевых значений, и поддерживаются только строковые, числовые значения и значения даты и времени (гггг-ММ-ддТЧЧ:мм:ссЗ).
reportingIntervalInSeconds	integer	Интервал, с которым устройство отправляет данные в секундах.
status	string	Состояние ресурса.
type	string	Тип устройства.

Ответы

Имя	Тип	Описание
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. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses справочный документ ErrorResponse.
InnerError	Внутренняя ошибка, содержащая список ошибок. См. https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object справочный документ InnerError.
Location	Класс модели расположения.

Device

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

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

Error

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

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

ErrorResponse

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

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

InnerError

Внутренняя ошибка, содержащая список ошибок. См. 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

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

Имя	Тип	Описание
latitude	number	Широта расположения.
longitude	number	Долгота расположения.

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

Devices - Create Or Update

Параметры URI

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

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

Ответы

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

Authorization

Примеры

Devices_CreateOrUpdate

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

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

Определения

Device

Error

ErrorResponse

InnerError

Location

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