REST APIリファレンス

前へ次へ

スケジュール

このリソースを使用して、スケジュールの詳細、または組織の全スケジュールの詳細を要求します。スケジュールは作成または更新することができます。また、スケジュールを削除することもできます。

完全なスケジュール機能を活用するには、バージョン2のscheduleリソースではなく、バージョン3のscheduleリソースを使用します。

GET要求

組織の全スケジュールの詳細を表示するには、次のURIを使用します。

/api/v2/schedule

特定のスケジュールの詳細を要求する場合、URIにスケジュールIDまたはスケジュール名を含めることができます。次のいずれかのURIを使用します。

/api/v2/schedule/<id>

/api/v2/schedule/name/<name>

URIにスケジュール名を使用し、スケジュール名にスペースが含まれる場合、スペースは

%20

に置き換えます。以下に例を示します。

/api/v2/schedule/name/my%20schedule

GET応答

成功した場合、要求されたスケジュールのスケジュールオブジェクトを返します。または、全スケジュールの詳細を要求した場合、組織の各スケジュールのスケジュールオブジェクトを返します。

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

スケジュールオブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
id	String	スケジュールID。
orgId	String	組織ID。
name	String	スケジュール名。
description	String	スケジュールの説明。
createTime	Date/Time	スケジュールが作成された日時。
updateTime	Date/Time	スケジュールの最終更新時刻。
createdBy	String	スケジュールを作成したユーザー。
updatedBy	String	スケジュールを最後に更新したユーザー。
startTime	Date/Time	スケジュールの実行を開始する日付と時刻。
startTimeUTC	Date/Time	スケジュールのタスクの実行を開始する日付と時刻。協定世界時（UTC）を使用します。
endTime	Date/Time	スケジュールの実行を停止する日付と時刻。
interval	String	スケジュールを実行する間隔または繰り返し頻度。次のいずれかのコードを返します。なし。スケジュールを繰り返しません。 Minutely。指定した分数、日数、および時間範囲に基づく間隔でタスクを実行します。 Hourly。スケジュールの開始時刻に基づき、タスクを1時間間隔で実行します。 Daily。スケジュールの開始時刻に基づき、日次の間隔でタスクを実行します。 Weekly。スケジュールの開始時刻に基づき、1週間間隔でタスクを実行します。隔週。スケジュールの開始時刻に基づき、2週間ごとにタスクを実行します。 Monthly。スケジュールの開始時刻に基づき、1カ月間隔でタスクを実行します。
frequency	Int	指定した間隔でスケジュールを実行する頻度。例えば、間隔が毎時の場合、頻度2は、2時間ごとにタスクを実行することを意味します。分間隔、時間隔、日次の間隔でのみ返されます。
rangeStartTime	Date/Time	タスクを実行する日の時間範囲の開始時刻。分間隔と時間隔でのみ返されます。
rangeEndTime	Date/Time	タスクを実行する日の時間範囲の終了時刻。分間隔と時間隔でのみ返されます。
sun	Boolean	タスクを日曜日に実行します。次のいずれかのコードを返します。 true false 分間隔、時間隔、週次の間隔、隔週の間隔でのみ返されます。
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	String	タスクを実行する月の週数。次のいずれかのコードを返します。 First。月の第1週にタスクを実行します。 Second。月の第2週にタスクを実行します。 Third。月の第3週にタスクを実行します。 Fourth。月の第4週にタスクを実行します。 Last。月の最後の週にタスクを実行します。月次の間隔でのみ返されます。
dayOfWeek	String	タスクを実行する曜日。次のいずれかのコードを返します。 Day。選択したweekOfMonthオプションに基づいて、月の最初または最後の日にタスクを実行します。日曜日月曜日火曜日水曜日木曜日金曜日土曜日月次の間隔でのみ返されます。
timeZone	String	スケジュールを最後に更新したユーザーのタイムゾーン。タイムゾーンは夏時間を使用します。

POST要求

スケジュールを更新するには、次のURIでスケジュールIDを使用します。スケジュールを作成するには、オプションのスケジュールIDを省略します。

/api/v2/schedule/<id>

部分モードを使用して部分的な更新を送信できます。部分モードを使用して要求を送信するには、JSON要求を使用してヘッダーに次の行を含めます。

Update-Mode=PARTIAL

schedule

オブジェクトでは次の属性を使用できます。

フィールド	タイプ	必須	説明
id	String	更新の場合のみ必須	スケジュールID。
orgId	String	○	組織ID。
name	String	○	スケジュール名。
description	String		スケジュールの説明。
startTime	Date/Time	はい	スケジュールの実行を開始する日付と時刻。
startTimeUTC	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。時間隔の場合、次のいずれかのオプションを使用します: 1、2、3、4、6、8、12。日次の間隔の場合、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週の日または最後の水曜日です。次のいずれかのオプションを使用します。日日曜日月曜日火曜日水曜日木曜日金曜日土曜日月次の間隔でのみ使用します。
timeZone	String		スケジュールに使用するタイムゾーン。有効なタイムゾーンが渡されない場合、 Informatica Intelligent Cloud Services はユーザーのタイムゾーンを使用します。詳細については、付録A、タイムゾーンのコードを参照してください。

POST応答

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

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

DELETE要求

スケジュールを削除するには、次のURIでスケジュールIDを使用します。

/api/v2/schedule/<id>

DELETE応答

要求に成功した場合に200の応答コードを返します。

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

GETの例

組織の全スケジュールについての情報を要求するには、次の要求を使用できます。

GET <serverUrl>/api/v2/schedule
Accept: application/json
icSessionId: <icSessionId>

成功した要求は、組織の各オブジェクトのスケジュールオブジェクトを返します。

プラットフォームREST APIバージョン2リソース

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal

Rename Saved Search

目次

REST APIリファレンス

REST APIリファレンス

スケジュール

スケジュール

GET要求

GET応答

POST要求

POST応答

DELETE要求

DELETE応答

GETの例