Farms - Get
Ruft eine angegebene Farmressource unter einer bestimmten Partei ab.
GET {endpoint}/parties/{partyId}/farms/{farmId}?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 |
farm
|
path | True |
string |
ID der Farmressource. |
party
|
path | True |
string |
ID der zugeordneten Parteiressource. |
api-version
|
query | True |
string |
Die angeforderte API-Version |
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 |
Erfolg |
|
Other Status Codes |
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
Farms_Get
Beispielanforderung
GET {endpoint}/parties/PARTY123/farms/FARM123?api-version=2023-11-01-preview
Beispiel für eine Antwort
{
"id": "FARM123",
"partyId": "PARTY123",
"name": "John Smith's Farm",
"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"
}
Definitionen
Name | Beschreibung |
---|---|
Error |
Ein Fehler des Azure AgPlatform-Diensts. |
Error |
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. |
Farm |
Schema der Farmressource. |
Inner |
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. |
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 |
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 |
Ein Fehler des Azure AgPlatform-Diensts. |
|
traceId |
string |
Eindeutige Ablaufverfolgungs-ID. |
Farm
Schema der Farmressource.
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. |
partyId |
string |
Partei-ID. |
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. |
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 |
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. |