Nutrient Analyses - Create Or Update

Reference

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

Creates or updates a nutrient analysis resource.

PATCH {endpoint}/parties/{partyId}/nutrient-analyses/{nutrientAnalysisId}?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
nutrientAnalysisId	path	True	string	Id of the nutrient analysis resource.
partyId	path	True	string	Id of the party resource.
api-version	query	True	string	The requested API version

Request Header

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

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.

Request Body

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

Name	Type	Description
classification	string	Classification for this nutrient analysis.
description	string	Textual description of the resource.
name	string	Name to identify resource.
parentId	string	Parent id for this nutrient analysis.
parentType	NutrientAnalysisParentType	Parent type for this nutrient analysis. i.e. PlantTissueAnalysis.
products	ProductDetails[]	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.

Responses

Name	Type	Description
200 OK	NutrientAnalysis	Success
201 Created	NutrientAnalysis	Created
Other Status Codes	ErrorResponse	Error Headers x-ms-error-code: string

Name

Type

Description

200 OK

NutrientAnalysis

Success

201 Created

NutrientAnalysis

Created

Other Status Codes

ErrorResponse

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_CreateOrUpdate

Sample request

HTTP

PATCH {endpoint}/parties/PARTY123/nutrient-analyses/NutrientAnalysis123?api-version=2023-11-01-preview

{
  "parentId": "ParentId",
  "parentType": "PlantTissueAnalysis",
  "unit": "Unit",
  "value": 250,
  "referenceValueLow": 22,
  "referenceValueHigh": 33,
  "classification": "Classification",
  "recommendation": "Advice",
  "products": [
    {
      "rate": "Rate",
      "instruction": "Instruction",
      "product": "product"
    }
  ],
  "status": "Active",
  "name": "John Smith's Nutrient Analysis",
  "description": "Some description",
  "source": "source",
  "properties": {
    "Irrigated": "Yes"
  }
}

Sample response

Status code:: 200

{
  "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 NutrientAnalysis",
  "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"
}

Status code:: 201

{
  "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 NutrientAnalysis",
  "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"
}

Definitions

Name	Description
Error	An error from the Azure AgPlatform service.
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.
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.
NutrientAnalysisParentType	Parent type for this nutrient analysis. i.e. PlantTissueAnalysis.
ProductDetails	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	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	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	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	NutrientAnalysisParentType	Parent type for this nutrient analysis. i.e. PlantTissueAnalysis.
partyId	string	Party id for this nutrient analysis.
products	ProductDetails[]	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.

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.

Share via

Nutrient Analyses - Create Or Update

URI Parameters

Request Header

Request Body

Responses

Security

Authorization

Examples

NutrientAnalyses_CreateOrUpdate

Sample request

Sample response

Definitions

Error

ErrorResponse

InnerError

NutrientAnalysis

NutrientAnalysisParentType

ProductDetails

Additional resources