Seasonal Fields - Create Or Update

Referência

Serviço:: Azure Data Manager for Agriculture

Versão da API:: 2023-11-01-preview

Cria ou atualiza um recurso de campo sazonal em uma determinada parte.

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
partyId	path	True	string	ID do recurso de parte associada.
seasonalFieldId	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 de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você tentou chamadas não autenticadas antes.

Corpo da solicitação

Media Types: "application/merge-patch+json"

Nome	Obrigatório	Tipo	Description
farmId	True	string minLength: 1	ID da Farm associada.
cropId		string	A ID da colheita à qual pertence.
cropProductIds		string[]	IDs de CropProduct.
description		string minLength: 0 maxLength: 500	Descrição textual do recurso.
fieldId		string	ID do campo associado.
geometry		GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (para obter mais detalhes: https://geojson.org/). Observação: as coordenadas são esperadas no formato [Longitude, Latitude].
name		string minLength: 0 maxLength: 100	Nome para identificar o recurso.
properties			Uma coleção de pares de valores de chave 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: um máximo de 25 pares de valor de chave pode ser fornecido para um recurso e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) têm suporte.
seasonId		string	Id da temporada à qual pertence.
source		string minLength: 2 maxLength: 100	Origem do recurso.
status		string minLength: 0 maxLength: 100	Status do recurso.

Respostas

Nome	Tipo	Description
200 OK	SeasonalField	Êxito
201 Created	SeasonalField	Criado
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

SeasonalField

Êxito

201 Created

SeasonalField

Criado

Other Status Codes

ErrorResponse

Erro

Cabeçalhos

x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas de API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

SeasonalFields_CreateOrUpdate

Solicitação de exemplo

HTTP

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

Código de status:: 200

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

Código de status:: 201

{
  "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.
ErrorResponse	Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse.
GeoJsonObjectType	Tipo de objeto GeoJSON.
InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
MultiPolygon	Geometria multiPolygon.
Point	Geometria de ponto.
Polygon	Geometria de polígono.
SeasonalField	Esquema do recurso de campo sazonal.

Error

Objeto

Um erro do serviço AgPlatform do Azure.

Nome	Tipo	Description
code	string minLength: 1	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	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.
message	string minLength: 1	Representação legível por humanos do erro.
target	string	Destino do erro.

ErrorResponse

Objeto

Uma resposta de erro do serviço Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para o documento de referência ErrorResponse.

Nome	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreamento exclusiva.

GeoJsonObjectType

Enumeração

Tipo de objeto GeoJSON.

Valor	Description
MultiPolygon
Point
Polygon

InnerError

Objeto

Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.

Nome	Tipo	Description
code	string	Código de erro específico que foi fornecido pelo erro que contém.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object para o documento de referência InnerError.

MultiPolygon

Objeto

Geometria multiPolygon.

Nome	Tipo	Description
coordinates	number[] (double)	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: MultiPolygon	Tipo de objeto GeoJSON.

Point

Objeto

Geometria de ponto.

Nome	Tipo	Description
coordinates	number[] (double)	Obtém ou define a coordenada deste ponto. Deve ser uma matriz de 2 ou 3 elementos para um sistema 2D ou 3D.
type	string: Point	Tipo de objeto GeoJSON.

Polygon

Objeto

Geometria de polígono.

Nome	Tipo	Description
coordinates	number[] (double)	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: Polygon	Tipo de objeto GeoJSON.

SeasonalField

Objeto

Esquema do recurso de campo sazonal.

Nome	Tipo	Description
createdBy	string	Criado por ID de usuário/locatário.
createdDateTime	string (date-time)	Data/hora em que o recurso foi criado, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
cropId	string	A ID da colheita à qual pertence.
cropProductIds	string[]	IDs de CropProduct.
description	string minLength: 0 maxLength: 500	Descrição textual do recurso.
eTag	string	O valor ETag para implementar a simultaneidade otimista.
farmId	string minLength: 1	ID da Farm associada.
fieldId	string	ID do campo associado.
geometry	GeoJsonObject: MultiPolygon Point Polygon	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 pela ID do usuário/locatário.
modifiedDateTime	string (date-time)	Data/hora em que o recurso foi modificado pela última vez, formato de exemplo: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nome para identificar o recurso.
partyId	string	ID da festa.
properties		Uma coleção de pares de valores de chave 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: um máximo de 25 pares de valor de chave pode ser fornecido para um recurso e somente valores de cadeia de caracteres, numeral e datetime (yyyy-MM-ddTHH:mm:ssZ) têm suporte.
seasonId	string	Id da temporada à qual pertence.
source	string minLength: 2 maxLength: 100	Origem do recurso.
status	string minLength: 0 maxLength: 100	Status do recurso.

Compartilhar via

Seasonal Fields - Create Or Update

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

Authorization

Exemplos

SeasonalFields_CreateOrUpdate

Solicitação de exemplo

Resposta de exemplo

Definições

Error

ErrorResponse

GeoJsonObjectType

InnerError

MultiPolygon

Point

Polygon

SeasonalField