Centro assistenzaIntegrazioni

Per: Amministratori

Cerca casi e utenti con una chiave di gestione

Trova casi, persone, membri del caso, ruoli e importa righe tramite testo, con filtri, dal tuo software.

In questo articolo6 sezioni

Prima di iniziare

Questa pagina riguarda l’opzione GET https://prd-api-manage.caseactive.com/v1/<hub id>/search, che permette di trovare i record presenti nel proprio hub, basandosi sul testo. Questa funzione effettua le ricerche soltanto all’interno del proprio hub.

Parametri

ParametroCosa faNecessarioPredefinito
tableCosa cercare: cases, host_users, case_users, host_roles, case_invoices, host_imports o import_itemsSì.–
queryIl testo da cercare: * corrisponde a tutto, per una ricerca effettuata soltanto in base ai filtri.Sì.–
query_byI campi di testo da verificare, separati da virgole. Ad esempio: given_name,family_name,emailSì.–
filter_byUna condizione, ad esempio case_status:=1. È necessario ripetere il parametro per aggiungere altri elementi; tutti i parametri devono essere validi.No.Nessuno
sort_byUn campo numerico e una direzione, ad esempio created_on:descNo.Miglior combinazione possibile
pageQuale pagina?No.1
limitI risultati presenti su una pagina possono raggiungere un massimo di 250 elementi.No.10
  • Una parola in query può corrispondere anche a parti del testo che iniziano con quella parola; quindi è possibile che ci siano degli errori di scrittura. Inoltre, jan permette di trovare “Jane”. Nei nomi, indirizzi email, numeri di telefono e ID di riferimento, il pattern può trovarsi in qualsiasi posizione del testo; quindi end-2026 può trovare rear-end-2026.
  • Un filtro è composto da un campo, un operatore e un valore: := indica “esatto”, :!= indica “no”, mentre :>, :<, :>= e :<= indicano dei numeri. Una condizione non può contenere elementi come &&, ||, parentesi o virgole; in tal caso, è meglio utilizzare più parametri filter_by. Un valore può contenere elementi come / e +; ad esempio, ref_id:=2026/rear-end o phone:=+15551234567. In un indirizzo, è possibile utilizzare + come %2B; in questo caso, il risultato viene rappresentato da uno spazio.
  • Solo i campi numerici possono essere ordinati. Le date presenti nei risultati sono espressa in secondi Unix.
  • Può volerci qualche minuto affinché un record venga visualizzato, dopo che è stato creato o modificato.
  • Le ricerche non possono essere effettuate utilizzando una chiave.

Tavoli

tableCampi di testo per cercare e filtrareCampi numerici per filtrare e ordinare
casescase_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.), title, description, case_type, case_stage, users (ID degli utenti dei membri)case_status (1 Aperto, 0 Chiuso). users_ct, date_opened, created_on, last_activity, updated_on
host_usersuser_id, given_name, family_name, email, phone, host_ref_id, title, company, address1, address2, locality, region, postal_code, country, gender, birthdate_md (mese e giorno, ad esempio 04-12), locale, zoneinfo, host_user_type, host_granted_status, host_default_role, host_staff_designationhost_user_status (1 attivo, 0 disattivo), host_cases_ct, email_verified, phone_verified, created_on, updated_on
case_userscase_id, user_id, case_ref_id, case_role_id, e anche i valori di title e description del caso in questione.case_status, created_on, updated_on
host_rolesrole_id, name, role_type, permissions, case_read_fields, case_write_fieldsusers_ct, created_on, updated_on
case_invoicesinvoice_id, name, invoice_number, po_number, host_ref_id, description, notes, status (open, paid, void, uncollectible o processing), status_reason, payment_gateway, case_id, user_id, participants_ids, refund_status (pending, succeeded, failed o canceled), refund_reason, completed_on_daytotal, subtotal, discount, tax, refund_amount, payment_attempts_ct, due_date, completed_on, created_on, updated_on
host_importsimport_id, name, source, type, user_id, statustotal, passed, failed, created_on, updated_on
import_itemsimport_id, unique_id, type, status, error_msg, error_recordcreated_on, updated_on

host_users include l’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. del proprio hub; il suo host_user_type è bot. case_users non contiene alcun nome: bisogna trovare la persona corrispondente in host_users, poi filtrare i dati riguardanti case_users utilizzando user_id come criterio di selezione. case_invoices contiene soltanto fatture pubblicate; le loro somme sono espressa in centesimi, mentre tax e discount rappresentano frazioni. Una fattura rimborsata conserva i dati status e paid; il rimborso avviene tramite refund_status.

Esempi

Un caso, in base all’ID di tag a cui è associato:

curl -G https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "table=cases" \
  --data-urlencode "query=*" \
  --data-urlencode "query_by=ref_id" \
  --data-urlencode "filter_by=ref_id:=rear-end-2026"

Persone attive il cui nome o indirizzo e-mail inizia con jane. Ordine di presentazione: i più recenti per primi.

curl -G https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "table=host_users" \
  --data-urlencode "query=jane" \
  --data-urlencode "query_by=given_name,family_name,email" \
  --data-urlencode "filter_by=host_user_status:=1" \
  --data-urlencode "sort_by=created_on:desc"

Aprire i casi in un singolo stadioPalcoscenico 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., utilizzando una stage_id proveniente da GET /stages: table=cases&query=*&query_by=title&filter_by=case_status:=1&filter_by=case_stage:=stage::20260927120000_8c1f0e2d3b4a59.

Le fatture sono state modificate a partire dalla mezzanotte del 8 ottobre 2026, secondo il fuso orario UTC. I cambiamenti più antichi vengono visualizzati per primo: table=case_invoices&query=*&query_by=name&filter_by=updated_on:>1791417600&sort_by=updated_on:asc.

Risultati

{
  "data": {
    "found": 1,
    "page": 1,
    "hits": [
      {
        "document": {
          "case_id": "cc-1a2b3c4d5e6f70",
          "host_id": "ca-7e6d5c4b3a2f10",
          "ref_id": "rear-end-2026",
          "title": "Jane Sample auto accident",
          "case_type": "general",
          "case_status": 1,
          "users": ["cu-4f1c2a9e8b7d60", "cu-9d8c7b6a5f4e30"],
          "users_ct": 2,
          "date_opened": 1790899200,
          "created_on": 1790949909,
          "updated_on": 1790949909
        }
      }
    ]
  }
}

found Quanti record corrispondono a questo valore? Ogni risultato positivo… document È il record che viene mostrato; inoltre, i risultati ottenuti vengono indicati anche nei campi di punteggio del motore di ricerca stesso. Questi campi possono essere ignorati. Non c’è nulla di più… nextLink: Chiedere il prossimo. page Fino a quando non lo avrai fatto. found Risultati.

La ricerca di parole può anche individuare valori simili. Quindi, quando si cerca un record in base a un identificatore specifico, è necessario verificare il risultato ottenuto da document.

Se una chiamata viene rifiutata

StatomessagePerché
400SchemaFieldsExceptiontable, query o query_by sono mancanti o sconosciuti; inoltre, un filter_by contiene caratteri che non possono essere utilizzati. (FieldSearchFilterTypeException, a filter_by.0 per il primo).
400SearchParameterExceptionIl motore di ricerca lo ha rifiutato: si tratta di un campo sconosciuto, un filtro che non può essere interpretato, oppure un campo di testo situato in sort_by. Inoltre, il valore di limit supera i 250 caratteri. reason contiene invece le parole proprie del motore di ricerca.
403BotSearchTableNotAllowedExceptionHai chiesto di host_inquiries, ma una chiave non può cercare quel valore.
500InternalErrorIl motore di ricerca è indisponibile per il momento. Provi a farlo di nuovo in un altro momento.

Articoli correlati

Crea e aggiorna i casi con una chiave di gestioneElenca, crea, leggi, aggiorna ed elimina i casi del tuo hub dal tuo software, inclusi i relativi campi di fase e personalizzati.IntegrazioniAggiungi e aggiorna gli utenti con una chiave di gestioneVisualizza l'elenco dei membri del tuo hub, aggiungi clienti, visualizza i dettagli e i casi di un utente e disabilita o riabilita il suo accesso.Integrazioni