All metadata object types are based on a common template.
...
| Key | Type | Optionality | Description | Constraints |
|---|
id | string | | a 16-byte long unique string | (a-z0-9) |
name | string | | name of the object must be unique across the project, must bethe same as the .json filename | (a-z0-9_-) |
type | string | | type of the object | [dashboard, dataPermission, dataset, export, indicator, indicatorDrill, marker, markerSelector, metric, projectSettings, share, view] |
title | string | | human-readable title of the object | (*) |
description
| string | | human-readable description of the object | (*) |
origin | string | | URL that indicates the original location of an imported object | (*) |
content | object | | actual content of the metadata object mandatory in all object types except datasets, they have a ref key |
|
accessInfo | object | | metadata about the access to the object |
|
links | array | | array containing links identifying the object (self link) |
|
accessInfo
| Key | Type | Optionality | Description | Constraints |
|---|
createdAt | string | | timestamp of the first submission of the object to the project | (*) |
createdBy | string | | email of the user who created the object | (a-z0-9_-@) |
modifiedAt | string | | timestamp of the last time the object was modified | (*) |
modifiedBy | string | | email of the user who last modified the object | (a-z0-9_-@) |
...