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 ConfigClock.

​
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",
  "container": [
    "example"
  ],
  "timezone": "example",
  "dayStart": "example",
  "dayEnd": "example",
  "weekStart": "example",
  "weekEnd": "example",
  "nonWorkingDay": [
    "example"
  ],
  "tick": "<clock-tick>",
  "greenThreshold": 0,
  "amberThreshold": 0,
  "redThreshold": 0
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
namestringRequired
containerarray<string>Optional
timezonestringRequired
dayStartstringRequired
dayEndstringRequired
weekStartstringRequired
weekEndstringRequired
nonWorkingDayarray<string>Optional
tickClockTickRequired
greenThresholdintegerOptional
amberThresholdintegerOptional
redThresholdintegerOptional
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/clock
  • PUT /api/clock/{id}

​
Response body

  • GET /api/clock/{id}
  • GET /api/clock

​
CLI

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