これらのパラメーターと、各ダッシュボードウィジェットフィールドオブジェクトの有効なプロパティ値を使用することで、dashboard.create
メソッドおよびdashboard.update
メソッドでアクションログウィジェットを設定できます。
ウィジェットのfields
プロパティは、ダッシュボードの作成または更新時に検証されません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新してしまうリスクも生じます。 アクションログウィジェットを正常に作成または更新するには、以下の表に記載されているパラメーターの動作を参照してください。
アクションログウィジェットでは、以下のパラメーターがサポートされています。
パラメーター | type | name | value | |
---|---|---|---|---|
リフレッシュ間隔 | 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 - 互換性のあるウィジェット(Referenceパラメーターを"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
}
レスポンス: