HilfezentrumIntegrationen

Für: Administratoren

Führen Sie einen Import mit einem Verwaltungsschlüssel aus

Erstellen Sie einen Import, laden Sie eine CSV-Datei hoch und hängen Sie diese an. Überprüfen Sie anschließend jede Zeile und wiederholen Sie die Importe, die fehlgeschlagen sind.

In diesem Artikel9 Abschnitte

Bevor Sie beginnen

Diese Seite beschreibt die Ausführung einer Importation mit einem entsprechenden Schlüssel. Die gleichen Vorgänge wie in Integration › Imports werden hier ebenfalls durchgeführt. Alle Pfade sind unter https://prd-api-manage.caseactive.com/v1/integration/<hub id> angegeben. Für die Kolumnen des Dateisatzes siehe Wo finden Sie die für jede Importation benötigten Kolumnen?.

Anrufe

AnrufWas es tut
POST /importsErstellt eine Import-Operation.
GET /drive/private?import_id=<id>&media_group=docs&media_extension=csvGibt eine Adresse an, an die das Datei hochgeladen werden soll.
PUT /imports/<import_id>Das hochgeladene Datei wird angehängt – dadurch beginnt die Importation.
GET /importsListet Ihre Importe auf – am Anfang stehen die neuesten Importe, zusammen mit dem Fortschritt ihrer Entwicklung.
GET /imports/<import_id>Listet die Zeilen eines Importers auf.
PUT /imports/<import_id>/<unique_id>Versucht erneut, die fehlgeschlagenen Zeilen zu korrigieren.

1. Import erstellen

FeldWas es tutErforderlich
nameEin Name dafür: Buchstaben, Zahlen, Leerzeichen und Bindestriche.Ja.
sourceWas das auslösende Element ist – beispielsweise claims-sync. Dieses wird im Administrationspanel als Quelle angezeigt.Ja.
typeEiner der unten aufgeführten TypenJa.
typeAuf dem Bildschirm
post_userHinzufügen von Benutzern
put_userBenutzer anpassen
post_caseErstellen von Fällen
put_caseAnpassung der Fälle
post_case_permissionWeisen Benutzer zu Fällen zuordnen.
delete_case_permissionEntfernen Sie die Benutzer, die zu den Fällen zugeordnet sind.
post_case_postErstellen von Fallbeispielen/Case Posts
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"}'

Es beantwortet die Frage. 201 Mit dem… import_id, zum Beispiel import::20261002141503_3f9a1c2b7d4e60.

2. Laden Sie die Datei hoch.

Bitten Sie um eine Upload-Adresse unter GET /drive/private?import_id=<import_id>&media_group=docs&media_extension=csv. Diese Adresse soll eine url sowie eine Reihe von fields entgegennehmen. Senden Sie das Datei als multipart/form-data-POST-Daten an diese Adresse. Jede Einheit von fields muss genau so angegeben werden, wie es beschrieben ist. Das Datei sollte schließlich als letztes Element angezeigt werden, wie in file angegeben.

curl -X POST "<url>" \
  --form-string "key=<fields.key>" \
  --form-string "<every other entry of fields, as given>" \
  -F "file=@october-claimants.csv"
  • Senden Sie die Einträge von fields zusammen mit --form-string – nicht mit -F. Einige der Einträge beginnen mit < oder enthalten einen ;. -F wird dabei als Datei oder Option interpretiert.
  • Die Adresse ist für eine Stunde gültig.
  • Speichern Sie das Dokument als CSV-Datei im UTF-8-Format. Die Namen der Spalten sollten in der ersten Zeile der Datei stehen.
  • Ein Datei kann bis zu 25.000 Zeilen enthalten – unterhalb der Spaltennamen. Eine Datei mit mehr als 25.000 Zeilen funktioniert nicht beim Import und liefert keine Daten. Es ist daher besser, die Dateien in solche mit maximal 25.000 Zeilen aufzuteilen, wobei für jede Datei ein separater Import durchgeführt werden muss.
  • Behalten Sie fields.key bei: So wird das Datei-Datein anschließend angehängt.

3. Fügen Sie die Datei an.

Mit der Schlüsselwörterbuch PUT /imports/<import_id> wird die Importation gestartet. Es wird auf den Wert 204 zurückgegriffen.

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

Fügen Sie einfach einfach eine Datei hinzu. Falls die Importation fehlschlägt, korrigieren Sie die Datei und starten Sie eine neue Importation.

4. Fortschritt prüfen

GET /imports listet Ihre Importe auf – sortiert nach der Altersreihenfolge. Für jede Importart werden die entsprechenden Werte in den Kategorien status, total, passed und failed angegeben.

  • QUEUED: Erstellt worden oder angehängt, aber noch nicht gelesen.
  • PROCESSED: Das Dateiinhalt wurde bereits in den Speicher übertragen. total Die Zeilen laufen einzeln ab. Es ist fertig, wenn… passed Und… failed Zusammenkommen zu total.
  • FAILED: Das Datei kann nicht gelesen werden. Es wurden keine Daten gespeichert, oder es wurden mehr als 25.000 Daten gespeichert. Die error_msg-Angabe gibt an, welche Art von Daten gespeichert sind: ImportFileUnreadableException, ImportFileEmptyException oder ImportFileTooLargeException.

Die Zeilen werden in der Reihenfolge des Importvorgangs bearbeitet – bei jedem zweiten Import wird also eine Zeile bearbeitet. Deshalb dauert es eine Weile, bis ein großer Dateiauszug fertiggestellt ist. Wenn ein Import oder die erste Zeile des Auszugs fehlschlagen, werden die Admins und Manager des jeweiligen Systems per E-Mail informiert.

GET /imports/<import_id> listet die Zeilen auf, die bereits ausgeführt wurden – in der Reihenfolge, in der sie im Dateiinhalt stehen. Dabei werden bis zu 1000 Zeilen angezeigt. limit und 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"
  }
}
FeldWas es enthält
lineDie Nummer der Zeile in Ihren Dateien – bei einer Tabellenkalkulation zählt man die Zeilen; die Spaltennamen entsprechen dabei den Zeilen 1 bis n.
dataDie Zellen der Zeile werden so gesendet.
statusSUCCEEDED, FAILED oder QUEUED – während eine Wiederholung wartet.
outputWas es bewirkt: entweder der user_id-Wert, der case_id-Wert – oder beides – für eine Zeile, die jemanden in eine bestimmte Situation bringt.
schema_errorsFür eine Zelle, die die Prüfung nicht bestanden hat: Die Spalte – und was falsch gelaufen ist.
error_msgWarum der Streit als Fehler bezeichnet wurde – zum Beispiel mit dem Namen CaseReferenceIdExistsException

Eine Zeile gilt als erfolgreich nur dann, wenn sie ihre Änderungen durchgeführt hat. Eine Zeile, deren Tag-ID, Referenz-ID oder Person mit einer anderen Zeile übereinstimmt, wird als Fehler abgelehnt. Der Name des Abweisenden wird dabei angezeigt. error_msg. Es gibt Probleme bei der Zuweisung von Benutzern zu Fällen oder bei der Erstellung von Beiträgen für Fälle, die bereits abgeschlossen sind. {"_schema": ["Case is closed"]} In schema_errors: Öffnen Sie das Dokument erneut, und importieren Sie anschließend die Zeile wieder.

Der Wert von unique_id besteht aus der ID des jeweiligen Eintrags sowie der Nummer des Eintrags innerhalb Ihres Files. Somit ist der Wert von import::20261002141503_3f9a1c2b7d4e60 gleich unique::20261002141503_3f9a1c2b7d4e60_0000002.

5. Eine Zeile erneut versuchen

PUT /imports/<import_id>/<unique_id> Mit/ohne {"retry": true} Es gibt wieder einen fehlerhaften Lauf – genau wie zuvor, am Ende der Reihe Ihres Hubs. Es antwortet… 204, Und die Importe… failed Zähle die „Tropfen“ um eins herum – bis die Zeile abgeschlossen ist. Verwenden Sie dieses Verfahren für Zeilen, die aus irgendeinem Grund nicht funktioniert haben – beispielsweise wegen einer Überlastung. Eine Zeile, deren Zellen falsch sind, wird wieder fehlerhaft sein. Korrigieren Sie das Datei-Format und starten Sie eine neue Importation.

Was geschieht als Nächstes?

Die Einträge der Importdatei tun genau das, was auch die entsprechenden Einträge auf dem Bildschirm tun: Die hinzugefügten Personen werden nicht per E-Mail benachrichtigt. Die Personen, die die Einladung erhalten haben, erhalten die Benachrichtigung über die „Assign Cases“-Regeln. Neue Benachrichtigungen informieren die betroffenen Personen. Der Import wird als Teil Ihres Systems registriert. Virtuelle Assistentin/Virtueller AssistentVirtueller Assistent Ein automatisiertes Teammitglied, das Begrüßungsnachrichten, Check-ins und Statusmeldungen für das Unternehmen veröffentlicht; seine Beiträge sind mit einem Virtual Assistant-Abzeichen versehen.Das Versenden desselben Files zweimal bedeutet, dass jede Zeile erneut ausgeführt wird. Die Zeilen, die mit der ersten Ausführung in Konflikt geraten, werden nicht erfolgreich ausgeführt – dadurch werden die Beiträge also zweimal hintereinander geschrieben. Um die fehlgeschlagenen Zeilen auf dem Bildschirm zu beheben, siehe… Stellen Sie eine Importvorgabe bereit, bei der fehlgeschlagene Zeilen enthalten sind..

Wenn ein Anruf abgelehnt wird

StatusmessageWarum
400SchemaFieldsExceptionEs fehlt ein Feld oder das Feld ist ungültig. Beispielsweise kann es sich um ein name handeln – allerdings mit anderen Zeichen darin. Oder es kann ein media_key sein, bei dem nichts hochgeladen wurde.
403ImportFileAlreadyAttachedExceptionDie Importvorgänge haben bereits ihre Dateien erstellt – oder wurden bereits gelesen. Führen Sie einen neuen Import durch.
403BotNotAllowedExceptionSie haben /v1/<hub id>/imports anstelle von /v1/integration/<hub id>/imports verwendet.
404ItemNotFoundExceptionKeine Bedeutung – oder keine Zeile mit dieser ID in Ihrem Datenbankinhalt.

Verwandte Artikel

Ermitteln Sie, welche Spalten für jeden Import benötigt werden.Die erforderlichen und optionalen CSV-Spalten für jeden Importtyp sowie die jeweils akzeptierten Formate.Fälle & AufnahmeImport mit fehlerhaften Zeilen korrigierenLesen Sie das Importprotokoll und die Zeilenfehler, versuchen Sie, Zeilen, die aus anderen Gründen fehlgeschlagen sind, erneut hochzuladen, und korrigieren Sie die Datei und laden Sie sie erneut hoch.Fälle & Aufnahme