The example above is a view object that has been imported by CleverMaps Shell.
All metadata object types are based on a common template.
The keys in this template are necessary to uniquely identify the object and store it in a database. Most of these keys are automatically generated by the application.
Syntax example
{
"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.clevermaps.io/rest/projects/$projectId/md/datasets?name=view_name",
"content": {
...
},
"accessInfo": {
"createdAt": "2017-01-01T00:00:00Z",
"createdBy": "tomas.schmidl@clevermaps.io",
"modifiedAt": "2017-01-02T00:00:00Z"
"modifiedBy": "tomas.schmidl@clevermaps.io"
},
"links": [
{
"rel": "self",
"href": "/rest/projects/$projectId/md/views/abcdefgh12345678"
}
]
} |
|
| 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 be the 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 | (*) | |
| 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 | ||
accessInfo | object | metadata about the access to the object | ||
links | array | array containing links identifying the object ( |
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_-@) |