Sensor Data Models - Create Or Update

Ссылка

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

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

Создание сущности модели данных датчика.

PATCH {endpoint}/sensor-partners/{sensorPartnerId}/sensor-data-models/{sensorDataModelId}?api-version=2023-11-01-preview

Параметры URI

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

Имя	Обязательно	Тип	Описание
measures	True	<string, SensorDataModelMeasure>	Сопоставление типа датчика с датчиками.
description		string	Текстовое описание ресурса.
manufacturer		string	Производитель датчика.
name		string	Имя для идентификации ресурса.
productCode		string	Датчик productCode.
properties			Коллекция пар "ключ-значение", принадлежащих ресурсу. Каждая пара не должна содержать ключ, превышающий 50 символов, и значение не должно превышать 150 символов. Примечание. Для ресурса можно указать не более 25 пар ключевых значений. Поддерживаются только значения string, numeral и datetime (гггг-ММ-ддTHH:мм:ссZ).
status		string	Состояние ресурса.
type		string	Тип датчика.

Ответы

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

Имя

Тип

Описание

200 OK

SensorDataModel

Успех

201 Created

SensorDataModel

Создание

Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

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

Authorization

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

Тип: apiKey
В: header

Примеры

SensorDataModels_CreateOrUpdate

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

HTTP

PATCH {endpoint}/sensor-partners/sp1/sensor-data-models/sdm124?api-version=2023-11-01-preview

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "status": "new",
  "name": "my sdm for soil moisture",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

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

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

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "sensorPartnerId": "sp1",
  "id": "sdm124",
  "status": "new",
  "createdDateTime": "2022-01-24T06:12:15Z",
  "modifiedDateTime": "2022-01-24T06:12:42Z",
  "eTag": "040161a2-0000-0700-0000-61ee435a0000",
  "name": "my sdm for soil moisture",
  "description": "description goes here",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

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

{
  "type": "Sensor",
  "manufacturer": "Some sensor manufacturer",
  "productCode": "soil m",
  "measures": {
    "soilMoisture": {
      "description": "measures soil moisture",
      "dataType": "Bool",
      "type": "sm",
      "unit": "none",
      "properties": {
        "abc": "def",
        "elevation": 5
      }
    }
  },
  "sensorPartnerId": "sp1",
  "id": "sdm124",
  "status": "new",
  "createdDateTime": "2022-01-24T06:12:15Z",
  "modifiedDateTime": "2022-01-24T06:12:15Z",
  "eTag": "040158a0-0000-0700-0000-61ee433f0000",
  "name": "my sdm for soil moisture",
  "description": "description 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.
SensorDataModel	Модель API SensorModel.
SensorDataModelMeasure	Сведения о мерах модели датчика.
SensorDataType	Тип данных меры датчика.

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.

SensorDataModel

Модель API SensorModel.

Имя	Тип	Описание
createdBy	string	Создается по идентификатору пользователя или арендатора.
createdDateTime	string	Дата и время создания ресурса. Пример формата: yyyy-MM-ddTHH:mm:ssZ.
description	string	Текстовое описание ресурса.
eTag	string	Значение ETag для реализации оптимистического параллелизма.
id	string	Идентификатор ресурса.
manufacturer	string	Производитель датчика.
measures	<string, SensorDataModelMeasure>	Сопоставление типа датчика с датчиками.
modifiedBy	string	Изменен по идентификатору пользователя или клиента.
modifiedDateTime	string	Дата и время последнего изменения ресурса. Пример формата: yyyy-MM-ddTHH:mm:ssZ.
name	string	Имя для идентификации ресурса.
productCode	string	Датчик productCode.
properties		Коллекция пар "ключ-значение", принадлежащих ресурсу. Каждая пара не должна содержать ключ, превышающий 50 символов, и значение не должно превышать 150 символов. Примечание. Для ресурса можно указать не более 25 пар ключевых значений. Поддерживаются только значения string, numeral и datetime (гггг-ММ-ддTHH:мм:ссZ).
sensorPartnerId	string	Идентификатор связанного партнера датчика.
status	string	Состояние ресурса.
type	string	Тип датчика.

SensorDataModelMeasure

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

Имя	Тип	Описание
dataType	SensorDataType	Тип данных меры датчика.
description	string	Описание меры датчика.
properties		Коллекция пар "ключ-значение" для модели данных датчика. Каждая пара не должна содержать ключ, превышающий 50 символов, и значение не должно превышать 150 символов. Примечание. Для модели можно указать не более 25 пар ключевых значений. Поддерживаются только значения string, numeral и datetime (гггг-ММ-ддTHH:мм:ссZ).
type	string	Тип измерения данных датчика.
unit	string	Единица измерения датчика.

SensorDataType

Тип данных меры датчика.

Имя	Тип	Описание
Bool	string
DateTime	string
Double	string
Long	string
String	string

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

Sensor Data Models - Create Or Update

Параметры URI

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

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

Ответы

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

Authorization

Примеры

SensorDataModels_CreateOrUpdate

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

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

Определения

Error

ErrorResponse

InnerError

SensorDataModel

SensorDataModelMeasure

SensorDataType

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