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 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| string |
| a 16-byte long unique string |
| ||||||
| string |
| name of the object must be unique across the project, must bethe same as the .json filename |
| ||||||
| string |
| type of the object |
| ||||||
| string |
| human-readable title of the object |
| ||||||
| string |
| human-readable description of the object |
| ||||||
| string |
| URL that indicates the original location of an imported object |
| ||||||
| object |
| actual content of the metadata object mandatory in all object types except datasets, they have a | |||||||
| object |
| metadata about the access to the object | |||||||
| array |
| array containing links identifying the object ( |
accessInfo
Key | Type | Optionality | Description | Constraints | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| string |
| timestamp of the first submission of the object to the project |
| ||||||
| string |
| email of the user who created the object |
| ||||||
| string |
| timestamp of the last time the object was modified |
| ||||||
| string |
| email of the user who last modified the object |
|