1 Aktionsprotokoll

Beschreibung

Diese Parameter und die möglichen Eigenschaftswerte für die jeweiligen Dashboard-Widget-Feldobjekte ermöglichen die Konfiguration des Widgets Aktionsprotokoll in den Methoden dashboard.create und dashboard.update.

Die Eigenschaften von Widget-fields werden bei der Erstellung oder Aktualisierung eines Dashboards nicht validiert. Dadurch können Benutzer integrierte Widgets ändern und benutzerdefinierte Widgets erstellen, es besteht jedoch auch das Risiko, Widgets fehlerhaft zu erstellen oder zu aktualisieren. Um die erfolgreiche Erstellung oder Aktualisierung des Widgets Aktionsprotokoll sicherzustellen, beachten Sie bitte das in den folgenden Tabellen beschriebene Parameterverhalten.

Parameter

Die folgenden Parameter werden für das Widget Action log unterstützt.

Parameter type name value
Refresh interval 0 rf_rate 0 - Keine Aktualisierung;
10 - 10 Sekunden;
30 - 30 Sekunden;
60 - (Standard) 1 Minute;
120 - 2 Minuten;
600 - 10 Minuten;
900 - 15 Minuten.
Recipients 11 userids.0 User ID.

Hinweis: Um mehrere Benutzer zu konfigurieren, erstellen Sie für jeden Benutzer ein Dashboard-Widget-Feldobjekt mit einer erhöhten Zahl im Eigenschaftsnamen.
Actions 12 actionids.0 Action ID.

Hinweis: Um mehrere Aktionen zu konfigurieren, erstellen Sie für jede Aktion ein Dashboard-Widget-Feldobjekt mit einer erhöhten Zahl im Eigenschaftsnamen.
Media types 13 mediatypeids.0 Media type ID.

Hinweis: Um mehrere Medientypen zu konfigurieren, erstellen Sie für jeden Medientyp ein Dashboard-Widget-Feldobjekt mit einer erhöhten Zahl im Eigenschaftsnamen.
Status 0 statuses.0 0 - In Bearbeitung;
1 - Gesendet/Ausgeführt;
2 - Fehlgeschlagen.

Hinweis: Um mehrere Werte zu konfigurieren, erstellen Sie für jeden Wert ein Dashboard-Widget-Feldobjekt mit einer erhöhten Zahl im Eigenschaftsnamen.
Search string 1 message Beliebiger Zeichenfolgenwert.
Time period 1 time_period._reference DASHBOARD._timeperiod - legt den Time period selector als Datenquelle fest;
ABCDE._timeperiod - legt ein kompatibles Widget (mit dem Parameter Reference auf "ABCDE" gesetzt) als Datenquelle fest.

Standard: DASHBOARD._timeperiod

Alternativ können Sie den Zeitraum nur in den Parametern From und To festlegen.
From 1 time_period.from Gültige Zeitangabe im absoluten (YYYY-MM-DD hh:mm:ss) oder relativen Zeitformat (now, now/d, now/w-1w, usw.).

Parameterverhalten:
- supported wenn Time period nicht gesetzt ist
- required wenn time_period.to gesetzt ist
To 1 time_period.to Gültige Zeitangabe im absoluten (YYYY-MM-DD hh:mm:ss) oder relativen Zeitformat (now, now/d, now/w-1w, usw.).

Parameterverhalten:
- supported wenn Time period nicht gesetzt ist
- required wenn time_period.from gesetzt ist
Sort entries by 0 sort_triggers 3 - Zeit (aufsteigend);
4 - (Standard) Zeit (absteigend);
5 - Typ (aufsteigend);
6 - Typ (absteigend);
7 - Status (aufsteigend);
8 - Status (absteigend);
11 - Empfänger (aufsteigend);
12 - Empfänger (absteigend).
Show lines 0 show_lines Mögliche Werte liegen im Bereich von 1-100.

Standard: 25.

Beispiele

Die folgenden Beispiele sollen lediglich die Konfiguration der Dashboard-Widget-Feldobjekte für das Aktionsprotokoll-Widget beschreiben. Weitere Informationen zur Konfiguration eines Dashboards finden Sie unter dashboard.create.

Konfiguration eines Widgets Aktionsprotokoll

Konfigurieren Sie ein Widget Aktionsprotokoll, das 10 Einträge mit Details zu Aktionsoperationen anzeigt, nach Zeit sortiert (in aufsteigender Reihenfolge). Zeigen Sie außerdem nur Details für diejenigen Aktionsoperationen an, die versucht haben, eine E-Mail an Benutzer „1“ zu senden, jedoch nicht erfolgreich waren.

Anfrage:

{
    "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
}

Antwort:

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

Siehe auch