一括書き込みステータスの確認

説明

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

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

リクエスト詳細

リクエストURL

GET

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

copy

api-domain

URL

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

project_id

Numerical

プロジェクトの一意のID

job_id

Numerical

Bulk Write APIの実行後に最初の[処理中ステータスレスポンス](/ja/api/introduction/overview-and-prerequisites/#response-details)で送信されたジョブの一意のID

リクエストヘッダー

Authorization: Zoho-oauthtoken {oauth_token}

オプションヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.tables.bulk.CREATE

レスポンス詳細

成功状態のJSONレスポンスには、実行されたジョブの詳細とダウンロードURLが含まれます。このURLから、ジョブ実行の詳細を含むCSVレポートファイルをダウンロードできます。書き込みがスキップされたすべてのレコードとその理由が一覧表示されます。

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

リクエスト例
copy

curl -X GET 

https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/write/2000000110044  

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

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

{
    "status": "success",
    "data": {
        "job_id": 2000000110044,
        "status": "In-Progress",
        "operation": "insert",
        "project_details": {
            "project_name": "EmployeeDatabase",
            "id": 4000000006007
        }
        "query": [
            {
                "table_id": 3376000000165511,
                "details": {
                    "object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv",
            }
        }
    ],
    &quot;callback&quot;: {
        &quot;url&quot;: &quot;https://hr.zylker.com/ja/EmpRecords/_callback.php&quot;,
        &quot;headers&quot;: {
            &quot;src&quot;: &quot;ZCatalyst&quot;,
            &quot;operation&quot;: &quot;bulkwriteAPI&quot;
        },
        &quot;params&quot;: {
            &quot;project_name&quot;: &quot;EmployeeDatabase&quot;
        }
    },
    &quot;created_by&quot;: {
            &quot;zuid&quot;: 3000000006111,
            &quot;is_confirmed&quot;: true,
            &quot;email_id&quot;: &quot;emma@zylker.com&quot;,
            &quot;first_name&quot;: &quot;Amelia&quot;,
            &quot;last_name&quot;: &quot;Burrows&quot;,
            &quot;user_id&quot;: 671930409
    },
    &quot;created_time&quot;: &quot;Oct 05, 2020 07:33 PM&quot;
}

}

レスポンス例：ジョブ成功
copy
{
    "status": "success",
    "data": {
        "job_id": 2000000110044,
        "status": "Completed",
        "operation": "insert",
        "project_details": {
            "project_name": "EmployeeDatabase",
            "id": 4000000006007
        }
        "query": [
            {
                "table_id": 3376000000165511,
                "details": {
                    "object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
                }
            }
        ],
        "callback": {
            "url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
            "headers": {
                "src": "ZCatalyst",
                "operation": "bulkwriteAPI"
            },
            "params": {
                "project_name": "EmployeeDatabase"
            }
        },
        "created_by": {
            "zuid": 3000000006111,
            "is_confirmed": true,
            "email_id": "emma@zylker.com",
            "first_name": "Amelia",
            "last_name": "Burrows",
            "user_id": 671930409
        },
        "created_time": "Oct 05, 2020 07:25 PM",
        "results": {
            "download_url": "https://api.catalyst.zoho.com/baas/v1/bulk/write/2000000110013/download",
            "description": "Bulk WRITE job completed. ",
            "details": [
                {
                    "table_id": 3376000000165511,
                    "records_processed": 176
                }
            ]
        }
    }
}

View more

レスポンス例：ジョブ失敗
copy
{
    "status": "success",
    "data": {
        "job_id": 2000000110044,
        "status": "Failed",
        "operation": "insert",
        "project_details": {
            "project_name": "EmployeeDatabase",
            "id": 4000000006007
        }
        "query": [
            {
                "table_id": 3376000000165511,
                "details": {
                    "object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
                }
            }
        ],
        "callback": {
            "url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
            "headers": {
                "src": "ZCatalyst",
                "operation": "bulkwriteAPI"
            },
            "params": {
                "project_name": "EmployeeDatabase"
            }
        },
        "created_by": {
            "zuid": 3000000006111,
            "is_confirmed": true,
            "email_id": "emma@zylker.com",
            "first_name": "Amelia",
            "last_name": "Burrows",
            "user_id": 671930409
        },
        "created_time": "Oct 05, 2020 07:25 PM",
        "results": {
            "description": "The reference_column 'DeptID' in fk_mapping of table 3376000000165511 is not a unique column",
            "details": [ ]
        }
    }
}

View more

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit