Farm Operations - Create Data Ingestion Job

Odwołanie

Usługa:: Azure Data Manager for Agriculture

Wersja interfejsu API:: 2023-11-01-preview

Utwórz zadanie pozyskiwania danych operacji farmy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Nazwa hosta przestrzeni nazw, np. admaInstanceName.farmbeats.azure.net
jobId	path	True	string	Identyfikator zadania dostarczony przez użytkownika.
api-version	query	True	string	Żądana wersja interfejsu API

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
authProviderId	True	string minLength: 1	Identyfikator dostawcy uwierzytelniania.
partyId	True	string minLength: 1	Identyfikator strony.
providerInput	True	FarmOperationJobProviderInput	Schemat danych wejściowych dostawcy dla zadania operacji farmy.
startYear	True	integer (int32)	Rok początkowy (minimum = 2000, maksimum = bieżący rok).
description		string minLength: 0 maxLength: 500	Tekstowy opis zasobu.
isIncremental		boolean	Użyj tego polecenia, aby ściągnąć tylko zmiany przyrostowe z ostatniego przebiegu.
name		string minLength: 0 maxLength: 100	Nazwa identyfikującego zasób.
operations		string[]	Lista typów operacji, dla których należy pobrać dane. Dostępne wartości: AllOperations, Application, Planting, Harvest, Tillage.
properties			Kolekcja par klucz-wartość, która należy do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: Dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	FarmOperationDataIngestionJob	Zaakceptowano
Other Status Codes	ErrorResponse	Błąd Nagłówki x-ms-error-code: string

Nazwa

Typ

Opis

202 Accepted

FarmOperationDataIngestionJob

Zaakceptowano

Other Status Codes

ErrorResponse

Błąd

Nagłówki

x-ms-error-code: string

Zabezpieczenia

Authorization

Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Typ: apiKey
W: header

Przykłady

FarmOperations_CreateDataIngestionJob

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
Error	Błąd usługi Azure AgPlatform.
ErrorResponse	Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses, aby zapoznać się z dokumentem referencyjnym ErrorResponse.
FarmOperationDataIngestionJob	Schemat zadania pozyskiwania danych operacji farmy.
FarmOperationJobProviderInput	Schemat danych wejściowych dostawcy dla zadania operacji farmy.
InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.
ShapeResolution	Rozdzielczość pliku kształtu do pozyskiwania z JohnDeere. Możliwe wartości rozpoznawania pliku kształtu pochodzą z parametru — https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.
ShapeType	Typ pliku kształtu do pozyskiwania z JohnDeere. Możliwe wartości typu pliku kształtu pochodzą z — https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

Error

Objekt

Błąd usługi Azure AgPlatform.

Nazwa	Typ	Opis
code	string minLength: 1	Zdefiniowany przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.
message	string minLength: 1	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses, aby zapoznać się z dokumentem referencyjnym ErrorResponse.

Nazwa	Typ	Opis
error	Error	Błąd usługi Azure AgPlatform.
traceId	string	Unikatowy identyfikator śledzenia.

FarmOperationDataIngestionJob

Objekt

Schemat zadania pozyskiwania danych operacji farmy.

Nazwa	Typ	Domyślna wartość	Opis
authProviderId	string minLength: 1		Identyfikator dostawcy uwierzytelniania.
createdBy	string		Utworzony przez identyfikator użytkownika/dzierżawy.
createdDateTime	string (date-time)		Zadanie utworzone w dateTime. Format próbki: rrrr-MM-ddTHH:mm:ssZ.
description	string minLength: 0 maxLength: 500		Tekstowy opis zasobu.
durationInSeconds	number (double)		Czas trwania zadania w sekundach.
endTime	string (date-time)		Godzina zakończenia zadania, gdy jest dostępna. Format próbki: rrrr-MM-ddTHH:mm:ssZ.
errorCode	string		Kod błędu, gdy zadanie nie powiodło się.
id	string		Unikatowy identyfikator zadania.
isIncremental	boolean	False	Użyj tego polecenia, aby ściągnąć tylko zmiany przyrostowe z ostatniego przebiegu.
lastActionDateTime	string (date-time)		Zadanie zostało ostatnio podjęte w dniu dateTime. Format próbki: rrrr-MM-ddTHH:mm:ssZ.
message	string		Komunikat o stanie umożliwiający przechwycenie dodatkowych szczegółów zadania.
modifiedBy	string		Zmodyfikowany przez identyfikator użytkownika/dzierżawy.
name	string minLength: 0 maxLength: 100		Nazwa identyfikującego zasób.
operations	string[]		Lista typów operacji, dla których należy pobrać dane. Dostępne wartości: AllOperations, Application, Planting, Harvest, Tillage.
partyId	string minLength: 1		Identyfikator strony.
properties			Kolekcja par klucz-wartość, która należy do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: Dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).
providerInput	FarmOperationJobProviderInput		Schemat danych wejściowych dostawcy dla zadania operacji farmy.
startTime	string (date-time)		Godzina rozpoczęcia zadania, gdy jest dostępna. Format próbki: rrrr-MM-ddTHH:mm:ssZ.
startYear	integer (int32)		Rok początkowy (minimum = 2000, maksimum = bieżący rok).
status	string		Stan zadania. Możliwe wartości: "Oczekiwanie", "Uruchomione", "Powodzenie", "Niepowodzenie", "Anulowane".

FarmOperationJobProviderInput

Objekt

Schemat danych wejściowych dostawcy dla zadania operacji farmy.

Nazwa	Typ	Opis
shapeResolution	ShapeResolution minLength: 1	Rozdzielczość pliku kształtu do pozyskiwania z JohnDeere. Możliwe wartości rozpoznawania pliku kształtu pochodzą z parametru — https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.
shapeType	ShapeType minLength: 1	Typ pliku kształtu do pozyskiwania z JohnDeere. Możliwe wartości typu pliku kształtu pochodzą z — https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

InnerError

Objekt

Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.

Nazwa	Typ	Opis
code	string	Określony kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Wewnętrzny błąd zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object, aby zapoznać się z dokumentem referencyjnym InnerError.

ShapeResolution

Wyliczanie

Rozdzielczość pliku kształtu do pozyskiwania z JohnDeere. Możliwe wartości rozpoznawania pliku kształtu pochodzą z parametru — https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

Wartość	Opis
EachSection
EachSensor
None
OneHertz

ShapeType

Wyliczanie

Typ pliku kształtu do pozyskiwania z JohnDeere. Możliwe wartości typu pliku kształtu pochodzą z — https://developer-portal.deere.com/#/myjohndeere/field-operations/field-operations?hash=download-shapefile.

Wartość	Opis
None
Point
Polygon

Udostępnij za pośrednictwem

Farm Operations - Create Data Ingestion Job

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Authorization

Przykłady

FarmOperations_CreateDataIngestionJob

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Error

ErrorResponse

FarmOperationDataIngestionJob

FarmOperationJobProviderInput

InnerError

ShapeResolution

ShapeType