Sensor Partner Integrations - List

Referenz

Dienst:: Azure Data Manager for Agriculture

API-Version:: 2023-11-01-preview

Ruft Partnerintegrationsmodelle ab.

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

Mit optionalen Parametern:

GET {endpoint}/sensor-partners/{sensorPartnerId}/integrations?partyIds={partyIds}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&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
sensorPartnerId	path	True	string	ID des zugeordneten Sensorpartners.
api-version	query	True	string	Die angeforderte API-Version
ids	query		string[]	Ids der Ressource.
maxCreatedDateTime	query		string date-time	Maximales Erstellungsdatum der Ressource (inklusive).
maxLastModifiedDateTime	query		string date-time	Maximales Datum der letzten Änderung der Ressource (einschließlich).
maxPageSize	query		integer int32	Maximale Anzahl erforderlicher Elemente (inklusive). Minimum = 10, Maximum = 1000, Standardwert = 50.
minCreatedDateTime	query		string date-time	Minimales Erstellungsdatum der Ressource (inklusive).
minLastModifiedDateTime	query		string date-time	Mindestdatum der letzten Änderung der Ressource (einschließlich).
names	query		string[]	Namen der Ressource.
partyIds	query		string[]	IDs der Parteien.
propertyFilters	query		string[]	Filtert nach Schlüssel-Wert-Paaren innerhalb des Properties-Objekts. Beispiel: "{testKey} eq {testValue}".
skipToken	query		string	Überspringen Sie das Token, um den nächsten Satz von Ergebnissen zu erhalten.
statuses	query		string[]	Status der Ressource.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Geben Sie ein gültiges Bearertoken für autorisierte API-Aufrufe an. Beachten Sie, dass Sie ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Antworten

Name	Typ	Beschreibung
200 OK	SensorPartnerIntegrationModelListResponse	Erfolg
Other Status Codes	ErrorResponse	Fehler Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

SensorPartnerIntegrationModelListResponse

Erfolg

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 ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

SensorPartnerIntegrations_List

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "integrationId": "I123",
      "partyId": "prbhad-party",
      "sensorPartnerId": "Davis",
      "id": "I123",
      "status": "string",
      "createdDateTime": "2021-11-22T05:07:14Z",
      "modifiedDateTime": "2022-01-04T11:17:08Z",
      "eTag": "8900a6d8-0000-0700-0000-61d42cb40000",
      "name": "string",
      "description": "string",
      "properties": {
        "key1": "value1",
        "key2": 123.45
      }
    },
    {
      "integrationId": "I456",
      "partyId": "prbhad-party2",
      "sensorPartnerId": "Davis",
      "id": "I456",
      "status": "string",
      "createdDateTime": "2022-01-12T10:33:54Z",
      "modifiedDateTime": "2022-01-12T10:33:54Z",
      "eTag": "8d014fe2-0000-0700-0000-61deae920000",
      "name": "string",
      "description": "string",
      "properties": {
        "key1": "value1",
        "key2": 123.45
      }
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/sensor-partners/Davis/integrations?maxPageSize=10&api-version=2023-11-01-preview&skipToken=W3sidG9rZW4iOiIrUklEOn4xQ1VyQU9zRU8zMXZucGdCQUFBQUFBPT0jUlQ6MSNUUkM6MTAjSVNWOjIjSUVPOjY1NTUxI1FDRjo0I0ZQQzpBZ0ppQm1JR1lnWUVBRytlRDRBPSIsInJhbmdlIjp7Im1pbiI6IiIsIm1heCI6IkZGIn19XQ"
}

Definitionen

Name	Beschreibung
Error	Ein Fehler vom Azure AgPlatform-Dienst.
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 Referenzdokument zu ErrorResponse.
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 Referenzdokument zu InnerError.
SensorPartnerIntegrationModel	Sensorpartnerintegrationsmodell.
SensorPartnerIntegrationModelListResponse	Die ausgelagerte Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen zu erhalten.

Error

Ein Fehler vom Azure AgPlatform-Dienst.

Name	Typ	Beschreibung
code	string	Serverdefinierter Satz 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 Referenzdokument zu InnerError.
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 Referenzdokument zu ErrorResponse.

Name	Typ	Beschreibung
error	Error	Ein Fehler vom Azure AgPlatform-Dienst.
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 Referenzdokument zu InnerError.

Name	Typ	Beschreibung
code	string	Spezifischer Fehlercode, der 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 Referenzdokument zu InnerError.

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 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 Auflistung von Schlüsselwertpaaren, die zur Ressource gehören. Jedes Paar darf keinen Schlüssel haben, der größer als 50 Zeichen ist, 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-, Numeral- und datetime-Werte (yyyy-MM-ddTHH:mm:ssZ) unterstützt.
sensorPartnerId	string	ID des zugeordneten Sensorpartners.
status	string	Status der Ressource.

SensorPartnerIntegrationModelListResponse

Die ausgelagerte Antwort enthält eine Liste der angeforderten Objekte und einen URL-Link, um den nächsten Satz von Ergebnissen zu erhalten.

Name	Typ	Beschreibung
nextLink	string	Fortsetzungslink (absoluter URI) auf die nächste Seite mit Ergebnissen in der Liste
skipToken	string	Token, das beim Abrufen der nächsten Seite verwendet wird. Wenn NULL, gibt es keine zusätzlichen Seiten.
value	SensorPartnerIntegrationModel[]	Liste der angeforderten Objekte.

Freigeben über

Sensor Partner Integrations - List

URI-Parameter

Anforderungsheader

Antworten

Sicherheit

Authorization

Beispiele

SensorPartnerIntegrations_List

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Error

ErrorResponse

InnerError

SensorPartnerIntegrationModel

SensorPartnerIntegrationModelListResponse

Zusätzliche Ressourcen