Read Schedule(スケジュールの参照)
PagerDutyインスタンスからスケジュールを参照します。
入力
| フィールド | 定義 | タイプ | Required (必須) |
|---|---|---|---|
|
スケジュール(Schedule) |
|||
|
スケジュールID(Schedule ID) |
読み取られるスケジュールの一意識別子。 |
テキスト | 正 |
|
開始日時(Since) |
スケジュール検索の日付範囲の始まり。 例: |
日時 | FALSE |
|
タイムゾーン(Time Zone) |
スケジュールのタイムゾーン。デフォルトは |
テキスト | FALSE |
|
終了日時(Until) |
スケジュール検索の日付範囲の終わり。 例: |
日時 | FALSE |
出力
| フィールド | 定義 | タイプ |
|---|---|---|
|
スケジュールID(Schedule ID) |
更新されるスケジュールの一意識別子。 |
テキスト |
|
名前(Name) |
スケジュールレイヤーの名前。 |
テキスト |
|
概要 |
スケジュールの概要。名前(Name)と同じである場合がありますが、識別子にすることは意図されていません。 |
テキスト |
|
説明(Description) |
スケジュールの目的の説明。 |
テキスト |
|
タイプ(Type) |
返されるデータのタイプ。 | テキスト |
|
タイムゾーン(Time Zone) |
スケジュールのタイムゾーン。 |
テキスト |
|
HTML URL |
PagerDuty Webアプリでエンティティーが一意に表示されるURL。 |
テキスト |
|
スケジュールレイヤー(Schedule Layers) |
スケジュールレイヤーのリスト。スケジュールには少なくとも1つのスケジュールレイヤーが含まれている必要があります。 |
オブジェクト |
|
名前(Name) |
スケジュールレイヤーの名前。 |
テキスト |
|
開始(Start) |
このレイヤーの開始時刻。 |
日時 |
|
終了(End) |
このレイヤーの終了時刻。nullの場合、レイヤーは終了しません。 |
日時 |
|
ユーザー(Users) |
ユーザーオブジェクトのリスト。 |
オブジェクトのリスト |
|
ユーザーID(User ID) |
ユーザーの一意識別子。 | テキスト |
|
概要 |
ユーザーオブジェクトの概要。名前(Name)と同じである場合がありますが、識別子にすることは意図されていません。 |
テキスト |
|
タイプ(Type) |
オブジェクトのスキーマを決定する文字列。これはエンティティ―の標準名である必要があり、オブジェクトが参照の場合は接尾辞として |
テキスト |
|
HTML URL |
PagerDuty Webアプリでエンティティーが一意に表示されるURL。 |
テキスト |
|
制限: |
スケジュールレイヤーの制限の配列。制限は、スケジュールレイヤーが割り当てを受け入れることができる日または週の期間に関する限度です。 |
オブジェクトのリスト |
|
タイプ(Type) |
制限の指定されたタイプ。 |
テキスト |
|
期間秒数(Duration Seconds) |
制限の期間(秒単位)。 |
数値 |
|
開始時刻(Start Time of Day) |
|
テキスト |
|
開始曜日(Start Day of Week) |
|
数値 |
|
ローテーション仮想開始(Rotation Virtual Start) |
レイヤーの実質的な開始時刻。これはスケジュールの開始時刻の前にすることができます。 |
日時 |
|
Rotation Turn Length Seconds(ローテーション担当期間(秒)) |
各オンコールシフトの期間(秒) |
数値 |
|
レンダリングされたスケジュールエントリー(Rendered Schedule Entries) |
現在の時間範囲に対して計算されたレイヤー上のエントリーのリスト。このフィールドの入力を有効にするには、開始日時または終了日時を設定する必要があります。 |
オブジェクトのリスト |
|
ユーザー(User)(オブジェクト) |
||
|
ユーザーID(User ID) |
ユーザーオブジェクトの一意のユーザー識別子。 |
テキスト |
|
概要 |
ユーザーオブジェクトの概要。名前(Name)と同じである場合がありますが、識別子にすることは意図されていません。 |
テキスト |
|
タイプ(Type) |
オブジェクトのスキーマを決定する文字列。これはエンティティ―の標準名である必要があり、オブジェクトが参照の場合は接尾辞として |
テキスト |
|
HTML URL |
PagerDuty Webアプリでエンティティーが一意に表示されるURL。 |
テキスト |
|
開始(Start) |
このエントリーの開始時刻。 |
日時 |
|
終了(End) |
このエントリーの終了時刻。nullの場合、エントリーは終了しません。 |
日時 |
|
レンダリングされたカバレッジパーセンテージ(Rendered Coverage Percentage) |
このレイヤーによって対象となった時間範囲のパーセンテージ。開始時刻または終了時刻が設定されない場合は、nullを返します。 |
数値 |
|
最終スケジュール(Final Schedule)(オブジェクト) |
||
|
名前(Name) |
サブスケジュールの名前。 |
テキスト |
|
レンダリングされたスケジュールエントリー(Rendered Schedule Entries) |
現在の時間範囲に対して計算されたレイヤー上のエントリーのリスト。このフィールドの入力を有効にするには、開始日時または終了日時を設定する必要があります。 |
オブジェクトのリスト |
|
ユーザー(User)(オブジェクト) |
||
|
ユーザーID(User ID) |
ユーザーオブジェクトの一意のユーザー識別子。 |
テキスト |
|
概要 |
ユーザーオブジェクトの概要。名前(Name)と同じである場合がありますが、識別子にすることは意図されていません。 |
テキスト |
|
タイプ(Type) |
オブジェクトのスキーマを決定する文字列。これはエンティティ―の標準名である必要があり、オブジェクトが参照の場合は接尾辞として |
テキスト |
|
HTML URL |
PagerDuty Webアプリでエンティティーが一意に表示されるURL。 |
テキスト |
|
開始(Start) |
このエントリーの開始時刻。 |
日時 |
|
終了(End) |
このエントリーの終了時刻。nullの場合、エントリーは終了しません。 |
日時 |
|
レンダリングされたカバレッジパーセンテージ(Rendered Coverage Percentage) |
このレイヤーによって対象となった時間範囲のパーセンテージ。開始時刻または終了時刻が設定されない場合は、nullを返します。 |
数値 |
|
オーバーライドサブスケジュール(Overrides Subschedule)(オブジェクト) |
||
|
名前(Name) |
サブスケジュールの名前 |
テキスト |
|
レンダリングされたスケジュールエントリー(Rendered Schedule Entries) |
現在の時間範囲に対して計算されたレイヤー上のエントリーのリスト。このフィールドの入力を有効にするには、開始日時または終了日時を設定する必要があります。 |
オブジェクトのリスト |
|
ユーザー(User)(オブジェクト) |
||
|
ユーザーID(User ID) |
ユーザーオブジェクトの一意のユーザー識別子。 |
テキスト |
|
概要 |
ユーザーオブジェクトの概要。名前(Name)と同じである場合がありますが、識別子にすることは意図されていません。 |
テキスト |
|
タイプ(Type) |
オブジェクトのスキーマを決定する文字列。これはエンティティ―の標準名である必要があり、オブジェクトが参照の場合は接尾辞として |
テキスト |
|
HTML URL |
PagerDuty Webアプリでエンティティーが一意に表示されるURL。 |
テキスト |
|
開始(Start) |
このエントリーの開始時刻。 |
日時 |
|
終了(End) |
このエントリーの終了時刻。nullの場合、エントリーは終了しません。 |
日時 |
|
レンダリングされたカバレッジパーセンテージ(Rendered Coverage Percentage) |
このレイヤーによって対象となった時間範囲のパーセンテージ。開始時刻または終了時刻が設定されない場合は、nullを返します。 |
数値 |
|
エスカレーションポリシー(Escalation Policies)(オブジェクトのリスト) |
||
|
エスカレーションポリシーID(Escalation Policy ID) |
エスカレーションポリシーの一意のユーザー識別子。 |
テキスト |
|
概要 |
エスカレーションポリシーオブジェクトの概要。名前(Name)と同じである場合がありますが、識別子にすることは意図されていません。 |
テキスト |
|
タイプ(Type) |
オブジェクトのスキーマを決定する文字列。これはエンティティ―の標準名である必要があり、オブジェクトが参照の場合は接尾辞として |
テキスト |
|
HTML URL |
PagerDuty Webアプリでエンティティーが一意に表示されるURL。 |
テキスト |
|
ユーザー(Users)(オブジェクトのリスト) |
||
|
ユーザーID(User ID) |
ユーザーオブジェクトの一意のユーザー識別子。 |
テキスト |
|
概要 |
ユーザーオブジェクトの概要。名前(Name)と同じである場合がありますが、識別子にすることは意図されていません。 |
テキスト |
|
タイプ(Type) |
オブジェクトのスキーマを決定する文字列。これはエンティティ―の標準名である必要があり、オブジェクトが参照の場合は接尾辞として |
テキスト |
|
HTML URL |
PagerDuty Webアプリでエンティティーが一意に表示されるURL。 |
テキスト |
|
チーム(Teams)(オブジェクトのリスト) |
||
|
チームID(Team ID) |
チームオブジェクトの一意のユーザー識別子。 |
テキスト |
|
概要 |
チームオブジェクトの概要。名前(Name)と同じである場合がありますが、識別子にすることは意図されていません。 |
テキスト |
|
タイプ(Type) |
オブジェクトのスキーマを決定する文字列。これはエンティティ―の標準名である必要があり、オブジェクトが参照の場合は接尾辞として |
テキスト |
|
HTML URL |
PagerDuty Webアプリでエンティティーが一意に表示されるURL。 |
テキスト |