Documentation Center

Using element names

All API calls use element names, because the title or label of an object can change over time.

All API calls use element names or identifiers, because the title or label of an object can change over time.

When creating a new object, an element name is generated. For most objects (e.g. topics, maps, illustrations, publications,...) the generated element name is a GUID which ensures that the element name is unique. However, for objects which are used during configuration (e.g. status, language, output format,...), a readable element name is generated (see Generating readable element names).

Note, for some object you can also provide an element name as long as it is unique and complies with the element name limitations.

Object typeGenerated element nameCan it be set during creation?Referencing
topics, maps, illustrations, publications,...GUIDyeselement name
foldersGUIDnonumeric identifier
output formatReadable element namenoelement name
list of values (e.g. status, language,...)Readable element nameyeselement name
usersReadable element namenoelement name
user groupsReadable element namenoelement name
user rolesReadable element namenoelement name
baselineGUIDnoelement name