report.update
Description
object report.update(object/array reports)
Cette méthode permet de mettre à jour des rapports planifiés existants.
Cette méthode est disponible uniquement pour le type d’utilisateur Admin et Super admin. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir Rôles utilisateur pour plus d’informations.
Paramètres
(object/array) Propriétés des rapports planifiés à mettre à jour.
La propriété reportid doit être définie pour chaque rapport planifié, toutes
les autres propriétés sont facultatives. Seules les propriétés transmises seront
mises à jour, toutes les autres resteront inchangées.
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 remplaçant les utilisateurs actuellement affectés au rapport planifié. Comportement du paramètre : - obligatoire si user_groups n’est pas défini |
| user_groups | object/array | Groupes d’utilisateurs remplaçant les groupes d’utilisateurs actuellement affectés au rapport planifié. Comportement du paramètre : - obligatoire si users n’est pas défini |
Valeurs retournées
(object) Retourne un objet contenant les identifiants des rapports planifiés mis à jour sous la propriété reportids.
Exemples
Désactivation d’un rapport planifié
{
"jsonrpc": "2.0",
"method": "report.update",
"params": {
"reportid": "1",
"status": "0"
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"reportids": [
"1"
]
},
"id": 1
}Voir également
- Utilisateurs
- [Groupes d'utilisateurs] (object#user_groups)
Source
CReport::update() dans ui/include/classes/api/services/CReport.php.