Add a new AdditionalUiField

POST /api/settings/ui_field

Session token Jwt token internal Login config

Query parameters

iw-build-id string

build id of the client
iw-package-id string

package id of the client

application/json

Body Required

data object
Hide data attributes Show data attributes object
- id integer
- entity_type string
- field_type string
- field_group string
- field_required boolean
- field_order integer
- field_scope string
- field_access_type integer
- field_is_internal boolean
- field_name string
- info_mode string
- created string(date-time)
- updated string(date-time)
- name string
- deleted boolean

Responses

200 application/json

Add a new AdditionalUiField
Hide response attributes Show response attributes object
- id integer
- entity_type string
- field_type string
- field_group string
- field_required boolean
- field_order integer
- field_scope string
- field_access_type integer
- field_is_internal boolean
- field_name string
- info_mode string
- created string(date-time)
- updated string(date-time)
- name string
- deleted boolean

POST /api/settings/ui_field

curl \
 --request POST 'https://replace-with-own-host.iw-erp.de/api/settings/ui_field' \
 --header "x-session-token: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"data":{"id":42,"entity_type":"string","field_type":"string","field_group":"string","field_required":true,"field_order":42,"field_scope":"string","field_access_type":42,"field_is_internal":true,"field_name":"string","info_mode":"string","created":"2025-05-04T09:42:00Z","updated":"2025-05-04T09:42:00Z","name":"string","deleted":true}}'

Request examples

{
  "data": {
    "id": 42,
    "entity_type": "string",
    "field_type": "string",
    "field_group": "string",
    "field_required": true,
    "field_order": 42,
    "field_scope": "string",
    "field_access_type": 42,
    "field_is_internal": true,
    "field_name": "string",
    "info_mode": "string",
    "created": "2025-05-04T09:42:00Z",
    "updated": "2025-05-04T09:42:00Z",
    "name": "string",
    "deleted": true
  }
}

Response examples (200)

{
  "id": 42,
  "entity_type": "string",
  "field_type": "string",
  "field_group": "string",
  "field_required": true,
  "field_order": 42,
  "field_scope": "string",
  "field_access_type": 42,
  "field_is_internal": true,
  "field_name": "string",
  "info_mode": "string",
  "created": "2025-05-04T09:42:00Z",
  "updated": "2025-05-04T09:42:00Z",
  "name": "string",
  "deleted": true
}