一括読み取りステータスの確認

説明

このAPIを実行すると、以前に開始した一括読み取りジョブのステータスを手動で確認できます。

JSONリクエストでコールバックURLを設定していない場合、このAPIを実行してジョブステータスを自分で確認する必要があります。一括読み取り操作を開始した際に自動的に送信される処理中レスポンスに含まれるjob_idを使用して、その後のジョブステータスを確認する必要があります。

リクエスト詳細

リクエストURL

GET

{api-domain}/baas/v1/project/{project_id}/bulk/read/{job_id}

copy

api-domain

URL

Catalyst APIにアクセスするためのDC固有のドメイン

project_id

Numerical

プロジェクトの一意のID

job_id

Numerical

一括読み取りAPIの実行後に最初の処理中ステータスレスポンスで送信されたジョブの一意のID

リクエストヘッダー

Authorization: Zoho-oauthtoken {oauth_token}

任意のヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.tables.bulk.READ

レスポンス詳細

成功状態のJSONレスポンスには、実行されたジョブの詳細と、一括読み取りジョブのクエリに一致するレコードのリストを含むCSVファイルをダウンロードできるダウンロードURLが含まれます。

失敗状態のJSONレスポンスには、実行されたジョブの詳細と、ジョブ処理で発生したエラーの説明、およびスキップされた行とその理由などの詳細が含まれます。

リクエスト例
copy

curl -X GET 

https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/read/2000000118004  

-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”

レスポンス例：ジョブ処理中
copy

{
"status": "success",
"data": {
    "job_id": 2000000118004,
    "status": "In-Progress",
    "operation": "read",
    "project_details": {
        "project_name": "EmployeeDatabase",
        "id": 4000000006007
    },
    "query": [
        {
            "table_id": 3376000000165541,
            "details": {
                "page": "1"
            }
        }
    ],
    "callback": {
        "url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
        "headers": {
                  "src" : "ZCatalyst",
                  "operation" : "bulkreadAPI"
                          },
        "params": {
                  "project_name" : "EmployeeDatabase"
                         }
    },
    "created_by": {
        "zuid": 1019540152,
        "is_confirmed": true,
        "email_id": "emma@zylker.com",
        "first_name": "Amelia",
        "last_name": "Burrows",
        "user_id": 671930409
    },
    "created_time": "Oct 06, 2020 07:06 PM"
}

}

レスポンス例：ジョブ成功
copy

{
"status": "success",
"data": {
    "job_id": 2000000118004,
    "status": "Completed",
    "operation": "read",
    "project_details": {
        "project_name": "EmployeeDatabase",
        "id": 4000000006007
    },
    "query": [
                    {
            "table_id": 3376000000165541,
            "details": {
                "page": "1"
                            }
                      }
                   ],
    "callback": {
            "url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
            "headers": {
                  "src" : "ZCatalyst",
                  "operation" : "bulkreadAPI"
                          },
              "params": {
                   "project_name" : "EmployeeDatabase"
                         }
                       },
    "created_by": {
            "zuid": 1019540152,
            "is_confirmed": true,
            "email_id": "emma@zylker.com",
            "first_name": "Amelia",
            "last_name": "Burrows",
            "user_id": 671930409
                           },
    "created_time": "Oct 06, 2020 07:06 PM",
"results": {
           "download_url": "https://api.catalyst.zoho.com/baas/v1/bulk/read/2000000117007/download",
           "description": "Bulk READ job 2000000117007 completed.",
            "details": [
                             {
                   "table_id": 3376000000165541,
                   "records_processed": 21,
                   "more_records": false
                             }
                           ]
                    }
           }

}

レスポンス例：ジョブ失敗
copy

{
"status": "success",
"data": {
    "job_id": 2000000117007,
    "status": "Failed",
    "operation": "read",
    "project_details": {
        "project_name": "EmployeeDatabase",
        "id": 4000000006007
    },
    "query": [
        {
            "table_id": 3376000000165541,
            "details": {
                "page": "1"
            }
        }
    ],
    "callback": {
        "url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
         "headers": {
                  "src" : "ZCatalyst",
                  "operation" : "bulkreadAPI"
                          },
        "params": {
                   "project_name" : "EmployeeDatabase"
                         }
    },
    "created_by": {
        "zuid": 1019540152,
        "is_confirmed": true,
        "email_id": "emma@zylker.com",
        "first_name": "Amelia",
        "last_name": "Burrows",
        "user_id": 671930409
    },
    "created_time": "Oct 06, 2020 07:00 PM",
    "results": {
        "description": "The column ID in select_columns is invalid",
    }
}

}

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit