Sitecore API catalog
/
Querying API
/
Querying

Querying API (v3.0)

Use the Querying API to fetch multiple pages of search results sequentially. This REST API lets you to retrieve entities that match a specific criteria.

The Try it functionality available from the API documentation lets you explore API endpoints and make calls directly from the documentation.

Authentication

To use the Try it feature of the Querying API, you need:

Download OpenAPI description
index.json
index.yaml
Overview
License closed source
Languages
Servers
https://{server}/

Querying

The Querying API is responsible for fetching multiple pages of results sequentially.

Operations

Retrieve a list of entities based on a search query

Request

Lists all entities that match the criteria. This endpoint supports sorted pagination using the search_after parameter.

Bodyapplication/jsonrequired

Request for executing queries with pagination.

filterAncestorIdQueryNodeFilter (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) or ModifiedByQueryNodeFilter (object) or NegatingQueryNodeFilter (object) or PathRootQueryNodeFilter (object) or ObjectPropertyQueryNodeFilter (object) or RelationExistsQueryNodeFilter (object) or RelationQueryNodeFilter (object) or RootTaxonomyItemQueryNodeFilter (object) or SelectionQueryNodeFilter (object)required

Base query filter for entities.

One of:

Base query filter for entities.

filter.​typestringrequired

Specifies the type of filter to be applied in a query node.

Enum"Negating""Logical""DefinitionId""DefinitionName""RootTaxonomyItem""PathRoot""Locked""LockedBy""CreatedBy""ModifiedBy"
filter.​idinteger(int64)required

Gets or sets ancestor ID.

filter.​relationstringnon-emptyrequired

Gets or sets ancestor relation name.

sortingArray of objects(Sorting)required

Defines how the results should be sorted.

sorting[].​fieldstringrequired
sorting[].​orderstring(QuerySortOrder)required
Enum"Desc""Asc"
sorting[].​field_typestring(SortFieldType)
Enum"Property""System"
sorting[].​culturestring or null
takeinteger or null(int32)

The number of items to take. If not specified, the underlying implementation will use a default value.

Default 25
search_afterArray of strings or null

To retrieve the next page of results using a set of sort values from the previous results. For example, if you make a request and receive 100 items, ending with entity_id_1, your subsequent call can include search_after=entity_id_1 to fetch the next page.

load_configurationobject(EntityLoadConfiguration)

Represents the configuration for loading an entity.

renditionsArray of strings or nullDeprecated

The renditions that will be loaded with the resulting entities.

nested_relationsArray of strings or nullDeprecated

The nested relations that will be loaded with the resulting entities.

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

The last returned results, 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
application/json
{
  "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
}