Opensearch dashboards.savedobjectsclient.bulkget

Home > opensearch-dashboards > SavedObjectsClient > bulkGet

SavedObjectsClient.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 ids, or an array of objects containing id, type and optionally fields
options	SavedObjectsBaseOptions

Returns:

Promise<SavedObjectsBulkResponse<T>>

Example

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