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

# ConfigClock

> Sample shape for ConfigClock.

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.

```json theme={null}
{
  "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

| Field            | Type                                            | Required     | Notes                                   |
| ---------------- | ----------------------------------------------- | ------------ | --------------------------------------- |
| `entity`         | string • nullable                               | Server-set   | Set by the server. Read-only on writes. |
| `name`           | string                                          | **Required** |                                         |
| `container`      | array\<string>                                  | Optional     |                                         |
| `timezone`       | string                                          | **Required** |                                         |
| `dayStart`       | string                                          | **Required** |                                         |
| `dayEnd`         | string                                          | **Required** |                                         |
| `weekStart`      | string                                          | **Required** |                                         |
| `weekEnd`        | string                                          | **Required** |                                         |
| `nonWorkingDay`  | array\<string>                                  | Optional     |                                         |
| `tick`           | [`ClockTick`](/data-model/constants#clock-tick) | **Required** |                                         |
| `greenThreshold` | integer                                         | Optional     |                                         |
| `amberThreshold` | integer                                         | Optional     |                                         |
| `redThreshold`   | integer                                         | Optional     |                                         |
| `tenantId`       | string                                          | Server-set   | Set by the server. Read-only on writes. |
| `id`             | string                                          | Server-set   | Set by the server. Read-only on writes. |
| `created`        | string (date-time)                              | Server-set   | Set by the server. Read-only on writes. |
| `createdBy`      | string                                          | Server-set   | Set by the server. Read-only on writes. |
| `updated`        | string (date-time)                              | Server-set   | Set by the server. Read-only on writes. |
| `updatedBy`      | string                                          | Server-set   | Set by the server. Read-only on writes. |
| `deleted`        | boolean                                         | Server-set   | Set 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](/cli/branches) page for available verbs. Body for create / update verbs typically passed via `--data @file.json` matching the [sample JSON](#sample-json) above.