Documentation
Table of Contents
report.create
Description
object report.create(object/array reports)
Cette méthode permet de créer de nouveaux rapports planifiés.
Cette méthode est disponible uniquement pour les types d'utilisateurs Admin et Super admin. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres de rôles utilisateur. Voir Rôles Utilisateur pour plus d'informations.
Paramètres
(object/array) Rapports planifiés à créer.
En plus des [propriétés de rapport planifié standard] (object#report), la méthode accepte les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| users | object/array of objects | Utilisateurs à qui envoyer le rapport. |
| user_groups | object/array of objects | Groupes d'utilisateurs à qui envoyer le rapport. |
Valeurs retournées
(object) Renvoie un objet contenant les ID des rapports planifiés créés sous la propriété reportids. L'ordre des ID renvoyés correspond à l'ordre des rapports planifiés transmis.
Exemples
Création d'un rapport planifié
Créez un rapport hebdomadaire qui sera préparé pour la semaine précédente tous les lundis-vendredis à 12h00 du 2021-04-01 au 2021-08-31.
Requête :
{
"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"
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
Voir également
- Utilisateurs
- [Groupes d'utilisateurs] (object#user_groups)
Source
CReport::create() dans ui/include/classes/api/services/CReport.php.