Dashboard is an ordered list of indicators and indicator drill pairs.
...
| Key | Type | Optionality | Description | Constraints |
|---|
type | string | | type identifier, always indicator | [indicator] |
indicator | string | | URL link to the indicator object | /rest/projects/$projectId/md/indicators?name={indicatorName} |
indicatorDrill | string | | URL link to the indicator drill object | /rest/projects/$projectId/md/indicatorDrills?name={indicatorDrillName} |
layout | string | | layout of the indicator when not specified, the indicator's layout is primary | [primary, secondary] |
collapsed | boolean | | determines if the indicator should be collapsed when entering the view |
|
itemId | string | | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId section. | [a-z0-9]{32} |
...
| Key | Type | Optionality | Description | Constraints |
|---|
type | string | | type identifier, always indicatorGroup | [indicatorGroup] |
title | string | | title of the indicator group | (*) |
description | string | | description of the indicator group | (*) |
collapsed | boolean | | determines if the group should be collapsed when entering the view | [true, false] |
blockRows | array | | array of either: see the syntax example above |
|
itemId | string | | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId section. | [a-z0-9]{32} |
...
| Key | Type | Optionality | Description | Constraints |
|---|
dataset | string | | URL link to the dataset, whose properties will be set | /rest/projects/$projectId/md/datasets?name={datasetName} |
defaultSearch | string | | specifies if the dataset will be enabled in Refine search enable = dataset will be enabled disable = dataset will be disabled auto = dataset will be enabled if its features are visible in the map | [enable, disable, auto] |
featureAttributes | array | | array of dataset.properties.featureAttributes |
|
itemId | string | | Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId section. | [a-z0-9]{32} |
content.**.itemId itemId
Generated ID for this item to be used for matching it within a parent array while rebasing share objects. itemId is genrated as hash from random UUID when given item is being created - either an entire dashboard is being created or an item is being added to MD object content via update. Once itemId is generated it is not supposed to be modified.
IMPORTANT: When interacting with REST API do not provide own generated values as itemId;
- if an item is being created do not provide itemId attribute at all - it will be generated at backend and returend within a response payload
- if an item is being updated provide the value of itemId which was previously retrieved from backend via REST API - this value will be used for matching the item with share object diffs while rebasing a share object
...