1 Log de ações

Descrição

Esses parâmetros e os possíveis valores de propriedade para os respectivos objetos de campo do widget do dashboard permitem configurar o widget Action log nos métodos dashboard.create e dashboard.update.

As propriedades fields do widget não são validadas durante a criação ou atualização de um dashboard. Isso permite que os usuários modifiquem widgets internos e criem widgets personalizados, mas também introduz o risco de criar ou atualizar widgets incorretamente. Para garantir a criação ou atualização bem-sucedida do widget Action log, consulte o comportamento dos parâmetros descritos nas tabelas abaixo.

Parâmetros

Os seguintes parâmetros são suportados para o widget Action log.

Parameter type name value
Refresh interval 0 rf_rate 0 - Sem atualização;
10 - 10 segundos;
30 - 30 segundos;
60 - (padrão) 1 minuto;
120 - 2 minutos;
600 - 10 minutos;
900 - 15 minutos.
Recipients 11 userids.0 ID do User.

Nota: Para configurar vários usuários, crie um objeto de campo do widget do dashboard para cada usuário com um número incrementado no nome da propriedade.
Actions 12 actionids.0 ID da Action.

Nota: Para configurar várias actions, crie um objeto de campo do widget do dashboard para cada action com um número incrementado no nome da propriedade.
Media types 13 mediatypeids.0 ID do Media type.

Nota: Para configurar vários tipos de mídia, crie um objeto de campo do widget do dashboard para cada tipo de mídia com um número incrementado no nome da propriedade.
Status 0 statuses.0 0 - Em andamento;
1 - Enviado/Executado;
2 - Falhou.

Nota: Para configurar vários valores, crie um objeto de campo do widget do dashboard para cada valor com um número incrementado no nome da propriedade.
Search string 1 message Qualquer valor de string.
Time period 1 time_period._reference DASHBOARD._timeperiod - define o seletor Time period como a fonte de dados;
ABCDE._timeperiod - define um widget compatível (com o parâmetro Reference definido como "ABCDE") como a fonte de dados.

Padrão: DASHBOARD._timeperiod

Como alternativa, você pode definir o período de tempo apenas nos parâmetros From e To.
From 1 time_period.from String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou de tempo relativa (now, now/d, now/w-1w, etc.).

Comportamento do parâmetro:
- supported se Time period não estiver definido
- required se time_period.to estiver definido
To 1 time_period.to String de tempo válida em sintaxe absoluta (YYYY-MM-DD hh:mm:ss) ou de tempo relativa (now, now/d, now/w-1w, etc.).

Comportamento do parâmetro:
- supported se Time period não estiver definido
- required se time_period.from estiver definido
Sort entries by 0 sort_triggers 3 - Hora (crescente);
4 - (padrão) Hora (decrescente);
5 - Tipo (crescente);
6 - Tipo (decrescente);
7 - Status (crescente);
8 - Status (decrescente);
11 - Destinatário (crescente);
12 - Destinatário (decrescente).
Show lines 0 show_lines Os valores possíveis variam de 1 a 100.

Padrão: 25.

Exemplos

Os exemplos a seguir visam apenas descrever a configuração dos objetos de campo do widget de dashboard para o widget Action log. Para mais informações sobre a configuração de um dashboard, consulte dashboard.create.

Configurando um widget Action log

Configure um widget Action log que exibe 10 entradas de detalhes de operações de ação, ordenadas por hora (em ordem crescente). Além disso, exiba detalhes apenas para aquelas operações de ação que tentaram enviar um e-mail para o usuário "1", mas não foram bem-sucedidas.

Requisição:

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

Resposta:

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

Veja também