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

# DataFieldInteger

> Sample shape for DataFieldInteger.

Sample shape for `DataFieldInteger`.

## 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}
{
  "fieldType": "example",
  "minimum": 0,
  "maximum": 0,
  "defaultValue": "example",
  "name": "Example name",
  "prompt": "example",
  "description": "Example description.",
  "isCore": false,
  "isFeature": false,
  "featureName": "example",
  "placement": [
    "<field-placement>"
  ],
  "usage": [
    "<field-usage>"
  ],
  "listEditable": false
}
```

## Fields

| Field          | Type                                                              | Required   | Notes                                   |
| -------------- | ----------------------------------------------------------------- | ---------- | --------------------------------------- |
| `entity`       | string • nullable                                                 | Server-set | Set by the server. Read-only on writes. |
| `fieldType`    | string • nullable                                                 | Optional   |                                         |
| `minimum`      | integer                                                           | Optional   |                                         |
| `maximum`      | integer                                                           | Optional   |                                         |
| `defaultValue` | string                                                            | Optional   |                                         |
| `name`         | string                                                            | Optional   |                                         |
| `prompt`       | string                                                            | Optional   |                                         |
| `description`  | string                                                            | Optional   |                                         |
| `isCore`       | boolean                                                           | Optional   |                                         |
| `isFeature`    | boolean                                                           | Optional   |                                         |
| `featureName`  | string                                                            | Optional   |                                         |
| `placement`    | array\<[`FieldPlacement`](/data-model/constants#field-placement)> | Optional   |                                         |
| `usage`        | array\<[`FieldUsage`](/data-model/constants#field-usage)>         | Optional   |                                         |
| `listEditable` | boolean                                                           | 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/field/integer`
* `PUT /api/field/integer`