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

Sensor Partner Integrations - Create Or Update

  • Ссылка
Служба:
Azure Data Manager for Agriculture
Версия API:
2023-11-01-preview

Создайте или обновите интеграцию с партнером по датчику.

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

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string

uri

Имя узла пространства имен, например admaInstanceName.farmbeats.azure.net
integrationId
 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"

Имя Тип Описание
description

string

Текстовое описание ресурса.
name

string

Имя для идентификации ресурса.
partyId

string

Идентификатор вечеринки.
properties

Коллекция пар "ключ-значение", принадлежащих ресурсу. Каждая пара не должна содержать ключ, превышающий 50 символов, и значение не должно превышать 150 символов. Примечание. Для ресурса можно указать не более 25 пар ключевых значений, и поддерживаются только строковые, числовые значения и значения даты и времени (гггг-ММ-ддТЧЧ:мм:ссЗ).
status

string

Состояние ресурса.

Ответы

Имя Тип Описание
200 OK

SensorPartnerIntegrationModel

Успех
201 Created

SensorPartnerIntegrationModel

Создание
Other Status Codes

ErrorResponse

Ошибка

Заголовки

x-ms-error-code: string

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

Authorization

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

Тип: apiKey
В: header

Примеры

SensorPartnerIntegrations_CreateOrUpdate

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

PATCH {endpoint}/sensor-partners/Davis/integrations/I123?api-version=2023-11-01-preview

{
  "partyId": "prbhad-party",
  "status": "string",
  "name": "string",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

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

Код состояния:
200 
{
  "integrationId": "I123",
  "partyId": "prbhad-party",
  "sensorPartnerId": "Davis",
  "id": "I123",
  "status": "string",
  "createdDateTime": "2021-11-22T05:07:14Z",
  "modifiedDateTime": "2022-03-16T11:38:45Z",
  "eTag": "73023740-0000-0700-0000-6231cc450000",
  "name": "string",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}
Код состояния:
201 
{
  "integrationId": "I123",
  "partyId": "prbhad-party",
  "sensorPartnerId": "Davis",
  "id": "I123",
  "status": "string",
  "createdDateTime": "2022-03-16T11:39:41Z",
  "modifiedDateTime": "2022-03-16T11:39:41Z",
  "eTag": "73023a53-0000-0700-0000-6231cc7d0000",
  "name": "string",
  "description": "string",
  "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.
SensorPartnerIntegrationModel

Модель интеграции партнера датчика.

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.

SensorPartnerIntegrationModel

Модель интеграции партнера датчика.

Имя Тип Описание
createdBy

string

Создается по идентификатору пользователя или клиента.
createdDateTime

string

Дата и время создания ресурса. Пример формата: yyyy-MM-ddTHH:mm:ssZ.
description

string

Текстовое описание ресурса.
eTag

string

Значение ETag для реализации оптимистичного параллелизма.
id

string

Идентификатор ресурса.
integrationId

string

Идентификатор интеграции.
modifiedBy

string

Изменен по идентификатору пользователя или клиента.
modifiedDateTime

string

Дата и время последнего изменения ресурса. Пример формата: yyyy-MM-ddTHH:mm:ssZ.
name

string

Имя для идентификации ресурса.
partyId

string

Идентификатор вечеринки.
properties

Коллекция пар "ключ-значение", принадлежащих ресурсу. Каждая пара не должна содержать ключ, превышающий 50 символов, и значение не должно превышать 150 символов. Примечание. Для ресурса можно указать не более 25 пар ключевых значений, и поддерживаются только строковые, числовые значения и значения даты и времени (гггг-ММ-ддТЧЧ:мм:ссЗ).
sensorPartnerId

string

Идентификатор связанного партнера датчика.
status

string

Состояние ресурса.