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

KB Execution Schema

Schema-ID
kb_execution
Collection
kb_executions
Permissions
  • Lesenkb_execution_view
  • Anlegenkb_execution_create
  • Ändernkb_execution_edit
  • Löschenkb_execution_delete

Felder

KB Execution Schema

kb_executions4 Permissions

Execution record for a knowledge base runbook/SOP article

articleIduuiderforderlich

Reference to the source kb_article (runbook/SOP)

ticketIdstringoptional

Optional reference to the ticket this execution is for

PatternDefault: nullnullable
statusstringerforderlich

Execution status

Werte
IN_PROGRESSCOMPLETEDABANDONED
Default: "IN_PROGRESS"
stepsobject[]erforderlich

Ordered list of checklist steps extracted from the article

stepIndexintegererforderlich
≥ 0
labelstringerforderlich
max 500 Zeichen
isCompletebooleanerforderlich
Default: false
completedAtdatetimeoptional
Default: nullnullable
completedBystringoptional
PatternDefault: nullnullable
startedAtdatetimeoptional

When execution was started

completedAtdatetimeoptional

When execution was completed or abandoned

Default: nullnullable
startedByuuidoptional

User who started the execution

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

Suche