Dashboard¶
| Field | NULL | Description | Note |
|---|---|---|---|
| name string |
The name of the dashboard | ||
| description string |
The description of the dashboard | ||
| categoryId string (GUID) |
Y | The id of the dashboard category | |
| categoryName string |
The name of the dashboard category | ||
| subCategoryId string (GUID) |
Y | The id of the dashboard sub-category | |
| subCategoryName string |
The name of the dashboard sub-category | ||
| tenantId string (GUID) |
Y | The id of the tenant if available | |
| imageUrl string |
The url of the image | ||
| stretchImage boolean |
Is the image stretched | ||
| backgroundColor string |
The background color | ||
| showFilterDescription boolean |
Whether to show filter descriptions | ||
| lastViewed datetime |
Y | The last viewed date time | |
| owner string |
The owner name | ||
| ownerId string (GUID) |
Y | The id of the owner | |
| createdById string (GUID) |
Y | Id of user who created this dashboard | |
| modifiedById string (GUID) |
Y | Id of user who last modified this dashboard | |
| checked boolean |
Is selected for copy in Copy Management | ||
| numberOfView integer |
The number of view | ||
| renderingTime real number |
The rendering time | ||
| sourceId string (GUID) |
Y | The id of the source dashboard in case this dashboard has been copied | |
| isGlobal boolean |
Whether this is global dashboard | ||
| deletable boolean |
Is deletable | ||
| editable boolean |
Is editable | ||
| movable boolean |
Is movable | ||
| copyable boolean |
Is copyable | ||
| accessPriority integer |
The access priority | ||
| dashboardParts array of objects |
An array of DashboardPart objects | ||
| indeterminate boolean |
Place-holder, returns false | ||
| isCheck boolean |
Whether this is selected | ||
displayDashboardTileHeader
|
Whether display dashboard tile or not |
Inherited fields:
Entity¶
| Field | NULL | Description | Note |
|---|---|---|---|
| id string (GUID) |
The id of this object Example: 572bd576-8c92-4901-ab2a-b16e38144813 |
Allow null incase insert a new entity | |
| state integer |
The entity state of this object
|
||
| deleted boolean |
Is this object deleted | ||
| inserted boolean |
Is this object inserted | ||
| version string |
Y | The version | |
| created datetime in ISO 8601 format |
Y | The created datetime | |
| createdBy string |
The creator | ||
| modified datetime in ISO 8601 format |
Y | The modification datetime | |
| modifiedBy string |
The user who last modified this object |