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

Customer Collaboration Profile Schema

Schema-ID
customer_collaboration_profile
Collection
customer_collaboration_profiles
Permissions
  • Lesencollaboration_profile_view
  • Anlegencollaboration_profile_manage
  • Änderncollaboration_profile_manage
  • Löschencollaboration_profile_manage

Felder

Customer Collaboration Profile Schema

customer_collaboration_profiles4 Permissions

Per-party configuration of the ticket collaboration / handover mode (ADR 0299)

partyIduuiderforderlich

The customer party this profile configures

read-only
handoverEnabledbooleanoptional

Whether the CUSTOMER↔MSP handover is active for this customer at all

Default: true
modestringerforderlich

How the customer physically works a handed-over ticket

Werte
NATIVECONNECTORAUTOMATIONPEER
directionstringoptional

Where a fresh ticket for this customer starts: CUSTOMER_FIRST begins at the customer, MSP_FIRST at the MSP. Configurable per party.

Werte
CUSTOMER_FIRSTMSP_FIRSTBOTH
Default: "MSP_FIRST"
returnPolicystringoptional

How a ticket sitting at the customer becomes active for the MSP again. ON_REPLY (default, also for parties without a profile): any reply from the customer side hands it back — the "warten auf Kunde" case. EXPLICIT: only an explicit return does — the customer IT is working the ticket and an end-user mail must not rip it away.

Werte
ON_REPLYEXPLICIT
Default: "ON_REPLY"
connectorobjectoptional
nullable
integrationConfigIduuidoptional

The integration_config (e.g. Jira connection) this party pushes to

takeBackTriggerstringoptional

How the external system signals a take-back to the MSP

Werte
status_transitionexplicit_return
peerobjectoptional
nullable
tenantLinkIduuidoptional

The accepted tenant_link this party is mirrored through. Read by connectionRefForProfile() and becomes ticket_external_links.connectionId.

automationobjectoptional
nullable
handoverWorkflowIduuidoptional

workflow_definition fired on handover → CUSTOMER (pushes to the customer system)

takeBackTriggerIdstringoptional

The webhook-trigger id the customer system POSTs to hand the ticket back to the MSP

labelsobjectoptional
nullable
mspShortNamestringoptional

MSP short name used in the "An {mspShortName} übergeben" button copy

max 60 Zeichen
takeBackTokenstringoptional

Opaque bearer token authorising external take-back for this party. Server-managed.

read-onlynullable

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

Suche