Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

Top-level work container — a project, queue, product line, or service queue. Every DataItem belongs to exactly one container. Containers carry an owner and one or more processes (each defining a workflow + field schema).

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "code": "FEN",
  "name": "Next-gen App",
  "description": "Next-gen enterprise automation platform",
  "label": "label_01HLABEL_PRODUCT",
  "owner": "user_01HUSER_OWNER",
  "archived": false,
  "role": [
    {
      "role": "View",
      "userGroup": [
        "group_01HGROUP_EVERYONE",
        "group_01HGROUP_DEV"
      ]
    },
    {
      "role": "Add",
      "userGroup": [
        "group_01HGROUP_EVERYONE",
        "group_01HGROUP_DEV"
      ]
    },
    {
      "role": "Filter",
      "userGroup": [
        "group_01HGROUP_EVERYONE"
      ]
    },
    {
      "role": "Manage",
      "userGroup": [
        "group_01HGROUP_EVERYONE",
        "group_01HGROUP_DEV"
      ]
    },
    {
      "role": "Change",
      "userGroup": [
        "group_01HGROUP_EVERYONE",
        "group_01HGROUP_DEV"
      ]
    },
    {
      "role": "ChangeOwn",
      "userGroup": [
        "group_01HGROUP_EVERYONE",
        "group_01HGROUP_DEV"
      ]
    },
    {
      "role": "Delete",
      "userGroup": [
        "group_01HGROUP_EVERYONE",
        "group_01HGROUP_DEV"
      ]
    },
    {
      "role": "DeleteOwn",
      "userGroup": [
        "group_01HGROUP_EVERYONE",
        "group_01HGROUP_DEV"
      ]
    }
  ]
}

​
What Ekso fills in

These fields are managed by the server. You don’t pass them on writes — they appear on the response.
  • lastSequence — Counter for the next item sequence number. Server increments this every time POST /api/item creates an item against this container.

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
codestringRequiredShort human-readable code. Unique per tenant. Used as a prefix in item identifiers (FEN-123).
namestringRequiredDisplay name shown across the UI and reports.
descriptionstringRequiredLong-form description. Plain text in the database; some surfaces render markdown.
labelstringOptionalId of a ConfigLabel for visual grouping — colour coded across boards and lists.
lastSequenceintegerServer-setServer-managed counter. The next item created against this container will be code-(lastSequence+1).
ownerstringOptionalUser id of the owning user. The owner has implicit ChangeOwn / DeleteOwn rights regardless of explicit role grants.
archivedbooleanOptionalWhen true, the container is hidden from default lists; items remain queryable.
rolearray<DataRole>OptionalPer-role access grants. Each entry pairs an AppRole with the user-group ids that hold that role on this container.
processarray<DataProcess>OptionalArray of DataProcess references attached to this container. The first acts as the default for new items.
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet by the server. Read-only on writes.

​
Used by

​
Request body

  • POST /api/container
  • PUT /api/container

​
Response body

  • GET /api/container/{id}
  • GET /api/container
  • POST /api/container

​
CLI

ekso container — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.