Parties - List

Dienst:

Azure Data Manager for Agriculture

API-Version:

2023-11-01-preview

Gibt eine paginierte Liste der Parteiressourcen zurück.

GET {endpoint}/parties?api-version=2023-11-01-preview

Mit optionalen Parametern:

GET {endpoint}/parties?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
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 der benötigten Elemente (inklusive). Minimum = 10, Maximum = 1000, Standardwert = 50.
minCreatedDateTime	query		string date-time	Mindesterstellungsdatum der Ressource (inklusive).
minLastModifiedDateTime	query		string date-time	Mindestdatum der letzten Änderung der Ressource (einschließlich).
names	query		string[]	Namen der Ressource.
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 abzurufen.
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 möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Antworten

Name	Typ	Beschreibung
200 OK	PartyListResponse	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 möglicherweise Ihren Browsercache löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Typ: apiKey
In: header

Beispiele

Parties_List

Beispielanforderung

HTTP

GET {endpoint}/parties?api-version=2023-11-01-preview

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "PARTY123",
      "name": "John Smith",
      "status": "Active",
      "description": "Some description",
      "source": "source",
      "properties": {
        "Irrigated": "Yes",
        "RetailerId": "Retailer123"
      },
      "createdDateTime": "2021-04-21T06:49:30Z",
      "modifiedDateTime": "2021-04-21T06:49:30Z",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "modifiedBy": "00000000-0000-0000-0000-000000000000",
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

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.
Party	Schema der Parteiressource.
PartyListResponse	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 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.

Party

Schema der Parteiressource.

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	Eindeutige Ressourcen-ID.
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.
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.
source	string	Quelle der Ressource.
status	string	Status der Ressource.

PartyListResponse

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	Party[]	Liste der angeforderten Objekte.