Sign in

v7

latestSwagger 2.02026-07-13186148695.0 KB
Insights

Gets a specified insight resource under a particular party.

get/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}

Path parameters

partyIdstring required

Id of the associated party.

modelIdstring required

Id of the associated model.

resourceTypestring required

Resource type associated with the record.

resourceIdstring required

Id of the associated resource.

insightIdstring required

Id of the insight resource.

Query parameters

api-versionstring required

The requested API version

Response

Success

partyIdstring

Id of the associated party.

modelIdstring

Id of the associated model.

resourceType'Party' | 'Farm' | 'Field' | 'SeasonalField'

Resource type associated with the record.

resourceIdstring

Id of the associated resource.

modelVersionstring

Version of the associated model.

attachmentsLinkstring

Gets link for attachments.

insightStartDateTimestring date-time

Start date to which the insight is related.

insightEndDateTimestring date-time

End date to which the insight is related.

measurementsobject

Measures to capture insights results.

idstring

Id of the resource.

statusstring

Status of the resource.

createdDateTimestring date-time

Date-time when resource was created, sample format: yyyy-MM-ddTHH:mm:ssZ.

modifiedDateTimestring date-time

Date-time when resource was last modified, sample format: yyyy-MM-ddTHH:mm:ssZ.

eTagstring

The ETag value to implement optimistic concurrency.

namestring

Name to identify resource.

descriptionstring

Textual description of the resource.

createdBystring

Created by user/tenant id.

modifiedBystring

Modified by user/tenant id.

propertiesobject

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.

Example response

{
  "createdDateTime": "2020-12-31T11:10:21Z",
  "modifiedDateTime": "2020-12-31T11:10:21Z",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}