Retrieve entities using a route-based query string

Request

Lists entities that match the query using a route-based query string, for example, /api/entities/query/Definition.Name=='M.Asset'.

Security

OAuth2.0

Path

querystringrequired

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

Query

skipinteger, (int32)

The number of items to skip before retrieving results, for example, 0.

takeinteger, (int32)

The number of items 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

Culture for the results, for example, en-US.

sortstring

Sort field, for example, created_on.

orderstring

Sort order, for example, desc.

sortCultureobject

Culture for sorting, for example, en-US.

nestedRelationsArray of strings

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

curl -i -X GET \
  'https://your-server/api/entities/query/{query}?skip=0&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
}