Sign in
Entities Management

Search entities

Search for entities across all templates using nested filter queries. Supports complex logical compositions (AND / OR) of filter criteria on template, identifier, name, properties, relations, and reverse relations.

post/api/v1/entities/search

Request body

querystring

Free-text search string. When present, returns entities whose identifier, name, templateIdentifier, or any property value contains this string (case-insensitive). Can be combined with filter.

pageinteger

Page number for pagination. Defaults to 0.

sizeinteger

Number of items per page. Defaults to 20.

sortstring

Sorting criteria in the format: property(,asc|desc). Defaults to identifier,asc.

Example request

{
  "query": "checkout",
  "filter": {
    "connector": "AND",
    "field": "template",
    "operation": "EQ",
    "value": "microservice"
  },
  "size": 20,
  "sort": "identifier:asc"
}

Response

Entities retrieved successfully

Changes

Changed in 4 of the 13 revisions of this API.123

  • e6f6d45eade311See the full diff
    • ●

      removed the optional property errorDescription from the response with the 400 status

      response-optional-property-removed

    • ○

      added the optional property error_description to the response with the 400 status

      response-optional-property-added

  • 7e634c43bc1b11See the full diff
    • ●

      removed the optional property content/items/relations_as_target from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property content/items/relations/additionalProperties/items/template_identifier to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e29b86a4899f1See the full diff
    • ○

      endpoint added

      endpoint-added

  • 88fc145b63971See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog