Skip to Content

POST /document/search

Search Document

Search documents — composable infra architecture.

Request Body (SearchDocumentApiRequest)

FieldTypeRequiredDescription
searchstringNo
scenario_idsstring[]No
field_idsstring[]No
filter_department_idsstring[]No
scenario_searchstringNo
field_searchstringNo
department_searchstringNo
page_sizeintegerNo
page_offsetintegerNo
snapshot_keystringNoCache snapshot key for consistent reads across related requests

Response (ListDocumentApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the current user
documentsListDocumentApiDocument[]NoList of documents
scenario_filterListFilterSectionNoFilter options for scenarios in list UI
field_filterListFilterSectionNoFilter options for fields in list UI
department_filterListFilterSectionNoFilter options for departments in list UI
flag_filterListFilterSectionNoFilter options for flags in list UI
total_countintegerNoTotal number of matching records
import_fieldsImportField[]NoCSV import column schema for the bulk-import dialog
Last updated on