timeexcludeオブジェクトは、X-MONの除外時刻設定を操作するオブジェクトです。
timeexclude.addは、除外時刻設定を新規作成するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| timeperiod_name 必須 | string |
時刻IDを指定します。 |
| alias | string |
除外時刻の名称を指定します。 省略時には、timeperiod_nameと同じ値が指定されます。 |
| type 必須 | string |
除外時刻の種別を指定します。
weekを指定した場合、weekカラムの指定が必須となります。 day/periodを指定した場合、dateカラムの指定が必須となります。 |
| week | array |
除外時刻の曜日を指定します。
|
| date | string |
除外時刻の日付を指定します。 2014/01/01 や 2014/01/01-2014/01/15 といったフォーマットで指定してください。 |
| time 必須 | string |
除外時刻の時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。
timeexclude.deleteは、除外時刻設定を削除するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| timeperiod_name 必須 | string |
時刻IDを指定します。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。
timeexclude.getは、除外時刻設定を取得するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
| カラム名称 | 型 | 概要 |
|---|---|---|
| timeperiod_name | string | 取得する除外時刻を指定します。 |
| key | string |
検索する除外時刻設定を指定します。 空欄を指定した場合、全ての除外時刻設定を取得します。 |
| limit | integer |
検索時に取得する件数を指定します。 省略時は、全件が取得されます。 |
| offset | integer |
取得開始する除外時刻設定の行数を指定します。 省略時は、0が指定されます。 |
このメソッドは、timeperiod_nameもしくはkeyのどちらかの指定が必要です。
| カラム名称 | 概要 |
|---|---|
| id |
内部管理用のID |
| timeperiod_name |
時刻ID |
| alias |
除外時刻名称 |
| type |
除外時刻の種別
|
| week |
除外時刻の曜日情報
|
| date |
除外時刻の日付情報 |
| time |
除外時刻の時間帯 |
timeexclude.updateは、既存の除外時刻設定を編集するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| timeperiod_name 必須 | string |
時刻IDを指定します。 |
| alias | string |
除外時刻の名称を指定します。 |
| type 必須 | string |
除外時刻の種別を指定します。
weekを指定した場合、weekカラムの指定が必須となります。 day/periodを指定した場合、dateカラムの指定が必須となります。 |
| week | array |
除外時刻の曜日を指定します。
|
| date | string |
除外時刻の日付を指定します。 2014/01/01 や 2014/01/01-2014/01/15 といったフォーマットで指定してください。 |
| time 必須 | string |
除外時刻の時間帯を指定します。 00:00-24:00 といったフォーマットで指定してください。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。