> ## Documentation Index
> Fetch the complete documentation index at: https://ekso.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Constants

> Every enum and constant value referenced by Ekso's data models, in one place.

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.

<h2 id="annotator-type">AnnotatorType</h2>

| Name     | Value | Description                         |
| -------- | ----- | ----------------------------------- |
| `User`   | `1`   | Annotator is a user                 |
| `Email`  | `2`   | Annotator is inbound email (ticket) |
| `System` | `3`   | Annotator is an API call            |

**Used by:** [`DataAnnotation`](/data-model/data-annotation).

<h2 id="app-role">AppRole</h2>

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      |

**Used by:** [`ConfigAccessControl`](/data-model/config-access-control), [`DataRole`](/data-model/data-role).

<h2 id="clock-status-enum">ClockStatusEnum</h2>

| Name    | Value | Description |
| ------- | ----- | ----------- |
| `Green` | `10`  |             |
| `Amber` | `20`  |             |
| `Red`   | `30`  |             |

**Used by:** [`DataItem`](/data-model/data-item).

<h2 id="clock-tick">ClockTick</h2>

| Name              | Value | Description |
| ----------------- | ----- | ----------- |
| `None`            | `0`   |             |
| `WorkingDay`      | `1`   |             |
| `TwentyFourSeven` | `247` |             |

**Used by:** [`ConfigClock`](/data-model/config-clock).

<h2 id="constraint-target-type">ConstraintTargetType</h2>

| Name      | Value | Description                         |
| --------- | ----- | ----------------------------------- |
| `Include` | `1`   | Include values that are allowed     |
| `Exclude` | `2`   | Exclude values that are not allowed |

**Used by:** [`DataConstraint`](/data-model/data-constraint).

<h2 id="content-owner">ContentOwner</h2>

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`  |             |

**Used by:** [`ConfigContentTemplate`](/data-model/config-content-template), [`ConfigRule`](/data-model/config-rule), [`DataAnnotation`](/data-model/data-annotation), [`DataArea`](/data-model/data-area), [`DataFile`](/data-model/data-file), [`DataLink`](/data-model/data-link), [`DataWatch`](/data-model/data-watch).

<h2 id="field-placement">FieldPlacement</h2>

| Name      | Value | Description |
| --------- | ----- | ----------- |
| `None`    | `0`   |             |
| `Process` | `10`  |             |
| `Board`   | `20`  |             |

**Used by:** [`DataFieldDate`](/data-model/data-field-date), [`DataFieldDecimal`](/data-model/data-field-decimal), [`DataFieldInteger`](/data-model/data-field-integer), [`DataFieldList`](/data-model/data-field-list), [`DataFieldPercent`](/data-model/data-field-percent), [`DataFieldPicker`](/data-model/data-field-picker), [`DataFieldText`](/data-model/data-field-text), [`DataFieldTime`](/data-model/data-field-time), [`DataFieldToggle`](/data-model/data-field-toggle).

<h2 id="field-usage">FieldUsage</h2>

| Name        | Value | Description |
| ----------- | ----- | ----------- |
| `System`    | `0`   |             |
| `Input`     | `10`  | Item        |
| `Filter`    | `20`  | Item        |
| `Condition` | `30`  | Rule        |
| `Action`    | `40`  | Rule        |

**Used by:** [`DataFieldDate`](/data-model/data-field-date), [`DataFieldDecimal`](/data-model/data-field-decimal), [`DataFieldInteger`](/data-model/data-field-integer), [`DataFieldList`](/data-model/data-field-list), [`DataFieldPercent`](/data-model/data-field-percent), [`DataFieldPicker`](/data-model/data-field-picker), [`DataFieldText`](/data-model/data-field-text), [`DataFieldTime`](/data-model/data-field-time), [`DataFieldToggle`](/data-model/data-field-toggle).

<h2 id="group-type">GroupType</h2>

| Name       | Value | Description |
| ---------- | ----- | ----------- |
| `Nobody`   | `0`   |             |
| `Everyone` | `1`   |             |
| `Custom`   | `2`   |             |

**Used by:** [`ConfigUserGroup`](/data-model/config-user-group).

<h2 id="mailbox-connection-type">MailboxConnectionType</h2>

| Name        | Value | Description |
| ----------- | ----- | ----------- |
| `Imap`      | `1`   |             |
| `Microsoft` | `2`   |             |

**Used by:** [`ConfigMailbox`](/data-model/config-mailbox).

<h2 id="operator-type">OperatorType</h2>

| Name                 | Value | Description |
| -------------------- | ----- | ----------- |
| `None`               | `0`   |             |
| `Equal`              | `10`  |             |
| `NotEqual`           | `11`  |             |
| `LessThanOrEqual`    | `20`  |             |
| `LessThan`           | `21`  |             |
| `GreaterThanOrEqual` | `30`  |             |
| `GreaterThan`        | `31`  |             |
| `Contains`           | `40`  |             |
| `StartsWith`         | `41`  |             |
| `EndsWith`           | `42`  |             |

**Used by:** [`ConfigCondition`](/data-model/config-condition).

<h2 id="resource-type">ResourceType</h2>

Identifies the type of resource -- (placeholder) Job Role or (actual) User

| Name      | Value | Description |
| --------- | ----- | ----------- |
| `Unknown` | `0`   |             |
| `User`    | `1`   |             |
| `JobRole` | `2`   |             |

**Used by:** [`DataItem`](/data-model/data-item).

<h2 id="rule-action">RuleAction</h2>

| Name       | Value | Description |
| ---------- | ----- | ----------- |
| `None`     | `0`   |             |
| `Value`    | `10`  |             |
| `Endpoint` | `20`  |             |

**Used by:** [`ConfigRuleActionEndpoint`](/data-model/config-rule-action-endpoint), [`ConfigRuleActionValue`](/data-model/config-rule-action-value).

<h2 id="rule-trigger">RuleTrigger</h2>

| Name    | Value | Description |
| ------- | ----- | ----------- |
| `None`  | `0`   |             |
| `Event` | `1`   |             |
| `Timer` | `2`   |             |

**Used by:** [`ConfigRule`](/data-model/config-rule).

<h2 id="rule-trigger-event">RuleTriggerEvent</h2>

| Name            | Value | Description |
| --------------- | ----- | ----------- |
| `None`          | `0`   |             |
| `OnItemAdd`     | `10`  |             |
| `OnItemAdded`   | `11`  |             |
| `OnItemUpdated` | `12`  |             |
| `OnItemDeleted` | `13`  |             |

**Used by:** [`ConfigRule`](/data-model/config-rule).

<h2 id="ticket-domain-list-type">TicketDomainListType</h2>

| Name         | Value | Description            |
| ------------ | ----- | ---------------------- |
| `Allowed`    | `1`   | Values are allowed     |
| `Disallowed` | `2`   | Values are not allowed |

**Used by:** [`ConfigTicket`](/data-model/config-ticket).

<h2 id="watch-type">WatchType</h2>

| Name       | Value | Description |
| ---------- | ----- | ----------- |
| `Pin`      | `1`   |             |
| `Follower` | `2`   |             |

**Used by:** [`DataWatch`](/data-model/data-watch).

<h2 id="watcher-type">WatcherType</h2>

Who is watching? Can be external Email address, UserId, UserGroupId

| Name        | Value | Description |
| ----------- | ----- | ----------- |
| `User`      | `1`   |             |
| `Email`     | `2`   |             |
| `UserGroup` | `3`   |             |

**Used by:** [`DataWatch`](/data-model/data-watch).