Skip to content

Opensearch dashboards.savedobjectsrepository.find

Home > opensearch-dashboards > SavedObjectsRepository > find

SavedObjectsRepository.find() method

Signature:

find<T = unknown>(options: SavedObjectsFindOptions): Promise<SavedObjectsFindResponse<T>>;

Parameters

Parameter Type Description
options SavedObjectsFindOptions {(string|Array)} [options.type] {string} [options.search] {string} [options.defaultSearchOperator] {Array} [options.searchFields] - see OpenSearch Simple Query String Query field argument for more information {integer} [options.page=1] {integer} [options.perPage=20] {string} [options.sortField] {string} [options.sortOrder] {Array} [options.fields] {string} [options.namespace] {object} [options.hasReference] - { type, id } {string} [options.preference]

Returns:

Promise<SavedObjectsFindResponse<T>>

{promise} - { saved_objects: [{ id, type, version, attributes }], total, per_page, page }