IDによるCircuitジョブの送信

説明

このAPIを使用すると、Circuitのエンドポイントをトリガーするジョブをジョブプールに送信できます。

リクエスト詳細

リクエストURL

POST

{api-domain}/baas/v1/project/{project_id}/job_scheduling/job

copy

project_id

Numerical

プロジェクトの一意のID

リクエストヘッダー

Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json

オプションヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.job.CREATE

リクエストJSON

以下に示す対応する値を含むJSONを送信する必要があります。

サンプルペイロード
copy
{
"source_type": "API",
"job_config": {
    "number_of_retries": "4",
    "retry_interval": 300
},
"job_name": "circuitJob",
"jobpool_id": "10108000003823699",
"target_type": "Circuit",
"target_id": "10108000004194246",
"test_cases": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
}
}

View more

このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：

request_method

mandatory

webhookがトリガーされるリクエストメソッドを示します。値はget、post、put、delete、head、またはpatchを指定できます。

source_type

mandatory

ジョブ送信APIの場合、常にAPIを値として含みます。

job_config JSON

mandatory

number_of_retriesとretry_intervalのキーバリューペアが含まれます。失敗時のリトライアクションを決定します。

target_type String

mandatory

ジョブがトリガーするターゲットタイプを示します。

jobpool_id Numerical

mandatory

ジョブを実行するジョブプールのJob Pool IDが含まれます。

job_name String

mandatory

トリガーするジョブの名前が含まれます。

target_id Number

mandatory

ジョブがトリガーするCircuitの一意のIDが含まれます。

test_cases JSON

optional

Circuitに入力する必要があるJSONのキーバリューペア入力が含まれます。

レスポンス詳細

JSONレスポンスは、送信されたジョブのメタデータを返します。レスポンスには、ジョブを送信したユーザーの詳細も含まれます。

リクエスト例
copy

curl -X POST 

https://api.catalyst.zoho.com/baas/v1/project/{project_id}/job_scheduling/job
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“source_type”:“API”,“job_config”:{“number_of_retries”:“4”,“retry_interval”:300},“job_name”:“circuitJob”,“jobpool_id”:“10108000003823699”,“target_type”:“Circuit”,“target_id”:“10108000004194246”,“test_cases”:{“key1”:“value1”,“key2”:“value2”,“key3”:“value3”}}’

レスポンス例
copy
{
"status": "success",
"data": {
    "job_id": "10108000004194251",
    "created_time": "Jun 05, 2024 04:56 PM",
    "response_code": null,
    "start_time": {},
    "end_time": {},
    "submitted_on": {
    "startTimeToRedirectLogsPage": "05/06/2024 16:51",
    "timeWithGivenTimezone": "Jun 05, 2024 04:56 PM IST",
    "timeWithJobTimezone": "Jun 05, 2024 04:56 PM IST"
    },
    "job_status": "PENDING",
    "capacity": {
    "number": "1"
    },
    "job_meta_details": {
    "id": "10108000004194252",
    "job_name": "circuitJob",
    "job_config": {
        "number_of_retries": 4,
        "retry_interval": 300
    },
    "target_type": "Circuit",
    "target_details": {
        "id": "10108000004194246",
        "target_name": "abc"
    },
    "source_type": "API",
    "source_details": {
        "source_name": "API"
    },
    "jobpool_id": "10108000003823699",
    "jobpool_details": {
        "type": "Circuit",
        "name": "InventoryDataMaintaince",
        "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:49 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:49 PM",
        "project_details": {
        "project_name": "ZylkerShipments",
        "id": "10108000003823392",
        "project_type": "Live"
        },
        "id": "10108000003823699"
    },
    "headers": {},
    "params": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
    }
    },
    "retried_count": null,
    "parent_job_id": "10108000004194251",
    "execution_time": null
}
}

View more

Create Job- Java SDK

Create Job- Node.js SDK

Create Job- Python SDK

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit