Sensor Partner Integrations - Create Or Update

  • Referenz
Dienst:
Azure Data Manager for Agriculture
API-Version:
2023-11-01-preview

Erstellen oder Aktualisieren einer Integration mit einem Sensorpartner

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string

uri

Der Hostname des Namespace, z. B. admaInstanceName.farmbeats.azure.net
integrationId
 path True

string

ID der zu erstellenden Integration.
sensorPartnerId
 path True

string

Id des Sensorpartners.
api-version
 query True

string

Die angeforderte API-Version

Anforderungsheader

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

Name Erforderlich Typ Beschreibung
Authorization True

string

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Anforderungstext

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

Name Typ Beschreibung
description

string

Textbeschreibung der Ressource.
name

string

Der Name zur Identifizierung der Ressource.
partyId

string

Id der Partei.
properties

Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel größer als 50 Zeichen haben und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Zahlen- und Datetime-Werte (JJJJ-MM-ddTHH:mm:ssZ) unterstützt.
status

string

Status der Ressource.

Antworten

Name Typ Beschreibung
200 OK

SensorPartnerIntegrationModel

Erfolg
201 Created

SensorPartnerIntegrationModel

Erstellt
Other Status Codes

ErrorResponse

Fehler

Header

x-ms-error-code: string

Sicherheit

Authorization

Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

SensorPartnerIntegrations_CreateOrUpdate

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
Error

Ein Fehler des Azure AgPlatform-Diensts.
ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.
InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.
SensorPartnerIntegrationModel

Sensorpartnerintegrationsmodell.

Error

Ein Fehler des Azure AgPlatform-Diensts.

Name Typ Beschreibung
code

string

Vom Server definierte Gruppe von Fehlercodes.
details

Error[]

Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.
message

string

Lesbare Darstellung des Fehlers.
target

string

Ziel des Fehlers.

ErrorResponse

Eine Fehlerantwort des Azure AgPlatform-Diensts. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses unter ErrorResponse-Referenzdokument.

Name Typ Beschreibung
error

Error

Ein Fehler des Azure AgPlatform-Diensts.
traceId

string

Eindeutige Ablaufverfolgungs-ID.

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

Name Typ Beschreibung
code

string

Spezifischer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innererror

InnerError

Innerer Fehler, der eine Fehlerliste enthält. Weitere Informationen finden Sie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object unter InnerError-Referenzdokument.

SensorPartnerIntegrationModel

Sensorpartnerintegrationsmodell.

Name Typ Beschreibung
createdBy

string

Erstellt von Benutzer-/Mandanten-ID.
createdDateTime

string

Datum und Uhrzeit der Erstellung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
description

string

Textbeschreibung der Ressource.
eTag

string

Der ETag-Wert, um eine optimistische Parallelität zu implementieren.
id

string

Id der Ressource.
integrationId

string

Id der Integration.
modifiedBy

string

Geändert durch Benutzer-/Mandanten-ID.
modifiedDateTime

string

Datum und Uhrzeit der letzten Änderung der Ressource, Beispielformat: jjjj-MM-ttTHH:mm:ssZ.
name

string

Der Name zur Identifizierung der Ressource.
partyId

string

Id der Partei.
properties

Eine Sammlung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel größer als 50 Zeichen haben und darf keinen Wert größer als 150 Zeichen haben. Hinweis: Für eine Ressource können maximal 25 Schlüsselwertpaare bereitgestellt werden, und es werden nur Zeichenfolgen-, Zahlen- und Datetime-Werte (JJJJ-MM-ddTHH:mm:ssZ) unterstützt.
sensorPartnerId

string

Id des zugeordneten Sensorpartners.
status

string

Status der Ressource.