Loading...

お知らせ:

当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Every Cronの更新

説明

このAPIを使用すると、プロジェクト内の繰り返しタイプのEvery cronを更新できます。更新するcronは、名前やIDなどの一意の識別子を使用して参照されます。

注意:

リクエスト詳細

リクエストURL

PUT

{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier (name/ID)}

copy

project_id
Numerical
プロジェクトの一意のID

cron_id
Numerical

cron_name
String
cronの名前

リクエストヘッダー

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

オプションヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.cron.UPDATE

リクエストJSON

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

サンプルペイロード
copy
{
"cron_name": "RecursiveCronEvery",
"cron_type": "Periodic",
"cron_status": true,
"end_time": 1717957799,
"cron_execution_type": "pre-defined",
"job_meta": {
    "id": "10108000004280482",
    "job_name": "jobName",
    "job_config": {
    "number_of_retries": 3,
    "retry_interval": 60
    },
    "target_type": "Function",
    "target_details": {
    "id": "10108000003823893",
    "target_name": "target_function_fetch"
    },
    "source_type": "Cron",
    "source_details": {
    "id": "10108000004280480",
    "source_name": "RecursiveCron",
    "details": {
        "cron_execution_type": "pre-defined"
    }
    },
    "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",
    "capacity": {
        "memory": "2048"
    },
    "project_details": {
        "project_name": "ZylkerShipments",
        "id": "10108000003823392",
        "project_type": "Live"
    },
    "id": "10108000003823563"
    },
    "params": {
    "param1": "value1"
    },
    "target_id": "10108000003823893"
},
"job_detail": {
    "hour": 6,
    "minute": 0,
    "second": 0,
    "repetition_type": "every"
},
"id": "10108000004280480"
}
View more

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

cron_type String
mandatory
cronのスケジュールタイプを示します
cron_status Boolean
mandatory
cronが有効か無効かを示します。
job_detail JSON
mandatory
cronによって送信されるジョブの詳細が含まれます。
job_meta JSON
mandatory
cronによって送信されるジョブのメタ情報が含まれます。
jobpool_id Numerical
mandatory
ジョブを実行するジョブプールのJob Pool IDが含まれます。
job_name String
mandatory
トリガーするジョブの名前が含まれます。
target_type String
mandatory
トリガーされるターゲットタイプのエンドポイントを示します。Function、Webhook、Circuit、またはAppSailのいずれかです。
target_id Numerical
mandatory
ターゲットタイプを参照するための一意のIDが含まれます。
params JSON
mandatory
ジョブ送信時に渡すヘッダーとパラメータの値が含まれます。
cron_name String
mandatory
作成するcronの名前が含まれます。
cron_execution_type String
mandatory
pre-defined cronかdynamic cronかを示します。

レスポンス詳細

JSONレスポンスは更新されたcronのメタデータを返します。レスポンスにはcronを更新したユーザーの詳細も含まれます。

リクエスト例
copy

curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280480 -H “Authorization: Zoho-oauthtoken 1000.91016.2f57” -H “Content-Type:application/json” --data-raw ‘{“cron_name”:“RecursiveCronEvery”,“cron_type”:“Periodic”,“cron_status”:true,“end_time”:1717957799,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280482”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:3,“retry_interval”:60},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280480”,“source_name”:“RecursiveCron”,“details”:{“cron_execution_type”:“pre-defined”}},“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”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“hour”:6,“minute”:0,“second”:0,“repetition_type”:“every”},“id”:“10108000004280480”}’

View more
レスポンス例
copy
{
    "status": "success",
    "data": {
        "cron_name": "RecursiveCronEvery",
        "cron_type": "Periodic",
        "cron_execution_type": "pre-defined",
        "job_meta": {
            "id": "10108000004280762",
            "url": "",
            "job_name": "jobName",
            "job_config": {
                "number_of_retries": 3,
                "retry_interval": 60
            },
            "target_type": "Function",
            "target_details": {
                "id": "10108000003823893",
                "target_name": "target_function_fetch"
            },
            "source_type": "Cron",
            "source_details": {
                "id": "10108000004280480",
                "source_name": "RecursiveCronEvery",
                "details": {
                    "cron_execution_type": "pre-defined"
                }
            },
            "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",
                "capacity": {
                    "memory": "2048"
                },
                "project_details": {
                    "project_name": "ZylkerShipments",
                    "id": "10108000003823392",
                    "project_type": "Live"
                },
                "id": "10108000003823563"
            },
            "headers": {},
            "params": {
                "param1": "value1"
            }
        },
        "cron_status": true,
        "modified_time": "Jun 07, 2024 12:56 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"
        },
        "project_details": {
            "project_name": "ZylkerShipments",
            "id": "10108000003823392",
            "project_type": "Live"
        },
        "end_time": "1717957799",
        "cron_detail": {
            "hour": 6,
            "minute": 0,
            "second": 0,
            "repetition_type": "every",
            "timezone": "Asia/Kolkata"
        },
        "id": "10108000004280480"
    }
}
View more