[comment]: # translation:outdated

[comment]: # ({7925fa72-7925fa72})
# report.get

[comment]: # ({/7925fa72-7925fa72})

[comment]: # ({89ab5cf0-22ec64b6})
### Descrição  
  
`integer/array report.get(object parameters)`  
  
O método permite recuperar relatórios programados de acordo com os parâmetros fornecidos.  
  
::: noteclassic  
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Consulte [Funções de usuário](/manual/web_interface/frontend_sections/administration/user_roles) para obter mais informações.  
:::

[comment]: # ({/89ab5cf0-22ec64b6})

[comment]: # ({17a91c62-2bc4ba55})
### Parâmetros  
  
`(object)` Parâmetros que definem a saída desejada.  
  
O método oferece suporte aos parâmetros a seguir.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|reportids|string/array|Retornar apenas relatórios programados com os IDs de relatório fornecidos.|
|expired|boolean|Se definido como `true`, retorna apenas relatórios programados expirados, se `false` - somente relatórios programados ativos.|
|selectUsers|query|Retorne uma propriedade [users](/manual/api/reference/user/object) para a qual o relatório está configurado para ser enviado.|
|selectUserGroups|query|Retorne uma propriedade [user\_groups](/manual/api/reference/user/object) para a qual o relatório está configurado para ser enviado.|
|sortfield|string/array|Classifique o resultado pelas propriedades fornecidas.<br><br>Os valores possíveis são: `reportid`, `name`, `status`.|
|countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos `get` são descritos em detalhes na página [comentário de referência](/manual/api/reference_commentary#common_get_method_parameters).|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/17a91c62-2bc4ba55})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno  
  
`(integer/array)` Retorna:  
  
- uma array de objetos;  
- a contagem de objetos recuperados, se o parâmetro `countOutput` foi usado.

[comment]: # ({/7223bab1-7223bab1})

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

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

[comment]: # ({aed4d78a-b7379080})
#### Recuperando dados do relatório

Request:

```json
{
    "jsonrpc": "2.0",
    "method": "report.get",
    "params": [
        "output": "extend",
        "selectUsers": "extend",
        "selectUserGroups": "extend",
        "reportids": ["1", "2"]
    ],
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Response:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "reportid": "1",
            "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",
            "state": "1",
            "lastsent": "1613563219",
            "info": "",
            "users": [
                {
                    "userid": "1",
                    "access_userid": "1",
                    "exclude": "0"
                },
                {
                    "userid": "2",
                    "access_userid": "0",
                    "exclude": "1"
                }
            ],
            "user_groups": [
                {
                    "usrgrpid": "7",
                    "access_userid": "0"
                }
            ]
        },
        {
            "reportid": "2",
            "userid": "1",
            "name": "Monthly report",
            "dashboardid": "2",
            "period": "2",
            "cycle": "2",
            "start_time": "0",
            "weekdays": "0",
            "active_since": "2021-05-01",
            "active_till": "",
            "subject": "Monthly report",
            "message": "Report accompanying text",
            "status": "1",
            "description": "",
            "state": "0",
            "lastsent": "0",
            "info": "",
            "users": [
                {
                    "userid": "1",
                    "access_userid": "1",
                    "exclude": "0"
                }
            ],
            "user_groups": []
        }
    ],
    "id": 1
}
```

[comment]: # ({/aed4d78a-b7379080})

[comment]: # ({7b8422b2-7b8422b2})
### Veja também

-   [Usuários](/manual/api/reference/user/object#users)
-   [Grupos de usuários](/manual/api/reference/user/object#user_groups)

[comment]: # ({/7b8422b2-7b8422b2})

[comment]: # ({de82795f-de82795f})
### Fonte

CReport::get() in *ui/include/classes/api/services/CReport.php*.

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