Per: Amministratori
Crea e aggiorna i casi con una chiave di gestione
Elenca, crea, leggi, aggiorna ed elimina i casi del tuo hub dal tuo software, inclusi i relativi campi di fase e personalizzati.
In questo articolo10 sezioni
Prima di iniziare
Questa pagina tratta del caso in cui una chiave di gestione può essere utilizzata per gestire determinate situazioni. I percorsi sono indicati sotto https://prd-api-manage.caseactive.com/v1/<hub id>.
Chiamate
| Chiamata | Cosa fa |
|---|---|
GET /cases | Elenca i casi presenti nel tuo hub, con i più recenti in primo piano. |
POST /cases | Si crea una situazione specifica/circostanza. |
GET /cases/<case_id> | Legge un caso specifico. |
PUT /cases/<case_id> | Cambia la casella di caratteri. |
DELETE /cases/<case_id> | Elimina un caso per sempre. |
GET /stages | Elenca le fasi del proprio hub, per poter trovare i loro identificativi. |
GET /schemas?schema_type=cases | Leggi i campi personalizzati relativi alla situazione del tuo hub. |
Elenco dei casi
| Parametro | Cosa fa | Necessario | Predefinito |
|---|---|---|---|
type | 1 serve per i casi aperti soltanto; 0 invece, per i casi chiusi. Nonostante il nome, il filtro si basa sullo stato del caso, non sul tipo di caso stesso. | No. | Entrambi |
limit | Quanti elementi possono essere presenti su una pagina, fino a 1000. | No. | 20 |
start_key | Il startKey della pagina precedente | No. | Prima pagina |
curl "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?type=1" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"items": [
{
"case_id": "cc-1a2b3c4d5e6f70",
"host_id": "ca-7e6d5c4b3a2f10",
"ref_id": "rear-end-2026",
"title": "Jane Sample auto accident",
"case_type": "general",
"case_status": 1,
"case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
"users": {
"cu-7e6d5c4b3a2f10": "role::bots",
"cu-4f1c2a9e8b7d60": "role::clients",
"cu-9d8c7b6a5f4e30": "role::staff"
},
"created_on": "2026-10-02T14:05:09+00:00"
}
],
"currentItemCount": 1,
"selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?type=1"
}
}
usersPer ogni persona coinvolta nel caso, viene assegnato un “mappe” specifica. RuoloRuolo Un insieme di autorizzazioni che determina cosa una persona può vedere e fare su un caso, ad esempio il personale o i clienti.. Include il 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., comerole::bots.- Anche se ci sono ancora molti casi da gestire, la pagina contiene anche i valori
nextLink, che rappresentano l’indirizzo completo della pagina successiva, estartKey. È possibile chiamarenextLink, oppure inviarestartKeycomestart_key, fino a quando non viene restituita una pagina senza questi valori. - I casi che vengono eliminati vengono esclusi dalla lista. Per trovare un caso in base al suo ID della 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., consultare la sezione Recerca di casi e utenti utilizzando una chiave di ricerca.
Casi di studio
POST /cases e PUT /cases/<case_id> considerano questi campi come dati in formato JSON. I campi non elencati vengono ignorati.
| Campo | Cosa fa | Necessario | Predefinito |
|---|---|---|---|
ref_id | L’ID del caso è composto da lettere, numeri, trattini e barre. Tutti questi elementi devono essere scritti in minuscolo. Nessun caso può condividere lo stesso ID con altri casi. Questo identificatore viene impostato soltanto al momento della creazione del caso; non può essere modificato in seguito. | Sì, per creare… | – |
title | Il nome del caso, mostrato a tutti. | Sì, per creare… | – |
description | Descrizione per il personale: i clienti non lo vedono. In caso di modifiche, "" lo elimina. | No. | Nessuno |
case_type | general, O uno dei vostri “hub”. Tipi di casiTipo di caso Una categoria per i casi, come ad esempio "generale", utilizzata per indirizzare le automazioni verso i casi appropriati., Si scrive come segue: impostazioni › Campi. È cambiato il tipo di oggetto in questione; questo tipo è comunque accettato, anche dopo averlo rimosso dalle impostazioni personali. | No. | general |
case_status | 1 per lo stato “aperto”, 0 per lo stato “chiuso”. | No. | 1 |
case_stage | L’ID della sua 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. è indicato da GET /stages. In caso di modifica, "" rimuove quella fase dalla sua posizione. | No. | Nessuna fase |
date_opened | La data in cui il caso è stato aperto, ad esempio 2026-03-15 | No. | Oggi, nel fuso orario UTC. |
hidden_modules | Le sezioni da nascondere in questo caso sono: case, convos, events, forms, signs, invoices, notes, tasks e team. Invia [] per rivelarle tutte nuovamente. | No. | Nessun elemento nascosto/non visibile. |
meta_data | I suoi campi personalizzati… vedere qui sotto. | No. | Nessuno |
Non è possibile aggiungere persone durante la creazione di un nuovo caso. Solo l’Assistente Virtuale può essere aggiunto a un nuovo caso. Per aggiungerne altre, utilizzare POST /cases/permissions. Per ulteriori informazioni, vedere “Aggiungere e rimuovere membri dei casi con la funzione ‘Manage’”.
Creazione di un caso
curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"ref_id": "rear-end-2026", "title": "Jane Sample auto accident", "case_type": "general", "date_opened": "2026-10-02"}'
Risponde a 201 con l’ID del nuovo caso.
{"data": {"case_id": "cc-1a2b3c4d5e6f70", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases"}}
Nessuno riceve email. Le regole per l’assegnazione dei casi prevedono che, per ogni caso e per il tipo di caso stesso, venga assegnato un personale competente a quel caso. Pertanto, se si aggiunge un nuovo membro del personale per gestire quel caso, tale membro verrà considerato già esistente e quindi non potrà essere assegnato nuovamente al caso. I casi creati in una fase specifica non ricevono alcun messaggio di notifica.
Leggere un caso
GET /cases/<case_id> Risponde alla questione sollevata nel caso in questione. case_id, host_id, ref_id, title, description, case_type, case_status, case_stage, date_opened, hidden_modules, meta_data, users_ct Quanti persone sono coinvolte in questo progetto? Include anche l’assistente virtuale. created_on E… updated_on. Per sapere chi è coinvolto in questa situazione, utilizzare… GET /cases/permissions?case_id=<case_id>.
Cambiare un caso
PUT /cases/<case_id> può utilizzare qualsiasi campo di tipo “case”, ma non ref_id. Inoltre, cambia soltanto quei valori che vengono inviati. 204 viene risposto senza alcun effetto particolare.
- Spostare un caso aperto in una fase aggiunge il relativo post di milestone per quella fase. Inoltre, se il tuo hub dispone di una funzione per questo scopo, allora… vedi qui. Aggiungere un messaggio automaticamente quando una situazione raggiunge una determinata fase.. Nient’altro viene pubblicato o inviato: chiudere un caso o cambiare il suo tipo non riguarda nessuno.
meta_datasostituisce ogni campo personalizzato presente nel caso in questione.- Un caso chiuso può comunque essere modificato; quindi, è possibile riaprirlo utilizzando
"case_status": 1.
Fasi e campi personalizzati
GET /stages elenca le fasi del proprio hub. Queste fasi vengono configurate dall’amministratore all’interno di impostazioni › Fasi. Ogni fase è identificata con i valori stage_id, name, description e order. Un utente può leggere le informazioni relative alle fasi, ma non può modificarle.
GET /schemas?schema_type=cases utilizza i campi personalizzati del tuo hub, definiti sotto impostazioni › Campi, come una lista di pagine. Ogni pagina contiene le chiavi dei campi, i loro titoli e i tipi di dati che vengono memorizzati in quelle pagine. Il messaggio meta_data viene inviato sotto forma di lista, con un oggetto per ogni pagina. I valori vengono memorizzati seguendo l’ordine indicato nei campi.
{"meta_data": [{"policy_number": "PN-5521", "insurer": "Northwind Mutual"}]}
Un valore deve essere compatibile con il tipo del campo a cui appartiene; altrimenti, la richiesta viene rifiutata. necessario viene verificato soltanto dalle form di controllo presenti nel Pannello Amministrativo e nell’Area di Controllo. Pertanto, i dati inseriti qui possono lasciare vuoti i campi obbligatori.
Eliminazione di un caso
DELETE /cases/<case_id> risponde a 204. In questo caso, le liste vengono eliminate definitivamente, insieme ai relativi post, file, moduli, documenti elettronici, fatture, eventi, task e note. Non è possibile annullare questa operazione, e nessuno viene informato del fatto che le liste sono state eliminate. Il ID della tag utilizzata per identificare l’elemento eliminato torna a essere disponibile dopo l’esecuzione dell’operazione di eliminazione.
Se una chiamata viene rifiutata
| Stato | message | Perché |
|---|---|---|
| 400 | SchemaFieldsException | Il campo è mancante o non valido; errors ne indica il nome. Un tipo di caso o una fase sconosciuta si trova in FieldValidatorFailedException quel campo. |
| 400 | CaseReferenceIdExistsException | C’è un altro caso che già possiede quell’ID di tag; anzi, uno di questi casi è ancora in fase di eliminazione. reason contiene i dati relativi a quel caso, specificati nell’elemento case_id. |
| 404 | ItemNotFoundException | Quel caso non esiste affatto. Potrebbe appartenere a un altro hub, oppure è stato cancellato. |
| 403 | ManageBillingInactiveException | Il pannello di controllo del tuo hub è bloccato dopo un tentativo di pagamento fallito. |
Per informazioni sul corpo dell’errore e sugli altri codici, si veda Comunicare gli errori dell’API e i codici di stato.