IDによるジョブの取得
説明
このAPIを使用すると、特定のジョブの詳細を取得できます。ジョブは一意のJob IDで参照されます。
リクエスト詳細
リクエストURL
GET
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job/{job_id}
copy
project_id
Numerical
job_id
Numerical
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.job.READ
レスポンス詳細
JSONレスポンスは、プロジェクトに存在する特定のジョブのメタデータを返します。レスポンスには、ジョブを作成したユーザーおよび最後に変更したユーザーの詳細も含まれます。
注意: サンプルレスポンスは、Job Functionをトリガーするジョブの例です。このAPIを使用してWebhook、Circuit、またはAppSailサービスをトリガーするジョブをGETする場合、capacity、target、request_method、target_details、params、およびheadersの値はそれに応じて変わります。
リクエスト例
copy
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/job/10278000000027019
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
レスポンス例
copy
{
"status": "success",
"data": {
"job_id": "10108000003880208",
"created_time": "May 29, 2024 02:29 PM",
"response_code": "Success",
"start_time": {
"startTimeToRedirectLogsPage": "29/05/2024 14:24",
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST"
},
"end_time": {
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST",
"endTimeToRedirectLogsPage": "29/05/2024 14:34"
},
"submitted_on": {
"startTimeToRedirectLogsPage": "29/05/2024 14:24",
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST"
},
"job_status": "SUCCESS",
"capacity": {
"memory": "256"
},
"job_meta_details": {
"id": "10108000003880209",
"url": "",
"job_name": "abc",
"job_config": {
"number_of_retries": 0
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {}
},
"retried_count": 0,
"parent_job_id": "10108000003880208",
"execution_time": "633",
"status": false,
"dispatch_delay": "103"
}
}
SDK Documentation
Yes
No
Thank you for your feedback!
Send your feedback to us
Skip
Submit