Für: Administratoren
Fügen Sie Fällen Notizen mit einem Hub-Schlüssel hinzu.
Erstellen Sie interne Notizen zu einem Fall mithilfe Ihrer eigenen Software, geben Sie ihnen ein Dokument und Dateien und wählen Sie aus, welche Rollen diese einsehen können.
In diesem Artikel7 Abschnitte
Bevor Sie beginnen
Diese Seite beschreibt, wie man eine Fallstudie hinzufügen und darüber lesen kann. AnmerkungenAnmerkungen Interne Notizen zu einem Fall, die nur Personen einsehen können, deren Rolle dies zulässt; Mandanten können sie nicht einsehen, es sei denn, die Kanzlei ändert dies. Mit einem Hub-Key. Die Wege liegen unter… https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.
Anrufe
| Anruf | Was es tut |
|---|---|
GET /notes/templates | Liste der Notentemplates |
POST /notes | Erstellt eine Notiz. |
GET /notes | Listet die Notizen zum Fall auf – mit den neuesten Informationen zuerst. |
GET /notes/<note_id> | Liest eine Notiz. |
PUT /notes/<note_id> | Ändert den Titel einer Notiz oder die Person, die sie sehen kann. |
DELETE /notes/<note_id> | Löscht eine Notiz sowie die dazugehörigen Dateien. |
Eine Notiz ist ein Dokument, das für das Team aufbewahrt wird – zusammen mit allen damit verbundenen Dateien. Der Inhalt der Notiz besteht aus dem jeweiligen Dokument selbst. Man kann entweder von einem Vorlage-Format aus beginnen oder nachdem die Notiz bereits existiert, ein PDF- oder Word-Dokument hochladen. Es gibt keine Textfelder. Niemand erfährt, wann eine Notiz hinzugefügt oder geändert wird. Zudem senden die Notizen keine Webhooks aus.
Eine Notiz erstellen
| Feld | Was es tut | Erforderlich | Standard |
|---|---|---|---|
name | Der Titel des Notes. Buchstaben, Zahlen, Leerzeichen und & ' - _ ( ) . / – keine Kommas, Kolonnen, Fragezeichen oder Anführungszeichen. | Ja. | – |
permissions | Die RollenRolle Ein Satz von Berechtigungen, der festlegt, was jemand in einem Fall sehen und tun kann, z. B. Mitarbeiter oder Klienten., die diese Daten sehen können, sind beispielsweise ["role::staff"]. Es handelt sich dabei nur um Rollen, die in der Lage sind, Notizen zu lesen. | Nein. | Die Rollen des Templates – oder jede Rolle, die in der Lage ist, Notizen zu lesen. |
template | Von {"owner": "host", "template_id": "<asset_id>"} nach GET /notes/templates – um das Dokument sowie die Dateien eines Templates zu bringen. Oder von {"owner": "case", "template_id": "<note_id>"} aus, um eine Notiz bezüglich dieses Falls zu kopieren. | Nein. | Keine. |
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/notes \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Case representation letter", "permissions": ["role::staff"], "template": {"owner": "host", "template_id": "note::20260915101500_5e4d3c2b1a0f90"}}'
Es beantwortet die Frage. 201 Mit dem… note_id.
- Aus dem Vorlage-Format erhält die Notiz das Dokument, die Dateien sowie die Rollen der beteiligten Personen. Die entsprechenden Codes – wie zum Beispiel der Name des Kunden – werden erst einmal eingegeben, sobald die Notiz erstellt wird. Die Informationen über die Person, die die Notiz erstellt hat, werden aus den Details der virtuellen Assistentin entnommen – diese Details enthalten schließlich den Namen Ihres Unternehmens. Der Titel der Notiz wird nicht kopiert: Senden Sie
name. - Eine Kopie eines Notizbuchs über diesen Fall bewahrt auch die eingetragenen oder gezeichneten Informationen auf – es sei denn, man sendet
schemaanstelle davon. Die Codes werden wieder eingegeben, sobald die Kopie erstellt wird. - Ohne einen Vorbild-Dateinamen muss man nun das Dokument hochladen. Geben Sie dazu eine Adresse ein, wie in „
media_group=schemas“. Anschließend kann man ein PDF- oder Word-Dokument hochladen und dieses mit „PUT /notes/<note_id>/schema/media“ anhängen. Ein Word-Dokument wird dabei in ein PDF-Format umgewandelt. Eine Note enthält dabei nur ein Dokument. Weitere Informationen finden Sie unter „Hochladen und Anhängen von Dateien mit der Hub-Schlüssel“. - Andere Dateien, wie z.B. Fotos oder Aufnahmen, sollten mit
PUT /notes/<note_id>/mediaversehen werden.
Wer sieht es?
Die Personen, die in den jeweiligen Rollen stehen, können diese Notizen öffnen. Das Personal, dessen Rolle es standardmäßig ist, die Notizen zu moderieren, sehen alle Notizen – unabhängig von ihrer Rolle. Kunden sehen keine Notizen, es sei denn, ein Administrator hat ihnen die Berechtigung gegeben, auf diese Notizen zuzugreifen. Weitere Informationen finden Sie unter Wie eine Rolle etwas tun kann.
Lesenotizen
GET /notes nimmt limit (Standardwert: 20, maximal: 1000) sowie start_key entgegen. Zudem werden wie bei jeder Liste auch die Seiten berücksichtigt. Eine Schlüsselzeichenliste enthält alle Notizen in der Liste. Jede Note enthält:
| Feld | Was es enthält |
|---|---|
note_id, case_id | Ihre IDs |
name | Sein Titel |
user_id | Wer hat das erstellt? Die Identität der virtuellen Assistentin – oder eine automatische Entscheidung. |
permissions | Die Rollen, die davon betroffen sein könnten… Sie werden ausgeschlossen, wenn jede Person, die in der Lage ist, Notizen zu lesen, davon erfährt. |
schema_media | Das media_id seines Dokuments |
media, media_ct | Seine Dokumente und Dateien – wie viele es sind… Laden Sie sie herunter, wie im Beispiel „Hochladen und anhängen der Dateien mit einem Hub-Key“. |
schema | Was die Menschen auf das Dokument eingetippt oder darauf gezeichnet haben, in Form von Instant JSON. |
template_id | Der Stil, nach dem das Template erstellt wurde |
created_on, updated_on | Als es fertiggestellt und zuletzt in UTC umgewandelt wurde. |
GET /notes/templates Listet Ihre veröffentlichten Notizen auf. VorlagenVorlage Ein wiederverwendbarer Feed-Beitrag, ein Formular, eine elektronische Signatur, eine Notiz oder eine Aufgabe, die in der Bibliothek aufbewahrt und in Fälle kopiert wird., Alle sind in der Reihenfolge des Alters geordnet – der Älteste zuerst. asset_id, title, description Und… permissions.
Ändern und Löschen
PUT /notes/<note_id> nimmt name und permissions entgegen und ändert nur die Werte, die Sie übermitteln. Ein Schlüssel kann jede Note im Fall ändern. Eine leere Liste von permissions wird abgewiesen – senden Sie stattdessen die Rollen, die diese Informationen erhalten sollen. Ein Text ohne diese Informationen wird ebenfalls abgewiesen.
DELETE /notes/<note_id> löscht alle Notizen sowie die damit verbundenen Dokumente und Dateien. Niemand wird darüber informiert.
Wenn ein Anruf abgelehnt wird
| Status | message | Warum |
|---|---|---|
| 400 | SchemaFieldsException | Es fehlt ein Feld oder es ist das Feld ungültig. Beispielsweise kann es ein Komma in name geben, eine leere Liste in permissions oder ein Rolle, die Ihr Hub nicht hat. errors bezeichnet dabei die Namen der Felder. |
| 400 | SchemaFieldsException, wobei ItemCopyNotAllowedException bei template liegt. | Das Template ist nicht veröffentlicht, steht der Rolle der Bots nicht offen – oder seine Dateien werden noch bearbeitet. |
| 400 | SchemaFieldsException, wobei NoteRoleCannotReadNotesException bei permissions.<n> liegt. | Eine Rolle in permissions kann die Notizen nicht lesen. |
| 403 | HostModuleDisabledException | Die Notizen sind für Ihr Hub ausgeschaltet oder in dieser Hülle versteckt. |
| 403 | CaseClosedException | Der Fall ist abgeschlossen. |
| 404 | ItemNotFoundException | Die Notiz existiert nicht. |
Für den Fehlermeldungsinhalt sowie die übrigen Codewerte siehe Verarbeitung von API-Fehlern und Statuscodes.