Retrieve entities using a scroll-based query

Request

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

Security

OAuth2.0

Query

querystringrequired

The query string, for example, Definition.Name == 'M.Asset'.

identifierstring

The scroll token used to fetch the next page of results, for example, DXF1ZXJ5QW.

takeinteger, (int32)

Number of entities to retrieve, for example, 25. The maximum is 100.

membersstring

Comma-separated list of members to retrieve, for example, Title,Filename.

renditionsstring

Comma-separated list of renditions to retrieve, for example, Preview,Thumbnail.

cultureobject

The culture code of the user, for example, en-US.

sortstring

Sort field, for example, created_on.

orderstring

Sort order, for example, desc.

sortCultureobject

Used for sorting operations, affecting the order of strings based on language-specific rules, for example, en-US.

nestedRelationsArray of strings

Nested relations to retrieve, for example, Children,Parent.

curl -i -X GET \
  'https://your-server/api/entities/scroll?query=string&identifier=string&take=0&members=string&renditions=string&culture=&sort=string&order=string&sortCulture=&nestedRelations=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json

last_hit_dataArray of strings or null

The last returned hits, which are used to fetch the next page of results.

itemsArray of objects or null(EntityResource)

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.

identifierstring or null

Gets or sets the identifier of the resource.

selfobject(Link)

Represents a link to a resource.

property name*anyadditional property

Response

{
  "last_hit_data": [
    "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
  },
  "identifier": "string",
  "self": {
    "href": "string",
    "filename_properties": [ … ],
    "title": "string",
    "templated": false
  },
  "property1": null,
  "property2": null
}