Parties - List

Service:

Azure Data Manager for Agriculture

API-versie:

2023-11-01-preview

Hiermee wordt een gepagineerde lijst met partijbronnen geretourneerd.

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

Met optionele parameters:

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

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De hostnaam van de naamruimte, bijvoorbeeld admaInstanceName.farmbeats.azure.net
api-version	query	True	string	De aangevraagde API-versie
ids	query		string[]	Id's van de resource.
maxCreatedDateTime	query		string (date-time)	Maximale aanmaakdatum van resource (inclusief).
maxLastModifiedDateTime	query		string (date-time)	Maximale datum van laatste wijziging van resource (inclusief).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximum aantal benodigde items (inclusief). Minimum = 10, Maximum = 1000, Standaardwaarde = 50.
minCreatedDateTime	query		string (date-time)	Minimale aanmaakdatum van resource (inclusief).
minLastModifiedDateTime	query		string (date-time)	Minimale datum van laatste wijziging van resource (inclusief).
names	query		string[]	Namen van de resource.
propertyFilters	query		string[]	Filters op sleutel-waardeparen in het object Eigenschappen. bijvoorbeeld "{testKey} eq {testValue}".
skipToken	query		string	Sla het token over voor het ophalen van de volgende set resultaten.
statuses	query		string[]	Statussen van de resource.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u uw browsercache mogelijk moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Antwoorden

Name	Type	Description
200 OK	PartyListResponse	Geslaagd
Other Status Codes	ErrorResponse	Fout Kopteksten x-ms-error-code: string

Beveiliging

Authorization

Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u uw browsercache mogelijk moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.

Type: apiKey
In: header

Voorbeelden

Parties_List

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
Error	Een fout van de Azure AgPlatform-service.
ErrorResponse	Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.
InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.
Party	Schema van partijresource.
PartyListResponse	Gepaginad antwoord bevat een lijst met aangevraagde objecten en een URL-koppeling om de volgende set resultaten op te halen.

Error

Object

Een fout van de Azure AgPlatform-service.

Name	Type	Description
code	string minLength: 1	Door de server gedefinieerde set foutcodes.
details	Error[]	Matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.
message	string minLength: 1	Leesbare weergave van de fout.
target	string	Doel van de fout.

ErrorResponse

Object

Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.

Name	Type	Description
error	Error	Een fout van de Azure AgPlatform-service.
traceId	string	Unieke tracerings-id.

InnerError

Object

Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

Name	Type	Description
code	string	Specifieke foutcode dan is opgegeven door de bijbehorende fout.
innererror	InnerError	Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object voor innerError-referentiedocument.

Party

Object

Schema van partijresource.

Name	Type	Description
createdBy	string	Gemaakt door gebruiker/tenant-id.
createdDateTime	string (date-time)	Datum en tijd waarop de resource is gemaakt, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500	Tekstbeschrijving van de resource.
eTag	string	De ETag-waarde voor het implementeren van optimistische gelijktijdigheid.
id	string	Unieke resource-id.
modifiedBy	string	Gewijzigd door de gebruikers-/tenant-id.
modifiedDateTime	string (date-time)	Datum en tijd waarop de resource voor het laatst is gewijzigd, voorbeeldindeling: jjjj-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Naam om de resource te identificeren.
properties		Een verzameling sleutel-waardeparen die deel uitmaken van de resource. Elk paar mag geen sleutel van meer dan 50 tekens hebben en mag geen waarde van meer dan 150 tekens hebben. Opmerking: er kunnen maximaal 25 sleutelwaardeparen worden opgegeven voor een resource en alleen tekenreeks-, numerieke en datum/tijd-waarden (jjjj-MM-ddTHH:mm:ssZ) worden ondersteund.
source	string minLength: 2 maxLength: 100	Bron van de resource.
status	string minLength: 0 maxLength: 100	Status van de resource.

PartyListResponse

Object

Gepaginad antwoord bevat een lijst met aangevraagde objecten en een URL-koppeling om de volgende set resultaten op te halen.

Name	Type	Description
nextLink	string	Vervolgkoppeling (absolute URI) naar de volgende pagina met resultaten in de lijst.
skipToken	string	Token dat wordt gebruikt bij het ophalen van de volgende pagina. Als null is, zijn er geen extra pagina's.
value	Party[]	Lijst met aangevraagde objecten.