Skip to content
Last updated

Terminology

Reporting API NameDesigner Name
IsMasterVariantWhen the variants feature is enabled, this indicates the primary variant.
IsRootNodeIf this is the item of the highest hierarchy within the facet, e.g. Process House.
SupportsVariantsIf this element supports different variants in the case that variant management is in use for the database.
SupportsVersionsIf this element supports different versions.
VariantsA list of variants of the elements and their details.
VersionsA list of the versions of this element and their details for each version.
AttributesAttributes can be different per element type and configurations to elements by the designer Admin in the “extended configuration”.
CreationIdOriginal ID for any element within a process that is just part of a process (Tasks, Events, Conditions, Rules), and can be used to identify unique tasks. This is kept consistent while tasks get duplicated into new process versions and get new IDs.
ContentA list of objects that is modeled within the Element, which can include children and non-hierarchical elements.
RelatedA list of objects that are related to the Element, such as their accountable organization and system used.
ContainerPermaLinkLink to the latest, relevant version of the element.
FacetNameThe facet this element belongs to. An element can only belong to a single facet.
IdContainer ID of the element which is the same across all versions of the element.
OrderingOrdering of the element in the Hierarchy , if custom defined.
PermaLinkLink to a version of the element.
ElementHierarchy:KeyElement Id

The Reporting API is organized in objects that share a set of similar attributes. The following diagram describes their relation to each other. Common attributes have been extracted to the table StandardAttributes for brevity.

contains

contains

contains

contains

contains

contains

Result

bool

IsMasterVariant

bool

IsRootNode

bool

SupportsVariants

bool

SupportsVersions

dict

Attributes

dict

Related

see_table

StandardAttributes

Content

bool

IsMasterVariant

bool

IsRootNode

bool

SupportsVariants

bool

SupportsVersions

dict

Attributes

dict

Related

see_table

StandardAttributes

Variants

bool

IsMasterVariant

bool

IsRootNode

bool

SupportsVariants

bool

SupportsVersions

dict

Attributes

dict

Related

see_table

StandardAttributes

Versions

bool

IsMasterVariant

bool

IsRootNode

bool

SupportsVariants

bool

SupportsVersions

dict

Attributes

dict

Related

see_table

StandardAttributes

StandardAttributes

string

ContainerPermaLink

Guid

CreationId

string

FacetName

Guid

Id

int

Ordering

string

PermaLink

string

State

string

Stereotype

string

Type

Guid

VariantDefinitionId

Guid

VariantId

Guid

VersionId

contains

contains

contains

contains

contains

contains

Result

bool

IsMasterVariant

bool

IsRootNode

bool

SupportsVariants

bool

SupportsVersions

dict

Attributes

dict

Related

see_table

StandardAttributes

Content

bool

IsMasterVariant

bool

IsRootNode

bool

SupportsVariants

bool

SupportsVersions

dict

Attributes

dict

Related

see_table

StandardAttributes

Variants

bool

IsMasterVariant

bool

IsRootNode

bool

SupportsVariants

bool

SupportsVersions

dict

Attributes

dict

Related

see_table

StandardAttributes

Versions

bool

IsMasterVariant

bool

IsRootNode

bool

SupportsVariants

bool

SupportsVersions

dict

Attributes

dict

Related

see_table

StandardAttributes

StandardAttributes

string

ContainerPermaLink

Guid

CreationId

string

FacetName

Guid

Id

int

Ordering

string

PermaLink

string

State

string

Stereotype

string

Type

Guid

VariantDefinitionId

Guid

VariantId

Guid

VersionId

children

Hierarchy

string

key

Element Id (maps to StandardAttributes.Guid Id)

children

Hierarchy

string

key

Element Id (maps to StandardAttributes.Guid Id)