Per: Amministratori
Leggi e aggiorna i dettagli del caso con una chiave hub
Leggi i dettagli di un caso e il team, e modifica i dettagli che un amministratore consente di modificare per il ruolo dell'assistente virtuale, come la fase o un campo personalizzato.
In questo articolo8 sezioni
Prima di iniziare
Questa pagina descrive come leggere e modificare i dettagli di un singolo caso, utilizzando una chiave “hub”. I percorsi sono indicati sotto https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.
Chiamate
| Chiamata | Cosa fa |
|---|---|
GET /case | Legge i dettagli del caso. |
PUT /case | Cambia i dettagli; la chiave potrebbe cambiare. |
GET /whoami | Viene indicato quali dettagli riguardano il modo in cui il codice può essere letto e modificato in questo caso, nonché quali sezioni vengono visualizzate. |
GET /team | Elenca le persone coinvolte nel caso. |
GET /placeholders | Legge i valori che i codici dei tuoi template inseriscono in questo caso. |
Cosa può leggere e modificare il hub key, dipende dal ruolo svolto dal proprio hub. Assistente virtualAssistente virtuale Un membro automatizzato del team che pubblica messaggi di benvenuto, check-in e post di aggiornamento per l'azienda; i suoi post sono contrassegnati da un badge di Assistente Virtuale., bot. In modalità predefinita, il programma legge i dettagli standard del caso. Non è possibile modificare alcuno di questi dettagli fino a quando un amministratore non lo permette.
Lasciando che la chiave cambi i dettagli
Nella sezione Impostazioni › Ruoli, modifica il ruolo del bot. Nella voce Astuccio, seleziona l’opzione Aggiornare tutti i campi specificati nel ruolo. I campi che possono essere modificati sono: Titolo, Descrizione, Data di apertura, Stato, Palcoscenico oppure campi personalizzati. Per permettere al bot di leggere i campi personalizzati, selezionale quelli nella voce Leggere tutti i campi specificati nel ruolo. Per ulteriori informazioni, vedi Cambia le funzionalità del ruolo.
GET /whoami La chiave svolge un ruolo fondamentale in questo caso. case_read_fields E… case_write_fields, I dettagli possono variare a seconda delle circostanze. case_write_fields Viene lasciato fuori, poiché potrebbe non cambiare nulla. Un campo personalizzato viene visualizzato lì. meta_data.<field key>. Inoltre, risponde anche a… case_modules, Le sezioni indicate nel caso sono quelle del tuo hub… senza alcun elemento nascosto in merito. Un tentativo di chiamare una delle sezioni mancanti viene rifiutato.
Leggere un caso
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"
}
}
- Per impostazione predefinita, la chiave viene letta come…
case_id,ref_id(the…) ID del tagID tag Un'etichetta permanente che si assegna a un caso, come ad esempio rear-end-2026, visualizzata anche come ID di riferimento e utilizzata nelle importazioni.),case_status,date_opened,title,description,case_typeE…case_stage. C’è un dettaglio del caso che non è stato menzionato. case_stageè l’ID di una fasePalcoscenico Una fase del percorso di una pratica, come ad esempio l'acquisizione dei dati o l'invio della richiesta, che lo studio legale nomina e descrive e che viene visualizzata nella pagina della pratica.;GET /v1/<hub id>/stageselenca i loro nomi.meta_data.contentcontiene i valori dei campi personalizzati. Un oggetto per ogni campo, in base alla chiave del campo stesso. Tuttavia, vengono letti soltanto i campi che la chiave può leggere. Per impostazione predefinita, non vengono letti alcuni campi; quindi la prima pagina risulta vuota. Nell’esempio, un amministratore ha permesso all’app di leggere il numero della politica.meta_data.schemadescrive i campi presenti in ciascuna pagina.hidden_moduleselenca le sezioni nascoste in questo caso, nel caso in cui ce ne siano.
Cambiare un caso
PUT /case accetta qualsiasi di questi campi come input JSON; inoltre, modifica soltanto quei campi che vengono effettivamente inviati.
| Campo | Cosa fa | Necessario | Predefinito |
|---|---|---|---|
title | Il nome del caso, mostrato a tutti. | No. | Inalterato |
description | Descrizione per il personale: inviare "" per eliminarla. | No. | Inalterato |
date_opened | La data in cui il caso è stato aperto, ad esempio 2026-03-15 | No. | Inalterato |
case_status | 0 Per chiudere il caso… Una chiave di hub non può riaprirlo. | No. | Inalterato |
case_stage | L’ID della piattaforma è GET /v1/<hub id>/stages. Inviate "" per rimuovere l’oggetto dalla piattaforma. | No. | Inalterato |
meta_data | Valori dei campi personalizzati: una lista contenente un oggetto per ogni pagina relativa a un campo. Ogni oggetto rappresenta i valori associati a quel campo. È possibile modificare soltanto la prima pagina, e solo i campi che si desiderano modificare. Per eliminare un campo, basta inviare "" o null; i campi obbligatori non possono essere eliminati. | No. | Inalterato |
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"}]}'
Il risultato è 200, corrispondente all’ID del caso. Se alcun campo inviato non è uno dei campi indicati come “chiave”, allora il valore di quel campo può cambiare. In tal caso, l’intera richiesta viene rifiutata con lo status 403; inoltre, nulla viene modificato. reason indica i campi da utilizzare; uno di questi è un campo personalizzato, indicato come meta_data.<field key>. Un campo inviato con un valore già presente nel caso non rappresenta una modifica, quindi né viene rifiutato né scritto alcun dato. Una richiesta che non apporta alcuna modifica risponde a 204.
- Spostare un caso aperto in una fase successiva significa che il relativo messaggio di avviso viene inviato automaticamente, se il tuo hub dispone di tale funzione. Per ulteriori informazioni, consulta “Aggiungere un messaggio automatico quando un caso raggiunge una fase specifica”. Niente altro viene inviato o comunicato: chiudere un caso o modificare i suoi dettagli non avviene in modo trasparente.
- Una volta che un caso viene chiuso, ogni tipo di modifica effettuata tramite la chiave di accesso viene negata, comprese le operazioni per riaprire il caso. È possibile riaprire il caso utilizzando l’interfaccia amministrativa o una chiave di gestione specifica. Per ulteriori informazioni, vedere Chiudere o riaprire un caso.
- L’ID del tag e il tipo di caso non possono essere modificati qui; è possibile modificare il tipo tramite una chiave di gestione.
La squadra
GET /team elenca tutti i membri coinvolti nel caso, compreso l’Assistente Virtuale e i membri disabili. Un caso può contenere al massimo 20 persone. È stato calcolato questo numero dall’Assistente Virtuale.
{
"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_idrappresenta il ruolo della persona in questo caso;case_designationinvece indica la sua designazioneDesignazione Un'etichetta che identifica il ruolo di una persona all'interno di un caso, come ad esempio Avvocato responsabile, Assistente legale o Tutore., ad esempioprimary.host_user_statusè uguale a0per qualcuno che è disabile nel tuo hub.- I nomi di ogni persona, il linguaggio utilizzato (
locale) e la zona horaria (zoneinfo) vengono restituiti per impostazione predefinita. Gli indirizzi email e i numeri di telefono, invece, non vengono mai restituiti. - Una chiave “hub” non può aggiungere o rimuovere persone: quelle chiamate vengono risposte tramite i codici 403
HostAddCaseUserNotEnabledExceptioneHostRemoveCaseUserNotEnabledException. È necessario utilizzare una chiave di gestione per effettuare tali operazioni; vedere “Aggiungere e rimuovere membri del caso con una chiave di gestione”.
valori modello
GET /placeholders Risposte, sotto… placeholders, Il valore che ogni codice presente nei tuoi template fornisce in questo caso, ad esempio… clients.primary.full_name, clients.primary.email, case_ref_id E… company.phone. Viene lasciato fuori il codice relativo a una denominazione che nessuno conosce per quel caso. Quando la sezione relativa al “Team” è disattivata o nascosta per quel caso, tutti i codici relativi ai team vengono eliminati; tuttavia, il resto dei codici continua comunque a essere visualizzato. Vedi… Compila i campi del modulo con i dettagli relativi al caso in questione..
Se una chiamata viene rifiutata
| Stato | message | Perché |
|---|---|---|
| 400 | SchemaFieldsException | Il campo è invano, ad esempio un title vuoto, un campo personalizzato obbligatorio inviato vuoto, oppure una fase che il proprio hub non possiede; errors ne indica il nome. |
| 403 | CaseFieldNotWritableException | Il campo che hai inviato non è uno dei campi chiave; reason lo indica come tale. |
| 403 | CaseClosedException | Il caso è chiuso. |
| 403 | HostModuleDisabledException | I dettagli legati a questo caso o al team che lo gestisce sono nascosti su di esso; inoltre, tali informazioni sono disattivate per il tuo hub. |
| 403 | CaseModulePermissionDeniedException | Il ruolo dei bot potrebbe non permettere loro di leggere i dettagli del caso o delle informazioni riguardanti il team. |
| 404 | CaseNotFoundException | Quel caso non esiste affatto. Potrebbe appartenere a un altro hub, oppure è stato cancellato. |
Per informazioni sul corpo dell’errore e sugli altri codici, si veda Comunicare gli errori dell’API e i codici di stato.