ftos.metadata.getOptionSet
IMPORTANT!
Starting with v24.3, this is renamed from getOptionSet to ftos.metadata.getOptionSet .
Starting with v24.3, this is renamed from getOptionSet to ftos.metadata.getOptionSet .
Returns the attributes and items of an optionset.
This is suitable for all modules of business service components.
Syntax
function ftos.metadata.getOptionSet(optionSetName: string): any
| Parameter | Description |
|---|---|
optionSetName
|
Name of the optionset. |
Return Value
Returns a object that contains the optionset's attributes and items:
- optionsetid - Unique identifier of the optionset.
- name - Name of the optionset.
- displayName - Name of the optionset as displayed on screen.
- isSystemOptionSet - Boolean indicating if this is a system optionset.
- items - array containing the attributes of each optionset item: value, optionsetitemid, orderIdx, statusID, id, optionSetId, name, displayName.
Examples
Check if an optionset is a system optionset
In this example, we check the isSystemOptionSet attribute of the ActionStages optionset and save its value in the sysOS variable:
var sysOS = ftos.metadata.getOptionSet('ActionStages').isSystemOptionSet;