Common syntax

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

Key description

KeyTypeOptionalityDescriptionConstraints
idstring

a 16-byte long unique string 

(a-z0-9)
namestring

name of the object

must be unique across the project, must be the same as the .json filename

(a-z0-9_-)
typestring

type of the object

[dashboard, dataPermissiondataset, exportindicator, indicatorDrill, marker, markerSelector, metric, projectSettings, shareview]
titlestring

human-readable title of the object(*)

description

stringhuman-readable description of the object(*)
originstringURL that indicates the original location of an imported object(*)
contentobject

actual content of the metadata object

mandatory in all object types except datasets, they have a ref key


accessInfoobjectmetadata about the access to the object
linksarray

array containing links identifying the object (self link)


accessInfo

KeyTypeOptionalityDescriptionConstraints
createdAtstringtimestamp of the first submission of the object to the project(*)
createdBystringemail of the user who created the object(a-z0-9_-@)
modifiedAtstring

timestamp of the last time the object was modified

(*)
modifiedBystringemail of the user who last modified the object(a-z0-9_-@)