Sign in
SensorMappings

Returns a paginated list of sensor mapping resources.

get/sensor-mappings

Query parameters

sensorIdsstring[]

Id of the sensors.

sensorPartnerIdsstring[]

Id of the sensor partners.

partyIdsstring[]

Id of the parties.

associatedResourceIdsstring[]

Resource Ids of the resource.

associatedResourceTypestring

Resource Types of the resource. i.e. Farmer, Farm, Field, SeasonalField, FarmOperationApplicationData, HarvestData, TillageData, PlantingData, PlantTissueAnalysis.

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
      }
    }
  ]
}

Changes

Changed in 2 of the 6 revisions of this API.34

  • 2021-03-31-previewaae0a90ec45733See the full diff
    • ●

      deleted the query request parameter $maxPageSize

      request-parameter-removed

    • ●

      deleted the query request parameter $skipToken

      request-parameter-removed

    • ●

      deleted the query request parameter farmerIds

      request-parameter-removed

    • ○

      added the new optional query request parameter maxPageSize

      new-optional-request-parameter

    • ○

      added the new optional query request parameter partyIds

      new-optional-request-parameter

    • ○

      added the new optional query request parameter skipToken

      new-optional-request-parameter

  • 2021-03-31-previewfea79168ed1e1See the full diff
    • ○

      endpoint added

      endpoint-added