searchEntitiesByType

View as Markdown

Grouped search across entity types (optionally anchored to a source).

Performs a full-text search across multiple entity types and returns results grouped by entity type (e.g., {REQUEST: [...], CHANGE: [...], ASSET: [...]}) instead of a flat paginated list. Same search engine as searchEntities — both hit the same Elasticsearch-backed query pipeline.

Parameters

NameTypeRequiredDescription
per_pageintegerNoDefault: 25.
pageintegerYesDefault: 1.
sort_orderBaseSearchSortOrderNo
source_display_idstringNoDisplay ID of the source entity for link-candidate mode (e.g., REQ-123). When provided, the source and its already-linke
source_entity_typeREQUEST | CHANGENoEntity type of the source entity. Required if source_display_id is provided.
reference_keystringNoRelationship reference key (e.g., “parent_child”, “relates”, “blocks”). When combined with a source, further filters alr
search_typeobjectNo
search_componentsobjectNo
querystringNo
per_pageintegerNoDefault: 10.
pageintegerNoDefault: 1.
filtersSearchBaseFilterDTO[]No