Documentation Index
Fetch the complete documentation index at: https://ekso.dev/llms.txt
Use this file to discover all available pages before exploring further.
Every enum referenced by an Ekso data model lives here with its variant names and integer values. When the API exposes a numeric enum value (e.g. owner: 30), this is the page that tells you 30 = Item.
API responses surface these as integers; the SDK exposes them as typed enums. CLI commands accept either the integer or the variant name, depending on the surface — consult each command’s --help for specifics.
AnnotatorType
| Name | Value | Description |
|---|
User | 1 | Annotator is a user |
Email | 2 | Annotator is inbound email (ticket) |
System | 3 | Annotator is an API call |
DataAnnotation.
AppRole
Generic roles for access control. Example: can “View” boards, can “Add” data (to some part of the application, outside of container/process).
| Name | Value | Description |
|---|
None | 0 | |
View | 500 | |
Add | 510 | |
Change | 520 | |
ChangeOwn | 521 | |
Delete | 530 | |
DeleteOwn | 531 | |
Filter | 540 | |
Manage | 550 | |
Plan | 560 | |
FieldView | 600 | Process Field level roles |
FieldAdd | 610 | |
FieldUpdate | 620 | |
Worker | 300 | Can be assigned work |
ConfigAccessControl, DataRole.
ClockStatusEnum
| Name | Value | Description |
|---|
Green | 10 | |
Amber | 20 | |
Red | 30 | |
DataItem.
ClockTick
| Name | Value | Description |
|---|
None | 0 | |
WorkingDay | 1 | |
TwentyFourSeven | 247 | |
ConfigClock.
ConstraintTargetType
| Name | Value | Description |
|---|
Include | 1 | Include values that are allowed |
Exclude | 2 | Exclude values that are not allowed |
DataConstraint.
ContentOwner
ContentOwner is the owner of the content (no shit!)
| Name | Value | Description |
|---|
None | 0 | |
System | 99 | |
Board | 10 | |
Container | 20 | |
Item | 30 | |
Annotation | 40 | |
Mailbox | 50 | |
Rule | 80 | |
ConfigContentTemplate, ConfigRule, DataAnnotation, DataArea, DataFile, DataLink, DataWatch.
FieldPlacement
| Name | Value | Description |
|---|
None | 0 | |
Process | 10 | |
Board | 20 | |
DataFieldDate, DataFieldDecimal, DataFieldInteger, DataFieldList, DataFieldPercent, DataFieldPicker, DataFieldText, DataFieldTime, DataFieldToggle.
FieldUsage
| Name | Value | Description |
|---|
System | 0 | |
Input | 10 | Item |
Filter | 20 | Item |
Condition | 30 | Rule |
Action | 40 | Rule |
DataFieldDate, DataFieldDecimal, DataFieldInteger, DataFieldList, DataFieldPercent, DataFieldPicker, DataFieldText, DataFieldTime, DataFieldToggle.
GroupType
| Name | Value | Description |
|---|
Nobody | 0 | |
Everyone | 1 | |
Custom | 2 | |
ConfigUserGroup.
MailboxConnectionType
| Name | Value | Description |
|---|
Imap | 1 | |
Microsoft | 2 | |
ConfigMailbox.
OperatorType
| Name | Value | Description |
|---|
None | 0 | |
Equal | 10 | |
NotEqual | 11 | |
LessThanOrEqual | 20 | |
LessThan | 21 | |
GreaterThanOrEqual | 30 | |
GreaterThan | 31 | |
Contains | 40 | |
StartsWith | 41 | |
EndsWith | 42 | |
ConfigCondition.
ResourceType
Identifies the type of resource — (placeholder) Job Role or (actual) User
| Name | Value | Description |
|---|
Unknown | 0 | |
User | 1 | |
JobRole | 2 | |
DataItem.
RuleAction
| Name | Value | Description |
|---|
None | 0 | |
Value | 10 | |
Endpoint | 20 | |
ConfigRuleActionEndpoint, ConfigRuleActionValue.
RuleTrigger
| Name | Value | Description |
|---|
None | 0 | |
Event | 1 | |
Timer | 2 | |
ConfigRule.
RuleTriggerEvent
| Name | Value | Description |
|---|
None | 0 | |
OnItemAdd | 10 | |
OnItemAdded | 11 | |
OnItemUpdated | 12 | |
OnItemDeleted | 13 | |
ConfigRule.
TicketDomainListType
| Name | Value | Description |
|---|
Allowed | 1 | Values are allowed |
Disallowed | 2 | Values are not allowed |
ConfigTicket.
WatchType
| Name | Value | Description |
|---|
Pin | 1 | |
Follower | 2 | |
DataWatch.
WatcherType
Who is watching? Can be external Email address, UserId, UserGroupId
| Name | Value | Description |
|---|
User | 1 | |
Email | 2 | |
UserGroup | 3 | |
DataWatch.
