Hierarchy relationship in Main(OMHierarchyRelationship)

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	OMHierarchyRelationship/(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 Hierarchy relationship	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Main/OMHierarchyRelationship
ChildOrganization		Main/OMHierarchyRelationship
HierarchyType		Main/OMHierarchyRelationship
ParentOrganization		Main/OMHierarchyRelationship
ValidFrom		Main/OMHierarchyRelationship
ValidTo		Main/OMHierarchyRelationship
Relationship_OMHierarchyType_FKRelationshipId		Main/OMHierarchyRelationship
Relationship_OMInternalOrganizationChild_FKRelationshipId		Main/OMHierarchyRelationship
Relationship_OMInternalOrganizationParent_FKRelationshipId		Main/OMHierarchyRelationship
Relationship_OMHierarchyChangeLogRelationshipId		Main/OMHierarchyRelationship

RecId

First included in: Main/OMHierarchyRelationship (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	OMHierarchyRelationship/(resolvedAttributes)/RecId	attribute

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

ChildOrganization

First included in: Main/OMHierarchyRelationship (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the ChildOrganization 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

HierarchyType

First included in: Main/OMHierarchyRelationship (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

ParentOrganization

First included in: Main/OMHierarchyRelationship (this entity)

Properties

Name	Value
dataFormat	int64
isNullable	true

Traits

List of traits for the ParentOrganization 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

ValidFrom

First included in: Main/OMHierarchyRelationship (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the ValidFrom attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

ValidTo

First included in: Main/OMHierarchyRelationship (this entity)

Properties

Name	Value
dataFormat	date
isNullable	true

Traits

List of traits for the ValidTo attribute are listed below.

is.dataFormat.date
means.measurement.date
is.nullable
The attribute value may be set to NULL.

is.dataFormat.date

Relationship_OMHierarchyType_FKRelationshipId

First included in: Main/OMHierarchyRelationship (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_OMHierarchyType_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

Relationship_OMInternalOrganizationChild_FKRelationshipId

First included in: Main/OMHierarchyRelationship (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_OMInternalOrganizationChild_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/OMInternalOrganization.cdm.json/OMInternalOrganization RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_OMInternalOrganizationParent_FKRelationshipId

First included in: Main/OMHierarchyRelationship (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_OMInternalOrganizationParent_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/OMInternalOrganization.cdm.json/OMInternalOrganization RecId	entity	a reference to the constant entity holding the list of entity references

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

Relationship_OMHierarchyChangeLogRelationshipId

First included in: Main/OMHierarchyRelationship (this entity)

Properties

Name	Value
dataFormat	guid

Traits

List of traits for the Relationship_OMHierarchyChangeLogRelationshipId 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/OMHierarchyChangeLog.cdm.json/OMHierarchyChangeLog RecId	entity	a reference to the constant entity holding the list of entity references

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