Farms

Returns a paginated list of farm resources across all parties.

Request

  • Base URL
    {endpoint}
  • Auth
    API key in header Authorization

Query parameters

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

  • 2021-03-31-previewaae0a90ec457Revision changes
    • warning

      deleted the query request parameter $maxPageSize

    • warning

      deleted the query request parameter $skipToken

    • info

      added the new optional query request parameter maxPageSize

    1 more change in this revision