Sensor Partner Integrations - Create Or Update

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Vytvořte nebo aktualizujte integraci s partnerem pro senzory.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string uri	Název hostitele oboru názvů, například admaInstanceName.farmbeats.azure.net
integrationId	path	True	string	ID integrace, která se má vytvořit.
sensorPartnerId	path	True	string	ID partnera senzoru.
api-version	query	True	string	Požadovaná verze rozhraní API

Hlavička požadavku

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

Name	Vyžadováno	Typ	Description
Authorization	True	string	Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste dříve zkoušeli neověřovaná volání, možná budete muset vymazat mezipaměť prohlížeče.

Text požadavku

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

Name	Typ	Description
description	string	Textový popis zdroje.
name	string	Název pro identifikaci prostředku.
partyId	string	ID strany.
properties		Kolekce párů hodnot klíčů, které patří do prostředku. Každý pár nesmí mít klíč větší než 50 znaků a hodnotu větší než 150 znaků. Poznámka: Pro prostředek je možné zadat maximálně 25 párů hodnot klíčů a podporují se pouze hodnoty string, numeral a datetime (yyyy-MM-ddTHH:mm:ssZ).
status	string	Stav prostředku.

Odpovědi

Name	Typ	Description
200 OK	SensorPartnerIntegrationModel	Success
201 Created	SensorPartnerIntegrationModel	Vytvořeno
Other Status Codes	ErrorResponse	Chybová Headers x-ms-error-code: string

Zabezpečení

Authorization

Zadejte platný nosný token pro autorizovaná volání rozhraní API. Mějte na paměti, že pokud jste dříve zkoušeli neověřovaná volání, možná budete muset vymazat mezipaměť prohlížeče.

Type: apiKey
In: header

Příklady

SensorPartnerIntegrations_CreateOrUpdate

Sample Request

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

Sample Response

Status code:

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

Status code:

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

Definice

Name	Description
Error	Došlo k chybě ze služby Azure AgPlatform.
ErrorResponse	Chybová odpověď ze služby Azure AgPlatform. Projděte si https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.
InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.
SensorPartnerIntegrationModel	Model integrace partnera senzoru

Error

Došlo k chybě ze služby Azure AgPlatform.

Name	Typ	Description
code	string	Sada kódů chyb definovaná serverem.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.
message	string	Pro člověka čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorResponse

Chybová odpověď ze služby Azure AgPlatform. Projděte si https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses referenční dokument ErrorResponse.

Name	Typ	Description
error	Error	Došlo k chybě ze služby Azure AgPlatform.
traceId	string	Jedinečné ID trasování

InnerError

Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

Name	Typ	Description
code	string	Konkrétní kód chyby, než byl poskytnut chybou obsahující chybu.
innererror	InnerError	Vnitřní chyba obsahující seznam chyb. Viz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object referenční dokument InnerError.

SensorPartnerIntegrationModel

Model integrace partnera senzoru

Name	Typ	Description
createdBy	string	Vytvořeno pomocí ID uživatele nebo tenanta.
createdDateTime	string	Datum a čas vytvoření prostředku, ukázkový formát: yyyy-MM-ddTHH:mm:ssZ.
description	string	Textový popis zdroje.
eTag	string	Hodnota ETag pro implementaci optimistické souběžnosti.
id	string	ID prostředku.
integrationId	string	ID integrace.
modifiedBy	string	Upraveno podle ID uživatele nebo tenanta.
modifiedDateTime	string	Datum a čas poslední změny prostředku, ukázkový formát: rrrr-MM-ddTHH:mm:ssZ.
name	string	Název pro identifikaci prostředku.
partyId	string	ID strany.
properties		Kolekce párů hodnot klíčů, které patří do prostředku. Každý pár nesmí mít klíč větší než 50 znaků a hodnotu větší než 150 znaků. Poznámka: Pro prostředek je možné zadat maximálně 25 párů hodnot klíčů a podporují se pouze hodnoty string, numeral a datetime (yyyy-MM-ddTHH:mm:ssZ).
sensorPartnerId	string	ID přidruženého partnera pro senzory.
status	string	Stav prostředku.