Per: Amministratori
Aggiungi note ai casi con una chiave hub
Crea note interne su un caso utilizzando il tuo software, fornisci un documento e i relativi file e scegli quali ruoli possono visualizzarli.
In questo articolo7 sezioni
Prima di iniziare
Questa pagina spiega come aggiungere e leggere i dati relativi a un caso specifico. Note/CommentiGli appunti Note interne relative a un caso, visibili solo alle persone il cui ruolo lo consente; i clienti non possono visualizzarle a meno che lo studio legale non modifichi questa impostazione. Con una chiave di hub. I percorsi sono sotto… https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.
Chiamate
| Chiamata | Cosa fa |
|---|---|
GET /notes/templates | Elenca i tuoi modelli di note. |
POST /notes | Creazione di una nota. |
GET /notes | Elenca le note relative al caso, con i dati più recenti in primo piano. |
GET /notes/<note_id> | Leggo una nota. |
PUT /notes/<note_id> | Modifica il titolo di una nota o chi può visualizzarla. |
DELETE /notes/<note_id> | Elimina una nota, insieme ai suoi file associati. |
Una nota è un documento conservato relativo a una specifica situazione, per il proprio team. Include tutti i file correlati a tale situazione. Il contenuto del documento può essere generato utilizzando uno schema predefinito, oppure si può caricare un file PDF o Word una volta che la nota è stata creata. Non esistono campi di testo per inserire informazioni. Nessuno viene informato quando una nota viene aggiunta o modificata. Inoltre, le note non inviano alcun tipo di segnalazione via webhook.
Creare una nota
| Campo | Cosa fa | Necessario | Predefinito |
|---|---|---|---|
name | Il titolo della nota: lettere, numeri, spazi e simboli & ' - _ ( ) . /. Non ci sono virgole, punti e virgolette. | Sì. | – |
permissions | I “ruoliRuolo Un insieme di autorizzazioni che determina cosa una persona può vedere e fare su un caso, ad esempio il personale o i clienti.” che possono visualizzare tali informazioni, come ad esempio ["role::staff"]. Solo i ruoli che hanno il diritto di leggere le note possono accedere a queste informazioni. | No. | I ruoli del modello, ovvero tutti quei ruoli che possono leggere le note. |
template | {"owner": "host", "template_id": "<asset_id>"} da GET /notes/templates, Per portare con sé il documento e i file di un modello… {"owner": "case", "template_id": "<note_id>"} Per copiare una nota relativa a questo caso. | No. | Nessuno |
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"}}'
Risponde a 201 con note_id.
- Da un modello, la nota riceve i dati relativi al documento, ai file e alle funzioni legate a quel modello. I codici, come il nome del cliente, vengono inseriti una volta, quando viene creata la nota. I codici relativi a chi ha creato la nota, come il nome di quella persona, vengono presi dai dati forniti dall’Assistente Virtuale; questi dati includono anche il nome dell’azienda. Il titolo della nota non viene copiato: si deve inviare
name. - Una copia di una nota relativa a questo caso conserva anche il testo scritto o disegnato su di essa, a meno che non si utilizzi
schemaper sostituire quel testo. I codici presenti sulla copia vengono riempiti nuovamente, nel momento in cui viene creata la copia stessa. - Senza un modello predefinito, caricate il documento successivamente: chiedete l’indirizzo utilizzando
media_group=schemas, caricate un file PDF o Word, e aggiungetelo conPUT /notes/<note_id>/schema/media. Un file Word viene convertito in formato PDF. Una nota rappresenta un singolo documento. Per ulteriori informazioni, vedete Caricare e aggiungere file utilizzando la chiave hub. - Altri file, come foto o registrazioni, devono essere allegati con il simbolo
PUT /notes/<note_id>/media.
Chi lo vede
Le persone che ricoprono i ruoli specifici possono aprire questa nota. Il personale, che di default ha il ruolo di moderatore delle note, può visualizzare tutte le note, indipendentemente dal loro ruolo. I clienti, invece, non possono vedere le note, a meno che un amministratore non abbia concesso loro l’accesso a queste note. Per ulteriori informazioni, si veda Modificare le funzionalità di un ruolo.
Note di lettura
GET /notes accetta i valori limit (valore predefinito: 20; massimo: 1000), start_key e, come in ogni lista, anche le pagine. Una chiave legge tutte le note presenti nel caso. Ogni nota contiene:
| Campo | Cosa contiene |
|---|---|
note_id, case_id | I loro ID |
name | Il suo titolo |
user_id | Chi l’ha creato? L’ID del assistente virtuale utilizzato per gestire le note… o è stato un processo automatizzato? |
permissions | I ruoli che potrebbero vederlo… Sono stati esclusi, visto che tutti i ruoli in grado di leggere le note possono vederlo. |
schema_media | Il valore di media_id del suo documento |
media, media_ct | I suoi documenti e file… quanti ne ha? Possiamo scaricarli, come se fossero semplici file normale. Caricate e allegate i file utilizzando una chiave Hub.. |
schema | Cosa le persone digitano o scrivono sul documento, in formato Instant JSON. |
template_id | Il modello da cui è stato realizzato… |
created_on, updated_on | Quando è stato realizzato e l’ultima volta modificato, nel fuso orario UTC. |
GET /notes/templates elenca le “template” della tua nota pubblicata: templateModello Un feed riutilizzabile, un modulo, una firma elettronica, una nota o un'attività conservati nella Biblioteca e copiati sui casi.. Le informazioni sono presentate in ordine di età, con ogni template indicato con i valori asset_id, title, description e permissions.
Modificare ed eliminare
PUT /notes/<note_id> riceve name e permissions; inoltre, modifica soltanto quelle informazioni che vengono inviate. Un “key” può modificare qualsiasi nota presente nel caso. Una lista vuota di permissions viene rifiutata: è necessario inviare le informazioni relative ai ruoli che devono essere visualizzate. Se il corpo dell’oggetto non contiene alcuna informazione, anch’esso viene rifiutato.
DELETE /notes/<note_id> elimina qualsiasi nota, insieme al relativo documento e ai file associati. Nessuno viene informato di ciò.
Se una chiamata viene rifiutata
| Stato | message | Perché |
|---|---|---|
| 400 | SchemaFieldsException | Il campo è mancante o non valido: ad esempio, potrebbe esserci una virgola nel campo name, oppure una lista vuota nel campo permissions. Inoltre, il nome del campo errors potrebbe non corrispondere a quello presente nel database del proprio hub. |
| 400 | SchemaFieldsException, con ItemCopyNotAllowedException a template | Il modello non è pubblicato, non è accessibile ai robot, oppure i suoi file sono ancora in fase di elaborazione. |
| 400 | SchemaFieldsException, con NoteRoleCannotReadNotesException a permissions.<n> | Un ruolo in permissions non può leggere le note. |
| 403 | HostModuleDisabledException | Le note sono disattivate per il tuo hub, oppure nascoste in questo caso. |
| 403 | CaseClosedException | Il caso è chiuso. |
| 404 | ItemNotFoundException | Quella nota non esiste. |
Per informazioni sul corpo dell’errore e sugli altri codici, si veda Comunicare gli errori dell’API e i codici di stato.