テーブルデータ追加の処理ステータスを確認
テーブルデータ追加の処理ステータスを確認
このAPIを使用するとデータベーステーブルへのデータ追加処理の進行状況(ステータス)を確認できます。
リクエストメソッド
GET
エンドポイント
https://api-${endpoint}.gptbots.ai/v1/database/query/import-results
認証
認証方法の説明についてはAPI Overviewをご参照ください。
リクエスト
リクエスト例
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/database/query/import-results?ids=id1&ids=id2' \
-H 'Authorization: Bearer ${API Key}'
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/database/query/import-results?ids=id1&ids=id2' \
-H 'Authorization: Bearer ${API Key}'
このコードブロックをポップアップで表示
リクエストヘッダー
フィールド | タイプ | 説明 |
---|---|---|
Authorization | Bearer ${API Key} | 認証には Authorization: Bearer ${API Key} を使用してください。トークンはAPIキーページから取得できます。 |
クエリパラメータ
フィールド | タイプ | 必須 | 説明 |
---|---|---|---|
ids | List | 必須 | データ追加タスクのIDリスト。複数のタスクIDを指定して、それぞれの処理ステータスを取得することが可能です。 |
レスポンス
レスポンス例
{
"code": 0,
"message": "OK",
"progress": 0,
"data": [
{
"id": "673e9cda9f7bc178002dbd9c",
"progress": 1,
"status": "FAIL",
"success_count": 0,
"fail_count": 2,
"fail_detail": [
{"row_number_start":1,"row_number_end":10,"fail_reason":"fail reason"},
{"row_number_start":31,"row_number_end":40,"fail_reason":"fail reason"}
]
}
]
}
{
"code": 0,
"message": "OK",
"progress": 0,
"data": [
{
"id": "673e9cda9f7bc178002dbd9c",
"progress": 1,
"status": "FAIL",
"success_count": 0,
"fail_count": 2,
"fail_detail": [
{"row_number_start":1,"row_number_end":10,"fail_reason":"fail reason"},
{"row_number_start":31,"row_number_end":40,"fail_reason":"fail reason"}
]
}
]
}
このコードブロックをポップアップで表示
システムはデフォルトで10行を1つのchunkとして分割し、エラーの理由はそのchunk内の最初の行で発生したエラーの内容となります。
成功時のレスポンス
フィールド | タイプ | 説明 |
---|---|---|
code | int | メッセージタイプのコード |
message | string | メッセージの説明 |
progress | int | 進捗値 |
data | list | データ結果 |
id | string | クエリタスクID |
success_count | int | 成功件数 |
fail_count | int | 失敗件数 |
fail_detail | list | 追加オブジェクトと失敗理由。システムはデフォルトで10行を1つのchunkとして分割し、エラーの理由はそのchunk内の最初の行で発生したエラーの内容となります |
エラー時のレスポンス
フィールド | タイプ | 説明 |
---|---|---|
code | Int | エラーコード |
message | String | エラーの詳細 |
エラーコード
コード | メッセージ |
---|---|
50000 | システム内部エラー |