REST APIリファレンス

前へ次へ

スケジュールの詳細の取得

スケジュールリソースを使用して、組織内のスケジュールに関する詳細を要求します。

GET要求

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

/public/core/v3/schedule

スケジュールIDを使用してスケジュールの詳細を取得するには、次のURIを使用します。

/public/core/v3/schedule/<id>

特定のスケジュールの詳細を取得するには、クエリパラメータを使用できます。例えば、ユーザーjdoeによって作成されたすべての無効スケジュールの詳細を取得するには、次のURIを使用できます。

/public/core/v3/schedule?q=status=='Disabled' and createdBy=='jdoe'

URIで以下のクエリパラメータを使用できます。

パラメータ	タイプ	説明
status	Boolean	スケジュールのステータス。以下の演算子を使用できます。 == ! =
id	String	スケジュールID。 ==演算子を使用します。
scheduleFederatedId	String	スケジュールのグローバル一意識別子。 ==演算子を使用します。
name	String	スケジュール名。 ==演算子を使用します。スケジュール名にスペースが含まれる場合は、スペースを %20 で置き換えます。
updateTime	Date	スケジュールの最終更新時刻（UTC形式）。以下の演算子を使用できます。 < <= == => > ! =
updatedBy	String	スケジュールを更新したユーザー。 ==演算子を使用します。
createdBy	String	スケジュールを作成したユーザー。 ==演算子を使用します。
interval	String	スケジュールを実行する間隔または繰り返し頻度。以下の値を使用できます。なし毎分 n時間ごと日次毎週隔週月別以下の演算子を使用できます。 == ! =

GET応答

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

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

タスクオブジェクトには次の属性が含まれます。

フィールド	タイプ	説明
id	String	スケジュールID。
scheduleFederatedId	String	スケジュールのグローバル一意識別子。
name	String	スケジュール名。
status	String	スケジュールのステータス。次のいずれかの値を返します。有効無効
description	String	スケジュールの説明。
createTime	Date/Time	スケジュールが作成された日時。
updateTime	Date/Time	スケジュールの最終更新時刻。
createdBy	String	スケジュールを作成したユーザー。
updatedBy	String	スケジュールを最後に更新したユーザー。
startTime	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オプションに基づいて、月の最初または最後の日にタスクを実行します。日曜日月曜日火曜日水曜日木曜日金曜日土曜日月次の間隔でのみ返されます。
timeZoneId	String	タスクが実行される月の特定の曜日、日、または週に使用されるタイムゾーン。

GETの例

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

GET <baseApiUrl>/public/core/v3/schedule/0An1v84VPL3k6kypOlxq06D0000000000003
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>

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

{        

"id": "0An1v84VPL3k6kypOlxq06D0000000000003",     
"scheduleFederatedId" : "24bDtKg6d9SbaNlqDolHSR",        
"name": "MI_FILE_LISTENER_10107",       
"status":"enabled", 
"createTime": "2018-12-03T17:34:45.000Z",        
"updateTime": "2019-05-09T12:13:34.000Z",        
"createdBy": "clouddemo",        
"updatedBy": "vnath",        
"startTime": "2020-06-09T00:15:55.000Z",       
"interval": "Minutely",        
"frequency": 5,     
"rangeStartTime" : "",
"rangeEndTime" : "",   
"mon": true,        
"tue": true,        
"wed": true,        
"thu": true,        
"fri": true,        
"sat": true,        
"sun": true,        
"weekDay": false,        
"dayOfMonth": 0,     
"weekOfMonth": null,
"dayOfWeek": null, 
"timeZoneId": "America/Los Angeles"

}

スケジュール

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal