Skip to Content
API ReferenceFieldPOST /search

POST /field/search

Search Field

Search fields — composable infra architecture.

Request Body (SearchFieldApiRequest)

FieldTypeRequiredDescription
searchstringNo
parameter_idsstring[]No
persona_idsstring[]No
filter_department_idsstring[]No
parameter_searchstringNo
persona_searchstringNo
department_searchstringNo
page_sizeintegerNo
page_offsetintegerNo
snapshot_keystringNoCache snapshot key for consistent reads across related requests

Response (ListFieldApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the acting user
fieldsListFieldApiField[]NoList of field items
parameter_filterListFilterSectionNoFilter options for parameters
persona_filterListFilterSectionNoFilter options for personas
department_filterListFilterSectionNoFilter options for departments
flag_filterListFilterSectionNoFilter options for flags in list UI
total_countintegerNoTotal number of fields
import_fieldsImportField[]NoCSV import column schema for the bulk-import dialog
Last updated on