Sign in

v7

latestSwagger 2.02026-07-13186148695.0 KB
Insights

Returns a paginated list of insight resources.

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

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.

Query parameters

minInsightStartDateTimestring date-time

Minimum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.

maxInsightStartDateTimestring date-time

Maximum insightStartDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.

minInsightEndDateTimestring date-time

Minimum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.

maxInsightEndDateTimestring date-time

Maximum insightEndDateTime time of insight resources (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.

measurementFiltersstring[]

Filters on measureKey.unit/unitValue or measureKey.value/value pairs within the Measures object. eg. "measureKey.unit eq {testValue}" where testValue is string. eg. "measureKey.value eq {testValue}" where testValue = double.

idsstring[]

Ids of the resource.

namesstring[]

Names of the resource.

propertyFiltersstring[]

Filters on key-value pairs within the Properties object. eg. "{testKey} eq {testValue}".

statusesstring[]

Statuses of the resource.

minCreatedDateTimestring date-time

Minimum creation date of resource (inclusive).

maxCreatedDateTimestring date-time

Maximum creation date of resource (inclusive).

minLastModifiedDateTimestring date-time

Minimum last modified date of resource (inclusive).

maxLastModifiedDateTimestring date-time

Maximum last modified date of resource (inclusive).

maxPageSizeinteger

Maximum number of items needed (inclusive). Minimum = 10, Maximum = 1000, Default value = 50.

skipTokenstring

Skip token for getting next set of results.

api-versionstring required

The requested API version

Response

Success

skipTokenstring

Token used in retrieving the next page. If null, there are no additional pages.

nextLinkstring

Continuation link (absolute URI) to the next page of results in the list.

Example response

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