Farm Operations - Get Data Ingestion Job Details
Hämta ett datainmatningsjobb för servergruppsåtgärd.
GET {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 |
job
|
path | True |
string |
Jobbets ID. |
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. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
Klart |
|
Other Status Codes |
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_GetDataIngestionJobDetails
Sample Request
GET {endpoint}/farm-operations/ingest-data/JOB123?api-version=2023-11-01-preview
Sample Response
{
"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
}
Definitioner
Name | Description |
---|---|
Error |
Ett fel från Azure AgPlatform-tjänsten. |
Error |
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. |
Farm |
Schema för datainmatningsjobb för servergruppsåtgärd. |
Farm |
Schema för providerindata för servergruppsåtgärdsjobb. |
Inner |
Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError. |
Shape |
Lösning av formfil som ska matas in från JohnDeere. Möjliga värden för formfilmatchning hämtas från - https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile. |
Shape |
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 |
Inre fel som innehåller en lista ö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 |
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 |
Autentiseringsprovider-ID. |
|
createdBy |
string |
Skapat av användar-/klient-ID. |
|
createdDateTime |
string |
Jobb som skapades vid dateTime. Exempelformat: yyyy-MM-ddTHH:mm:ssZ. |
|
description |
string |
Textbeskrivning av resursen. |
|
durationInSeconds |
number |
Jobbets varaktighet i sekunder. |
|
endTime |
string |
Jobbsluttid när det är tillgängligt. Exempelformat: yyyy-MM-ddTHH:mm:ssZ. |
|
errorCode |
string |
Felkod när jobbet misslyckades. |
|
id |
string |
Unikt jobb-ID. |
|
isIncremental |
boolean |
False |
Använd detta om du bara vill hämta de inkrementella ändringarna från den senaste körningen. |
lastActionDateTime |
string |
Jobbet utfördes senast på dateTime. Exempelformat: yyyy-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 resurs. |
|
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 nyckelvärdepar 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 nyckelvärdepar kan anges för en resurs och endast värden för sträng, siffror och datetime (åååå-MM-ddTHH:mm:ssZ) stöds. |
||
providerInput |
Schema för providerindata för servergruppsåtgärdsjobb. |
||
startTime |
string |
Starttid för jobb när det är tillgängligt. Exempelformat: yyyy-MM-ddTHH:mm:ssZ. |
|
startYear |
integer |
Startår (Minimum = 2000, Maximum = CurrentYear). |
|
status |
string |
Status för jobbet. Möjliga värden: "Waiting", 'Running', 'Succeeded', 'Failed', 'Cancelled'. |
FarmOperationJobProviderInput
Schema för providerindata för servergruppsåtgärdsjobb.
Name | Typ | Description |
---|---|---|
shapeResolution |
Lösning av formfil som ska matas in från JohnDeere. Möjliga värden för formfilmatchning 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. |
InnerError
Inre fel som innehåller en lista ö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 |
Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError. |
ShapeResolution
Lösning av formfil som ska matas in från JohnDeere. Möjliga värden för formfilmatchning 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 |