Dla: Administratorzy
Dodawaj notatki do spraw za pomocą klucza centralnego
Twórz wewnętrzne notatki dotyczące sprawy w swoim oprogramowaniu, udostępniaj dokumenty i pliki oraz wybieraj role, które mogą je widzieć.
W tym artykule7 sekcji
Zanim zaczniesz
Ta strona obejmuje procedury dodawania i odczytywania informacji związanych z danym przypadkiem. uwagiUwagi Wewnętrzne notatki dotyczące sprawy, które mogą zobaczyć tylko osoby pełniące określone role; klienci nie mogą ich zobaczyć, chyba że firma to zmieni. Z kluczem do centrum. Ścieżki znajdują się pod… https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.
Połączenia
| Dzwonić | Co to robi |
|---|---|
GET /notes/templates | Lista twoich szablon notatek |
POST /notes | Stworzy notatkę. |
GET /notes | Wylicza notatki dotyczące sprawy, w kolejności od najnowszych do najstarszych. |
GET /notes/<note_id> | Czytam jeden notatnik. |
PUT /notes/<note_id> | Zmiana tytułu notatki lub osoby, która ją widzi. |
DELETE /notes/<note_id> | Usuwa notatkę wraz z jej plikami. |
Notatka to dokument, który jest przechowywany w przypisanym do danej sprawy folderze, wraz z wszystkimi plikami, które do niej należą. Treść notatki stanowi sam dokument – można zacząć od przygotowania szablonu, albo załadować plik w formacie PDF lub Word, gdy notatka już istnieje. Nie ma żadnych polów tekstowych. Nikt nie wie, kiedy dana notatka zostaje dodana lub zmieniona. Notatki również nie wysyłają żadnych komunikatów typu webhook.
Tworzenie notatki
| Pole | Co to robi | Wymagany | Domyślny |
|---|---|---|---|
name | Tytuł notatki: Litery, cyfry, spacje i symbol & ' - _ ( ) . /. Brak kółek, współczynników, kropek czy nawiasów. | Tak. | – |
permissions | roleRola Zestaw uprawnień decydujący o tym, co dana osoba może zobaczyć i zrobić w danej sprawie, np. pracownicy lub klienci., które mogą mieć dostęp do tego danych, np. ["role::staff"]. Tylko role, które mogą czytać notatki. | Nie | Rola modelu, lub każda rola, która może czytać notatki |
template | {"owner": "host", "template_id": "<asset_id>"} z GET /notes/templates, aby przynieść dokument i pliki danej szablonu. Albo {"owner": "case", "template_id": "<note_id>"}, aby kopiować informacje na ten temat. | Nie | Żadnego. |
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"}}'
Odpowiada na 201 za pomocą note_id.
- Z szablonu notatka otrzymuje dokument szablonu, pliki oraz rolę, które przypisane są do tego szablonu. Kody, takie jak nazwa klienta, są wprowadzane raz, gdy notatka jest utworzona. Kody dotyczące osoby, która ją utworzyła, np. jej nazwisko, pochodzą z danych wirtualnego asystenta, którym przypisany jest nazwa twojej firmy. Tytuł notatki nie jest kopiowany; należy wysłać
name. - Kopia notatku dotyczącego tego przypadku zachowuje również teksty wpisane lub narysowane na niej. Jeśli jednak wyślesz
schemaw celu zastąpienia tych tekstów, kody będą ponownie wypełnione od momentu sporządzenia kopii. - Bez żadnego szablonu należy teraz załadować odpowiedni dokument: prosić o adres zamieszkania za pomocą
media_group=schemas, załadować plik w formacie PDF lub Word, a następnie przywiązać go za pomocąPUT /notes/<note_id>/schema/media. Plik w formacie Word zostaje konwertowany na format PDF. Jeden dokument może mieć tylko jedną notatkę. Zobacz Załadowanie i przywiązywanie plików za pomocą klucza hub. - Inne pliki, takie jak zdjęcia czy nagrania, należy przywiązywać za pomocą
PUT /notes/<note_id>/media.
Kto to widzi
Ludzie, którzy pełnią określone role w systemie, mogą otworzyć tę notatkę. Personel, który przez domyślność ma uprawnienia do moderowania notatek, może oglądać wszystkie notatki, niezależnie od ich roli. Klientów nie mogą zobaczyć żadnych notatek, chyba że administrator da im uprawnienia do ich widzenia. Więcej informacji znajdziesz w sekcji Zmiana uprawnień poszczególnych roli.
Notatki z czytania
GET /notes przyjmuje wartość limit (domyślnie 20, a maksymalnie do 1000). Ponadto przyjmuje również wartość start_key oraz liczby stron, tak jak w przypadku każdego listu. Klucz analizuje każdą notatkę w tym liście. Każda nota zawiera:
| Pole | Co zawiera |
|---|---|
note_id, case_id | Jego identyfikatory |
name | Tytuł tego dzieła |
user_id | Kto to zrobił? To identyfikator wirtualnego asystenta, który służy do tworzenia notatek. Może to być efekt działań automatyzacji. |
permissions | Możliwe role, które mogą być widziane. Wykluczone są te role, których uczestnicy mogą czytać notatki. |
schema_media | media_id jego dokumentu |
media, media_ct | Jego dokumenty i pliki – wielu z nich. Można je pobrać w sposób opisany w „Utworzenie i przykładanie plików za pomocą klucza hub”. |
schema | To, co ludzie wpisują lub rysują na dokumencie w formacie Instant JSON. |
template_id | Ten szablon został stworzony zgodnie z określonymi wymaganiami. |
created_on, updated_on | Gdy został ukończony i ostatnio zmieniony, w UTC. |
GET /notes/templates wyświetla listę twoich publikowanych notatek – szablonówSzablon Wielokrotnego użytku wpis, formularz, podpis elektroniczny, notatka lub zadanie przechowywane w bibliotece i kopiowane do spraw.. Szablony są uporządkowane według wieku: najstarszy szablon znajduje się na początku listy. Dla każdego szablonu podano informacje o jego asset_id, title, description i permissions.
Zmiana i usuwanie
PUT /notes/<note_id> przyjmuje name i permissions, a zmienia tylko te elementy, które zostaną przesłane. Klucz może zmienić dowolną notę w danym przypadku. Pusty list permissions jest odrzucany – należy przesłać te elementy, które powinny być widoczne. Całe elementy bez żadnych informacji są również odrzucane.
DELETE /notes/<note_id> usuwa wszystkie notatki, wraz z dokumentami i plikami związanymi z nimi. Nikt o tym nie wie.
Jeśli połączenie zostanie odrzucone
| Status | message | Dlaczego |
|---|---|---|
| 400 | SchemaFieldsException | W tekście brakuje lub istnieją nieprawidłowe znaki, np. kropki. name, pusty permissions Lista lub rola, które nie występują w strukturze twojego centrum. errors Nazywam to tak. |
| 400 | SchemaFieldsException, przy czym ItemCopyNotAllowedException znajduje się w obrębie template | Šablona nie została opublikowana, nie jest dostępna dla botów, lub jej pliki nadal są przetwarzane. |
| 400 | SchemaFieldsException, przy czym NoteRoleCannotReadNotesException znajduje się w obrębie permissions.<n> | W permissions nie można odczytać żadnych notatek. |
| 403 | HostModuleDisabledException | Notatki są wyłączone dla twojego huba, lub ukryte w tym pojemniku. |
| 403 | CaseClosedException | Sprawa została zamknięta. |
| 404 | ItemNotFoundException | Ten notatyk nie istnieje. |
Informacje dotyczące kodu błędów oraz pozostałych kodów znajdują się w sekcji Obsługa błędów API i kodów statusowych.