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 permettant d’appeler la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Consultez User roles pour plus d’informations.
Paramètres
(object/array) Rapports planifiés à créer.
En plus des propriétés standard des rapports planifiés, la méthode accepte les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| users | object/array | Utilisateurs auxquels envoyer le rapport. Comportement du paramètre : - obligatoire si user_groups n’est pas défini |
| user_groups | object/array | Groupes d’utilisateurs auxquels envoyer le rapport. Comportement du paramètre : - obligatoire si users n’est pas défini |
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 chaque lundi-vendredi à 12:00 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"
}
]
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1"
]
},
"id": 1
}Voir également
- Utilisateurs
- [Groupes d'utilisateurs] (object#user_groups)
Source
CReport::create() dans ui/include/classes/api/services/CReport.php.