Nutrient Analyses - List By Farmer Id

Referencia

Servicio:: Azure Data Manager for Agriculture

Versión de la API:: 2021-07-31-preview

Devuelve una lista paginada de recursos de análisis de nutrientes bajo un granjero determinado.

GET /farmers/{farmerId}/nutrient-analyses?api-version=2021-07-31-preview

Con parámetros opcionales:

GET /farmers/{farmerId}/nutrient-analyses?parentType={parentType}&parentIds={parentIds}&classifications={classifications}&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
farmerId	path	True	string	Id. del granjero asociado.
api-version	query	True	string	La versión de API solicitada
$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.
$skipToken	query		string	Omita el token para obtener el siguiente conjunto de resultados.
classifications	query		string[]	Clasificaciones para análisis de nutrientes.
ids	query		string[]	Identificadores del recurso.
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).
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. Es decir, PlantTissueAnalysis.
propertyFilters	query		string[]	Filtra los pares clave-valor dentro del objeto Properties. Eg. "{testKey} eq {testValue}".
statuses	query		string[]	Estados 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	NutrientAnalysisListResponse	Éxito
Other Status Codes	ErrorResponse	Error Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

NutrientAnalysisListResponse

É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

NutrientAnalyses_ListByFarmerId

Solicitud de ejemplo

HTTP

GET /farmers/FARMER123/nutrient-analyses?api-version=2021-07-31-preview

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "farmerId": "FARMER123",
      "id": "ManagementZone123",
      "parentId": "ParentId",
      "parentType": "PlantTissueAnalysis",
      "unit": "Unit",
      "value": 250,
      "referenceValueLow": 22,
      "referenceValueHigh": 33,
      "classification": "Classification",
      "recommendation": "Advice",
      "products": [
        {
          "rate": "Rate",
          "instruction": "Instruction",
          "product": "product"
        }
      ],
      "name": "John Smith's Nutrient analysis",
      "status": "Active",
      "description": "Some description",
      "properties": {
        "Irrigated": "Yes"
      },
      "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}}/nutrient-analyses?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.
ErrorResponse	Respuesta de error del servicio Azure AgPlatform. Documento de referencia ErrorResponse..
InnerError	Error interno que contiene la lista de errores. Documento de referencia innerError.
NutrientAnalysis	Modelo de API para el objeto de análisis de nutrientes.
NutrientAnalysisListResponse	La respuesta paginada contiene una lista de objetos solicitados y un vínculo de dirección URL para obtener el siguiente conjunto de resultados.
NutrientAnalysisParentType	Tipo primario para este análisis de nutrientes. Es decir, PlantTissueAnalysis.
ProductDetails	Modelo para representar el objeto ProductDetails.

Error

Object

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	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

Object

Respuesta de error del servicio Azure AgPlatform. 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. Documento de referencia 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. Documento de referencia innerError.

NutrientAnalysis

Object

Modelo de API para el objeto de análisis de nutrientes.

Nombre	Tipo	Description
classification	string minLength: 0 maxLength: 50	Clasificación para este análisis de nutrientes.
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.
farmerId	string	Identificador de granjero para este análisis de nutrientes.
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: 0 maxLength: 100	Nombre para identificar el recurso.
parentId	string	Id. de padre para este análisis de nutrientes.
parentType	NutrientAnalysisParentType	Tipo primario para este análisis de nutrientes. Es decir, PlantTissueAnalysis.
products	ProductDetails[]	Productos para este análisis de nutrientes.
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).
recommendation	string minLength: 0 maxLength: 1000	Recomendación para este análisis de nutrientes.
referenceValueHigh	number (double)	Valor de referencia alto para este análisis de nutrientes.
referenceValueLow	number (double)	Valor de referencia bajo para este análisis de nutrientes.
source	string minLength: 2 maxLength: 100	Origen del recurso.
status	string minLength: 0 maxLength: 100	Estado del recurso.
unit	string minLength: 0 maxLength: 32	Unidad para este análisis de nutrientes.
value	number (double)	Valor para este análisis de nutrientes.

NutrientAnalysisListResponse

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
$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	NutrientAnalysis[]	Lista de objetos solicitados.

NutrientAnalysisParentType

Enumeración

Tipo primario para este análisis de nutrientes. Es decir, PlantTissueAnalysis.

Valor	Description
PlantTissueAnalysis

ProductDetails

Object

Modelo para representar el objeto ProductDetails.

Nombre	Tipo	Description
instruction	string minLength: 0 maxLength: 1000	Instrucción del recurso.
product	string minLength: 0 maxLength: 100	Producto del recurso.
rate	string minLength: 0 maxLength: 100	Tasa del producto.

Compartir a través de

Nutrient Analyses - List By Farmer Id

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

Authorization

Ejemplos

NutrientAnalyses_ListByFarmerId

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Error

ErrorResponse

InnerError

NutrientAnalysis

NutrientAnalysisListResponse

NutrientAnalysisParentType

ProductDetails