List documents

Retrieves a list of the documents in a project. You can use filters to narrow down the list. Unlike the search endpoint, the pagination isn't restricted to 1000 documents in total, meaning this endpoint can be used to iterate through all the documents in your project.

For more information on how the filtering works, see the documentation for the search endpoint.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
Request Body schema: application/json
required

Fields to be set for the list request.

(bool filters (and (object) or or (object) or not (object))) or (leaf filters (equals (object) or in (object) or containsAny (object) or containsAll (object) or range (object) or prefix (object) or search (object) or exists (object) or geojsonIntersects (object) or geojsonDisjoint (object) or geojsonWithin (object) or inAssetSubtree (object))) (DocumentFilter)

A JSON based filtering language. See detailed documentation above.

Array of objects (DocumentSortItem) = 1 items

List of properties to sort by. Currently only supports 1 property.

limit
integer <int32> [ 1 .. 1000 ]
Default: 100

Maximum number of items per page. Use the cursor to get more pages.

cursor
string

Cursor for paging through results.

Responses
200

One page of document list results.

400

The response for a failed request.

post/documents/list
Request samples
application/json
{
  • "filter": {
    • "and": [
      ]
    },
  • "sort": [
    • {
      }
    ],
  • "limit": 100,
  • "cursor": "string"
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "string"
}