Farm Operations - Create Data Ingestion Job

Referenz

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

Erstellen Sie einen Auftrags zur Datenerfassung für Den Farmvorgang.

PUT {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	Auftrags-ID vom Benutzer angegeben.
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 ihren Browsercache möglicherweise löschen müssen, wenn Sie zuvor nicht authentifizierte Aufrufe ausprobiert haben.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
authProviderId	True	string	Id des Authentifizierungsanbieters.
partyId	True	string	Partei-ID.
providerInput	True	FarmOperationJobProviderInput	Schema für die Anbietereingabe für den Farmbetriebsauftrag.
startYear	True	integer	Startjahr (Minimum = 2000, Maximum = CurrentYear).
description		string	Textbeschreibung der Ressource.
isIncremental		boolean	Verwenden Sie diese Option, um nur die inkrementellen Änderungen der letzten Ausführung zu pullen.
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.
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.

Antworten

Name	Typ	Beschreibung
202 Accepted	FarmOperationDataIngestionJob	Akzeptiert
Other Status Codes	ErrorResponse	Fehler Headers x-ms-error-code: string

Name

Typ

Beschreibung

202 Accepted

FarmOperationDataIngestionJob

Akzeptiert

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

Type: apiKey
In: header

Beispiele

FarmOperations_CreateDataIngestionJob

Sample Request

HTTP

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

{
  "partyId": "TEST-PARTY",
  "authProviderId": "JOHNDEERE",
  "operations": [
    "AllOperations"
  ],
  "providerInput": {
    "shapeType": "Point",
    "shapeResolution": "EachSection"
  },
  "startYear": 2012,
  "name": "Farm Operations Job",
  "description": "For TEST-PARTY",
  "properties": {
    "Operation": "All"
  }
}

Sample Response

Status code:: 202

{
  "operations": [
    "AllOperations"
  ],
  "startYear": 2012,
  "providerInput": {
    "shapeType": "Point",
    "shapeResolution": "EachSection"
  },
  "durationInSeconds": 14.79,
  "id": "sdi-0916aeec-ad8d-41d0-9797-63924f818cd7",
  "status": "Waiting",
  "message": "string",
  "createdDateTime": "2021-03-15T07:14:14Z",
  "lastActionDateTime": "2021-03-15T07:14:14Z",
  "startTime": "2021-03-15T07:14:14Z",
  "endTime": "2021-03-15T07:14:14Z",
  "name": "Farm Operations Job",
  "description": "For TEST-PARTY",
  "properties": {
    "Operation": "All"
  },
  "partyId": "TEST-PARTY",
  "authProviderId": "JOHNDEERE"
}

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.
FarmOperationDataIngestionJob	Schema des Auftrags zur Datenerfassung des Farmvorgangs.
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 Referenzdokument zu InnerError.
ShapeResolution	Auflösung der Shape-Datei, die von JohnDeere erfasst werden soll. Mögliche Werte der Shape-Dateiauflösung werden von https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile- übernommen.
ShapeType	Typ der Shape-Datei, die von JohnDeere erfasst werden soll. Mögliche Werte des Shape-Dateityps stammen von - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

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.

FarmOperationDataIngestionJob

Schema des Auftrags zur Datenerfassung des Farmvorgangs.

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: yyyy-MM-ttTHH:mm:ssZ.
description	string		Textbeschreibung der Ressource.
durationInSeconds	number		Dauer des Auftrags in Sekunden.
endTime	string		Auftragsendzeit, wenn verfügbar. Beispielformat: yyyy-MM-ttTHH:mm:ssZ.
errorCode	string		Fehlercode, wenn der Auftrag fehlgeschlagen ist.
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 um dateTime ausgeführt. Beispielformat: yyyy-MM-ttTHH: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 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.
providerInput	FarmOperationJobProviderInput		Schema für die Anbietereingabe für den Farmbetriebsauftrag.
startTime	string		Startzeit des Auftrags, sofern verfügbar. Beispielformat: yyyy-MM-ttTHH: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 Shape-Dateiauflösung werden von https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile- übernommen.
shapeType	ShapeType	Typ der Shape-Datei, die von JohnDeere erfasst werden soll. Mögliche Werte des Shape-Dateityps stammen von - 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 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.

ShapeResolution

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

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 stammen von - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

Name	Typ	Beschreibung
None	string
Point	string
Polygon	string

Freigeben über

Farm Operations - Create Data Ingestion Job

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Authorization

Beispiele

FarmOperations_CreateDataIngestionJob

Sample Request

Sample Response

Definitionen

Error

ErrorResponse

FarmOperationDataIngestionJob

FarmOperationJobProviderInput

InnerError

ShapeResolution

ShapeType

Zusätzliche Ressourcen