Plant Tissue Analyses - Search

Service:: Azure Data Manager for Agriculture

API Version:: 2023-11-01-preview

Search for PlantTissueAnalyses across all parties by intersecting geometry.

POST {endpoint}/plant-tissue-analyses:search?api-version=2023-11-01-preview

With optional parameters:

POST {endpoint}/plant-tissue-analyses:search?skipToken={skipToken}&maxPageSize={maxPageSize}&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
api-version	query	True	string	The requested API version
maxPageSize	query		integer (int32) minimum: 10 maximum: 1000	Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default Value = 50.
skipToken	query		string	Skip token for getting next set of results.

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.

Request Body

Name	Type	Description
cropIds	string[]	CropIds of the resource.
cropProductIds	string[]	CropVariety Ids of the resource.
fieldIds	string[]	Field Ids of the resource.
ids	string[]	Ids of the resource.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format.
maxCreatedDateTime	string (date-time)	Maximum creation date of resource (inclusive).
maxLastModifiedDateTime	string (date-time)	Maximum last modified date of resource (inclusive).
minCreatedDateTime	string (date-time)	Minimum creation date of resource (inclusive).
minLastModifiedDateTime	string (date-time)	Minimum last modified date of resource (inclusive).
names	string[]	Names of the resource.
partyId	string	Party ID which belongs to the operation data.
propertyFilters	string[]	Filters on key-value pairs within the Properties object. e.g. "{testKey} eq {testValue}".
seasonIds	string[]	Season Ids of the resource.
statuses	string[]	Statuses of the resource.

Responses

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

Name

Type

Description

200 OK

PlantTissueAnalysisMetaDataListResponse

Success

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

PlantTissueAnalyses_Search

Sample request

HTTP

POST {endpoint}/plant-tissue-analyses:search?maxPageSize=50&api-version=2023-11-01-preview

{
  "intersectsWithGeometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70457172393799,
          20.545385304358106
        ],
        [
          73.70448589324951,
          20.542411534243367
        ],
        [
          73.70877742767334,
          20.541688176010233
        ],
        [
          73.71023654937744,
          20.545083911372505
        ],
        [
          73.70663166046143,
          20.546992723579137
        ],
        [
          73.70457172393799,
          20.545385304358106
        ]
      ]
    ]
  }
}

Sample response

Status code:: 200

{
  "value": [
    {
      "partyId": "FARMER123",
      "id": "PLANTTISSUEANALYSIS123",
      "seasonId": "Season123",
      "fieldId": "Field123",
      "plantingDateTime": "2021-03-21T06:49:30Z",
      "plantPart": "PlantPart",
      "plantPosition": "PlantPosition",
      "plantAppearance": "PlantAppearance",
      "sampleCollectionCondition": "SampleCollectionCondition",
      "sampleCollectionDateTime": "2021-04-21T06:49:30Z",
      "sampleReceivedDateTime": "2021-04-22T06:49:30Z",
      "sampleTestResultDateTime": "2021-04-23T06:49:30Z",
      "labDetails": {
        "code": "LabId",
        "name": "Name",
        "address": "Address",
        "description": "Description"
      },
      "name": "John Smith's ManagementZone",
      "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/plant-tissue-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.
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.
GeoJsonObjectType	GeoJSON object type.
InnerError	Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.
LabDetails	Model for representing LabDetails object.
MultiPolygon	MultiPolygon geometry.
PlantTissueAnalysisMetaData	Api Model for plant tissue analysis object.
PlantTissueAnalysisMetaDataListResponse	Paged response contains list of requested objects and a skipToken to get the next set of results.
Point	Point geometry.
Polygon	Polygon geometry.
SearchPlantTissueAnalysisQuery	Search All PlantTissueAnalysis and Search PlantTissueAnalyses parameters.

Error

Object

An error from the Azure AgPlatform service.

Name	Type	Description
code	string minLength: 1	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 minLength: 1	Human-readable representation of the error.
target	string	Target of the error.

ErrorResponse

Object

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.

GeoJsonObjectType

Enumeration

GeoJSON object type.

Value	Description
Point
Polygon
MultiPolygon

InnerError

Object

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.

LabDetails

Object

Model for representing LabDetails object.

Name	Type	Description
address	string minLength: 0 maxLength: 500	Address of the resource.
code	string minLength: 0 maxLength: 150	Code of the resource.
description	string minLength: 0 maxLength: 500	Description of the resource.
name	string minLength: 0 maxLength: 100	Name of the resource.

MultiPolygon

Object

MultiPolygon geometry.

Name	Type	Description
coordinates	number[] (double)	Gets or sets Coordinates of GeoJSON Object. It must be an array of polygons, each polygon contains list of linear rings. For Polygons with more than one of these rings, the first MUST be the exterior ring, and any others MUST be interior rings.
type	string: MultiPolygon	GeoJSON object type.

PlantTissueAnalysisMetaData

Object

Api Model for plant tissue analysis object.

Name	Type	Description
createdBy	string	Created by user/tenant id.
createdDateTime	string (date-time)	Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.
cropId	string	Id of the associated Crop.
cropProductId	string	Id of the associated Crop product.
description	string minLength: 0 maxLength: 500	Textual description of the resource.
eTag	string	The ETag value to implement optimistic concurrency.
fieldId	string	Id of the associated Field.
growthStage	string minLength: 0 maxLength: 200	Growth stage for this plant tissue analysis.
id	string	Unique resource ID.
labDetails	LabDetails	Model for representing LabDetails object.
modifiedBy	string	Modified by user/tenant id.
modifiedDateTime	string (date-time)	Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.
name	string minLength: 0 maxLength: 100	Name to identify resource.
partyId	string	Id of the associated Party.
plantAppearance	string minLength: 0 maxLength: 500	Plant appearance for this plant tissue analysis.
plantPart	string minLength: 0 maxLength: 200	Plant part for this plant tissue analysis.
plantPosition	string minLength: 0 maxLength: 200	Plant position for this plant tissue analysis.
plantingDateTime	string (date-time)	Planting datetime for this plant tissue 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.
sampleCollectionCondition	string minLength: 0 maxLength: 500	Sample collection condition for this plant tissue analysis.
sampleCollectionDateTime	string (date-time)	Sample collection dateTime for this plant tissue analysis.
sampleReceivedDateTime	string (date-time)	Sample received dateTime.
sampleTestResultDateTime	string (date-time)	Sample test result dateTime for this plant tissue analysis.
seasonId	string	Id of the associated Season.
source	string minLength: 2 maxLength: 100	Source of the resource.
status	string minLength: 0 maxLength: 100	Status of the resource.

PlantTissueAnalysisMetaDataListResponse

Object

Paged response contains list of requested objects and a skipToken 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	PlantTissueAnalysisMetaData[]	List of requested objects.

Point

Object

Point geometry.

Name	Type	Description
coordinates	number[] (double)	Gets or sets the coordinate of this point. It must be an array of 2 or 3 elements for a 2D or 3D system.
type	string: Point	GeoJSON object type.

Polygon

Object

Polygon geometry.

Name	Type	Description
coordinates	number[] (double)	Gets or sets type of the GeoJSON Object. It must be an array of linear ring coordinate arrays. For Polygons with more than one of these rings, the first MUST be the exterior ring, and any others MUST be interior rings.
type	string: Polygon	GeoJSON object type.

SearchPlantTissueAnalysisQuery

Object

Search All PlantTissueAnalysis and Search PlantTissueAnalyses parameters.

Name	Type	Description
cropIds	string[]	CropIds of the resource.
cropProductIds	string[]	CropVariety Ids of the resource.
fieldIds	string[]	Field Ids of the resource.
ids	string[]	Ids of the resource.
intersectsWithGeometry	GeoJsonObject: MultiPolygon Point Polygon	GeoJSON (For more details: https://geojson.org/). Note: Coordinates are expected in [Longitude, Latitude] format.
maxCreatedDateTime	string (date-time)	Maximum creation date of resource (inclusive).
maxLastModifiedDateTime	string (date-time)	Maximum last modified date of resource (inclusive).
minCreatedDateTime	string (date-time)	Minimum creation date of resource (inclusive).
minLastModifiedDateTime	string (date-time)	Minimum last modified date of resource (inclusive).
names	string[]	Names of the resource.
partyId	string	Party ID which belongs to the operation data.
propertyFilters	string[]	Filters on key-value pairs within the Properties object. e.g. "{testKey} eq {testValue}".
seasonIds	string[]	Season Ids of the resource.
statuses	string[]	Statuses of the resource.