Retrieve entities using a search query

Request

Lists all entities that match the criteria. This endpoint supports sorted pagination using the search-after property.

Note

For additional information, see the SearchAfter API (V3) developer documentation, including information about supported query operators, filters and supported operators, as well as SearchAfter examples.

Security

OAuth2.0

X-ApiVersionintegerrequired

API version. Must be set to 3.

Example:3

Bodyapplication/jsonrequired

Request for executing queries with pagination.

filterQueryNodeFilter (object) or AncestorIdQueryNodeFilter (object) or CreatedByQueryNodeFilter (object) or DefinitionIdQueryNodeFilter (object) or DefinitionNameQueryNodeFilter (object) or FullTextQueryNodeFilter (object) or IdentifierQueryNodeFilter (object) or IdInQueryNodeFilter (object) or LockedByQueryNodeFilter (object) or LockedQueryNodeFilter (object) or LogicalQueryNodeFilter (object)required

One of:

Base query filter for entities.

sortingArray of objects(Sorting)required

search_afterArray of strings or null

takeinteger or null, (int32)

load_configurationobject(EntityLoadConfiguration)

Represents the configuration for loading an entity.

curl -i -X POST \
  https://your-server/api/entities/searchAfter \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-ApiVersion: 3' \
  -d '{
    "filter": {
      "type": "Negating"
    },
    "sorting": [
      {
        "field_type": "Property",
        "field": "string",
        "culture": "string",
        "order": "Desc"
      }
    ],
    "search_after": [
      "string"
    ],
    "take": 0,
    "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

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
}