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

Contract Type Schema

Schema-ID
contract_type
Collection
contract_types
Permissions
  • Lesencontract_type_view
  • Anlegencontract_type_create
  • Änderncontract_type_edit
  • Löschencontract_type_delete

Felder

Contract Type Schema

contract_types4 Permissions

Schema for validating contract type entities

namestringerforderlich

Contract type name

1–100 Zeichen
codestringerforderlich

Unique code identifier

1–20 ZeichenPattern
descriptionstringoptional

Contract type description

nullable
categorystringerforderlich

Contract category — MAINTENANCE or LICENSE (see contract schema for semantics).

Werte
MAINTENANCELICENSE
colorstringoptional

Display color (hex)

Patternnullable
iconstringoptional

Display icon identifier

nullable
defaultsobjectoptional

Default values applied when creating contracts of this type

nullable
billingCyclestringoptional
Werte
MONTHLYQUARTERLYSEMI_ANNUALYEARLYONE_TIMENONE
nullable
cancellationobjectoptional
nullable
noticePeriodDaysnumberoptional
≥ 0
extensionMonthsnumberoptional
≥ 0
autoRenewbooleanoptional
scopeobjectoptional
nullable
coverageTypestringoptional
Werte
ALL_ASSETSASSIGNED_ONLYCUSTOM
excludeAfterHoursbooleanoptional
excludeTravelbooleanoptional
serviceTargetProfileIduuidoptional

Default service target profile (ADR 0117a)

nullable
requiredFieldsstring[]optional

Fields required for contracts of this type

nullable
isActivebooleanerforderlich

Whether this contract type is active

sortOrdernumbererforderlich

Display sort order

≥ 0

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

Suche