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.

Sample shape for DataBoard.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "name": "Example name",
  "description": "Example description.",
  "container": [
    "example"
  ],
  "resource": [
    "example"
  ],
  "budgetHours": 0,
  "budgetChange": [
    "<budget-change-entry>"
  ],
  "locked": false,
  "archived": false,
  "role": [
    "<data-role>"
  ]
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
namestringRequired
descriptionstringOptional
containerarray<string>Optional
resourcearray<string>Optional
budgetHoursintegerOptional
budgetChangearray<BudgetChangeEntry>Optional
lockedbooleanOptional
archivedbooleanOptional
rolearray<DataRole>Optional
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/board
  • PUT /api/board/{id}

​
Response body

  • GET /api/board/{id}
  • GET /api/board

​
CLI

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