1 Action log

説明

これらのパラメータと各ダッシュボードウィジェットフィールドオブジェクトの可能なプロパティ値により、dashboard.createおよびdashboard.updateメソッドでアクションログウィジェットを設定できます。

ウィジェットのfieldsプロパティは、ダッシュボードの作成または更新時にバリデーションされません。 これにより、ユーザーは組み込みウィジェットを変更したり、カスタムウィジェットを作成したりできますが、ウィジェットを誤って作成または更新するリスクも生じます。 アクションログウィジェットの作成または更新を確実に行うには、以下の表に記載されているパラメータの動作を参照してください。

パラメータ

以下のパラメータは、Action log ウィジェットでサポートされています。

Parameter type name value
Refresh interval 0 rf_rate 0 - 更新しない;
10 - 10秒;
30 - 30秒;
60 - (default) 1分;
120 - 2分;
600 - 10分;
900 - 15分。
Recipients 11 userids.0 User ID。

Note: 複数のユーザーを設定するには、プロパティ名の番号を増やしながら、ユーザーごとに dashboard widget field object を作成します。
Actions 12 actionids.0 Action ID。

Note: 複数のアクションを設定するには、プロパティ名の番号を増やしながら、アクションごとに dashboard widget field object を作成します。
Media types 13 mediatypeids.0 Media type ID。

Note: 複数のメディアタイプを設定するには、プロパティ名の番号を増やしながら、メディアタイプごとに dashboard widget field object を作成します。
Status 0 statuses.0 0 - 進行中;
1 - 送信済み/実行済み;
2 - 失敗。

Note: 複数の値を設定するには、プロパティ名の番号を増やしながら、値ごとに dashboard widget field object を作成します。
Search string 1 message 任意の文字列値。
Time period 1 time_period._reference DASHBOARD._timeperiod - Time period selector をデータソースとして設定します;
ABCDE._timeperiod - 互換性のあるウィジェットReference パラメータを "ABCDE" に設定したもの)をデータソースとして設定します。

Default: DASHBOARD._timeperiod

または、FromTo パラメータのみで時間範囲を設定することもできます。
From 1 time_period.from 絶対時間 (YYYY-MM-DD hh:mm:ss) または 相対 時刻構文 (now, now/d, now/w-1w, など) における有効な時刻文字列。

Parameter behavior:
- supported if Time period is not set
- time_period.to が設定されている場合は required
To 1 time_period.to 絶対時間 (YYYY-MM-DD hh:mm:ss) または 相対 時刻構文 (now, now/d, now/w-1w, など) における有効な時刻文字列。

Parameter behavior:
- supported if Time period is not set
- time_period.from が設定されている場合は required
Sort entries by 0 sort_triggers 3 - 時刻(昇順);
4 - (default) 時刻(降順);
5 - 種別(昇順);
6 - 種別(降順);
7 - ステータス(昇順);
8 - ステータス(降順);
11 - 受信者(昇順);
12 - 受信者(降順)。
Show lines 0 show_lines 値の範囲は 1-100 です。

Default: 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
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "3"
        ]
    },
    "id": 1
}

参照