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

# DataFilter

> Sample shape for DataFilter.

Sample shape for `DataFilter`.

## 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}
{
  "containerId": "<container_id>",
  "name": "Example name",
  "active": false,
  "criteria": "<filter-criteria>"
}
```

## Fields

| Field         | Type                                            | Required     | Notes                                   |
| ------------- | ----------------------------------------------- | ------------ | --------------------------------------- |
| `entity`      | string • nullable                               | Server-set   | Set by the server. Read-only on writes. |
| `containerId` | string                                          | **Required** |                                         |
| `name`        | string                                          | **Required** |                                         |
| `active`      | boolean                                         | Optional     |                                         |
| `criteria`    | [`FilterCriteria`](/data-model/filter-criteria) | 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/container/{containerId}/filter`
* `PUT /api/container/{containerId}/filter/{filterId}`

### Response body

* `GET /api/container/{containerId}/filter/{filterId}`
* `GET /api/container/{containerId}/filter`