Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

KeyTypeOptionalityDescriptionConstraints
idstring

Status
colourBlue
titlegenerated

a 16-byte long unique string 

(a-z0-9)
namestring

Status
colourRed
titlerequired

name of the object

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

(a-z0-9_-)
typestring

Status
colourRed
titlerequired

type of the object

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

Status
colourGreen
titleoptional

human-readable title of the object(*)

description

string
Status
colourGreen
titleoptional
human-readable description of the object(*)
originstring
Status
colourBlue
titlegenerated
URL that indicates the original location of an imported object(*)
contentobject
Status
colourYellow
titlevaries

actual content of the metadata object

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


accessInfoobject
Status
colourBlue
titlegenerated
metadata about the access to the object
linksarray
Status
colourBlue
titlegenerated

array containing links identifying the object (self link)


...