report.get

Description

integer/array report.get(object parameters)

Cette méthode vous permet de récupérer les rapports planifiés en fonction des paramètres indiqués.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations permettant d'appeler la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Consultez la page Rôles utilisateur pour plus d'informations.

Paramètres

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

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

Paramètre Type 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 contenant les utilisateurs auxquels le rapport est configuré pour être envoyé.
selectUserGroups query Retourner une propriété 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.

Valeurs possibles : reportid, name, status.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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é.

Exemples

Récupération des données des rapports

Requête:

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

Réponse :

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

Voir aussi

Source

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