Farm Operations - Get Data Ingestion Job Details

Service:

Azure Data Manager for Agriculture

API Version:

2023-11-01-preview

Abrufen eines Datenerfassungsauftrags für einen Farmvorgang.

GET {endpoint}/farm-operations/ingest-data/{jobId}?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
jobId	path	True	string	Id des Auftrags.
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	FarmOperationDataIngestionJob	Erfolg
Other Status Codes	ErrorResponse	Fehler Headers 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.

Type: apiKey
In: header

Beispiele

FarmOperations_GetDataIngestionJobDetails

Sample Request

HTTP

GET {endpoint}/farm-operations/ingest-data/JOB123?api-version=2023-11-01-preview

Sample Response

Status code:

200

{
  "providerInput": {
    "shapeType": "Point",
    "shapeResolution": "EachSection"
  },
  "durationInSeconds": 11.2,
  "id": "farm-operations-job",
  "status": "Succeeded",
  "message": "string",
  "createdDateTime": "2021-04-16T08:24:50Z",
  "lastActionDateTime": "2021-04-16T08:24:50Z",
  "startTime": "2021-04-16T08:24:50Z",
  "endTime": "2021-04-16T08:24:50Z",
  "name": "Farm operations Job",
  "description": "Test job",
  "properties": {
    "Region": "Asia"
  },
  "partyId": "PARTY123",
  "authProviderId": "JOHNDEERE",
  "operations": [
    "AllOperations"
  ],
  "startYear": 2012
}

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.
FarmOperationDataIngestionJob	Schema des Datenerfassungsauftrags für den Farmbetrieb.
FarmOperationJobProviderInput	Schema für die Anbietereingabe für den Farmbetriebsauftrag.
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.
ShapeResolution	Auflösung der Shape-Datei, die von JohnDeere erfasst werden soll. Mögliche Werte der Auflösung von Shape-Dateien werden von abgeleitet. https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile
ShapeType	Typ der Shape-Datei, die von JohnDeere erfasst werden soll. Mögliche Werte des Shape-Dateityps werden von übernommen: https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

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.

FarmOperationDataIngestionJob

Schema des Datenerfassungsauftrags für den Farmbetrieb.

Name	Typ	Standardwert	Beschreibung
authProviderId	string		Id des Authentifizierungsanbieters.
createdBy	string		Erstellt von Benutzer-/Mandanten-ID.
createdDateTime	string		Auftrag, der bei dateTime erstellt wurde. Beispielformat: JJJJ-MM-ddTHH:mm:ssZ.
description	string		Textbeschreibung der Ressource.
durationInSeconds	number		Dauer des Auftrags in Sekunden.
endTime	string		Auftragsendzeit, sofern verfügbar. Beispielformat: JJJJ-MM-ddTHH:mm:ssZ.
errorCode	string		Fehlercode beim Fehler beim Auftrag.
id	string		Eindeutige Auftrags-ID.
isIncremental	boolean	False	Verwenden Sie diese Option, um nur die inkrementellen Änderungen der letzten Ausführung zu pullen.
lastActionDateTime	string		Der Auftrag wurde zuletzt bei dateTime bearbeitet. Beispielformat: JJJJ-MM-ddTHH:mm:ssZ.
message	string		Statusmeldung, um weitere Details des Auftrags zu erfassen.
modifiedBy	string		Geändert durch Benutzer-/Mandanten-ID.
name	string		Der Name zur Identifizierung der Ressource.
operations	string[]		Liste der Vorgangstypen, für die Daten heruntergeladen werden müssen. Verfügbare Werte: AllOperations, Application, Planting, Harvest, Tillage.
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.
providerInput	FarmOperationJobProviderInput		Schema für die Anbietereingabe für den Farmbetriebsauftrag.
startTime	string		Auftragsstartzeit, sofern verfügbar. Beispielformat: JJJJ-MM-ddTHH:mm:ssZ.
startYear	integer		Startjahr (Minimum = 2000, Maximum = CurrentYear).
status	string		Status des Auftrags. Mögliche Werte: "Waiting", "Running", "Succeeded", "Failed", "Cancelled".

FarmOperationJobProviderInput

Schema für die Anbietereingabe für den Farmbetriebsauftrag.

Name	Typ	Beschreibung
shapeResolution	ShapeResolution	Auflösung der Shape-Datei, die von JohnDeere erfasst werden soll. Mögliche Werte der Auflösung von Shape-Dateien werden von abgeleitet. https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile
shapeType	ShapeType	Typ der Shape-Datei, die von JohnDeere erfasst werden soll. Mögliche Werte des Shape-Dateityps werden von übernommen: https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

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.

ShapeResolution

Auflösung der Shape-Datei, die von JohnDeere erfasst werden soll. Mögliche Werte der Auflösung von Shape-Dateien werden von abgeleitet. https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile

Name	Typ	Beschreibung
EachSection	string
EachSensor	string
None	string
OneHertz	string

ShapeType

Typ der Shape-Datei, die von JohnDeere erfasst werden soll. Mögliche Werte des Shape-Dateityps werden von übernommen: https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

Name	Typ	Beschreibung
None	string
Point	string
Polygon	string