Field Groups

21 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

List field groups for the current organization#

GET/field-groupsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`	Query	`string`	–
`search`	Query	`string`	–
`is_deleted`	Query	`string`	–

Antworten

200Field groups returned

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/field-groups" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a field group#

POST/field-groupsToken

Request-Body`application/jsonCreateFieldGroupDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Ignored — org comes from auth token
`name`Pflicht	`string`	Beispiel: `General Information`
`description`	`object`	–
`name_i18n`	`object`	–
`description_i18n`	`object`	–
`sort_order`	`number`	–
`is_collapsed_default`	`boolean`	–
`color`	`object`	Beispiel: `#3b82f6`
`icon`	`object`	–
`space_id`	`object`	Optional space id; when omitted, the group is org-level.

Antworten

201Field group created

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/field-groups" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"General Information"}'

Get a field group by id (with fields embedded)#

GET/field-groups/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`includeFields`Pflicht	Query	`string`	–
`spaceId`Pflicht	Query	`string`	–

Antworten

200Field group returned

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/field-groups/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a field group#

PUT/field-groups/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateFieldGroupDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Ignored — org comes from auth token
`name`	`string`	–
`description`	`object`	–
`name_i18n`	`object`	–
`description_i18n`	`object`	–
`sort_order`	`number`	–
`is_collapsed_default`	`boolean`	–
`color`	`object`	–
`icon`	`object`	–

Antworten

200Field group updated

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/field-groups/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"…","name":"…","description":{}}'

Action dispatcher: restore | permanent_delete | duplicate#

PATCH/field-groups/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonPatchFieldGroupDto`

Name	Typ	Beschreibung
`action`Pflicht	`string`	Werte: `restorepermanent_deleteduplicate`
`newName`	`string`	New group name for duplicate.
`organizationId`	`string`	–
`copyFields`	`boolean`	When action=duplicate, copy field memberships.

Antworten

200Action applied

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/field-groups/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action":"restore"}'

Soft delete a field group (cascades assignments)#

DELETE/field-groups/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200Field group soft-deleted

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/field-groups/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List fields belonging to a field group#

GET/field-groups/{id}/fieldsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200Fields returned

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/field-groups/{id}/fields" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Add field(s) to a group — accepts a single entry or a batch#

POST/field-groups/{id}/fieldsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/json`

Keine Felder dokumentiert.

Antworten

201Field(s) added

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/field-groups/{id}/fields" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Update per-field settings OR reorder fields (when body has `reorder: true`)#

PUT/field-groups/{id}/fieldsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200Update applied

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/field-groups/{id}/fields" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Remove a field from a group#

DELETE/field-groups/{id}/fieldsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–
`custom_field_id`Pflicht	Query	`any`	–

Antworten

200Field removed from group

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/field-groups/{id}/fields" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get permissions for a level-field-group assignment. NOTE: `:id` is the ASSIGNMENT id, not the group id.#

GET/field-groups/{id}/permissionsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Assignment id

Antworten

200Permissions returned

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/field-groups/{id}/permissions" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Replace permissions for a level-field-group assignment. NOTE: `:id` is the ASSIGNMENT id.#

PUT/field-groups/{id}/permissionsToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Assignment id

Request-Body`application/jsonSetAssignmentPermissionsDto`

Name	Typ	Beschreibung
`permissions`Pflicht	`AssignmentPermissionDto[]`	–
`permissions[].target_type`Pflicht	`string`	Werte: `userrolegroupbase_role`
`permissions[].user_id`	`object`	–
`permissions[].role_id`	`object`	–
`permissions[].group_id`	`object`	–
`permissions[].base_role`	`string`	Werte: `owneradminmemberviewer`
`permissions[].can_view`Pflicht	`boolean`	–
`permissions[].can_edit`Pflicht	`boolean`	–

Antworten

200Permissions replaced

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/field-groups/{id}/permissions" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"permissions":[]}'

Get the full field configuration for a hierarchy level#

GET/field-groups/for-levelToken

Returns groups + standalone fields assigned to a level, optionally grouped by UI section.

Parameter

Name	Ort	Typ	Beschreibung
`hierarchyLevelId`Pflicht	Query	`string`	–
`entityType`Pflicht	Query	`string`	–
`bySection`	Query	`string`	–
`spaceId`	Query	`string`	UUID of space — returns org-level + space-specific groups/fields
`organizationId`	Query	`any`	Accepted for compatibility; org comes from auth token

Antworten

200Level fields configuration

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/field-groups/for-level" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List level assignments (groups and/or fields)#

GET/field-groups/level-assignmentsToken

Parameter

Name	Ort	Typ	Beschreibung
`hierarchyLevelId`Pflicht	Query	`string`	–
`entityType`Pflicht	Query	`string`	–
`type`	Query	`string`	Werte: `groupsfields`
`spaceId`Pflicht	Query	`string`	–

Antworten

200Assignments returned

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/field-groups/level-assignments" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Assign a field group or standalone field to a hierarchy level#

POST/field-groups/level-assignmentsToken

Request-Body`application/json`

Keine Felder dokumentiert.

Antworten

201Assignment created

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/field-groups/level-assignments" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Remove a group or field assignment from a level#

DELETE/field-groups/level-assignmentsToken

Request-Body`application/jsonUnassignLevelDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Ignored — org comes from auth token
`type`Pflicht	`string`	Werte: `groupfield`
`hierarchy_level_id`Pflicht	`string`	–
`entity_type`Pflicht	`string`	Werte: `processtasklist_item`
`field_group_id`	`string`	Required when type=group.
`custom_field_id`	`string`	Required when type=field.

Antworten

200Assignment removed

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/field-groups/level-assignments" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"type":"group","hierarchy_level_id":"…","entity_type":"process"}'

Bulk reorder field groups#

PATCH/field-groups/reorderToken

Request-Body`application/jsonReorderFieldGroupsDto`

Name	Typ	Beschreibung
`items`Pflicht	`ReorderItemDto[]`	–

Antworten

200Field groups reordered

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/field-groups/reorder" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"items":[]}'

List wiki field assignments for a space#

GET/field-groups/wiki-assignmentsToken

Returns group and standalone-field assignments for the wiki of the given space, each embedding its field group (with member fields) or custom-field definition.

Parameter

Name	Ort	Typ	Beschreibung
`space_id`Pflicht	Query	`string`	Space UUID

Antworten

200Assignments returned

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/field-groups/wiki-assignments" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Assign a field group or standalone field to a space's wiki#

POST/field-groups/wiki-assignmentsToken

Request-Body`application/jsonCreateWikiAssignmentDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Ignored — org comes from auth token
`space_id`Pflicht	`string`	Space the wiki assignment belongs to
`assignment_type`Pflicht	`string`	Werte: `groupfield`
`field_group_id`	`string`	Required when assignment_type=group
`custom_field_id`	`string`	Required when assignment_type=field
`section`	`string`	Werte: `headermainfootersidebar`
`sort_order`	`number`	–
`is_required`	`boolean`	–
`is_hidden`	`boolean`	–
`column_span`	`number`	–
`is_collapsed_default`	`boolean`	–
`show_in_header`	`boolean`	–

Antworten

201Assignment created
409Assignment already exists

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/field-groups/wiki-assignments" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"space_id":"…","assignment_type":"group"}'

Update layout/behaviour flags of a wiki field assignment#

PATCH/field-groups/wiki-assignments/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Assignment id

Request-Body`application/jsonUpdateWikiAssignmentDto`

Name	Typ	Beschreibung
`organizationId`	`string`	Ignored — org comes from auth token
`section`	`string`	Werte: `headermainfootersidebar`
`sort_order`	`number`	–
`is_required`	`boolean`	–
`is_hidden`	`boolean`	–
`column_span`	`number`	–
`is_collapsed_default`	`boolean`	–
`show_in_header`	`boolean`	–

Antworten

200Assignment updated

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/field-groups/wiki-assignments/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"organizationId":"…","section":"header","sort_order":0}'

Remove a wiki field assignment#

DELETE/field-groups/wiki-assignments/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	Assignment id

Antworten

200Assignment removed

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/field-groups/wiki-assignments/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Field Groups

List field groups for the current organization#

Parameter

Antworten

Create a field group#

Request-Bodyapplication/jsonCreateFieldGroupDto

Antworten

Get a field group by id (with fields embedded)#

Parameter

Antworten

Update a field group#

Parameter

Request-Bodyapplication/jsonUpdateFieldGroupDto

Antworten

Action dispatcher: restore | permanent_delete | duplicate#

Parameter

Request-Bodyapplication/jsonPatchFieldGroupDto

Antworten

Soft delete a field group (cascades assignments)#

Parameter

Antworten

List fields belonging to a field group#

Parameter

Antworten

Add field(s) to a group — accepts a single entry or a batch#

Parameter

Request-Bodyapplication/json

Antworten

Update per-field settings OR reorder fields (when body has `reorder: true`)#

Parameter

Antworten

Remove a field from a group#

Parameter

Antworten

Get permissions for a level-field-group assignment. NOTE: `:id` is the ASSIGNMENT id, not the group id.#

Parameter

Antworten

Replace permissions for a level-field-group assignment. NOTE: `:id` is the ASSIGNMENT id.#

Parameter

Request-Bodyapplication/jsonSetAssignmentPermissionsDto

Antworten

Get the full field configuration for a hierarchy level#

Parameter

Antworten

List level assignments (groups and/or fields)#

Parameter

Antworten

Assign a field group or standalone field to a hierarchy level#

Request-Bodyapplication/json

Antworten

Remove a group or field assignment from a level#

Request-Bodyapplication/jsonUnassignLevelDto

Antworten

Bulk reorder field groups#

Request-Bodyapplication/jsonReorderFieldGroupsDto

Antworten

List wiki field assignments for a space#

Parameter

Antworten

Assign a field group or standalone field to a space's wiki#

Request-Bodyapplication/jsonCreateWikiAssignmentDto

Antworten

Update layout/behaviour flags of a wiki field assignment#

Parameter

Request-Bodyapplication/jsonUpdateWikiAssignmentDto

Antworten

Remove a wiki field assignment#

Parameter

Antworten

Request-Body`application/jsonCreateFieldGroupDto`

Request-Body`application/jsonUpdateFieldGroupDto`

Request-Body`application/jsonPatchFieldGroupDto`

Request-Body`application/json`

Request-Body`application/jsonSetAssignmentPermissionsDto`

Request-Body`application/json`

Request-Body`application/jsonUnassignLevelDto`

Request-Body`application/jsonReorderFieldGroupsDto`

Request-Body`application/jsonCreateWikiAssignmentDto`

Request-Body`application/jsonUpdateWikiAssignmentDto`