[comment]: # translation:outdated

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

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

[comment]: # ({c4ffda2f-22ec64b6})
### Description

`integer/array report.get(object parameters)`

Cette méthode permet de récupérer les rapports planifiés selon les paramètres donnés.

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Voir [User
roles](/manual/web_interface/frontend_sections/users/user_roles)
pour plus d’informations.
:::

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

[comment]: # ({9bbdf58d-2bc4ba55})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Paramètre|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|reportids|ID/array|Retourner uniquement les rapports planifiés avec les ID de rapport indiqués.|
|expired|boolean|Si défini sur `true`, retourner uniquement les rapports planifiés expirés.|
|selectUsers|query|Retourner une propriété [`users`](/manual/api/reference/report/object#users) contenant les utilisateurs auxquels le rapport est configuré pour être envoyé.|
|selectUserGroups|query|Retourner une propriété [`user_groups`](/manual/api/reference/report/object#user-groups) contenant les groupes d'utilisateurs auxquels le rapport est configuré pour être envoyé.|
|sortfield|string/array|Trier le résultat selon les propriétés indiquées.<br><br>Valeurs possibles : `reportid`, `name`, `status`.|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/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]: # ({/9bbdf58d-2bc4ba55})

[comment]: # ({7223bab1-7223bab1})
### Valeurs retournées

`(integer/array)` Retourne soit :

-   un tableau d'objets ;
-   le nombre d'objets récupérés, si le paramètre `countOutput` a été utilisé.

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

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

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

[comment]: # ({65ef8cf5-b7379080})
#### Récupération des données de rapport

[Requête](/manual/api#performing-requests):

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

Réponse :

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "reportid": "1",
            "userid": "1",
            "name": "Rapport hebdomadaire",
            "dashboardid": "1",
            "period": "1",
            "cycle": "1",
            "start_time": "43200",
            "weekdays": "31",
            "active_since": "2021-04-01",
            "active_till": "2021-08-31",
            "subject": "Rapport hebdomadaire",
            "message": "Texte d’accompagnement du rapport",
            "status": "1",
            "description": "Description du rapport",
            "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": "Rapport mensuel",
            "dashboardid": "2",
            "period": "2",
            "cycle": "2",
            "start_time": "0",
            "weekdays": "0",
            "active_since": "2021-05-01",
            "active_till": "",
            "subject": "Rapport mensuel",
            "message": "Texte d’accompagnement du rapport",
            "status": "1",
            "description": "",
            "state": "0",
            "lastsent": "0",
            "info": "",
            "users": [
                {
                    "userid": "1",
                    "access_userid": "1",
                    "exclude": "0"
                }
            ],
            "user_groups": []
        }
    ],
    "id": 1
}
```

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

[comment]: # ({7dcda109-7b8422b2})
### Voir aussi

-   [Utilisateurs](/manual/api/reference/user/object#users)
-   [Groupes d'utilisateurs](/manual/api/reference/user/object#user-groups)

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

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

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

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