Retrieve entities using a scroll-based query

Request

Lists all entities using a scroll-based query for efficient large result set traversal.

Note

The Querying API supports various operators for filter types that use an operator field. Relation filters do not support operators.

Security

OAuth2.0

X-ApiVersionintegerrequired

API version. Must be set to 3.

Example:3

Body

The scroll.

scroll_idstring or null

The ID of the scroll session to get the next results for.

scroll_timestring, (date-span)

The time to keep the scroll session active.

load_configurationobject(EntityLoadConfiguration)

Represents the configuration for loading an entity.

curl -i -X POST \
  https://your-server/api/entities/scroll \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-ApiVersion: 3' \
  -d '{
    "scroll_id": "string",
    "scroll_time": "string",
    "load_configuration": {
      "culture_option": {
        "load_option": "None",
        "cultures": [
          "string"
        ]
      },
      "property_option": {
        "load_option": "None",
        "properties": [
          "string"
        ]
      },
      "relation_option": {
        "load_option": "None",
        "relations": [
          {
            "name": "string",
            "role": "Parent"
          }
        ],
        "max_related_items": 0
      }
    }
  }'

Responses

Successful operation

Bodyapplication/json

scroll_idstring or null

itemsArray of objects or null(SearchDocumentResource)

Gets or sets the list of items.

total_itemsinteger or null, (int64)

Gets or sets the total number of items.

returned_itemsinteger or null, (int64)

Gets or sets the number of returned items.

offsetinteger or null, (int32)

Gets or sets the offset of the items.

nextobject(Link)

Represents a link to a resource.

previousobject(Link)

Represents a link to a resource.

Response

{
  "scroll_id": "string",
  "items": [
    { … }
  ],
  "total_items": 0,
  "returned_items": 0,
  "offset": 0,
  "next": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "previous": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  }
}