Nutrient Analyses - List By Party Id
Returns a paginated list of nutrient analysis resources under a particular party.
GET {endpoint}/parties/{partyId}/nutrient-analyses?api-version=2023-11-01-preview
GET {endpoint}/parties/{partyId}/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=2023-11-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net |
party
|
path | True |
string |
Id of the associated party. |
api-version
|
query | True |
string |
The requested API version |
classifications
|
query |
string[] |
Classifications for nutrient analyses. |
|
ids
|
query |
string[] |
Ids of the resource. |
|
max
|
query |
string date-time |
Maximum creation date of resource (inclusive). |
|
max
|
query |
string date-time |
Maximum last modified date of resource (inclusive). |
|
max
|
query |
integer int32 |
Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50. |
|
min
|
query |
string date-time |
Minimum creation date of resource (inclusive). |
|
min
|
query |
string date-time |
Minimum last modified date of resource (inclusive). |
|
names
|
query |
string[] |
Names of the resource. |
|
parent
|
query |
string[] |
Parent ids of the resource. |
|
parent
|
query |
string |
Type of the parent it belongs to. i.e. PlantTissueAnalysis. |
|
property
|
query |
string[] |
Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}". |
|
skip
|
query |
string |
Skip token for getting next set of results. |
|
statuses
|
query |
string[] |
Statuses of the resource. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
Authorization | True |
string |
Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
Error Headers x-ms-error-code: string |
Security
Authorization
Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.
Type:
apiKey
In:
header
Examples
NutrientAnalyses_ListByPartyId
Sample request
GET {endpoint}/parties/PARTY123/nutrient-analyses?api-version=2023-11-01-preview
Sample response
{
"value": [
{
"partyId": "PARTY123",
"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",
"source": "source",
"properties": {
"Irrigated": "Yes"
},
"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"
}
],
"skipToken": "string",
"nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/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"
}
Definitions
Name | Description |
---|---|
Error |
An error from the Azure AgPlatform service. |
Error |
An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document. |
Inner |
Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. |
Nutrient |
Api Model for nutrient analysis object. |
Nutrient |
Paged response contains list of requested objects and a URL link to get the next set of results. |
Nutrient |
Parent type for this nutrient analysis. i.e. PlantTissueAnalysis. |
Product |
Model for representing ProductDetails object. |
Error
An error from the Azure AgPlatform service.
Name | Type | Description |
---|---|---|
code |
string |
Server-defined set of error codes. |
details |
Error[] |
Array of details about specific errors that led to this reported error. |
innererror |
Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. |
|
message |
string |
Human-readable representation of the error. |
target |
string |
Target of the error. |
ErrorResponse
An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.
Name | Type | Description |
---|---|---|
error |
An error from the Azure AgPlatform service. |
|
traceId |
string |
Unique trace Id. |
InnerError
Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
Name | Type | Description |
---|---|---|
code |
string |
Specific error code than was provided by the containing error. |
innererror |
Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document. |
NutrientAnalysis
Api Model for nutrient analysis object.
Name | Type | Description |
---|---|---|
classification |
string |
Classification for this nutrient analysis. |
createdBy |
string |
Created by user/tenant id. |
createdDateTime |
string |
Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ. |
description |
string |
Textual description of the resource. |
eTag |
string |
The ETag value to implement optimistic concurrency. |
id |
string |
Unique resource ID. |
modifiedBy |
string |
Modified by user/tenant id. |
modifiedDateTime |
string |
Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ. |
name |
string |
Name to identify resource. |
parentId |
string |
Parent id for this nutrient analysis. |
parentType |
Parent type for this nutrient analysis. i.e. PlantTissueAnalysis. |
|
partyId |
string |
Party id for this nutrient analysis. |
products |
Products for this nutrient analysis. |
|
properties |
|
A collection of key value pairs that belongs to the resource. Each pair must not have a key greater than 50 characters and must not have a value greater than 150 characters. Note: A maximum of 25 key value pairs can be provided for a resource and only string, numeral and datetime (yyyy-MM-ddTHH:mm:ssZ) values are supported. |
recommendation |
string |
Recommendation for this nutrient analysis. |
referenceValueHigh |
number |
Reference value high for this nutrient analysis. |
referenceValueLow |
number |
Reference value low for this nutrient analysis. |
source |
string |
Source of the resource. |
status |
string |
Status of the resource. |
unit |
string |
Unit for this nutrient analysis. |
value |
number |
Value for this nutrient analysis. |
NutrientAnalysisListResponse
Paged response contains list of requested objects and a URL link to get the next set of results.
Name | Type | Description |
---|---|---|
nextLink |
string |
Continuation link (absolute URI) to the next page of results in the list. |
skipToken |
string |
Token used in retrieving the next page. If null, there are no additional pages. |
value |
List of requested objects. |
NutrientAnalysisParentType
Parent type for this nutrient analysis. i.e. PlantTissueAnalysis.
Name | Type | Description |
---|---|---|
PlantTissueAnalysis |
string |
ProductDetails
Model for representing ProductDetails object.
Name | Type | Description |
---|---|---|
instruction |
string |
Instruction of the resource. |
product |
string |
Product of the resource. |
rate |
string |
Rate of the product. |