Use the kanban (ticket management) API
A lightweight kanban board for the admin area. It lets a Betrieb organize internal tasks as
tickets that move through states on one or more boards. All endpoints live under
/api/admin/kanban/ and require a session authenticated as an admin.
Entity model
- A Board is a separate kanban view, addressed by its numeric
id(theboard_idparameter everywhere). A board owns a set of states. - A State is a column on a board (e.g. Inbox, In Progress,
Done). It is identified by
namewithin aboard_id, so the same state name may exist on different boards. States carry a color and a sort order. - A Ticket is one card. It belongs to exactly one board (
board_id) and sits in onestate(referencing a state'sname); ordering within a state is controlled bysorting. Tickets have a title, markdown description, optional start/end dates, anarchivedflag and an optional cardbackground_color. - A ticket may have several Detail notes (a comment thread,
markdown) and file Attachments (stored in the filestore
with tag
ticket/<id>, uploaded/fetched via the generic file endpoints).
On first access an empty installation is auto-seeded with a Default board and the four states
Inbox / Scheduled / In Progress / Done.
Every mutation returns a TicketResult (action, result, op,
plus whichever of id / detail_id / board_id / name applies). On invalid input a mutation
answers HTTP 400 with the exit code in the X-oekobox-error header.
Boards
- /api/admin/kanban/list — all boards, each with its state count.
- /api/admin/kanban/add — create a board; the result carries the
new
board_id. - /api/admin/kanban/update — rename / recolor / reorder a board
(identified by
board_id, so renaming is safe). - /api/admin/kanban/delete — delete a board and all its states, tickets and details.
States
- /api/admin/kanban/state/list — states of a board
(
?board_id=N), each with its active-ticket count. - /api/admin/kanban/state/add — add a state to a board.
- /api/admin/kanban/state/update — change a state's color
or sorting (identified by
name+board_id). - /api/admin/kanban/state/delete — remove a state; all tickets using it on that board (including archived) are deleted too.
Tickets
- /api/admin/kanban/ticketlist — the board's tickets plus
its states with counts (
?board_id=N). Optionalstate,searchandarchivedfilters. - /api/admin/kanban/ticket — a single ticket with its details
and attachments (
?id=N). - /api/admin/kanban/ticket/new — create a ticket on a board; the response also echoes back the created Ticket.
- /api/admin/kanban/ticket/update — partial update; only
idis required, omitted fields keep their value. Pass a newstateto move a card between columns, a newboard_idto move it to another board, orarchived=1to archive it. - /api/admin/kanban/ticket/delete — delete a ticket and its details.
Ticket notes
- /api/admin/kanban/detail/add — append a markdown note to a ticket.
- /api/admin/kanban/detail/delete — remove a note by
detail_id.
A typical flow
listthe boards, pick aboard_id(oraddone).ticketlist?board_id=Nto render the columns (fromstate/listdata embedded in the response) and the cards.- Drag a card →
ticket/updatewith the newstate(andsorting). - Open a card →
ticket?id=Nfor its details and attachments; add progress viadetail/add.
All endpoints support the usual response formats via oo-rf (json, md, html, openapi, …),
so any endpoint documents itself live — e.g. append ?oo-rf=html to try it in the browser.