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

# DataBoard

> Sample shape for DataBoard.

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.

```json theme={null}
{
  "name": "Example name",
  "description": "Example description.",
  "container": [
    "example"
  ],
  "resource": [
    "example"
  ],
  "budgetHours": 0,
  "budgetChange": [
    "<budget-change-entry>"
  ],
  "locked": false,
  "archived": false,
  "role": [
    "<data-role>"
  ]
}
```

## Fields

| Field          | Type                                                           | Required     | Notes                                   |
| -------------- | -------------------------------------------------------------- | ------------ | --------------------------------------- |
| `entity`       | string • nullable                                              | Server-set   | Set by the server. Read-only on writes. |
| `name`         | string                                                         | **Required** |                                         |
| `description`  | string                                                         | Optional     |                                         |
| `container`    | array\<string>                                                 | Optional     |                                         |
| `resource`     | array\<string>                                                 | Optional     |                                         |
| `budgetHours`  | integer                                                        | Optional     |                                         |
| `budgetChange` | array\<[`BudgetChangeEntry`](/data-model/budget-change-entry)> | Optional     |                                         |
| `locked`       | boolean                                                        | Optional     |                                         |
| `archived`     | boolean                                                        | Optional     |                                         |
| `role`         | array\<[`DataRole`](/data-model/data-role)>                    | 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/board`
* `PUT /api/board/{id}`

### Response body

* `GET /api/board/{id}`
* `GET /api/board`

### CLI

`ekso board` — 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.