Sensor Partner Integrations - Create Or Update

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Skapa eller uppdatera en integrering med en sensorpartner.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string uri	Namnområdets värdnamn, t.ex. admaInstanceName.farmbeats.azure.net
integrationId	path	True	string	ID för den integrering som ska skapas.
sensorPartnerId	path	True	string	ID för sensorpartnern.
api-version	query	True	string	Den begärda API-versionen

Begärandehuvud

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

Name	Obligatorisk	Typ	Description
Authorization	True	string	Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Begärandetext

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

Name	Typ	Description
description	string	Textbeskrivning av resursen.
name	string	Namn för att identifiera resurs.
partyId	string	ID för festen.
properties		En samling nyckelvärdepar som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckelvärdepar kan anges för en resurs och endast värden för sträng, siffror och datetime (åååå-MM-ddTHH:mm:ssZ) stöds.
status	string	Status för resursen.

Svar

Name	Typ	Description
200 OK	SensorPartnerIntegrationModel	Klart
201 Created	SensorPartnerIntegrationModel	Skapad
Other Status Codes	ErrorResponse	Fel Headers x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
Error	Ett fel från Azure AgPlatform-tjänsten.
ErrorResponse	Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.
InnerError	Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
SensorPartnerIntegrationModel	Integrationsmodell för sensorpartner.

Error

Ett fel från Azure AgPlatform-tjänsten.

Name	Typ	Description
code	string	Serverdefinierad uppsättning felkoder.
details	Error[]	Matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
message	string	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.

Name	Typ	Description
error	Error	Ett fel från Azure AgPlatform-tjänsten.
traceId	string	Unikt spårnings-ID.

InnerError

Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Name	Typ	Description
code	string	Specifik felkod än vad som angavs av det innehållande felet.
innererror	InnerError	Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

SensorPartnerIntegrationModel

Integrationsmodell för sensorpartner.

Name	Typ	Description
createdBy	string	Skapat av användar-/klient-ID.
createdDateTime	string	Datum-tid när resursen skapades, exempelformat: ååå-MM-ddTHH:mm:ssZ.
description	string	Textbeskrivning av resursen.
eTag	string	ETag-värdet för att implementera optimistisk samtidighet.
id	string	ID för resursen.
integrationId	string	ID för integreringen.
modifiedBy	string	Ändrat av användar-/klientorganisations-ID.
modifiedDateTime	string	Datum-tid när resursen senast ändrades, exempelformat: ååååå-MM-ddTHH:mm:ssZ.
name	string	Namn för att identifiera resurs.
partyId	string	ID för festen.
properties		En samling nyckelvärdepar som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckelvärdepar kan anges för en resurs och endast värden för sträng, siffror och datetime (åååå-MM-ddTHH:mm:ssZ) stöds.
sensorPartnerId	string	ID för den associerade sensorpartnern.
status	string	Status för resursen.