Dla: Administratorzy
Wyszukaj przypadki i użytkowników za pomocą klucza zarządzania
Znajdź sprawy, osoby, członków sprawy, role i importuj wiersze według tekstu, używając filtrów, z własnego oprogramowania.
W tym artykule6 sekcji
Zanim zaczniesz
Ta strona pokazuje informacje o GET https://prd-api-manage.caseactive.com/v1/<hub id>/search – program ten znajduje dane w twoim systemie za pomocą tekstu. Program ten skanuje tylko twoje własne dane.
Parametry
| Parametr | Co to robi | Wymagany | Domyślny |
|---|---|---|---|
table | Co należy sprawdzić: cases, host_users, case_users, host_roles, case_invoices, host_imports lub import_items | Tak. | – |
query | Tekst do wyszukiwania: * pasuje do wszystkich elementów, bez względu na filtry używane do wyszukiwania. | Tak. | – |
query_by | Pola tekstowe, które należy sprawdzić, oddzielone klamerkami, np. given_name,family_name,email | Tak. | – |
filter_by | Jedna z warunków to np. case_status:=1. Należy powtórzyć ten parametr, aby dodać więcej takich warunków; wszystkie muszą być spełnione. | Nie | Żadnego. |
sort_by | Pole i kierunek, np. created_on:desc | Nie | Najlepszy wybór |
page | Która strona? | Nie | 1 |
limit | Na jednej stronie może znajdować się maksymalnie 250 elementów. | Nie | 10 |
- Słowo w
querypasuje od początku, więc może być wprowadzone z błędami typograficznymi. Dlategojanznajduje słowo „Jane”. W identyfikatorach tagów, nazwach, adresach e-mailowych, numerach telefonów oraz identyfikatorach referencyjnych słowo może pasować również w dowolnym miejscu. Dlategoend-2026znajdujerear-end-2026. - Filtr stanowi pole, operator oraz wartość:
:=oznacza „dokładnie takie”,:!=oznacza „nie”, a:>,:<,:>=i:<=odnoszą się do liczb. Warunek nie może zawierać symboli typu&&,||, nawiasów ani kółek; w takim przypadku należy użyć kilku parametrów typufilter_by. Wartość może zawierać elementy typu/i+; np.ref_id:=2026/rear-endlubphone:=+15551234567. W adresach należy przesłać+jako%2B, inaczej otrzymamy spację jako rezultat. - Tylko pola liczbowe mogą być sortowane. Dni w wynikach są wyrażone w sekundach według standardu Unixa.
- Po utworzeniu lub zmianie danych, rekord może potrwać kilka minut, zanim się pojawi.
- Pytania nie można szukać za pomocą klucza.
Tabele
table | Pola tekstowe do wyszukiwania i filtrowania | Pola liczbowe do filtrowania i sortowania |
|---|---|---|
cases | case_id, ref_id (tak) ID tagaIdentyfikator tagu Trwała etykieta nadawana obudowie, np. rear-end-2026, wyświetlana również jako ID referencyjne i używana przy imporcie.), title, description, case_type, case_stage, users ID użytkowników członków | case_status (1 otwarte, 0 zamknięte), users_ct, date_opened, created_on, last_activity, updated_on |
host_users | user_id, given_name, family_name, email, phone, host_ref_id, title, company, address1, address2, locality, region, postal_code, country, gender, birthdate_md (miesiąc i dzień, np. 04-12), locale, zoneinfo, host_user_type, host_granted_status, host_default_role, host_staff_designation | host_user_status (1 aktywne, 0 wyłączone), host_cases_ct, email_verified, phone_verified, created_on, updated_on |
case_users | case_id, user_id, case_ref_id, case_role_id oraz title i description w tym przypadku. | case_status, created_on, updated_on |
host_roles | role_id, name, role_type, permissions, case_read_fields, case_write_fields | users_ct, created_on, updated_on |
case_invoices | invoice_id, name, invoice_number, po_number, host_ref_id, description, notes, status (open, paid, void, uncollectible lub processing), status_reason, payment_gateway, case_id, user_id, participants_ids, refund_status (pending, succeeded, failed lub canceled), refund_reason, completed_on_day | total, subtotal, discount, tax, refund_amount, payment_attempts_ct, due_date, completed_on, created_on, updated_on |
host_imports | import_id, name, source, type, user_id, status | total, passed, failed, created_on, updated_on |
import_items | import_id, unique_id, type, status, error_msg, error_record | created_on, updated_on |
host_users obejmuje Wirtualnego AsystentaAsystent wirtualny Automatyczny członek zespołu, który publikuje wiadomości powitalne, meldunki i wpisy dotyczące etapów rozwoju firmy. Jego wpisy są oznaczone odznaką wirtualnego asystenta. znajdującego się w twoim centrum. Jego host_user_type wynosi bot. case_users nie zawiera żadnych nazw. Należy znaleźć osobę w host_users, a następnie filtrować case_users według user_id. case_invoices zawiera tylko wydane faktury. Ich kwoty są wyrażone w centach, a tax i discount to ułamki. Faktura zwrócona z powodu zwrotu pieniędzy zachowuje status i paid; zwrot pieniędzy odbywa się w refund_status.
Przykłady
Przypadek według identyfikatora Tag:
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"
Osoby aktywne, których nazwiska lub adresy e-mail zaczynają się na jane. W kolejności według najnowszej daty:
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"
Otwórz sprawy w jednym momencie. etapScena Etap, przez który przechodzi sprawa, taki jak Przyjęcie lub Wysłanie żądania, który firma nazywa i opisuje, a który jest wyświetlany na stronie sprawy., używając stage_id od GET /stages: table=cases&query=*&query_by=title&filter_by=case_status:=1&filter_by=case_stage:=stage::20260927120000_8c1f0e2d3b4a59.
Faktury zostały zmienione od północy 8 października 2026 roku według czasu UTC. Najstarsze zmiany znajdują się na początku listy: table=case_invoices&query=*&query_by=name&filter_by=updated_on:>1791417600&sort_by=updated_on:asc.
Wyniki
{
"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 Ile takich rekordów się zgadza. Każdy przypadek… document To jest rekord; także wpisy zawierają własne pola ocenowe wyszukiwarki, które można pominąć. Nie ma żadnych innych informacji. nextLink: Proszę o następnego. page aż do momentu, gdy to się stanie found Wyniki.
Wyszukiwanie słów może również doprowadzić do wyników z podobnymi wartościami. Dlatego, gdy szukasz danego rekordu za pomocą identyfikatora, należy sprawdzić także inne elementy danych. document Wróć do mnie.
Jeśli połączenie zostanie odrzucone
| Status | message | Dlaczego |
|---|---|---|
| 400 | SchemaFieldsException | table, query lub query_by są nieobecne lub nieznane. Również filter_by może zawierać znaki, których nie może używać (FieldSearchFilterTypeException, w miejscu filter_by.0 dla pierwszego elementu). |
| 400 | SearchParameterException | Sprzęt do wyszukiwania odrzucił tę datę: to nieznana pola, filtr, który nie może być odczytany, tekst znajdujący się w polu sort_by, albo pole limit o rozmiarze powyżej 250. Pole reason zawiera słowa samego sprzętu do wyszukiwania. |
| 403 | BotSearchTableNotAllowedException | Proszłeś o host_inquiries, ale klucz nie może go znaleźć. |
| 500 | InternalError | Sprzęt do wyszukiwania danych jest nieaktualny. Spróbuj ponownie później. |