Centrum pomocyIntegracje

Dla: Administratorzy

Uruchom import z kluczem zarządzającym

Utwórz import, prześlij plik CSV i załącz go, a następnie sprawdź każdy wiersz i spróbuj ponownie w przypadku tych, które nie zostały przetworzone.

W tym artykule9 sekcji

Zanim zaczniesz

Ta strona opisuje procedurę wykonania importu za pomocą klucza „manage”. To samo co w sekcji Integration › Imports. Wszystkie dane znajdują się pod tagiem https://prd-api-manage.caseactive.com/v1/integration/<hub id>. Informacje dotyczące kolumn pliku można znaleźć w sekcji Kolumny potrzebne do realizacji poszczególnych operacji importu.

Połączenia

DzwonićCo to robi
POST /importsTworzy element importu.
GET /drive/private?import_id=<id>&media_group=docs&media_extension=csvPrzesyła wiadomość z poleceniem załadowania pliku.
PUT /imports/<import_id>Przykłada plik załączony do systemu, co zapoczątkowuje proces importu.
GET /importsLista twoich importów, najnowszych na początku, z informacjami o ich postępach.
GET /imports/<import_id>Wyświetla wyniki importu.
PUT /imports/<import_id>/<unique_id>Próbuje ponownie realizacji nieudanej operacji.

1. Utwórz import

PoleCo to robiWymagany
nameNazwa tego elementu: litery, cyfry, spacje i kropki.Tak.
sourceCo to jest „claims-sync”? Wygląda na element źródłowy w panelu administracyjnym.Tak.
typeJedna z poniższych kategoriiTak.
typeNa ekranie
post_userDodawanie użytkowników
put_userModyfikacja użytkowników
post_caseTworzenie przypadków
put_caseModyfikujemy przypadki
post_case_permissionPrzydzielanie użytkowników do spraw
delete_case_permissionUsuń użytkowników przydzielonych do poszczególnych spraw.
post_case_postTworzenie postów w ramach sprawy
curl -X POST https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "October claimants", "source": "claims-sync", "type": "post_user"}'

Odpowiada na 201 za pomocą import_id, np. import::20261002141503_3f9a1c2b7d4e60.

2. Prześlij plik

Proszę o podanie adresu do wczytania plików. GET /drive/private?import_id=<import_id>&media_group=docs&media_extension=csv. Odpowiada na to. url i zestaw fields. Niech plik zostanie wysłany tam jako… multipart/form-data POST, wraz z każdym wpisem… fields Właśnie tak, jak zostało napisane. Plik znajduje się w tym miejscu. file:

curl -X POST "<url>" \
  --form-string "key=<fields.key>" \
  --form-string "<every other entry of fields, as given>" \
  -F "file=@october-claimants.csv"
  • Niech wpisy zawierający fields są wysyłane razem z --form-string, a nie z -F. Niektóre wpisy zaczynają się od <, a inne zawierają ;. -F interpretuje te elementy jako pliki lub opcje.
  • Adresator działa przez jeden godzinę.
  • Zachowaj plik w formacie CSV z kodem nadawanym na UTF-8. Nazwy kolumn powinny znajdować się w pierwszej kolejności.
  • Plik może zawierać do 25 000 wierszy pod nazwami kolumn. Pliki o większej długości nie mogą być importowane – nic się nie importuje. Zaleca się więc rozdzielić pliki na takie, które zawierają po 25 000 wierszy lub mniej, a następnie importować każdy z tych plików osobno.
  • Zachowaj fields.key: w ten sposób przyczepisz plik następnie.

3. Dołącz plik

PUT /imports/<import_id> za pomocą klucza związanego z plikiem przesyłanym zaczyna proces importu. Klucz ten odpowiada na pytanie 204.

{"media_key": "<fields.key>"}

Należy załączyć tylko jeden plik. Jeśli import nie udaje się, należy poprawić plik i przeprowadzić nowy import.

4. Sprawdź postęp

GET /imports wyświetla listę twoich importów, w kolejności od najnowszego do najstarszego. Dla każdego importu podano informacje o jego status, total, passed i failed.

  • QUEUED: zostało utworzone lub przyczepione, ale jeszcze nie zostało przeczytane.
  • PROCESSED: plik został przeczytany w total wierszach. Proces ten odbywa się jeden po drugim. Całość zakończy się, gdy passed i failed sumują się do wartości total.
  • FAILED: plik nie został odczytany, nie zawiera żadnych danych, lub liczba danych przekracza 25 000. error_msg wskazuje, który z pól jest niespójny: ImportFileUnreadableException, ImportFileEmptyException czy ImportFileTooLargeException.

Wyjścia w twoim hubie następują co drugie podczas importu, więc duży plik potrzebuje trochę czasu na przetworzenie. Administratorzy i menedżerowie twojego hubu otrzymują e-maile, gdy dochodzi do niepowodzenia przy importowaniu lub przy pierwszym wyjściu z procesu importu.

GET /imports/<import_id> wyświetla wiersze, które zostały przetworzone, w kolejności, w jakiej znajdują się w pliku. W tym celu użyto symboli limit (do 1000 wierszy) i start_key.

{
  "data": {
    "items": [
      {
        "unique_id": "unique::20261002141503_3f9a1c2b7d4e60_0000002",
        "line": 2,
        "type": "post_user",
        "status": "SUCCEEDED",
        "data": {"username": "jane.sample@example.com", "given_name": "Jane", "family_name": "Sample", "host_ref_id": "cl-1042"},
        "output": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60"}
      }
    ],
    "currentItemCount": 1,
    "selfLink": "https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports/import::20261002141503_3f9a1c2b7d4e60"
  }
}
PoleCo zawiera
lineNumer wiersza w twoim pliku, tak jak to robią arkusze danych – nazwy kolumn stanowią pierwszy wiersz.
dataKomórki wiersza, tak jak zostały przesłane…
statusSUCCEEDED, FAILED lub QUEUED, podczas gdy czeka się na ponowne próbę.
outputTo, co powstało w rezultacie tego procesu: elementy user_id, case_id, albo oba te elementy, w przypadku wiersza, który sprawił, że ktoś został umieszczony w jakiejś sytuacji.
schema_errorsDla komórki, która nie przeszła kontroli: kolumna, oraz to, co się stało.
error_msgDlaczego ta próba nie powiodła się, jako nazwa błędu, np. CaseReferenceIdExistsException

Wiersz jest uznawany za udane tylko wtedy, gdy przynosi żądany efekt. Wiersz, który ma identyfikator Tag ID, Reference ID lub informacje o osobie, które występują w sprzeczności z innym rekordem, nie udaje się – nazwa rekordu w takim przypadku znajduje się w tagach error_msg. Wiersz polegający na przydzielaniu użytkowników do spraw lub tworzeniu postów dotyczących spraw, którym nadano nazwę zamkniętej sprawy, również nie udaje się – w takim przypadku widnieje komunikat {"_schema": ["Case is closed"]} w tagach schema_errors. W takiej sytuacji należy ponownie importować ten wiersz.

I rzut… unique_id Składa się z identyfikatora importu oraz numeru wiersza w twoim pliku. Więc wiersz nr 2… import::20261002141503_3f9a1c2b7d4e60 to unique::20261002141503_3f9a1c2b7d4e60_0000002.

5. Spróbuj ponownie wiersz

PUT /imports/<import_id>/<unique_id> z {"retry": true} ponownie wykonuje błędną operację – dokładnie tak samo jak poprzednio, na końcu kolejki. Odpowiada na polecenie 204, a liczba elementów w pliku failed spada o jeden, aż cała operacja zostanie ukończona. Można to użyć do usuwania błędów, które wystąpiły z powodu braku czasu na wykonanie operacji, np. gdy plik jest zbyt duży. Błędy w elementach pliku powodują ponowny błąd: należy poprawić plik i rozpocząć nową operację importu.

Co się stanie dalej?

Wiersze z importu robią to samo co wiersze na ekranie: osoby dodane do listy nie otrzymują wiadomości e-mailowych. Osoby, które zostały dodane do listy poprzez zaproszenie, otrzymują tę informację. Nowe sprawy są obsługiwane zgodnie z zasadami określonymi w regulaminie „Assign Cases”. Nowe komentarze informują o tym osoby związane z tą sprawą. Import jest rejestrowany jako część systemu, który jest używany do zarządzania sprawami. Wirtualny asystentAsystent 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.Wysyłanie tego samego pliku dwa razy powoduje ponowne wykonywanie każdej wersji tego pliku. Wersje, które się pokrywają z pierwszym przeprowadzeniem, nie udaje się, a wiadomości są wysyłane dwa razy. Aby naprawić takie sytuacje na ekranie, patrz… Należy ustalić import z danymi, które nie spełniają wymogów..

Jeśli połączenie zostanie odrzucone

StatusmessageDlaczego
400SchemaFieldsExceptionW tym polu brakuje jakiegoś elementu lub ten jest nieprawidłowy. Na przykład name z innymi znakami, albo media_key bez żadnego danych włożonych do tego pola.
403ImportFileAlreadyAttachedExceptionWartości wniesione do importu są już zapisane w pliku, lub zostały już przeczytane. Należy więc rozpocząć nowy proces importu.
403BotNotAllowedExceptionUżyłeś /v1/<hub id>/imports zamiast /v1/integration/<hub id>/imports.
404ItemNotFoundExceptionNie ma żadnego znaczenia, ani żadnej potrzeby, aby ten identyfikator był obecny w twoim systemie.

Powiązane artykuły

Wyszukaj kolumny potrzebne do każdego importuWymagane i opcjonalne kolumny CSV dla każdego typu importu wraz z akceptowanymi przez każdy z nich formatami.Przypadki i przyjęciaNapraw import z błędnymi wierszamiPrzeczytaj dziennik importu i błędy wierszy, spróbuj ponownie zaimportować wiersze, które nie powiodły się z innych powodów, a następnie popraw i ponownie prześlij plik.Przypadki i przyjęcia