Sensor Partner Integrations - Create Or Update

Usługa:

Azure Data Manager for Agriculture

Wersja interfejsu API:

2023-11-01-preview

Tworzenie lub aktualizowanie integracji z partnerem czujników.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string uri	Nazwa hosta przestrzeni nazw, np. admaInstanceName.farmbeats.azure.net
integrationId	path	True	string	Identyfikator integracji do utworzenia.
sensorPartnerId	path	True	string	Identyfikator partnera czujnika.
api-version	query	True	string	Żądana wersja interfejsu API

Nagłówek żądania

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

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej podjęto próbę nieuwierzytelnionego wywołania.

Treść żądania

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

Nazwa	Typ	Opis
description	string	Tekstowy opis zasobu.
name	string	Nazwa identyfikującego zasób.
partyId	string	Identyfikator strony.
properties		Kolekcja par klucz wartości, które należą do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).
status	string	Stan zasobu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SensorPartnerIntegrationModel	Powodzenie
201 Created	SensorPartnerIntegrationModel	Utworzone
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Zabezpieczenia

Authorization

Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej podjęto próbę nieuwierzytelnionego wywołania.

Typ: apiKey
W: header

Przykłady

SensorPartnerIntegrations_CreateOrUpdate

Przykładowe żądanie

HTTP

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
  }
}

Przykładowa odpowiedź

Kod stanu:

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
  }
}

Kod stanu:

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
  }
}

Definicje

Nazwa	Opis
Error	Błąd usługi Azure AgPlatform.
ErrorResponse	Odpowiedź o błędzie z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.
InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.
SensorPartnerIntegrationModel	Model integracji partnera czujników.

Error

Błąd usługi Azure AgPlatform.

Nazwa	Typ	Opis
code	string	Zestaw kodów błędów zdefiniowanych przez serwer.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź o błędzie z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.

Nazwa	Typ	Opis
error	Error	Błąd usługi Azure AgPlatform.
traceId	string	Unikatowy identyfikator śledzenia.

InnerError

Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.

Nazwa	Typ	Opis
code	string	Określony kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokument referencyjny InnerError.

SensorPartnerIntegrationModel

Model integracji partnera czujników.

Nazwa	Typ	Opis
createdBy	string	Utworzony przez identyfikator użytkownika/dzierżawy.
createdDateTime	string	Data i godzina utworzenia zasobu, przykładowy format: rrrr-MM-ddTHH:mm:ssZ.
description	string	Tekstowy opis zasobu.
eTag	string	Wartość ETag do zaimplementowania optymistycznej współbieżności.
id	string	Identyfikator zasobu.
integrationId	string	Identyfikator integracji.
modifiedBy	string	Zmodyfikowane przez identyfikator użytkownika/dzierżawy.
modifiedDateTime	string	Data i godzina ostatniej modyfikacji zasobu, format próbki: rrrr-MM-ddTHH:mm:ssZ.
name	string	Nazwa identyfikującego zasób.
partyId	string	Identyfikator strony.
properties		Kolekcja par klucz wartości, które należą do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).
sensorPartnerId	string	Identyfikator skojarzonego partnera czujnika.
status	string	Stan zasobu.