Opensearch dashboards.savedobjectsrepository.bulkget

Home > opensearch-dashboards > SavedObjectsRepository > bulkGet

SavedObjectsRepository.bulkGet() method

Returns an array of objects by id

Signature:

bulkGet<T = unknown>(objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions): Promise<SavedObjectsBulkResponse<T>>;

Parameters

Parameter	Type	Description
objects	SavedObjectsBulkGetObject[]	an array of objects containing id, type and optionally fields
options	SavedObjectsBaseOptions	{string} [options.namespace]

Returns:

Promise<SavedObjectsBulkResponse<T>>

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

Example

bulkGet([ { id: 'one', type: 'config' }, { id: 'foo', type: 'index-pattern' } ])