Purpose type in Main(OMHierarchyPurpose)

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	OMHierarchyPurpose/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.1"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Purpose type	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Main/OMHierarchyPurpose
HierarchyPurpose		Main/OMHierarchyPurpose
HierarchyType		Main/OMHierarchyPurpose
IsDefault		Main/OMHierarchyPurpose
IsImmutable		Main/OMHierarchyPurpose
Relationship_HierarchyPurpose_FKRelationshipId		Main/OMHierarchyPurpose

RecId

First included in: Main/OMHierarchyPurpose (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	OMHierarchyPurpose/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

HierarchyPurpose

First included in: Main/OMHierarchyPurpose (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the HierarchyPurpose attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

HierarchyType

First included in: Main/OMHierarchyPurpose (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the HierarchyType attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer
is.dataFormat.big

IsDefault

First included in: Main/OMHierarchyPurpose (this entity)

Properties

Name	Value
displayName	Set as default
dataFormat	int32
isNullable	true

Traits

List of traits for the IsDefault attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Set as default	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

IsImmutable

First included in: Main/OMHierarchyPurpose (this entity)

Properties

Name	Value
displayName	Immutable
dataFormat	int32
isNullable	true

Traits

List of traits for the IsImmutable attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Immutable	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

Relationship_HierarchyPurpose_FKRelationshipId

First included in: Main/OMHierarchyPurpose (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_HierarchyPurpose_FKRelationshipId attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.dataFormat.guid
means.identity.entityId
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference /core/operationsCommon/Tables/Common/GAB/Main/OMHierarchyType.cdm.json/OMHierarchyType RecId	entity	a reference to the constant entity holding the list of entity references

is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array