Skip to content

Search System

GET [base]?param1=value&...

Handling Errors

By default, Blaze ignores unknown or unsupported search parameters. If you prefer to get an error instead, you can set the Prefer header to handling=strict. In this case, Blaze will return a 400 Bad Request with an OperationOutcome detailing the unknown or unsupported search parameters.

Search Parameters Since 1.11.0

The following common search parameters, defined on all resources, are supported:

NameSinceDescription
_has1.11.0reverse chaining
_id1.11.0logical resource id
_lastUpdated1.11.0date of last update
_list1.11.0resources referenced by a list
_profile1.11.0profiles the resource claims to conform to
_security1.11.0security labels applied to the resource
_source1.11.0where the resource comes from
_tag1.11.0tags applied to the resource

The resulting resources are returned in a stable but unspecified order — resources of the same type are grouped together and sorted by logical resource id within each type — matching the order of the search without any search parameters.

Search Result Parameters

NameSinceDescription
_countthe default page size is 50 and the maximum page size is 10.000
_elements1.11.0fully supported
_include1.11.0supported, except the wildcard *
_revinclude1.11.0supported, except the wildcard *
_summary1.0.0true, count and false are supported
_total1.11.0accurate is supported

Paging

The search-system interaction supports paging which is described in depth in the separate paging sessions section.