[comment]: # ({9793e988-9793e988})
# report.create

[comment]: # ({/9793e988-9793e988})

[comment]: # ({ea36381d-a8301e64})
### Descrição

`object report.create(object/array reports)`

Este método permite criar novos relatórios agendados.

::: noteclassic
Este método está disponível apenas para os tipos de usuário *Admin* e *Super admin*. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja [Funções de usuário](/manual/web_interface/frontend_sections/users/user_roles) para mais informações.
:::

[comment]: # ({/ea36381d-a8301e64})

[comment]: # ({352998e1-869414cf})
### Parâmetros

`(object/array)` Relatórios agendados a serem criados.

Além das [propriedades padrão de relatórios agendados](object#report), o método aceita os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|users|object/array|[Usuários](object#users) para enviar o relatório.<br><br>[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):<br>- *obrigatório* se `user_groups` não estiver definido|
|user\_groups|object/array|[Grupos de usuários](object#user-groups) para enviar o relatório.<br><br>[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):<br>- *obrigatório* se `users` não estiver definido|

[comment]: # ({/352998e1-869414cf})

[comment]: # ({05ef7a50-05ef7a50})
### Valores de retorno

`(object)` Retorna um objeto contendo os IDs dos relatórios agendados criados na propriedade `reportids`. A ordem dos IDs retornados corresponde à ordem dos relatórios agendados passados.

[comment]: # ({/05ef7a50-05ef7a50})

[comment]: # ({b41637d2-b41637d2})
### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({05ea3a37-1cfccf99})
#### Criando um relatório agendado

Crie um relatório semanal que será preparado para a semana anterior toda
segunda a sexta-feira às 12:00 de 2021-04-01 a 2021-08-31.

[Requisição](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "report.create",
    "params": {
        "userid": "1",
        "name": "Weekly report",
        "dashboardid": "1",
        "period": "1",
        "cycle": "1",
        "start_time": "43200",
        "weekdays": "31",
        "active_since": "2021-04-01",
        "active_till": "2021-08-31",
        "subject": "Weekly report",
        "message": "Report accompanying text",
        "status": "1",
        "description": "Report description",
        "users": [
            {
                "userid": "1",
                "access_userid": "1",
                "exclude": "0"
            },
            {
                "userid": "2",
                "access_userid": "0",
                "exclude": "1"
            }
        ],
        "user_groups": [
            {
                "usrgrpid": "7",
                "access_userid": "0"
            }
        ]
    },
    "id": 1
}
```

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "reportids": [
            "1"
        ]
    },
    "id": 1
}
```

[comment]: # ({/05ea3a37-1cfccf99})

[comment]: # ({24bb6b3b-c52572c8})
### Veja também

-   [Usuários](object#users)
-   [Grupos de usuários](object#user-groups)

[comment]: # ({/24bb6b3b-c52572c8})

[comment]: # ({f8046691-f8046691})
### Origem

CReport::create() em *ui/include/classes/api/services/CReport.php*.

[comment]: # ({/f8046691-f8046691})