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