IListedDashboard
Home > @gooddata/sdk-model > IListedDashboard
IListedDashboard interface
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.
Listed dashboard - to display the dashboard in the list Only a subset of dashboard data is available, for the full definition see IDashboard
Signature:
export interface IListedDashboard extends Readonly<Required<IAuditableDates>>, Readonly<IAuditableUsers>, IAccessControlAware
Extends: Readonly<Required<IAuditableDates>>, Readonly<IAuditableUsers>, IAccessControlAware
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| availability | readonly | ListedDashboardAvailability | (ALPHA) States if dashboard is shared with the user and fully accessible or if it is hidden but accessible via link if user knows it. |
| description | readonly | string | (ALPHA) Dashboard description |
| identifier | readonly | string | (ALPHA) Dashboard identifier |
| ref | readonly | ObjRef | (ALPHA) Dashboard object ref |
| tags? | readonly | string[] | (ALPHA) (Optional) Dashboard tags. |
| title | readonly | string | (ALPHA) Dashboard title |
| uri | readonly | string | (ALPHA) Dashboard uri |