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

Contract Ticket Rule Schema

Schema-ID
contract_ticket_rule
Collection
contract_ticket_rules
Permissions
  • Lesencontract_ticket_rule_view
  • Anlegencontract_ticket_rule_create
  • Änderncontract_ticket_rule_edit
  • Löschencontract_ticket_rule_delete

Felder

Contract Ticket Rule Schema

contract_ticket_rules4 Permissions

ADR 0439 — tenant-wide rule that turns activated contract positions into recurring tickets (interval + lead time + ticket template + checklist/task templates).

namestringerforderlich

Rule name (shown in settings and on the contract Tickets tab).

1–200 Zeichen
descriptionstringoptional

Optional internal note on what this rule covers.

max 2000 ZeichenDefault: nullnullable
isActivebooleanoptional

Inactive rules are neither suggested nor executed; existing activations on contracts stay dormant until the rule is reactivated.

Default: true
matchArticleIdsuuid[]optional

Catalog articles that suggest this rule for a contract position (matched against position.articleId on both items[] and licensePositions[]). Positions without an articleId can only be activated manually.

Default: []
intervalstringerforderlich

Recurring cadence between due dates. Recurring subset of the contract-item interval enum (no ONE_TIME/NONE/DAILY — a rule always recurs).

Werte
WEEKLYMONTHLYQUARTERLYSEMI_ANNUALYEARLYTWO_YEARLYTHREE_YEARLY
leadDaysintegeroptional

Days before the due date the ticket is created (ticket.dueAt stays the due date). 0 = create on the due date.

0 – 365Default: 0
ticketTemplateobjecterforderlich

Template for the generated ticket. `title` and `descriptionHtml` support the placeholders {contract.name}, {contract.contractNumber}, {position.name}, {party.name} and {dueDate}.

titlestringerforderlich

Ticket title template (placeholders allowed).

1–500 Zeichen
descriptionHtmlstringoptional

Ticket description template, HTML (placeholders allowed).

max 50000 ZeichenDefault: nullnullable
prioritystringoptional

Priority of the generated ticket.

Werte
LOWNORMALHIGHCRITICAL
Default: "NORMAL"
ticketTypestringoptional

Ticket type key (references a ticket_type entity, tenant-configurable). null = tenant default.

max 40 ZeichenDefault: nullnullable
orgUnitIdstringoptional

Team (org unit) the generated ticket is routed to. Assignment comes from the rule, not the contract (ADR 0439, decision 5).

PatternDefault: nullnullable
assignedToIdstringoptional

Optional fixed assignee for the generated ticket.

PatternDefault: nullnullable
checklistTemplateIdsuuid[]optional

checklist_template ids instantiated onto the generated ticket (spawnChecklistFromTemplate, best-effort).

Default: []
taskTemplateIdsuuid[]optional

task_template ids instantiated onto the generated ticket (internal API bridge, flat-task fallback, best-effort).

Default: []

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

Suche