integer/array report.get(object parameters)
La méthode permet de récupérer des rapports planifiés en fonction des paramètres donnés.
Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.
(objet)
Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
Paramètre | Type | Description |
---|---|---|
reportids | string/array | Renvoie uniquement les rapports planifiés avec les ID de rapport donnés. |
expired | boolean | Si défini sur true , seuls les rapports planifiés expirés sont renvoyés, si false - uniquement les rapports planifiés actifs. |
selectUsers | query | Renvoie une propriété users à laquelle le rapport est configuré pour être envoyé. |
selectUserGroups | query | Renvoie une propriété user_groups à laquelle le rapport est configuré pour être envoyé. |
sortfield | string/array | Trier le résultat selon les propriétés données. Les valeurs possibles sont : reportid , name , status . |
countOutput | boolean | Ces paramètres, communs à toutes les méthodes get , sont décrits dans les commentaires de référence. |
editable | boolean | |
excludeSearch | boolean | |
filter | object | |
limit | integer | |
output | query | |
preservekeys | boolean | |
search | object | |
searchByAny | boolean | |
searchWildcardsEnabled | boolean | |
sortorder | string/array | |
startSearch | boolean |
(integer/array)
Retourne soit :
countOutput
a été utilisé.Requête :
{
"jsonrpc": "2.0",
"method": "report.get",
"params": [
"output": "extend",
"selectUsers": "extend",
"selectUserGroups": "extend",
"reportids": ["1", "2"]
],
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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
}
CReport::get() dans ui/include/classes/api/services/CReport.php.