HilfezentrumIntegrationen

Für: Administratoren

Falldetails mit einem Hub-Schlüssel lesen und aktualisieren

Lesen Sie die Details eines Falls und des zugehörigen Teams und ändern Sie die Details, die ein Administrator der virtuellen Assistentenrolle ändern lässt, wie z. B. die Phase oder ein benutzerdefiniertes Feld.

In diesem Artikel8 Abschnitte

Bevor Sie beginnen

Diese Seite beschreibt, wie man die Details eines Falls mit einem Hub-Key ändern kann. Die Wege sind unter https://prd-api-app.caseactive.com/v1/<hub id>/<case id> dargestellt.

Anrufe

AnrufWas es tut
GET /caseliest die Details des Falls
PUT /caseDie Details ändern sich – die Schlüssel können sich ebenfalls ändern.
GET /whoamiEs wird beschrieben, welche Details die Schlüsselinformationen in diesem Fall enthalten und wie diese sich ändern können. Zudem werden die Abschnitte angezeigt, die betroffen sind.
GET /teamListet die Personen auf, die an dem Fall beteiligt sind.
GET /placeholdersliest die Werte, die in den Code-Teilen Ihrer Vorlagen eingefügt werden.

Was eine Hub-Key kann lesen und ändern, hängt von der Funktion der Hub ab. Virtuelle Assistentin/Virtueller AssistentVirtueller Assistent Ein automatisiertes Teammitglied, das Begrüßungsnachrichten, Check-ins und Statusmeldungen für das Unternehmen veröffentlicht; seine Beiträge sind mit einem Virtual Assistant-Abzeichen versehen., Botter. Standardmäßig liest es die Standarddetails des Falls aus. Es kann keine dieser Details ändern, bevor ein Administrator dies erlaubt.

Details zum Schlüsselwechsel

In den Optionen › Rollen können Sie die Rolle der Bot-Programme bearbeiten. Unter Fall markieren Sie das Feld Alle in der Rolle angegebenen Fallfelder aktualisieren. Die Details der Schlüsselwerte können sich ändern: Titel, Beschreibung, Datum geöffnet, Status, Bühne oder auch benutzerdefinierte Felder. Um es zu ermöglichen, benutzerdefinierte Felder zu lesen, markieren Sie dieses Feld unter Alle in der Rolle angegebenen Fallfelder lesen. Weitere Informationen finden Sie unter Wie eine Rolle ausgeführt werden kann.

GET /whoami Die Schlüsselrolle der „Schlüssel“ in diesem Fall wird damit erklärt. case_read_fields Und… case_write_fields, Die Details können sich ändern. case_write_fields Es wird ausgeschlossen – obwohl es möglicherweise nichts ändert. Ein benutzerdefinierter Feld zeigt dies an. meta_data.<field key>. Es beantwortet auch die Frage. case_modules, Die Abschnitte, die in dem Fall angegeben werden – also die Abschnitte Ihres Ziels, abzüglich aller versteckten Informationen in diesem Fall. Ein Anruf an einen solchen fehlenden Abschnitt wird abgewiesen.

Lesen eines Falls

curl https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "data": {
    "case_id": "cc-1a2b3c4d5e6f70",
    "host_id": "ca-7e6d5c4b3a2f10",
    "ref_id": "rear-end-2026",
    "title": "Jane Sample auto accident",
    "description": "Rear-end collision on Route 9. Waiting on the insurer's estimate.",
    "case_type": "general",
    "case_status": 1,
    "case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
    "date_opened": "2026-03-05",
    "meta_data": {
      "schema": [{"schema": {"type": "object", "properties": {"policy_number": {"type": "string", "title": "Policy number"}}}}],
      "content": [{"policy_number": "PN-5521"}]
    },
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case"
  }
}
  • Standardmäßig wird die Schlüsselzeichen als case_id, ref_id (die Tag-IDTag-ID Eine permanente Bezeichnung, die Sie einem Fall geben, z. B. rear-end-2026, die auch als Referenz-ID angezeigt und bei Importen verwendet wird.), case_status, date_opened, title, description, case_type und case_stage angegeben. Einzelheiten bezüglich dieser Situation werden hier nicht erläutert.
  • case_stage ist die ID einer StufeBühne Ein Verfahrensschritt, den ein Fall durchläuft, wie z. B. die Aufnahme oder das Versenden der Aufforderung, der von der Kanzlei benannt und beschrieben wird und auf der Fallseite angezeigt wird.. GET /v1/<hub id>/stages enthält die Namen dieser Stufen.
  • meta_data.content enthält die Werte der benutzerdefinierten Felder. Es gibt ein Objekt pro Feldseite, und dabei werden nur die Felder angezeigt, die durch den entsprechenden Schlüssel identifiziert werden können. Standardmäßig wird nichts angezeigt – daher ist die erste Seite leer. Im Beispiel hat der Administrator es erlaubt, die Nummer der Richtlinie anzuzeigen. meta_data.schema beschreibt die Felder auf jeder Seite.
  • hidden_modules listet die Abschnitte auf, die in diesem Fall versteckt sind – falls es solche Abschnitte überhaupt gibt.

einen Fall ändern

PUT /case nimmt jedes dieser Felder als JSON-Daten entgegen und ändert nur diejenigen Werte, die Sie übermitteln.

FeldWas es tutErforderlichStandard
titleDer Name des Falles wird allen mitgeteilt.Nein.Unverändert
descriptionEine Beschreibung für das Personal: Senden Sie "", um diese Informationen zu löschen.Nein.Unverändert
date_openedDer Tag, an dem der Fall verhandelt wurde, beispielsweise 2026-03-15Nein.Unverändert
case_status0 Um den Fall zu schließen – eine Hub-Taste kann den Fall nicht erneut öffnen.Nein.Unverändert
case_stageDie ID der Bühne lautet GET /v1/<hub id>/stages. Senden Sie "", um den Gegenstand von der Bühne zu entfernen.Nein.Unverändert
meta_dataBenutzerdefinierte Werte für Felder: Eine Liste mit einem Objekt pro Feldseite. Jedes Objekt enthält die Werte für das jeweilige Feld. Nur die erste Seite kann hier geändert werden – und nur die Felder, die Sie senden. Senden Sie "" oder null, um ein Feld zu leeren. Ein erforderliches Feld kann nicht gelöscht werden.Nein.Unverändert
curl -X PUT https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/case \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"case_stage": "stage::20260927120000_8c1f0e2d3b4a59", "meta_data": [{"policy_number": "PN-5521"}]}'

Es wird 200 mit der ID des Falles beantwortet. Wenn ein der gesendeten Felder nicht zu den Schlüsselwerten gehört, kann sich der Wert ändern. In diesem Fall wird die Anfrage mit 403 abgelehnt – dabei ändert sich nichts. reason bezeichnet die Felder; das eigene Feld wird als meta_data.<field key> bezeichnet. Ein Feld, dessen Wert dem bereits vorhandenen Wert entspricht, stellt keine Änderung dar. Daher wird es weder abgelehnt noch verändert. Eine Anfrage, die nichts ändert, beantwortet 204.

  • Wenn man ein offenes Case in eine bestimmte Phase verschiebt, wird eine entsprechende Meldung für diese Phase erstellt. Das gilt auch, wenn Ihr Hub über eine virtuelle Assistentin verfügt – siehe „Automatische Meldung bei Erreichen einer bestimmten Phase des Cases“. Sonst wird nichts gesendet oder angezeigt: Wenn man ein Case schließt oder seine Details ändert, wird das an niemanden weitergegeben.
  • Sobald ein Fall abgeschlossen ist, wird jede Änderung mit dem Hub-Key verweigert – auch das Wiederöffnen des Falls. Öffnen Sie den Fall wieder im Administrationspanel oder mit einem anderen Key. Siehe dazu Fall schließen oder öffnen.
  • Die Tag-ID und der Falltyp können hier nicht geändert werden. Nur eine zuständige Person kann den Falltyp ändern.

Das Team

GET /team listet alle Personen auf der Liste auf – einschließlich des virtuellen Assistenten und der Menschen mit Behinderungen. Ein Fall kann maximal 20 Personen enthalten, wie der virtuelle Assistent feststellte.

{
  "data": {
    "items": [
      {
        "case_id": "cc-1a2b3c4d5e6f70",
        "user_id": "cu-4f1c2a9e8b7d60",
        "case_role_id": "role::clients",
        "case_designation": "primary",
        "case_notify": 1,
        "host_user_status": 1,
        "given_name": "Jane",
        "family_name": "Sample",
        "locale": "en",
        "zoneinfo": "America/New_York"
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/team"
  }
}
  • case_role_id Was ist die Rolle dieser Person in diesem Fall? case_designation ihre BezeichnungBezeichnung Eine Bezeichnung für die Funktion einer Person in einem Fall, wie z. B. leitender Anwalt, Rechtsanwaltsgehilfe oder Vormund., zum Beispiel primary.
  • host_user_status ist 0 für jemanden, der in Ihrem Zentrum behindert ist.
  • Die Namen jedes Menschen, die Sprache (locale) sowie die Zeitzone (zoneinfo) werden standardmäßig zurückgeliefert. E-Mail-Adressen und Telefonnummern hingegen werden niemals zurückgeliefert.
  • Eine Hub-Key kann keine Personen hinzufügen oder entfernen – diese Anrufe werden schließlich mit den Codes 403 HostAddCaseUserNotEnabledException und HostRemoveCaseUserNotEnabledException beantwortet. Verwenden Sie stattdessen eine Management-Key. Weitere Informationen finden Sie in „Hinzufügen und Entfernen von Mitgliedern mit einer Management-Key“.

Vorlagenwerte

GET /placeholders Antworten, unter… placeholders, Der Wert, den jeder Code in Ihren Vorlagen in diesem Fall ausgibt, beispielsweise… clients.primary.full_name, clients.primary.email, case_ref_id Und… company.phone. Ein Code für eine Bezeichnung, die von niemandem verwendet wird, wird hier nicht angegeben. Wenn der Abschnitt „Team“ auf dem Fall deaktiviert oder versteckt ist, dann werden alle Team-Codes weggelassen – die restlichen Codes funktionieren jedoch weiterhin. Siehe dazu… Füllen Sie die Formfelder mit den Details bezüglich des Falles aus..

Wenn ein Anruf abgelehnt wird

StatusmessageWarum
400SchemaFieldsExceptionDas Feld ist ungültig – beispielsweise ein leeres title, ein benötigtes Custom-Feld, das leer angezeigt wird, oder ein Stadium, das in Ihrem Hub nicht vorhanden ist. errors bezeichnet dabei die Namen der einzelnen Stadia.
403CaseFieldNotWritableExceptionDas Feld, das Sie gesendet haben, ist nicht eines der Schlüsselfelder. Der Name dieses Feldes lautet reason.
403CaseClosedExceptionDer Fall ist abgeschlossen.
403HostModuleDisabledExceptionDie Details des Falls oder die Informationen über das Team werden in diesem Fall verborgen – oder sind für Ihren Rechner deaktiviert.
403CaseModulePermissionDeniedExceptionDie Rolle der Bots ermöglicht es nicht, die Details des Falls oder die Teammitglieder zu lesen.
404CaseNotFoundExceptionDer Fall existiert nicht. Er gehört zu einem anderen Hub oder wird gerade gelöscht.

Für den Fehlermeldungsinhalt sowie die übrigen Codewerte siehe Verarbeitung von API-Fehlern und Statuscodes.

Verwandte Artikel

Verstehen Sie, was die API leisten kann.Erfahren Sie, welche Funktionen eine Verwaltungstaste und eine Hub-Taste jeweils haben, warum jede Taste als virtueller Assistent fungiert und wo Sie die vollständige technische Auflistung finden.IntegrationenFinden Sie Fälle mit einem Hub-SchlüsselListen Sie die Fälle in Ihrem Hub auf, ob offen oder geschlossen, suchen Sie nach ihnen anhand der Tag-ID oder des Titels und finden Sie die ID eines Falls in Ihrer eigenen Software.IntegrationenVerändern Sie, was eine Rolle bewirken kannBearbeiten Sie die Berechtigungen einer Rolle, die Fallfelder, die sie lesen oder ändern kann, und ihre Upload-Limits, einschließlich der integrierten Rollen.Sicherheit und Konto · 5 minAPI-Fehler und Statuscodes behandelnLesen Sie den Fehlertext, was 400, 401, 403, 404, 500 und 503 bedeuten und warum ein Element, dessen Schlüssel nicht angezeigt werden kann, 404.Integrationen