のために: 管理者
管理キーを使用してインポートを実行します
インポートを作成し、CSVファイルをアップロードして添付します。その後、各行を確認し、失敗した行を再試行します。
この記事では9 セクション
始める前に
このページでは、管理キーを使ってインポートを行う方法について説明しています。これは、Integration › Importsで説明されている内容と同じです。ここにあるすべてのパスはhttps://prd-api-manage.caseactive.com/v1/integration/<hub id>の下にあります。ファイルの各列については、各インポートで必要な列を確認してくださいを参照してください。
電話
| 電話 | その機能 |
|---|---|
POST /imports | インポートを行うための処理を実行します。 |
GET /drive/private?import_id=<id>&media_group=docs&media_extension=csv | そのファイルをアップロードするための指示を出します。 |
PUT /imports/<import_id> | アップロードされたファイルを添付することで、インポートが開始されます。 |
GET /imports | ご自身の輸入品を、最新のものから順番に一覧表示します。また、各商品の進捗状況も表示されます。 |
GET /imports/<import_id> | インポートされたデータの行を一覧表示します。 |
PUT /imports/<import_id>/<unique_id> | 失敗した行を再試行する。 |
1. インポートを作成する
| 分野 | その機能 | 必須 |
|---|---|---|
name | その名前としては、文字、数字、スペース、ハイフンなどがあります。 | はい。 |
source | 何がそれを引き起こしたのか、例えばclaims-syncのようなものです。これは、管理パネルでその出典として表示されています。 | はい。 |
type | 以下のタイプのうちの一つです。 | はい。 |
type | 画面上で |
|---|---|
post_user | ユーザーを追加する |
put_user | ユーザーを変更する |
post_case | ケースを作成する |
put_case | ケースを変更する |
post_case_permission | ユーザーをケースに割り当てる |
delete_case_permission | ケースに割り当てられているユーザーを削除する。 |
post_case_post | ケースレポートを作成する |
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"}'
つまり、201をimport_idで置き換えることになります。例えば、import::20261002141503_3f9a1c2b7d4e60のような場合です。
2. ファイルをアップロードする
GET /drive/private?import_id=<import_id>&media_group=docs&media_extension=csvを使って、アップロード用のアドレスを要求してください。そのアドレスはurlに対応し、さらにfieldsの一連の値も含まれます。ファイルをmultipart/form-data形式で送信してください。各fieldsの値も正確に指定してください。そして、ファイルは最後に置かれます。その際、fileの値も正確に指定してください。
curl -X POST "<url>" \
--form-string "key=<fields.key>" \
--form-string "<every other entry of fields, as given>" \
-F "file=@october-claimants.csv"
fieldsのエントリを--form-stringで送信してください。-Fではなく。<で始まるものもありますし、;を持つものもあります。ここで-Fは、ファイルやオプションとして解釈されます。- このアドレスは、1時間間隔で機能します。
- ファイルをCSV形式、UTF-8エンコーディングで保存してください。列名は、最初の行に記載してください。
- ファイル内には、列名の下に最大25,000行分のデータが保持されています。より長いファイルをインポートすると、何もインポートされません。ですから、25,000行以下のファイルに分割し、各ファイルごとにインポートを行う必要があります。
fields.keyを保持してください。これが、次にファイルをアップロードする際の方法です。
3. ファイルを添付する
PUT /imports/<import_id>というキーを使って、アップロードを行います。これは204に対応しています。
{"media_key": "<fields.key>"}
一度だけファイルをアップロードしてください。もしインポートに失敗した場合は、ファイルを修正してから、再度インポートを試みてください。
4. 進捗状況を確認する
GET /importsには、導入されているものがリストされています。それぞれの項目について、status、total、passed、failedという情報が記載されています。
QUEUED:作成されているか、あるいはアップロードされているが、まだ読み込まれていない状態です。PROCESSED:ファイルがtotal行分読み込まれました。これらの行は、1行ずつ処理されていきます。passedとfailedの和がtotalに達した時点で、処理は終了します。FAILED:そのファイルを読み取ることができませんでした。行が存在しないか、25,000行以上のデータが保持されています。インポートの際に、error_msgが指定する値は、ImportFileUnreadableException、ImportFileEmptyException、またはImportFileTooLargeExceptionです。
各行は、インポートの際に交互に処理されます。そのため、大きなファイルをインポートする場合は、時間がかかります。インポートが失敗したり、最初の行がエラーを起こした場合には、Hubの管理者やマネージャーにメールが送信されます。
GET /imports/<import_id>は、ファイル内に記載されている順番に並んでいる行のリストです。limitは最大1000まで表示されます。また、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"
}
}
| 分野 | 中身 |
|---|---|
line | ファイル内の行番号です。スプレッドシートでは、行を数える際に、列名が1番目の行として扱われます。 |
data | 送られてきた行のセルたち。 |
status | SUCCEEDED、FAILED、またはQUEUEDのいずれかを指定し、再試行が行われるまで待ちます。 |
output | 何が行われるか:user_id、case_id、またはその両方。これは、ある行において、誰かをケースに入れるための処理です。 |
schema_errors | チェックに合格できなかったセルについては、その列の状態、そして何が問題だったかを確認する必要があります。 |
error_msg | なぜ、CaseReferenceIdExistsExceptionというようなエラー名で行が失敗したのでしょうか? |
行が成功したとは、その行が変更された場合にのみ言えます。タグIDや参照ID、または人物情報が他のレコードと衝突している場合、その行は失敗します。失敗時のエラーメッセージはerror_msgに表示されます。また、閉じられたケースを再開するためにユーザーを割り当てる行や、閉じられたケースに関する投稿を行う行が失敗すると、{"_schema": ["Case is closed"]}がschema_errorsに表示されます。その場合は、ケースを再開した後、その行を再度インポートしてください。
行のunique_idは、インポートされたIDと、そのファイル内での行番号から構成されています。したがって、import::20261002141503_3f9a1c2b7d4e60の2番目の行はunique::20261002141503_3f9a1c2b7d4e60_0000002になります。
5. 行を再試行する
PUT /imports/<import_id>/<unique_id>と{"retry": true}は、再び失敗した行を実行します。これは、ハブの順番が回ってきた時にも同じように起こります。この場合、204に応答し、インポートのfailedの数は1減少します。これは、忙しい時など、何らかの理由で行が失敗した場合に使用されます。もし、セルが間違っている場合は、ファイルを修正してから、新しいインポートを開始してください。
次に何が起こるのか
インポートされた情報は、スクリーン上で同じ情報が表示されるようになっています。つまり、追加された人々はメールで通知されません。招待状を受け取った人々は、自動的にその案件に登録されます。また、新しい案件が発生した場合には、「案件を割り当てる」ルールが適用されます。さらに、新しい投稿があった場合には、その案件の関係者に通知が送信されます。このインポートされた情報は、あなたのハブに記録されます。 バーチャルアシスタントバーチャルアシスタント 会社への歓迎メッセージ、チェックイン、ステージングに関する投稿を行う自動化されたチームメンバー。その投稿にはバーチャルアシスタントのバッジが付いています。同じファイルを2回送信すると、すべての行が再び実行されてしまいます。最初の実行でエラーが発生した行は、再度実行され、結果として投稿が2回行われてしまいます。画面に表示されるエラー行を修正するには、こちらを参照してください。 エラーが発生した行を含むインポートを修正してください。.
電話が拒否された場合
| 状態 | message | なぜ |
|---|---|---|
| 400 | SchemaFieldsException | フィールドが欠落しているか、無効な値を含んでいます。例えば、他の文字が含まれているnameや、何もアップロードされていないmedia_keyのような状態です。 |
| 403 | ImportFileAlreadyAttachedException | 既に、インポートにはファイルが存在しているか、またはすでに読み取られている状態です。新しいインポートを開始しましょう。 |
| 403 | BotNotAllowedException | あなたは使ったのです。 /v1/<hub id>/imports 代わりに /v1/integration/<hub id>/imports |
| 404 | ItemNotFoundException | そのIDを持つものは、何の意味もない。また、どの行にも含まれていない。 |