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
Common metadata object syntax
| Code Block |
|---|
{
"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"
}
]
} |
| Info |
|---|
|
Key description
...
Key
...
Type
...
Optionality
...
Description
...
Constraints
...
id
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
a 16-byte long unique string
...
(a-z0-9)
...
name
...
string
...
| Status | ||||
|---|---|---|---|---|
|
name of the object
...
(a-z0-9_-)
...
type
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
type of the object
...
[dashboard, dataPermission, dataset, export, indicator, indicatorDrill, marker, markerSelector, metric, projectSettings, share, view]
...
title
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
human-readable title of the object
...
(*)
...
description
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
human-readable description of the object
...
(*)
...
origin
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
URL that indicates the original location of an imported object
...
(*)
...
content
...
object
...
| Status | ||||
|---|---|---|---|---|
|
...
actual content of the metadata object
mandatory in all object types except datasets, they have a ref key
...
accessInfo
...
object
...
| Status | ||||
|---|---|---|---|---|
|
...
metadata about the access to the object
...
links
...
array
...
| Status | ||||
|---|---|---|---|---|
|
...
array containing links identifying the object (self link)
accessInfo
...
Key
...
Type
...
Optionality
...
Description
...
Constraints
...
createdAt
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
timestamp of the first submission of the object to the project
...
(*)
...
createdBy
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
email of the user who created the object
...
(a-z0-9_-@)
...
modifiedAt
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
timestamp of the last time the object was modified
...
(*)
...
modifiedBy
...
string
...
| Status | ||||
|---|---|---|---|---|
|
...
email of the user who last modified the object
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
The content you are trying to reach has been moved here: https://docs.clevermaps.io/docs/common-syntaxWe are proud to announce that we have launched a new documentation. Please update your saved links and bookmarks to follow a new address docs.clevermaps.io. |