Seasonal Fields - Create Or Update
Cria ou Atualizações um recurso de campo sazonal em uma parte específica.
PATCH {endpoint}/parties/{partyId}/seasonal-fields/{seasonalFieldId}?api-version=2023-11-01-preview
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net |
party
|
path | True |
string |
ID do recurso de parte associada. |
seasonal
|
path | True |
string |
ID do recurso de campo sazonal. |
api-version
|
query | True |
string |
A versão da API solicitada |
Cabeçalho da solicitação
Media Types: "application/merge-patch+json"
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
Authorization | True |
string |
Forneça um token de portador válido para chamadas à API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes. |
Corpo da solicitação
Media Types: "application/merge-patch+json"
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
farmId | True |
string |
ID da Farm associada. |
cropId |
string |
ID da cultura à qual pertence. |
|
cropProductIds |
string[] |
IDs cropProduct. |
|
description |
string |
Descrição textual do recurso. |
|
fieldId |
string |
ID do Campo associado. |
|
geometry | GeoJsonObject: |
GeoJSON (para obter mais detalhes: https://geojson.org/). Observação: as coordenadas são esperadas no formato [Longitude, Latitude]. |
|
name |
string |
Nome para identificar o recurso. |
|
properties |
Uma coleção de pares chave-valor que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Observação: há suporte para um máximo de 25 pares de valores de chave para um recurso e apenas valores de cadeia de caracteres, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ). |
||
seasonId |
string |
ID da temporada à qual pertence. |
|
source |
string |
Origem do recurso. |
|
status |
string |
Status do recurso. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Êxito |
|
201 Created |
Criado |
|
Other Status Codes |
Erro Cabeçalhos x-ms-error-code: string |
Segurança
Authorization
Forneça um token de portador válido para chamadas à API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.
Tipo:
apiKey
Em:
header
Exemplos
SeasonalFields_CreateOrUpdate
Solicitação de exemplo
PATCH {endpoint}/parties/PARTY123/seasonal-fields/SEASONALFIELD123?api-version=2023-11-01-preview
{
"farmId": "FARM123",
"fieldId": "FIELD123",
"seasonId": "WINTER_WHEAT_2021",
"cropId": "WHEAT",
"name": "John Smith's Seasonal Field",
"status": "Active",
"description": "Some description",
"source": "source",
"properties": {
"Irrigated": "Yes",
"RetailerId": "Retailer123"
}
}
Resposta de exemplo
{
"id": "SEASONALFIELD123",
"partyId": "PARTY123",
"farmId": "FARM123",
"fieldId": "FIELD123",
"seasonId": "WINTER_WHEAT_2021",
"cropId": "WHEAT",
"name": "John Smith's Seasonal Field",
"status": "Active",
"description": "Some description",
"source": "source",
"properties": {
"Irrigated": "Yes",
"RetailerId": "Retailer123"
},
"createdDateTime": "2021-04-21T06:49:30Z",
"modifiedDateTime": "2021-04-21T06:49:30Z",
"createdBy": "00000000-0000-0000-0000-000000000000",
"modifiedBy": "00000000-0000-0000-0000-000000000000",
"eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
{
"id": "SEASONALFIELD123",
"partyId": "PARTY123",
"farmId": "FARM123",
"fieldId": "FIELD123",
"seasonId": "WINTER_WHEAT_2021",
"cropId": "WHEAT",
"name": "John Smith's Seasonal Field",
"status": "Active",
"description": "Some description",
"source": "source",
"properties": {
"Irrigated": "Yes",
"RetailerId": "Retailer123"
},
"createdDateTime": "2021-04-21T06:49:30Z",
"modifiedDateTime": "2021-04-21T06:49:30Z",
"createdBy": "00000000-0000-0000-0000-000000000000",
"modifiedBy": "00000000-0000-0000-0000-000000000000",
"eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
Definições
Nome | Description |
---|---|
Error |
Um erro do serviço AgPlatform do Azure. |
Error |
Uma resposta de erro do serviço AgPlatform do Azure. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse. |
Geo |
Tipo de objeto GeoJSON. |
Inner |
Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError. |
Multi |
Geometria multiPolygon. |
Point |
Geometria de ponto. |
Polygon |
Geometria de polígono. |
Seasonal |
Esquema do recurso de campo sazonal. |
Error
Um erro do serviço AgPlatform do Azure.
Nome | Tipo | Description |
---|---|---|
code |
string |
Conjunto definido pelo servidor de códigos de erro. |
details |
Error[] |
Matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
innererror |
Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError. |
|
message |
string |
Representação legível ao olho humano do erro. |
target |
string |
Destino do erro. |
ErrorResponse
Uma resposta de erro do serviço AgPlatform do Azure. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.
Nome | Tipo | Description |
---|---|---|
error |
Um erro do serviço AgPlatform do Azure. |
|
traceId |
string |
ID de rastreamento exclusiva. |
GeoJsonObjectType
Tipo de objeto GeoJSON.
Nome | Tipo | Description |
---|---|---|
MultiPolygon |
string |
|
Point |
string |
|
Polygon |
string |
InnerError
Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código de erro específico que foi fornecido pelo erro que o contém. |
innererror |
Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError. |
MultiPolygon
Geometria multiPolygon.
Nome | Tipo | Description |
---|---|---|
coordinates |
number[] |
Obtém ou define coordenadas do objeto GeoJSON. Deve ser uma matriz de polígonos, cada polígono contém uma lista de anéis lineares. Para polígonos com mais de um desses anéis, o primeiro DEVE ser o anel exterior, e qualquer outro DEVE ser anéis interiores. |
type | string: |
Tipo de objeto GeoJSON. |
Point
Geometria de ponto.
Nome | Tipo | Description |
---|---|---|
coordinates |
number[] |
Obtém ou define a coordenada deste ponto. Deve ser uma matriz de elementos 2 ou 3 para um sistema 2D ou 3D. |
type | string: |
Tipo de objeto GeoJSON. |
Polygon
Geometria de polígono.
Nome | Tipo | Description |
---|---|---|
coordinates |
number[] |
Obtém ou define o tipo do objeto GeoJSON. Deve ser uma matriz de matrizes de coordenadas de anel linear. Para polígonos com mais de um desses anéis, o primeiro DEVE ser o anel exterior, e qualquer outro DEVE ser anéis interiores. |
type | string: |
Tipo de objeto GeoJSON. |
SeasonalField
Esquema do recurso de campo sazonal.
Nome | Tipo | Description |
---|---|---|
createdBy |
string |
Criado por ID de usuário/locatário. |
createdDateTime |
string |
Data e hora em que o recurso foi criado; formato de amostra: yyyy-MM-ddTHH:mm:ssZ. |
cropId |
string |
ID da cultura à qual pertence. |
cropProductIds |
string[] |
IDs cropProduct. |
description |
string |
Descrição textual do recurso. |
eTag |
string |
O valor de ETag para implementar a simultaneidade otimista. |
farmId |
string |
ID da Farm associada. |
fieldId |
string |
ID do Campo associado. |
geometry | GeoJsonObject: |
GeoJSON (para obter mais detalhes: https://geojson.org/). Observação: as coordenadas são esperadas no formato [Longitude, Latitude]. |
id |
string |
ID de recurso exclusiva. |
modifiedBy |
string |
Modificado por ID de usuário/locatário. |
modifiedDateTime |
string |
Data e hora em que o recurso foi modificado pela última vez; formato de amostra: yyyy-MM-ddTHH:mm:ssZ. |
name |
string |
Nome para identificar o recurso. |
partyId |
string |
ID da festa. |
properties |
Uma coleção de pares chave-valor que pertence ao recurso. Cada par não deve ter uma chave maior que 50 caracteres e não deve ter um valor maior que 150 caracteres. Observação: há suporte para um máximo de 25 pares de valores de chave para um recurso e apenas valores de cadeia de caracteres, numeral e datetime (aaaa-MM-ddTHH:mm:ssZ). |
|
seasonId |
string |
ID da temporada à qual pertence. |
source |
string |
Origem do recurso. |
status |
string |
Status do recurso. |