Für: Administratoren
Finden Sie Fälle mit einem Hub-Schlüssel
Listen 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.
In diesem Artikel7 Abschnitte
Bevor Sie beginnen
Diese Seite beschreibt die Aktionen, die eine Hub-Key ausführt, um Fälle zu finden. Die Wege werden unter https://prd-api-app.caseactive.com/v1/<hub id> angezeigt.
Anrufe
| Anruf | Was es tut |
|---|---|
GET /cases | Liste der offenen oder geschlossenen Fälle Ihres Zentrums |
GET /cases/search | Suchen nach Fällen basierend auf der Tag-ID oder dem Titel. |
GET /whoami | liest die Einstellungen Ihres Geräts – also die Arten von Gehäusen sowie die entsprechenden Seiten des Geräts. |
GET /roles | Liste der Rollen Ihres Zentrums |
GET /stages | Liste die Phasen Ihres Zentrums auf. |
GET /schemas | Ich lese den Fall sowie die von dem Benutzer angepassten Felder deines Systems durch. |
Ein Hub-Key funktioniert als „Hub“ für Ihr System. 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., Das gilt in jedem Fall. Somit erreichen diese Anrufe alle Fälle in Ihrem Zentrum – einschließlich der beiden beispielhaften Fälle.
Ein Hub-Key kann keine Fälle erstellen. POST /cases Antworten 403 HostCreateCaseNotEnabledException. Um aus Ihrem Softwareprogramm Fallstücke zu erstellen, verwenden Sie eine entsprechende Funktion zur Verwaltung dieser Fallstücke. Siehe dazu… Erstellen und aktualisieren von Fällen – unter Verwendung einer Schlüsselstruktur zur Verwaltung der Fälle..
Auflistung der Fälle
| Parameter | Was es tut | Erforderlich | Standard |
|---|---|---|---|
status | 1 für offene Fälle, 0 für geschlossene Fälle | Nein. | 1 |
limit | Wie viele Einträge können auf eine Seite gespeichert werden – bis zu 1000 Einträge. | Nein. | 20 |
start_key | Der startKey aus der vorherigen Seite | Nein. | Erste Seite |
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?status=1" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"items": [
{
"case_id": "cc-1a2b3c4d5e6f70",
"case_ref_id": "ca-7e6d5c4b3a2f10::rear-end-2026",
"title": "Jane Sample auto accident",
"team": {
"cu-7e6d5c4b3a2f10": "role::bots",
"cu-4f1c2a9e8b7d60": "role::clients",
"cu-9d8c7b6a5f4e30": "role::staff"
}
}
],
"currentItemCount": 1,
"selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?status=1"
}
}
- Die Fälle werden in der Reihenfolge von 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. aufgelistet – von Z nach A. Dabei wird nicht die Datumsgrundlage berücksichtigt.
case_ref_idist die ID des Hub-Systems. Zwei Kommas sowie die Tag-ID des Fahrzeugs werden ebenfalls angegeben.teamWeist jede Person im Fall ihre rolleRolle Ein Satz von Berechtigungen, der festlegt, was jemand in einem Fall sehen und tun kann, z. B. Mitarbeiter oder Klienten. zu – ohne dass dabei Namen angegeben werden. Für die Namen siehe das Team des Falls; siehe auch Lesen und aktualisieren der Falldaten mit einem Hub-Key.- Während es noch mehr Fälle gibt, enthält die Seite auch die Adresse von der nächsten Seite – nämlich
nextLink– sowiestartKey. Rufen SienextLinkauf, oder senden SiestartKeyalsstart_key, bis eine Seite ohne diese Informationen zurückkommt. - Die gelöschten Fälle werden ausgeschlossen. Daher kann eine Seite weniger als
limitFälle enthalten – während es immer noch weitere Fälle gibt. Beziehen Sie sich auf die ZahlnextLink, nicht auf die tatsächliche Anzahl der Fälle. - Der Titel und der Status eines Falles können hier um einige Sekunden verzögert werden.
Fallsuche
GET /cases/search passt zu den Worten an jedem Ort in der Tag-ID eines Beispiels – und auch am Anfang eines Wortes im Titel. Zudem ermöglicht es die Erkennung kleiner Fehler. Es sucht jedoch keine Beschreibungen durch.
| Parameter | Was es tut | Erforderlich | Standard |
|---|---|---|---|
query | Die Wörter, nach denen gesucht werden sollten: Senden Sie * für jedes Fall. | Ja. | – |
status | 1 für offene Fälle, 0 für geschlossene Fälle | Nein. | 1 |
limit | Wie viele Ergebnisse eine Seite enthalten kann – bis zu 250. | Nein. | 20 |
page | Welche Seite der Ergebnisse, von 1 an? | Nein. | 1 |
sort_by | Eine Zahlenreihe sowie eine Richtung – beispielsweise created_on:desc. Es werden die Werte created_on, date_opened, last_activity, updated_on, users_ct und case_status verwendet. | Nein. | Gleiche Eigenschaften zuerst |
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/search?query=rear-end-2026" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"found": 1,
"page": 1,
"hits": [
{
"document": {
"case_id": "cc-1a2b3c4d5e6f70",
"ref_id": "rear-end-2026",
"title": "Jane Sample auto accident",
"case_status": 1,
"case_type": "general",
"case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
"date_opened": 1772668800,
"created_on": 1791043509,
"last_activity": 1791050112,
"users_ct": 3
}
}
],
"selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/search?query=rear-end-2026"
}
}
- Jeder Treffer…
documentHält die ID des Falles, die eindeutige Tag-ID, den Titel, den Status des Falls fest. FalltypFallart Eine Kategorie für Fälle, wie z. B. „Allgemein“, die dazu dient, Automatisierungen auf die richtigen Fälle auszurichten., Stufe/PhaseBü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., Wie viele Personen auf diesem Gerät sind – und welche Daten das sind, in Unix-Sekunden im UTC-Zeitbereich. foundgibt an, wie viele Fälle übereinstimmen. Durchgehen Sie diese mitpage– es gibt keinenextLink-Angaben.- Ein Fall kann innerhalb von Sekunden nach einer Änderung gesucht werden.
Einen Fall anhand seiner Tag-ID finden
Es gibt keine exakte Suche nach der Tag-ID. Suchen Sie einfach nach der entsprechenden Eingabe. Wählen Sie dann die Ergebnisse aus, bei denen document.ref_id genau die Tag-ID entspricht. Denn eine Suche findet auch ähnliche Ergebnisse wie rear-end-2025. Suchen Sie weiter mit status=1 und anschließend mit status=0 – damit man alle möglichen Ergebnisse berücksichtigen kann.
Sobald Sie die ID des Falles haben, wird diese bei jeder Anfrage bezüglich des Falls verwendet. Siehe dazu Lesen und Aktualisieren der Falldaten mit einer Hub-Schlüssel.
Einstellungen Ihres Hubs
| Anruf | Was es beantwortet |
|---|---|
GET /whoami | Der Benutzername der Schlüsselverwaltung, der Name Ihres Hub-Systems, die Arten der Kästen, in denen es sich befindet, sowie die Felder „host_default_schemas“ für die Kästen und Benutzerdaten. |
GET /roles | Jede Rolle, einschließlich der role::bots-Rolle des virtuellen Assistenten, umfasst auch die role_id-, name-, description-, color- und reads_notes-Rollen. Ebenso kann der virtuelle Assistent Notizen lesen. |
GET /stages | Jede Stufe – von Anfang bis Ende – mit stage_id, name, description und order |
GET /schemas | default_schemas – Die Seiten mit den Daten Ihres Hub sowie der benutzerdefinierten Felder. Auf diesen Seiten finden Sie jeweils die Schlüsselwörter, die Beschreibungen sowie die Arten der einzelnen Felder. |
Keine dieser Seiten liefert alle Antworten auf eine einzige Frage.
Wenn ein Anruf abgelehnt wird
| Status | message | Warum |
|---|---|---|
| 400 | SchemaFieldsException | Ein Parameter ist fehlend oder ungültig – beispielsweise eine leere query oder eine status, die nicht den Wert 0 oder 1 annimmt. Die errors-Angabe ist ebenfalls ungültig. |
| 400 | InvalidStartKeyException | Die start_key stammt aus einer anderen Liste. |
| 400 | SearchParameterException | Die Suche weigerte sich, Parameter wie sort_by für einen Textfeldwert oder limit über 250 zu akzeptieren. reason gibt an, welcher Wert verwendet werden soll. |
| 403 | HostCreateCaseNotEnabledException | Ein Hub-Key versuchte, einen Fall zu schaffen. |
Für den Fehlermeldungsinhalt sowie die übrigen Codewerte siehe Verarbeitung von API-Fehlern und Statuscodes.