Boundaries - Create Or Update

Servicio:: Azure Data Manager for Agriculture

Versión de la API:: 2023-06-01-preview

Crea o actualiza un recurso de límite.

PATCH /parties/{partyId}/boundaries/{boundaryId}?api-version=2023-06-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
boundaryId	path	True	string	Identificador del recurso de límite.
partyId	path	True	string	Identificador del recurso de entidad.
api-version	query	True	string	La versión de API solicitada

Encabezado de la solicitud

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

Nombre	Requerido	Tipo	Description
Authorization	True	string	Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.

Cuerpo de la solicitud

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

Nombre	Tipo	Description
area	Measure	Esquema para almacenar la lectura y la unidad de medida.
bbox	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Para obtener más información: https://geojson.org/). Nota: Las coordenadas se esperan en formato [Longitud, Latitud].
centroid	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Para obtener más información: https://geojson.org/). Nota: Las coordenadas se esperan en formato [Longitud, Latitud].
description	string minLength: 0 maxLength: 500	Descripción textual del recurso.
geometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Para obtener más información: https://geojson.org/). Nota: Las coordenadas se esperan en formato [Longitud, Latitud].
name	string minLength: 0 maxLength: 100	Nombre para identificar el recurso.
parentId	string	Identificador del elemento primario al que pertenece.
parentType	BoundaryParentType	Tipo del elemento primario al que pertenece. Es decir, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
properties		Colección de pares clave-valor que pertenece al recurso. Cada par no debe tener una clave superior a 50 caracteres y no debe tener un valor superior a 150 caracteres. Nota: Se pueden proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores string, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ).
source	string minLength: 2 maxLength: 100	Origen del recurso.
status	string minLength: 0 maxLength: 100	Estado del recurso.
type	string	Indica el tipo de límite que pertenece a un elemento primario.

Respuestas

Nombre	Tipo	Description
200 OK	Boundary	Éxito
201 Created	Boundary	Creado
Other Status Codes	ErrorResponse	Error Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

Boundary

Éxito

201 Created

Boundary

Creado

Other Status Codes

ErrorResponse

Error

Encabezados

x-ms-error-code: string

Seguridad

Authorization

Proporcione un token de portador válido para las llamadas API autorizadas. Tenga en cuenta que es posible que tenga que borrar la memoria caché del explorador si ha intentado realizar llamadas no autenticadas antes.

Tipo: apiKey
En: header

Ejemplos

Boundaries_CreateOrUpdate

Solicitud de ejemplo

HTTP

PATCH /parties/PARTY123/boundaries/BOUNDARY123?api-version=2023-06-01-preview

{
  "parentId": "FIELD123",
  "parentType": "Field",
  "type": "string",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70448589324951,
          20.542411534243367
        ],
        [
          73.70877742767334,
          20.541688176010233
        ],
        [
          73.71023654937744,
          20.545083911372505
        ],
        [
          73.70663166046143,
          20.546992723579137
        ],
        [
          73.70457172393799,
          20.545385304358106
        ]
      ]
    ]
  },
  "name": "John Smith's Boundary",
  "description": "Some description"
}

Respuesta de muestra

status code:: 200

{
  "parentId": "FIELD123",
  "parentType": "Field",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70448589324951,
          20.542411534243367
        ],
        [
          73.70877742767334,
          20.541688176010233
        ],
        [
          73.71023654937744,
          20.545083911372505
        ],
        [
          73.70663166046143,
          20.546992723579137
        ],
        [
          73.70457172393799,
          20.545385304358106
        ]
      ]
    ]
  },
  "type": "string",
  "crs": "WGS84",
  "centroid": {
    "type": "Point",
    "coordinates": [
      73.70711478791443,
      20.54418916247634
    ]
  },
  "bbox": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.70448589324951,
          20.541688176010233
        ],
        [
          73.70448589324951,
          20.546992723579137
        ],
        [
          73.71023654937744,
          20.546992723579137
        ],
        [
          73.71023654937744,
          20.541688176010233
        ]
      ]
    ]
  },
  "area": {
    "unit": "Acre",
    "value": 60.405
  },
  "name": "John Smith's Boundary",
  "description": "Some description"
}

status code:: 201

{
  "parentId": "FIELD123",
  "parentType": "Field",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70448589324951,
          20.542411534243367
        ],
        [
          73.70877742767334,
          20.541688176010233
        ],
        [
          73.71023654937744,
          20.545083911372505
        ],
        [
          73.70663166046143,
          20.546992723579137
        ],
        [
          73.70457172393799,
          20.545385304358106
        ]
      ]
    ]
  },
  "type": "string",
  "crs": "WGS84",
  "centroid": {
    "type": "Point",
    "coordinates": [
      73.70711478791443,
      20.54418916247634
    ]
  },
  "bbox": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.70448589324951,
          20.541688176010233
        ],
        [
          73.70448589324951,
          20.546992723579137
        ],
        [
          73.71023654937744,
          20.546992723579137
        ],
        [
          73.71023654937744,
          20.541688176010233
        ]
      ]
    ]
  },
  "area": {
    "unit": "Acre",
    "value": 60.405
  },
  "name": "John Smith's Boundary",
  "description": "Some description"
}

Definiciones

Nombre	Description
Boundary	Esquema del recurso de límite.
BoundaryParentType	Tipo del elemento primario al que pertenece. Es decir, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
Error	Error del servicio Azure AgPlatform.
ErrorResponse	Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para ver el documento de referencia ErrorResponse.
GeoJsonObjectType	Tipo de objeto GeoJSON.
InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.
Measure	Esquema para almacenar la lectura y la unidad de medida.
MultiPolygon	Geometría multipolygon.
Point	Geometría de punto.
Polygon	Geometría de polígono.

Boundary

Object

Esquema del recurso de límite.

Nombre	Tipo	Description
area	Measure	Esquema para almacenar la lectura y la unidad de medida.
bbox	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Para obtener más información: https://geojson.org/). Nota: Las coordenadas se esperan en formato [Longitud, Latitud].
centroid	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Para obtener más información: https://geojson.org/). Nota: Las coordenadas se esperan en formato [Longitud, Latitud].
createdBy	string	Creado por el identificador de usuario o inquilino.
createdDateTime	string (date-time)	Fecha y hora en que se creó el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
crs	string	Sistema de referencia de coordenadas.
description	string minLength: 0 maxLength: 500	Descripción textual del recurso.
eTag	string	Valor ETag para implementar la simultaneidad optimista.
geometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (Para obtener más información: https://geojson.org/). Nota: Las coordenadas se esperan en formato [Longitud, Latitud].
id	string	Identificador de recurso único.
modifiedBy	string	Modificado por identificador de usuario o inquilino.
modifiedDateTime	string (date-time)	Fecha y hora en que el recurso se modificó por última vez, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Nombre para identificar el recurso.
parentId	string	Identificador del elemento primario al que pertenece.
parentType	BoundaryParentType	Tipo del elemento primario al que pertenece. Es decir, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.
partyId	string	Id. de fiesta.
properties		Colección de pares clave-valor que pertenece al recurso. Cada par no debe tener una clave superior a 50 caracteres y no debe tener un valor superior a 150 caracteres. Nota: Se pueden proporcionar un máximo de 25 pares clave-valor para un recurso y solo se admiten valores string, numeral y datetime (aaaa-MM-ddTHH:mm:ssZ).
source	string minLength: 2 maxLength: 100	Origen del recurso.
status	string minLength: 0 maxLength: 100	Estado del recurso.
type	string	Indica el tipo de límite que pertenece a un elemento primario.

BoundaryParentType

Enumeración

Tipo del elemento primario al que pertenece. Es decir, Field, SeasonalField, Zone, Prescription, PlantTissueAnalysis, ApplicationData, HarvestData, TillageData, PlantingData.

Valor	Description
Field
SeasonalField
Zone
Prescription
PlantTissueAnalysis
ApplicationData
PlantingData
TillageData
HarvestData

Error

Object

Error del servicio Azure AgPlatform.

Nombre	Tipo	Description
code	string minLength: 1	Conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.
message	string minLength: 1	Representación legible del error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error del servicio Azure AgPlatform. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses para ver el documento de referencia ErrorResponse.

Nombre	Tipo	Description
error	Error	Error del servicio Azure AgPlatform.
traceId	string	Identificador de seguimiento único.

GeoJsonObjectType

Enumeración

Tipo de objeto GeoJSON.

Valor	Description
Point
Polygon
MultiPolygon

InnerError

Object

Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.

Nombre	Tipo	Description
code	string	Código de error específico del proporcionado por el error contenedor.
innererror	InnerError	Error interno que contiene la lista de errores. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object documento de referencia de InnerError.

Measure

Object

Esquema para almacenar la lectura y la unidad de medida.

Nombre	Tipo	Description
unit	string minLength: 1 maxLength: 50	Unidad de datos.
value	number (double)	Valor de datos.

MultiPolygon

Object

Geometría multipolygon.

Nombre	Tipo	Description
coordinates	number[] (double)	Obtiene o establece coordenadas del objeto GeoJSON. Debe ser una matriz de polígonos, cada polígono contiene una lista de anillos lineales. Para polígonos con más de uno de estos anillos, el primero debe ser el anillo exterior, y cualquier otro debe ser anillos interiores.
type	string: MultiPolygon	Tipo de objeto GeoJSON.

Point

Object

Geometría de punto.

Nombre	Tipo	Description
coordinates	number[] (double)	Obtiene o establece la coordenada de este punto. Debe ser una matriz de 2 o 3 elementos para un sistema 2D o 3D.
type	string: Point	Tipo de objeto GeoJSON.

Polygon

Object

Geometría de polígono.

Nombre	Tipo	Description
coordinates	number[] (double)	Obtiene o establece el tipo del objeto GeoJSON. Debe ser una matriz de matrices de coordenadas de anillo lineal. Para polígonos con más de uno de estos anillos, el primero debe ser el anillo exterior, y cualquier otro debe ser anillos interiores.
type	string: Polygon	Tipo de objeto GeoJSON.