Audit¶
Audit¶
DHIS2 audite les mises à jour et les suppressions de valeurs de données agrégées, de valeurs de données d'entités suivies, de valeurs d'attributs d'entités suivies et d'enregistrements d'approbation de données. Cette section explique comment récupérer les enregistrements d'audit pour les entités mentionnées. Plusieurs paramètres de requête peuvent être répétés autant de fois que nécessaire.
Audits des valeurs de données agrégées¶
Le point d'extrémité des audits de valeurs de données agrégées se trouve ici :
/api/audits/dataValue
Tableau : Paramètres de requête pour les valeurs de données agrégées
| Paramètre | Option | Description |
|---|---|---|
| ds | ID de l'ensemble de données | Un ou plusieurs identifiants d'ensembles de données pour obtenir des éléments de données |
| de | ID de l'élément de données | Un ou plusieurs identifiants d'éléments de données |
| pe | Période ISO | Un ou plusieurs identifiants ISO de période |
| ou | Identifiant de l'unité d'organisation | Un ou plusieurs identifiants d'unité d'organisation |
| auditType | UPDATE | DELETE |
| skipPaging | faux | vrai | Activer / désactiver la pagination |
| pagination | faux | vrai | Activer ou désactiver la pagination |
| page | Numéro | Numéro de page (par défaut 1) |
| pageSize | Numéro | Taille de la page (par défaut 50) |
Exemple : Obtenir les audits pour un ensemble de données lyLU2wR22tC et un type d'audit CREATE ou UPDATE :
/api/33/audits/dataValue?ds=lyLU2wR22tC&auditType=CREATE,UPDATE
Exemple : Obtenir les audits pour l'élément de données BOSZApCrBni, l'unité d'organisation DiszpKrYNg8 et la combinaison d'options de catégorie TkDhg29x18A :
/api/33/audits/dataValue?de=BOSZApCrBni&ou=DiszpKrYNg8&co=TkDhg29x18A
Audits de valeurs de données d'entités suivies¶
Le point d'extrémité des audits de valeurs de données d'entités suivies se trouve ici :
/api/audits/trackedEntityDataValue
Tableau : Paramètres de requête pour les valeurs de données d'entités suivies
| Paramètre | Option | Description ; |
|---|---|---|
| de | ID de l'élément de données | Un ou plusieurs identifiants d'éléments de données |
| ou | Identifiant de l'unité d'organisation | Un ou plusieurs identifiants d'unité d'organisation de l'événement audité |
| events | ID des événements | Un ou plusieurs identifiants d'évènement pour l'événement audité (séparés par des virgules) |
| ps | ID de l'étape de programme | Une ou plusieurs étape(s) du programme de l'événement d'audit |
| startDate | Date de début | Renvoie uniquement les enregistrements d'audit créés après cette date |
| endDate | Date de fin | Renvoie uniquement les enregistrements d'audit créés avant cette date |
| ouMode | Mode de sélection de l'unité d'organisation | SELECTED | DESCENDANTS |
| auditType | UPDATE | DELETE |
| skipPaging | false | true |
| pagination | faux | vrai | Détermine s'il faut activer ou désactiver la pagination |
| page | Numéro | Numéro de page (par défaut 1) |
| pageSize | Numéro | Taille de la page (par défaut 50) |
Exemple : Obtenir les audits pour les éléments de données eMyVanycQSC et qrur9Dvnyt5 :
/api/33/audits/trackedEntityDataValue?de=eMyVanycQSC&de=qrur9Dvnyt5
Exemple : Obtenir les audits de l'unité d'organisation O6uvpzGd5pu, y compris les unités d'organisation qui lui sont inférieures dans la hiérarchie :
/api/audits/trackedEntityDataValue?ou=O6uvpzGd5pu&ouMode=DESCENDANTS
Audits des valeurs d'attributs d'entités suivies¶
Le point d'extrémité des audits de valeurs d'attributs d'entités suivies se trouve ici :
/api/audits/trackedEntityAttributeValue
Tableau : Paramètres de requête pour les valeurs d'attributs d'entités suivies
| Paramètre | Option | Description |
|---|---|---|
| tea | ID de l'attribut d'entité suivie | Un ou plusieurs identifiants d'attributs d'entités suivies |
| trackedEntities | ID de l'entité suivie | Un ou plusieurs identifiants d'entités suivies (séparés par des virgules) |
| auditType | UPDATE | DELETE |
| skipPaging | faux | vrai | Activer / désactiver la pagination |
| pagination | false | true | Détermine s'il faut activer ou désactiver la pagination |
| page | Numéro | Numéro de page (par défaut 1) |
| taille de la page | Numéro | Taille de la page (par défaut 50) |
Exemple : Obtenir les audits pour l'attribut d'entité suivie VqEFza8wbwA :
/api/33/audits/trackedEntityAttributeValue?tea=VqEFza8wbwA
Exemple : Obtenir les audits pour l'instance d'entité suivie wNiQ2coVZ39 et le type d'audit DELETE :
/api/33/audits/trackedEntityAttributeValue?trackedEntities=wNiQ2coVZ39&auditType=DELETE
Audits d'instances d'entités suivies¶
Une fois que l'audit est activé pour les entités suivies (en réglant allowAuditLog des types d'entités suivies sur true), toutes les opérations de lecture et de recherche sont enregistrées. Le point d'extrémité pour accéder aux journaux d'audit se trouve ici :
/api/audits/trackedEntity
Tableau : Paramètres de requête pour les audits d'entités suivies
| Paramètre | Option | Description |
|---|---|---|
| trackedEntities | Uid d'entités suivies | Un ou plusieurs identifiants d'entités suivies (séparés par des virgules) |
| user | Utilisateur | Un ou plusieurs identifiants d'utilisateur |
| auditType | SEARCH | READ |
| startDate | Date de début | Date de début des audits au format aaaa-mm-jj. |
| endDate | Date de fin | Date de fin des audits au format aaaa-mm-jj. |
| skipPaging | false | true |
| pagination | false | true | Détermine s'il faut activer ou désactiver la pagination |
| page | Numéro | Numéro de page (par défaut 1) |
| pageSize | Numéro | Taille de la page (par défaut 50) |
Exemple : Obtenir les audits de type READ avec startDate 2018-03-01 et endDate 2018-04-24 avec une taille de page de 5 :
/api/33/audits/trackedEntity.json?startDate=2021-03-01&endDate=2022-04-24&auditType=READ&pageSize=5
Exemple : Obtenir les audits de l'entité suivie wNiQ2coVZ39 :
/api/33/audits/trackedEntity.json?trackedEntities=wNiQ2coVZ39
Audits d'instances d'entités suivies OBSOLÈTES¶
Une fois que l'audit est activé pour les instances d'entités suivies (en réglant allowAuditLog des types d'entités suivies sur true), toutes les opérations de lecture et de recherche sont enregistrées. Le point d'extrémité pour accéder aux journaux d'audit se trouve ici :
/api/audits/trackedEntityInstance
Tableau : Paramètres de requête pour les instances d'audit d'entités suivies
| Paramètre | Option | Description |
|---|---|---|
| trackedEntities | Uid d'entités suivies | Un ou plusieurs identifiants d'entités suivies (séparés par des virgules) |
| user | Utilisateur | Un ou plusieurs identifiants d'utilisateur |
| auditType | SEARCH | READ |
| startDate | Date de début | Date de début des audits au format aaaa-mm-jj. |
| endDate | Date de fin | Date de fin des audits au format aaaa-mm-jj. |
| skipPaging | false | true |
| pagination | false | true | Détermine s'il faut activer ou désactiver la pagination |
| page | Numéro | Numéro de page (par défaut 1) |
| pageSize | Numéro | Taille de la page (par défaut 50) |
Exemple : Obtenir les audits de type READ avec startDate 2018-03-01 et endDate 2018-04-24 avec une taille de page de 5 :
/api/33/audits/trackedEntityInstance.json?startDate=2021-03-01&endDate=2022-04-24&auditType=READ&pageSize=5
Exemple : Obtenir les audits de l'entité suivie wNiQ2coVZ39 :
/api/33/audits/trackedEntityInstance.json?trackedEntities=wNiQ2coVZ39
Audits d'approbation des données¶
Le point d'extrémité des audits d'approbation de données se trouve ici :
/api/audits/dataApproval
Tableau : Paramètres de requête pour l'approbation des données
| Paramètre | Option | Description |
|---|---|---|
| dal | ID du niveau d'approbation des données | Un ou plusieurs identifiants de niveau d'approbation des données |
| wf | ID du flux d'approbation des données | Un ou plusieurs identifiants de flux d'approbation des données |
| ou | Identifiant de l'unité d'organisation | Un ou plusieurs identifiants d'unité d'organisation |
| aoc | ID de la combinaison d'options d'attribut | Un ou plusieurs identifiants de combinaison d'options d'attribut |
| startDate | Date de début | Date de début des approbations au format aaaa-mm-jj. |
| endDate | Date de fin | Date de fin des approbations au format aaaa-mm-jj. |
| skipPaging | false | true |
| page | Nombre | Numéro de page (par défaut 1) |
| pageSize | Numéro | Taille de la page (par défaut 50) |
Exemple : Obtenir les audits pour le flux d'approbation des données i5m0JPw4DQi :
/api/33/audits/dataApproval?wf=i5m0JPw4DQi
Exemple : Obtenir les audits entre 2021-01-01 et 2022-01-01 pour l'unité d'organisation DiszpKrYNg8 :
/api/33/audits/dataApproval?ou=DiszpKrYNg8&startDate=2021-01-01&endDate=2022-01-01