All metadata object types are based on a common template.
...
| Code Block |
|---|
| title | Common metadata object syntax |
|---|
|
{
"id": "abcdefgh12345678",
"name": "my_view",
"type": "view",
"title": "My view",
"description": "In this view, you'll see a lot of interesting things.",
"origin": "https://secure.cleveranalyticsclevermaps.comio/rest/projects/$projectId/md/datasets?name=view_name",
"content": {
...
},
"accessInfo": {
"createdAt": "2017-01-01T00:00:00Z",
"modifiedAt": "2017-01-02T00:00:00Z"
},
"links": [
{
"rel": "self",
"href": "/rest/projects/$projectId/md/views/abcdefgh12345678"
}
]
} |
...
Key description
| 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, 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 | (*) |
modifiedAt | string | | timestamp of the last time the object was modified | (*) |
...
The example above is a