Table of Contents
1 Action log
説明
これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.createメソッドおよびdashboard.updateメソッドでアクションログウィジェットを設定できます。
ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 アクションログウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
パラメーター
アクションログウィジェットでサポートされているパラメーターは以下の通りです。
| パラメーター | type | name | 値 | |
|---|---|---|---|---|
| リフレッシュ間隔 | 0 | rf_rate | 0 - リフレッシュなし; 10 - 10秒; 30 - 30秒; 60 - (デフォルト) 1分; 120 - 2分; 600 - 10分; 900 - 15分。 |
|
| 受信者 | 11 | userids.0 | ユーザーID。 注: 複数のユーザーを設定するには、プロパティ名の番号を増やして各ユーザーごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
| アクション | 12 | actionids.0 | アクションID。 注: 複数のアクションを設定するには、プロパティ名の番号を増やして各アクションごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
| メディアタイプ | 13 | mediatypeids.0 | メディアタイプID。 注: 複数のメディアタイプを設定するには、プロパティ名の番号を増やして各メディアタイプごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
| ステータス | 0 | statuses.0 | 0 - 進行中; 1 - 送信/実行済み; 2 - 失敗。 注: 複数の値を設定するには、プロパティ名の番号を増やして各値ごとにダッシュボードウィジェットフィールドオブジェクトを作成してください。 |
|
| 検索文字列 | 1 | message | 任意の文字列値。 | |
| 期間 | 1 | time_period._reference | DASHBOARD._timeperiod - ダッシュボードの期間セレクターをデータソースとして設定;ABCDE._timeperiod - 互換ウィジェット（参照パラメーターを"ABCDE"に設定）をデータソースとして設定。デフォルト: DASHBOARD._timeperiodまたは、FromおよびToパラメーターで期間のみを設定することもできます。 |
|
| From | 1 | time_period.from | 絶対（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1wなど）の有効な時間文字列。パラメーターの動作: - 期間が設定されていない場合にサポート |
|
| To | 1 | time_period.to | 絶対（YYYY-MM-DD hh:mm:ss）または相対時間構文（now、now/d、now/w-1wなど）の有効な時間文字列。パラメーターの動作: - 期間が設定されていない場合にサポート |
|
| エントリの並び替え | 0 | sort_triggers | 3 - 時刻（昇順）; 4 - (デフォルト) 時刻（降順）; 5 - タイプ（昇順）; 6 - タイプ（降順）; 7 - ステータス（昇順）; 8 - ステータス（降順）; 11 - 受信者（昇順）; 12 - 受信者（降順）。 |
|
| 表示行数 | 0 | show_lines | 1-100の範囲で指定可能。 デフォルト: 25。 |
|
例
次の例は、アクションログウィジェットのダッシュボードウィジェットフィールドオブジェクトの設定を説明することだけを目的としています。 ダッシュボードの設定の詳細については、dashboard.createを参照してください。
アクションログウィジェットの設定
時間でソート(昇順)したアクション操作の詳細の10のエントリを表示するアクションログウィジェットを設定します。 さらに、ユーザー"1"に電子メールを送信しようとしたが失敗したアクション操作のみの詳細を表示します。
{
"jsonrpc": "2.0",
"method": "dashboard.create",
"params": {
"name": "My dashboard",
"display_period": 30,
"auto_start": 1,
"pages": [
{
"widgets": [
{
"type": "actionlog",
"name": "Action log",
"x": 0,
"y": 0,
"width": 36,
"height": 5,
"view_mode": 0,
"fields": [
{
"type": 0,
"name": "show_lines",
"value": 10
},
{
"type": 0,
"name": "sort_triggers",
"value": 3
},
{
"type": 11,
"name": "userids.0",
"value": 1
},
{
"type": 13,
"name": "mediatypeids.0",
"value": 1
},
{
"type": 0,
"name": "statuses.0",
"value": 2
}
]
}
]
}
],
"userGroups": [
{
"usrgrpid": 7,
"permission": 2
}
],
"users": [
{
"userid": 1,
"permission": 3
}
]
},
"id": 1
}レスポンス: