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

# ConfigProcess

> Sample shape for ConfigProcess.

Sample shape for `ConfigProcess`.

## 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.",
  "image": "example",
  "fields": [
    "<config-process-field>"
  ],
  "features": [
    "example"
  ],
  "workflow": [
    "<config-process-workflow>"
  ]
}
```

## Fields

| Field         | Type                                                                   | Required     | Notes                                   |
| ------------- | ---------------------------------------------------------------------- | ------------ | --------------------------------------- |
| `entity`      | string • nullable                                                      | Server-set   | Set by the server. Read-only on writes. |
| `name`        | string                                                                 | **Required** |                                         |
| `description` | string                                                                 | **Required** |                                         |
| `image`       | string                                                                 | Optional     |                                         |
| `fields`      | array\<[`ConfigProcessField`](/data-model/config-process-field)>       | Optional     |                                         |
| `features`    | array\<string>                                                         | Optional     |                                         |
| `workflow`    | array\<[`ConfigProcessWorkflow`](/data-model/config-process-workflow)> | 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/process`
* `PUT /api/process/{id}`

### Response body

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

### CLI

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