Boundaries - List By Party Id

Servicio:

Azure Data Manager for Agriculture

Versión de la API:

2023-06-01-preview

Devuelve una lista paginada de recursos de límites en una entidad determinada.

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

Con parámetros opcionales:

GET /parties/{partyId}/boundaries?parentType={parentType}&type={type}&parentIds={parentIds}&minArea={minArea}&maxArea={maxArea}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-06-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
partyId	path	True	string	Id. de la entidad asociada.
api-version	query	True	string	La versión de API solicitada
ids	query		string[]	Identificadores del recurso.
maxArea	query		number (double)	Superficie máxima del límite (inclusive).
maxCreatedDateTime	query		string (date-time)	Fecha máxima de creación del recurso (inclusivo).
maxLastModifiedDateTime	query		string (date-time)	Fecha máxima de última modificación del recurso (inclusive).
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Número máximo de elementos necesarios (ambos incluidos). Mínimo = 10, Máximo = 1000, Valor predeterminado = 50.
minArea	query		number (double)	Área mínima del límite (inclusivo).
minCreatedDateTime	query		string (date-time)	Fecha de creación mínima del recurso (inclusivo).
minLastModifiedDateTime	query		string (date-time)	Fecha mínima de última modificación del recurso (inclusive).
names	query		string[]	Nombres del recurso.
parentIds	query		string[]	Identificadores primarios del recurso.
parentType	query		string	Tipo del elemento primario al que pertenece.
propertyFilters	query		string[]	Filtra los pares clave-valor dentro del objeto Properties. Eg. "{testKey} eq {testValue}".
skipToken	query		string	Omita el token para obtener el siguiente conjunto de resultados.
statuses	query		string[]	Estados del recurso.
type	query		string	Escriba al que pertenece.

Encabezado de la solicitud

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.

Respuestas

Nombre	Tipo	Description
200 OK	BoundaryMetadataListResponse	Éxito
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_ListByPartyId

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "parentId": "FIELD123",
      "parentType": "Field",
      "area": {
        "unit": "Acre",
        "value": 60.405
      },
      "name": "John Smith's Boundary",
      "description": "Some description"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/boundaries/?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

Definiciones

Nombre	Description
BoundaryMetadata	Esquema de metadatos de recursos de límite.
BoundaryMetadataListResponse	La respuesta paginada contiene una lista de objetos solicitados y un vínculo de dirección URL para obtener el siguiente conjunto de resultados.
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.
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.

BoundaryMetadata

Object

Esquema de metadatos de recursos de límite.

Nombre	Tipo	Description
area	Measure	Esquema para almacenar la lectura y la unidad de medida.
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.
description	string minLength: 0 maxLength: 500	Descripción textual del recurso.
eTag	string	Valor ETag para implementar la simultaneidad optimista.
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.
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	Escriba al que pertenece.

BoundaryMetadataListResponse

Object

La respuesta paginada contiene una lista de objetos solicitados y un vínculo de dirección URL para obtener el siguiente conjunto de resultados.

Nombre	Tipo	Description
nextLink	string	Vínculo de continuación (URI absoluto) a la siguiente página de resultados en la lista.
skipToken	string	Token usado para recuperar la página siguiente. Si es null, no hay páginas adicionales.
value	BoundaryMetadata[]	Lista de objetos solicitados.

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.

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.