getDashboardReferencedObjects()

Home > @gooddata/sdk-backend-spi > IWorkspaceDashboardsService > getDashboardReferencedObjects

IWorkspaceDashboardsService.getDashboardReferencedObjects() method

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Get objects referenced by a given dashboard.

Signature:

getDashboardReferencedObjects(dashboard: IDashboard, types?: SupportedDashboardReferenceTypes[]): Promise<IDashboardReferences>;

Parameters

Parameter	Type	Description
dashboard	IDashboard	dashboard to get referenced objects for
types	SupportedDashboardReferenceTypes[]	(Optional) optional array of object types to include, when not specified, all supported references will be retrieved

Returns:

Promise<IDashboardReferences>