IDによるAppSailジョブの送信

説明

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

リクエスト詳細

リクエスト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
{
"request_method": "get",
"source_type": "API",
"job_config": {
    "number_of_retries": "3",
    "retry_interval": 300
},
"job_name": "appsailJob",
"jobpool_id": "10108000002976201",
"target_type": "AppSail",
"target_id": "10108000002976191",
"url": "",
"headers": {
    "h1": "k1"
},
"params": {
    "p1": "v1"
}
}

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

ジョブがトリガーするターゲットのIDが含まれます。例えば、これはAppSailジョブなので、ターゲットIDはAppSailサービスのIDになります。

url String

optional

AppSailサービスのURLが含まれます。

headers JSON

optional

ジョブ送信時に渡すヘッダーの値が含まれます。

params JSON

optional

ジョブ送信時に渡すパラメータの値が含まれます。

レスポンス詳細

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 ‘{“request_method”:“get”,“source_type”:“API”,“job_config”:{“number_of_retries”:“3”,“retry_interval”:300},“job_name”:“appsailJob”,“jobpool_id”:“10108000002976201”,“target_type”:“AppSail”,“target_id”:“10108000002976191”,“url”:"",“headers”:{“h1”:“k1”},“params”:{“p1”:“v1”}}’

レスポンス例
copy
{
"status": "success",
"data": {
    "job_id": "10108000004194320",
    "created_time": "Jun 05, 2024 05:02 PM",
    "response_code": null,
    "start_time": {},
    "end_time": {},
    "submitted_on": {
    "startTimeToRedirectLogsPage": "05/06/2024 16:57",
    "timeWithGivenTimezone": "Jun 05, 2024 05:02 PM IST",
    "timeWithJobTimezone": "Jun 05, 2024 05:02 PM IST"
    },
    "job_status": "PENDING",
    "capacity": {
    "number": "1"
    },
    "job_meta_details": {
    "id": "10108000004194321",
    "url": "",
    "job_name": "appsailJob",
    "job_config": {
        "number_of_retries": 3,
        "retry_interval": 300
    },
    "target_type": "AppSail",
    "target_details": {
        "id": "10108000002976191",
        "target_name": "appsailTrue"
    },
    "source_type": "API",
    "source_details": {
        "source_name": "API"
    },
    "jobpool_id": "10108000002976201",
    "jobpool_details": {
        "type": "AppSail",
        "name": "appsailJP",
        "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": "Mar 28, 2024 05:41 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": "Mar 28, 2024 05:41 PM",
        "project_details": {
        "project_name": "AppsailCron",
        "id": "10108000002976144",
        "project_type": "Live"
        },
        "id": "10108000002976201"
    },
    "headers": {
        "h1": "k1"
    },
    "params": {
        "p1": "v1"
    },
    "request_method": "get"
    },
    "retried_count": null,
    "parent_job_id": "10108000004194320",
    "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