Prescription Maps - List By Farmer Id
Devuelve una lista paginada de recursos de mapa de prescripción bajo un granjero determinado.
GET /farmers/{farmerId}/prescription-maps?api-version=2021-07-31-preview
GET /farmers/{farmerId}/prescription-maps?types={types}&cropIds={cropIds}&seasonIds={seasonIds}&fieldIds={fieldIds}&sources={sources}&ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&$maxPageSize={$maxPageSize}&$skipToken={$skipToken}&api-version=2021-07-31-preview
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
farmer
|
path | True |
string |
Id. del granjero asociado. |
api-version
|
query | True |
string |
La versión de API solicitada |
$max
|
query |
integer (int32) minimum: 10maximum: 1000 |
Número máximo de elementos necesarios (ambos incluidos). Mínimo = 10, Máximo = 1000, Valor predeterminado = 50. |
|
$skip
|
query |
string |
Omita el token para obtener el siguiente conjunto de resultados. |
|
crop
|
query |
string[] |
Identificadores de recorte del recurso. |
|
field
|
query |
string[] |
Identificadores de campo del recurso. |
|
ids
|
query |
string[] |
Identificadores del recurso. |
|
max
|
query |
string (date-time) |
Fecha máxima de creación del recurso (inclusivo). |
|
max
|
query |
string (date-time) |
Fecha máxima de última modificación del recurso (inclusive). |
|
min
|
query |
string (date-time) |
Fecha de creación mínima del recurso (inclusivo). |
|
min
|
query |
string (date-time) |
Fecha mínima de última modificación del recurso (inclusive). |
|
names
|
query |
string[] |
Nombres del recurso. |
|
property
|
query |
string[] |
Filtra los pares clave-valor dentro del objeto Properties. Eg. "{testKey} eq {testValue}". |
|
season
|
query |
string[] |
Identificadores de temporada del recurso. |
|
sources
|
query |
string[] |
Orígenes del recurso. |
|
statuses
|
query |
string[] |
Estados del recurso. |
|
types
|
query |
string[] |
Tipos del recurso. |
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 |
Éxito |
|
Other Status Codes |
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
PrescriptionMaps_ListByFarmerId
Solicitud de ejemplo
GET /farmers/FARMER123/prescription-maps?api-version=2021-07-31-preview
Respuesta de muestra
{
"value": [
{
"id": "PRESCRIPTIONMAP123",
"farmerId": "FARMER123",
"fieldId": "FIELD123",
"seasonId": "SEASON123",
"cropId": "CROP123",
"type": "Planting",
"source": "TestLab123",
"name": "John Smith's Prescription map",
"status": "Active",
"description": "Some description",
"properties": {
"Irrigated": "Yes",
"RetailerId": "Retailer123"
},
"createdDateTime": "2021-04-21T06:49:30Z",
"modifiedDateTime": "2021-04-21T06:49:30Z",
"eTag": "0f8fad5b-d9cb-469f-a165-70867728950e"
}
],
"$skipToken": "string",
"nextLink": "https://{{resourceName}}.farmbeats.azure.net/farmers/{{farmerId}}/prescription-maps?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 |
---|---|
Error |
Error del servicio Azure AgPlatform. |
Error |
Respuesta de error del servicio Azure AgPlatform. Documento de referencia ErrorResponse.. |
Inner |
Error interno que contiene la lista de errores. Documento de referencia innerError. |
Prescription |
Modelo de API para el objeto De mapa de prescripción. |
Prescription |
La respuesta paginada contiene una lista de objetos solicitados y un vínculo de dirección URL para obtener el siguiente conjunto de resultados. |
Error
Error del servicio Azure AgPlatform.
Nombre | Tipo | Description |
---|---|---|
code |
string |
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 |
Error interno que contiene la lista de errores. Documento de referencia innerError. |
|
message |
string |
Representación legible del error. |
target |
string |
Destino del error. |
ErrorResponse
Respuesta de error del servicio Azure AgPlatform. Documento de referencia ErrorResponse..
Nombre | Tipo | Description |
---|---|---|
error |
Error del servicio Azure AgPlatform. |
|
traceId |
string |
Identificador de seguimiento único. |
InnerError
Error interno que contiene la lista de errores. Documento de referencia innerError.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error específico del proporcionado por el error contenedor. |
innererror |
Error interno que contiene la lista de errores. Documento de referencia innerError. |
PrescriptionMap
Modelo de API para el objeto De mapa de prescripción.
Nombre | Tipo | Description |
---|---|---|
createdDateTime |
string (date-time) |
Fecha y hora en que se creó el recurso, formato de ejemplo: aaaa-MM-ddTHH:mm:ssZ. |
cropId |
string |
Id. de recorte. |
description |
string minLength: 0maxLength: 500 |
Descripción textual del recurso. |
eTag |
string |
Valor ETag para implementar la simultaneidad optimista. |
farmerId |
string |
Identificador de granjero. |
fieldId |
string |
Id. de campo. |
id |
string |
Identificador de recurso único. |
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: 0maxLength: 100 |
Nombre para identificar el recurso. |
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). |
|
seasonId |
string |
Id. de temporada. |
source |
string minLength: 2maxLength: 100 |
Origen del recurso. |
status |
string minLength: 0maxLength: 100 |
Estado del recurso. |
type |
string minLength: 0maxLength: 100 |
Tipo de mapa de prescripción. |
PrescriptionMapListResponse
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 |
---|---|---|
$skipToken |
string |
Token usado para recuperar la página siguiente. Si es null, no hay páginas adicionales. |
nextLink |
string |
Vínculo de continuación (URI absoluto) a la siguiente página de resultados en la lista. |
value |
Lista de objetos solicitados. |