API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · ticket_boards

Ticket Board Schema

Schema-ID
ticket_board
Collection
ticket_boards
Permissions
  • Lesenticket_board_view
  • Anlegenticket_board_create
  • Ändernticket_board_edit
  • Löschenticket_board_delete

Felder

Ticket Board Schema

ticket_boards4 Permissions

Schema for validating ticket board (Kanban) entities

namestringerforderlich

Board name

1–200 Zeichen
descriptionstringoptional

Optional board description

max 1000 Zeichennullable
iconstringoptional

Optional icon identifier

max 50 Zeichennullable
colorstringoptional

Accent color hex code

Patternnullable
groupByFieldstringerforderlich

Ticket field used to group tickets into columns

Werte
statuspriorityassignedToIdorgUnitIdticketTypepartyIdtagscontactChannel
columnsobject[]erforderlich
min 1 Items
idstringerforderlich

Column identifier

titlestringerforderlich
1–200 Zeichen
valueoneOferforderlich

Field value(s) that map to this column. Empty when `valueSource` is set — those values are resolved server-side on every read.

valueSourceobjectoptional

Dynamic column source (ADR 0467) — resolved on every read so membership changes reach the board without editing it

nullable
typestringerforderlich
Werte
org_unit_members
orgUnitIduuiderforderlich

Org unit (team) whose membership drives this column

includeSubUnitsbooleanoptional

Include members of descendant org units (ADR 0107 subtree)

Default: falsenullable
expandstringerforderlich

group = one column for the whole team; perMember = expanded into one column per member on read

Werte
groupperMember
colorstringoptional
Patternnullable
wipLimitintegeroptional

Work-in-progress limit

≥ 1nullable
collapsedbooleanoptional
nullable
sortFieldstringoptional

Per-column sort override (falls back to board cardSortField when unset)

nullable
sortOrderstringoptional
Werte
ascdesc
nullable
uncategorizedColumnobjectoptional
nullable
titlestringoptional
1–200 Zeichen
collapsedbooleanoptional
nullable
hiddenbooleanoptional
nullable
filtersobjectoptional

Persisted board filters in CRUD query format

Default: {}nullable
savedFiltersobject[]optional

Board-level saved filter presets

Default: []nullable
idstringerforderlich
namestringerforderlich
1–100 Zeichen
filtersobjecterforderlich
cardFieldsstring[]optional

Fields displayed on ticket cards

Default: []nullable
cardSortFieldstringoptional

Sort field within columns

Default: "createdAt"nullable
cardSortOrderstringoptional
Werte
ascdesc
Default: "desc"nullable
swimlanesobjectoptional

Optional horizontal swimlane grouping

nullable
enabledbooleanoptional
Default: false
fieldstringoptional
Werte
statuspriorityassignedToIdorgUnitIdticketTypepartyIdtagscontactChannel
collapsedstring[]optional

List of collapsed swimlane values

nullable
visibilitystringerforderlich

Board visibility level

Werte
privatesharedtenant
ownerIduuidoptional

Board owner (creator) user ID

read-only
sharedWithobject[]optional
Default: []nullable
typestringerforderlich
Werte
userorg_unitrole
iduuiderforderlich
accessstringoptional

Access granted to this recipient. Absent = view-only (backward-compatible default).

Werte
viewedit
Default: "view"nullable
columnWidthintegeroptional
200 – 800Default: 320nullable
showTicketCountbooleanoptional
Default: truenullable
showWipWarningbooleanoptional
Default: truenullable
cardPreviewModebooleanoptional

When true, clicking a card opens a side preview slideout instead of navigating to the ticket detail page

Default: falsenullable
showAgeIndicatorbooleanoptional

When true, cards display a small clock with ticket age and per-status tooltip

Default: truenullable
templateIdstringoptional

Template this board was created from

Werte
kanban_statuskanban_prioritysupport_queuedev_boardcustom
nullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/ticket_boards — Liste, paginiert + filterbar
  • GET /api/v1/ticket_boards/<id> — Einzelne Entity
  • POST /api/v1/ticket_boards — Anlegen
  • PATCH /api/v1/ticket_boards/<id> — Teil-Update
  • DELETE /api/v1/ticket_boards/<id> — Soft-Delete
  • GET /api/v1/ticket_boards/<id>/timeline — Audit + Aktivitäten

Suche