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

# DataArea

> Sample shape for DataArea.

Sample shape for `DataArea`.

## 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.",
  "owner": "<content-owner>",
  "ownerId": "<owner_id>",
  "archived": false,
  "parentId": "<parent_id>",
  "sequence": 0
}
```

## Fields

| Field         | Type                                                  | Required     | Notes                                   |
| ------------- | ----------------------------------------------------- | ------------ | --------------------------------------- |
| `entity`      | string • nullable                                     | Server-set   | Set by the server. Read-only on writes. |
| `name`        | string                                                | **Required** |                                         |
| `description` | string                                                | **Required** |                                         |
| `owner`       | [`ContentOwner`](/data-model/constants#content-owner) | Optional     |                                         |
| `ownerId`     | string                                                | **Required** |                                         |
| `archived`    | boolean                                               | Optional     |                                         |
| `parentId`    | string                                                | Optional     |                                         |
| `sequence`    | 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/area`
* `PUT /api/area`

### Response body

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

### CLI

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