REST APIリファレンス

前へ次へ

スケジュールの作成

スケジュールリソースを使用して、組織のスケジュールを作成します。

POST要求

スケジュールを作成するには、次のURIを使用します。

/public/core/v3/schedule

スケジュールオブジェクトでは次のフィールドを使用できます。

フィールド	タイプ	必須	説明
name	String	○	スケジュール名。
description	String	-	スケジュールの説明。
status	String	-	スケジュールのステータス。以下のいずれかの値を使用します。有効無効デフォルトでは有効になっています。
startTime	Date/Time	はい	スケジュールの実行を開始する日付と時刻（UTC形式）。
endTime	Date/Time	-	スケジュールの実行を停止する日付と時刻。このパラメータを使用しない場合、スケジュールは無制限に実行されます。
interval	String	○	スケジュールのタスクを実行する間隔または繰り返し頻度。次のいずれかのオプションを使用します。なし。スケジュールの開始時間にタスクを実行します。スケジュールを繰り返しません。 Minutely。指定した分数、日数、および時間範囲に基づく間隔でタスクを実行します。以下のパラメータを使用できます。 frequency。タスクを実行する分単位の頻度。 sun、mon、tue、wed、thu、fri、sat。タスクを実行する曜日。 startTimeRangeおよびendTimeRange。タスクを実行する日のうちの時間範囲。すべての日でタスクを実行する場合は使用しないでください。 endTime。スケジュールの実行を停止する時間。スケジュールを無制限に実行する場合は使用しないでください。 Hourly。スケジュールの開始時刻に基づき、タスクを1時間間隔で実行します。以下のパラメータを使用できます。 frequency。タスクを実行する時間単位の頻度。 sun、mon、tue、wed、thu、fri、sat。タスクを実行する曜日。 startTimeRangeおよびendTimeRange。タスクを実行する日のうちの時間範囲。すべての日でタスクを実行する場合は使用しないでください。 endTime。スケジュールの実行を停止する時間。スケジュールを無制限に実行する場合は使用しないでください。 Daily。スケジュールに設定された開始時刻に基づき、日次の間隔でタスクを実行します。以下のパラメータを使用できます。 frequency。タスクを実行する日単位の頻度。 weekDay。すべての平日にタスクを実行します。すべての日でタスクを実行する場合は使用しないでください。 endTime。スケジュールの実行を停止する時間。スケジュールを無制限に実行する場合は使用しないでください。 Weekly。スケジュールの開始時刻に基づき、1週間間隔でタスクを実行します。以下のパラメータを使用できます。 sun、mon、tue、wed、thu、fri、sat。タスクを実行する曜日。 endTime。スケジュールの実行を停止する時間。スケジュールを無制限に実行する場合は使用しないでください。隔週。スケジュールの開始時刻に基づき、2週間ごとにタスクを実行します。以下のパラメータを使用できます。 sun、mon、tue、wed、thu、fri、sat。タスクを実行する曜日。 endTime。スケジュールの実行を停止する時間。スケジュールを無制限に実行する場合は使用しないでください。 Monthly。スケジュールの開始時刻に基づき、1カ月間隔でタスクを実行します。以下のパラメータを使用できます。 dayOfMonth。タスクを実行する1-28の日付。 dayOfWeek。タスクを実行する曜日。 weekOfMonth。タスクを実行する月の週数。 endTime。スケジュールの実行を停止する時間。スケジュールを無制限に実行する場合は使用しないでください。タスクを実行する時を示すには、第1月曜日など、dayOfWeekとともにweekOfMonthを使用します。または、1などのdayOfMonthを使用します。ヒント: 月の最終日にタスクを実行するには、weekOfMonthパラメータの「Last」とともにdayOfWeekパラメータの「Day」を使用します。デフォルトは間隔なしです。
frequency	Int	○	タスクの繰り返し頻度。以下のいずれかの値を使用します。分間隔の場合、次のいずれかのオプションを使用します: 5、10、15、20、30、45。デフォルトは5です。時間隔の場合、次のいずれかのオプションを使用します: 1、2、3、4、6、8、12。デフォルトは1です。日次の間隔の場合、1～30の日数を使用します。デフォルトは1です。分間隔、時間隔、日次の間隔でのみ使用します。
rangeStartTime	Date/Time	-	タスクを実行する日の時間範囲の開始時刻。標準の日付/時間の形式を使用して日時を入力します。時刻部分のみが使用されます。分間隔、時間隔、日次の間隔でのみ使用します。
rangeEndTime	Date/Time	-	タスクを実行する日の時間範囲の終了時刻。標準の日付/時間の形式を使用して日時を入力します。時刻部分のみが使用されます。分間隔、時間隔、日次の間隔でのみ使用します。
sun	Boolean	-	日曜日の設定された時刻にタスクを実行します。 sun - satパラメータを使用して、週の複数の曜日でタスクを実行することができます。分間隔、時間隔、週次の間隔、隔週の間隔でのみ使用します。
mon	Boolean	-	月曜日の設定された時刻にタスクを実行します。 sunの説明を参照してください。
tue	Boolean	-	火曜日の設定された時刻にタスクを実行します。 sunの説明を参照してください。
wed	Boolean	-	水曜日の設定された時刻にタスクを実行します。 sunの説明を参照してください。
thu	Boolean	-	木曜日の設定された時刻にタスクを実行します。 sunの説明を参照してください。
fri	Boolean	-	金曜日の設定された時刻にタスクを実行します。 sunの説明を参照してください。
sat	Boolean	-	土曜日の設定された時刻にタスクを実行します。 sunの説明を参照してください。
weekDay	Boolean	-	平日にタスクを実行します。次のいずれかのオプションを使用します。 True。月曜日から金曜日にタスクを実行します。週末にはタスクを実行しません。 False。毎日タスクを実行します。日次の間隔でのみ使用します。
dayOfMonth	Int	-	タスクを実行する日付。1-28の日付を使用します。月次の間隔でのみ使用します。ヒント: 月の最終日にタスクを実行するには、weekOfMonthパラメータの「Last」とともにdayOfWeekパラメータの「Day」を使用します。
weekOfMonth	String	-	タスクを実行する月の週数。dayOfWeekとともに使用して、タスクを実行する曜日と月の週数を指定します。例えば、月の第1週の日または最後の水曜日です。次のいずれかのオプションを使用します。第1 第2 第3 第4 最後月次の間隔でのみ使用します。
dayOfWeek	String	-	タスクを実行する曜日。weekOfMonthとともに使用して、タスクを実行する曜日と月の週数を指定します。例えば、月の第1週の日または最後の水曜日です。次のいずれかのオプションを使用します。日日曜日月曜日火曜日水曜日木曜日金曜日土曜日月次の間隔でのみ使用します。
timeZoneId	String	-	スケジュールがdayOfMonth、weekOfMonth、dayOfWeekフィールドに使用するタイムゾーン。デフォルトはUTCです。詳細については、付録A、タイムゾーンのコードを参照してください。

POST要求の例

スケジュールを作成する場合、要求は次の例のようになります。

POST <baseApiUrl>/public/core/v3/schedule
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
  "name": "my_schedule_1",
  "startTime" : "2023-09-18T22:00:00.000Z",
  "interval" : "Minutely",
  "frequency" : 5,
  "mon" : true,
  "wed" : true,
  "status" : "enabled"
}

POST応答

作成または更新したスケジュールのスケジュール応答オブジェクトを返します。

エラーが発生した場合はエラーオブジェクトを返します。

応答が成功した場合、以下の例のようになります。

{
    "id": "8oKIw0ib9qMg1lGIWNPzkdD000000000000H",
    "createTime": "2023-09-10T11:48:28.000Z",
    "updateTime": "2023-09-10T11:48:28.000Z",
    "createdBy": "dev_scott",
    "updatedBy": "dev_scott",
    "name": "my_schedule_1",
    "rangeStartTime": null,
    "rangeEndTime": null,
    "status": "enabled",
    "frequency": 5,
    "description": null,
    "mon": true,
    "tue": false,
    "wed": true,
    "thu": false,
    "fri": false,
    "sat": false,
    "sun": false,
    "weekDay": false,
    "dayOfMonth": 0,
    "weekOfMonth": null,
    "dayOfWeek": null,
    "scheduleFederatedId": "1BrVocfYMAzeQHwXaaMWe7",
    "startTime": "2020-12-25T12:00:00.000Z",
    "endTime": null,
    "interval": "Minutely",
    "timeZoneId": "America/Los Angeles"
}

スケジュール

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal