Sensors - Create Or Update

Ссылка

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

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

Создание сущности датчика.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string uri	Имя узла пространства имен, например admaInstanceName.farmbeats.azure.net
sensorId	path	True	string	Идентификатор ресурса датчика.
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"

Имя	Тип	Описание
depthInMeters	number[]	Глубина каждого датчика измеряется в метрах. Как датчик влажности на 2 м, 4 м, 6 м.
description	string	Текстовое описание ресурса.
deviceId	string	Идентификатор связанного устройства.
hardwareId	string	Идентификатор связанного оборудования.
integrationId	string	Идентификатор интеграции для устройства.
location	Location	Класс модели расположения.
name	string	Имя для идентификации ресурса.
port	Port	Схема для хранения значений портов.
properties		Коллекция пар "ключ-значение", принадлежащих ресурсу. Каждая пара не должна содержать ключ, превышающий 50 символов, и значение не должно превышать 150 символов. Примечание. Для ресурса можно указать не более 25 пар ключевых значений, и поддерживаются только строковые, числовые значения и значения даты и времени (гггг-ММ-ддТЧЧ:мм:ссЗ).
sensorDataModelId	string	Идентификатор связанной модели данных датчика.
status	string	Состояние ресурса.
type	string	Тип датчика.

Ответы

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

Имя

Тип

Описание

200 OK

Sensor

Успех

201 Created

Sensor

Создание

Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

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

Authorization

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

Тип: apiKey
В: header

Примеры

Sensors_CreateOrUpdate

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

HTTP

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

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD 456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "status": "sm created",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

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

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

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

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

{
  "sensorDataModelId": "sdm124",
  "integrationId": "string",
  "hardwareId": "SMHD-456",
  "deviceId": "d124",
  "type": "SM",
  "location": {
    "latitude": 23.5,
    "longitude": 42.7
  },
  "port": {
    "name": "measure",
    "type": "digital"
  },
  "sensorPartnerId": "sp1",
  "id": "s124",
  "status": "sm created",
  "createdDateTime": "2022-01-24T06:27:05Z",
  "modifiedDateTime": "2022-01-24T06:27:05Z",
  "eTag": "040139eb-0000-0700-0000-61ee46b90000",
  "name": "my new sm",
  "description": "description for sensor goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

Определения

Имя	Описание
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	Класс модели расположения.
Port	Схема для хранения значений портов.
Sensor	Модель API датчика.

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	Долгота расположения.

Port

Схема для хранения значений портов.

Имя	Тип	Описание
name	string	Имя порта.
type	string	Тип цифрового или аналогового порта.

Sensor

Модель API датчика.

Имя	Тип	Описание
createdBy	string	Создается по идентификатору пользователя или клиента.
createdDateTime	string	Дата и время создания ресурса. Пример формата: yyyy-MM-ddTHH:mm:ssZ.
depthInMeters	number[]	Глубина каждого датчика измеряется в метрах. Как датчик влажности на 2 м, 4 м, 6 м.
description	string	Текстовое описание ресурса.
deviceId	string	Идентификатор связанного устройства.
eTag	string	Значение ETag для реализации оптимистичного параллелизма.
hardwareId	string	Идентификатор связанного оборудования.
id	string	Идентификатор ресурса.
integrationId	string	Идентификатор интеграции для устройства.
location	Location	Класс модели расположения.
modifiedBy	string	Изменен по идентификатору пользователя или клиента.
modifiedDateTime	string	Дата и время последнего изменения ресурса. Пример формата: yyyy-MM-ddTHH:mm:ssZ.
name	string	Имя для идентификации ресурса.
port	Port	Схема для хранения значений портов.
properties		Коллекция пар "ключ-значение", принадлежащих ресурсу. Каждая пара не должна содержать ключ, превышающий 50 символов, и значение не должно превышать 150 символов. Примечание. Для ресурса можно указать не более 25 пар ключевых значений, и поддерживаются только строковые, числовые значения и значения даты и времени (гггг-ММ-ддТЧЧ:мм:ссЗ).
sensorDataModelId	string	Идентификатор связанной модели данных датчика.
sensorPartnerId	string	Идентификатор связанного партнера датчика.
status	string	Состояние ресурса.
type	string	Тип датчика.

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

Sensors - Create Or Update

Параметры URI

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

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

Ответы

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

Authorization

Примеры

Sensors_CreateOrUpdate

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

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

Определения

Error

ErrorResponse

InnerError

Location

Port

Sensor

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