Daten & Dokumente
Die REST-API bietet unter anderem Funktionen zum Abrufen, Anlegen und Aktualisieren von Anliegen, zum Erfassen von Kontakten und zum Verarbeiten von Dokumenten. Je nach Funktion werden strukturierte Daten als JSON oder Dokumente über Upload-Schnittstellen übertragen.
Typische API-Aufrufe im Serviceprozess
- Kundenanliegen anlegen: POST /concerns legt ein Anliegen in einer neuen oder bestehenden Akte an.
- Anliegen abrufen und aktualisieren: GET /concerns/{id} liefert Anliegeninformationen. PATCH /concerns/{id} aktualisiert unterstützte Angaben wie Status, Labels oder dynamische Felder.
- Kontakte erfassen: POST /contacts dokumentiert einen eingehenden oder ausgehenden Kontakt zu einem Kundenanliegen. Dokumente lassen sich dabei zuordnen.
- Dokumente übernehmen: POST /upload lädt Dokumente hoch. POST /documents/{id}/indexing ordnet sie einer Akte oder einem Anliegen zu. Dabei kann auch ein neues Anliegen entstehen.
Ausgewählte Aufrufe relativ zum API-Basispfad /tfapi. Verfügbare Funktionen und Felder richten sich nach API-Version und Berechtigungen.