Farm Operations - Create Data Ingestion Job

Referens

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

Skapa ett datainmatningsjobb för servergruppsåtgärd.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string uri	Namnområdets värdnamn, t.ex. admaInstanceName.farmbeats.azure.net
jobId	path	True	string	Jobb-ID som tillhandahålls av användaren.
api-version	query	True	string	Den begärda API-versionen

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Begärandetext

Name	Obligatorisk	Typ	Description
authProviderId	True	string	ID för autentiseringsprovider.
partyId	True	string	Party-ID.
providerInput	True	FarmOperationJobProviderInput	Schema för providerindata för servergruppsåtgärder.
startYear	True	integer	Startår (Minimum = 2000, Maximum = CurrentYear).
description		string	Textbeskrivning av resursen.
isIncremental		boolean	Använd det här alternativet om du bara vill hämta de inkrementella ändringarna från den senaste körningen.
name		string	Namn för att identifiera resursen.
operations		string[]	Lista över åtgärdstyper som data måste laddas ned för. Tillgängliga värden: AllOperations, Application, Planting, Harvest, Tillage.
properties			En samling nyckel/värde-par som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckel/värde-par kan anges för en resurs och endast värden för sträng, siffror och datetime (åå-MM-ddTHH:mm:ssZ) stöds.

Svar

Name	Typ	Description
202 Accepted	FarmOperationDataIngestionJob	Har godkänts
Other Status Codes	ErrorResponse	Fel Headers x-ms-error-code: string

Name

Typ

Description

202 Accepted

FarmOperationDataIngestionJob

Har godkänts

Other Status Codes

ErrorResponse

Fel

Headers

x-ms-error-code: string

Säkerhet

Authorization

Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.

Type: apiKey
In: header

Exempel

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

Definitioner

Name	Description
Error	Ett fel från Azure AgPlatform-tjänsten.
ErrorResponse	Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.
FarmOperationDataIngestionJob	Schema för datainmatningsjobb för servergruppsåtgärd.
FarmOperationJobProviderInput	Schema för providerindata för servergruppsåtgärder.
InnerError	Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
ShapeResolution	Upplösning på formfil som ska matas in från JohnDeere. Möjliga värden för formfilupplösning hämtas från – https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.
ShapeType	Typ av formfil som ska matas in från JohnDeere. Möjliga värden för formfiltypen hämtas från – https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

Error

Ett fel från Azure AgPlatform-tjänsten.

Name	Typ	Description
code	string	Serverdefinierad uppsättning felkoder.
details	Error[]	Matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerError	Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
message	string	Mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorResponse

Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.

Name	Typ	Description
error	Error	Ett fel från Azure AgPlatform-tjänsten.
traceId	string	Unikt spårnings-ID.

FarmOperationDataIngestionJob

Schema för datainmatningsjobb för servergruppsåtgärd.

Name	Typ	Standardvärde	Description
authProviderId	string		ID för autentiseringsprovider.
createdBy	string		Skapat av användar-/klientorganisations-ID.
createdDateTime	string		Jobbet skapades vid dateTime. Exempelformat: åååå-MM-ddTHH:mm:ssZ.
description	string		Textbeskrivning av resursen.
durationInSeconds	number		Jobbets varaktighet i sekunder.
endTime	string		Jobbets sluttid när det är tillgängligt. Exempelformat: åååå-MM-ddTHH:mm:ssZ.
errorCode	string		Felkod när jobbet misslyckades.
id	string		Unikt jobb-ID.
isIncremental	boolean	False	Använd det här alternativet om du bara vill hämta de inkrementella ändringarna från den senaste körningen.
lastActionDateTime	string		Jobbet utfördes senast på dateTime. Exempelformat: åååå-MM-ddTHH:mm:ssZ.
message	string		Statusmeddelande för att samla in mer information om jobbet.
modifiedBy	string		Ändrat av användar-/klientorganisations-ID.
name	string		Namn för att identifiera resursen.
operations	string[]		Lista över åtgärdstyper som data måste laddas ned för. Tillgängliga värden: AllOperations, Application, Planting, Harvest, Tillage.
partyId	string		Party-ID.
properties			En samling nyckel/värde-par som tillhör resursen. Varje par får inte ha en nyckel som är större än 50 tecken och får inte ha ett värde som är större än 150 tecken. Obs! Högst 25 nyckel/värde-par kan anges för en resurs och endast värden för sträng, siffror och datetime (åå-MM-ddTHH:mm:ssZ) stöds.
providerInput	FarmOperationJobProviderInput		Schema för providerindata för servergruppsåtgärder.
startTime	string		Starttid för jobb när det är tillgängligt. Exempelformat: åååå-MM-ddTHH:mm:ssZ.
startYear	integer		Startår (Minimum = 2000, Maximum = CurrentYear).
status	string		Jobbets status. Möjliga värden: "Väntar", "Körs", "Lyckades", "Misslyckades", "Avbröts".

FarmOperationJobProviderInput

Schema för providerindata för servergruppsåtgärder.

Name	Typ	Description
shapeResolution	ShapeResolution	Upplösning på formfil som ska matas in från JohnDeere. Möjliga värden för formfilupplösning hämtas från – https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.
shapeType	ShapeType	Typ av formfil som ska matas in från JohnDeere. Möjliga värden för formfiltypen hämtas från – https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

InnerError

Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

Name	Typ	Description
code	string	Specifik felkod än vad som angavs av det innehållande felet.
innererror	InnerError	Inre fel som innehåller listan över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.

ShapeResolution

Upplösning på formfil som ska matas in från JohnDeere. Möjliga värden för formfilupplösning hämtas från – https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

Name	Typ	Description
EachSection	string
EachSensor	string
None	string
OneHertz	string

ShapeType

Typ av formfil som ska matas in från JohnDeere. Möjliga värden för formfiltypen hämtas från – https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

Name	Typ	Description
None	string
Point	string
Polygon	string

Dela via

Farm Operations - Create Data Ingestion Job

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Authorization

Exempel

FarmOperations_CreateDataIngestionJob

Sample Request

Sample Response

Definitioner

Error

ErrorResponse

FarmOperationDataIngestionJob

FarmOperationJobProviderInput

InnerError

ShapeResolution

ShapeType

Ytterligare resurser