Enumeration functions
- Last UpdatedOct 01, 2026
- 1 minute read
This section provides information relating to enumeration functions.
|
Function / Aliases |
Returns |
Description |
Example |
|---|---|---|---|
|
GETENUMERATION |
String |
Gets an enumeration ID, or null if not found |
'myEnum'.GetEnumeration |
|
GETENUMERATIONANNOTATION / GETENUMERATIONEXTENSION |
String |
Gets an annotation on an enumeration |
'myEnum'.GetEnumerationAnnotation('*:alias') |
|
GETENUMERATIONBYANNOTATION / BYEXTENSION / MATCHINGANNOTATION / MATCHINGEXTENSION |
String |
Finds enumeration by annotation or extension |
'Enumerations.ProcessUnits'.getEnumerationByExtension(':aspect') |
|
GETENUMERATIONBYASPECT / GETENUMBYASPECT / ENUMBYASPECT |
String |
Finds enumeration by aspect (v2.9) |
'Enumerations.EDWContext'.getEnumerationByAspect |
|
GETENUMERATIONDESCRIPTION |
String |
Gets the description of an enumeration |
'myEnum'.GetEnumerationDescription => 'best ever description' |
|
GETENUMERATIONITEM |
String |
Gets the specified enumeration item |
GetEnumerationItem('myEnum', 'item') |
|
GETENUMERATIONITEMANNOTATION / GETENUMERATIONITEMEXTENSION |
String |
Gets an extension on an enumeration item |
'myEnum'.GetEnumerationItemAnnotation('item', '*:yyWhy') |
|
GETENUMERATIONITEMANNOTATIONURIS / GETENUMERATIONITEMEXTENSIONURIS |
String[] |
Gets all extension URIs for an enumeration item |
'myEnum'.GetEnumerationItemAnnotation('item', '*:*') |
|
GETENUMERATIONITEMDESCRIPTION |
String |
Gets the description of an enumeration item |
'myEnum'.GetEnumerationItemDescription |
|
GETENUMERATIONITEMMATCHINGEXTENSION / MATCHINGANNOTATION |
String |
Finds enumeration item by matching extension |
'Enumerations.ProcessUnits'.getEnumerationItemMatchingExtension('item', ':aspect') |
|
GETENUMERATIONITEMBYNOMENCLATURE / LOOKUPENUMITEM |
String |
Looks up enum item by nomenclature |
'Facility'.lookupEnumItem(@[Facility], 'PIDATA_CDS01') |
|
GETENUMERATIONITEMBYASPECT / GETENUMITEMBYASPECT / ENUMITEMBYASPECT |
String |
Returns enumeration item by aspect (v2.8) |
‘Enumerations.CMMSCodes'.getEnumItemByAspect |
|
GETENUMERATIONITEMNAME |
String |
Gets the human readable name of an enumeration item |
'myEnum'.GetEnumerationItemName |
|
GETENUMERATIONITEMS |
String[] |
Gets a list of all items in an enumeration |
'myEnum'.GetEnumerationItems |
|
GETENUMERATIONNAME |
String |
Gets the human readable name of an enumeration |
'myEnum'.GetEnumerationName => 'My Enum' |
|
GETENUMERATIONS |
String[] |
Gets a list of all enumerations |
GetEnumerations |
|
REMOVEENUMERATIONITEMIDSFROMTEXT / REMOVEENUMITEMIDSFROMTEXT |
String |
Removes enumeration item IDs from text (v2.8) |
$[attr.value].removeEnumItemIdsFromText('Enumerations.CMMSCodes'.getEnumByAspect) |
|
REMOVEENUMERATIONITEMNAMESFROMTEXT / REMOVEENUMITEMNAMESFROMTEXT |
String |
Removes enumeration item names from text (v2.8) |
@[Field].removeEnumItemNamesFromText('Enumerations.CMMSCodes'.getEnumByAspect) |