Aller au contenu
For the complete DHIS2 documentation index, see llms.txt.

Approbation des données

Approbation des données

Cette section explique comment approuver, désapprouver et vérifier le statut d'approbation en utilisant la ressource dataApprovals (Approbation des données). L'approbation se fait par flux de travail d'approbation des données, par période, par unité d'organisation et par combinaison d'options d'attributs.

/api/33/dataApprovals

Un processus d'approbation des données est associé à plusieurs entités :

  • Un type de période qui définit la fréquence d'approbation
  • Une combinaison de catégories facultative
  • Un ou plusieurs niveaux d'approbation des données qui font partie du flux de travail
  • Un ou plusieurs ensembles de données utilisés pour la collecte de données

Obtenir le statut d'approbation

Pour obtenir des informations sur l'approbation d'un ensemble de données, vous pouvez envoyer une requête GET :

/api/dataApprovals?wf=rIUL3hYOjJc&pe=201801&ou=YuQRtpLP10I

Tableau : Paramètres de requête pour l'approbation des données

Paramètre de requête Obligatoire Description
wf Oui Identifiant du workflow d'approbation des données
pe Oui Identifiant de période
ou Oui Identifiant de l'unité d'organisation
aoc Non Identifiant de combinaison d'options d'attributs

Remarque

Pour des raisons de compatibilité en amont, le paramètre ds pour l'ensemble de données peut être donné à la place de wf pour le flux de travail dans cette demande d'approbation de données et dans d'autres, comme décrit ci-dessous. Si l'ensemble de données est donné, le flux de travail associé à cet ensemble de données sera utilisé.

Vous obtiendrez une réponse similaire à celle-ci :

{
" peutApprouver " : faux,
" peutDésapprouver " : faux,
" peutAccepter " : faux,
" peutRefuser " : faux,
" status " : " APPROUVÉ_ICI ",
" approuvéPar " : "Utilisateur A",
" approuvéÀ " : "2022-01-13T12:56:07.005",
" acceptéPar " : "Utilisateur A",
" AcceptéÀ " : "2022-01-13T12:56:07.005"
}

Les paramètres obtenus sont les suivants :

Tableau : Paramètres obtenus pour l'approbation des données

Paramètre de retour Description
peutApprouver Si l'utilisateur actuel peut approuver cette sélection de données.
peutDésapprouver Si l'utilisateur actuel peut désapprouver cette sélection de données.
peutAccepter Si l'utilisateur actuel peut accepter cette sélection de données.
peutRefuser Si l'utilisateur actuel peut refuser cette sélection de données.
État L'un des états d'approbation des données est indiqué dans le tableau ci-dessous.
approuvéPar Si la sélection est approuvée, et si disponible (pas toujours nécessaire), le nom de l'utilisateur qui a approuvé la sélection.
approuvéÀ Si la sélection est approuvée, et si disponible (pas toujours nécessaire), la date et l'heure à laquelle le niveau d'approbation le plus élevé a été créé.
acceptéPar Si la sélection est approuvée, et si disponible (pas toujours nécessaire), le nom de l'utilisateur qui a effectué la dernière mise à jour.
acceptéÀ Si la sélection est approuvée, et si disponible (pas toujours nécessaire), la date et l'heure de la dernière mise à jour du niveau d'approbation le plus élevé.

Tableau : États d'approbation des données

État Description
NON APPROUVÉ L'approbation des données ne s'applique pas à cette sélection. (Les données ne sont ni approuvées ni non approuvées).
NON APPROUVÉ_EN ATTENTE Les données pourraient être approuvées pour cette sélection, mais elles attendent une approbation de niveau inférieur avant d'être prêtes à être approuvées.
NON APPROUVÉ_AUTRE PART Les données ne sont pas approuvées et attendent d'être approuvées autre part (elles ne peuvent pas être approuvées ici).
NON APPROUVÉ_ PRÊT Les données ne sont pas approuvées et sont prêtes à être approuvées pour cette sélection.
APPROUVÉ_ICI Les données sont approuvées et ont été approuvées ici (elles pourraient donc être non approuvées ici).
APPROUVÉ_AUTRE PART Les données sont approuvées, mais n'ont pas été approuvées ici (et ne peuvent donc pas être non approuvées ici) :
* Les données sont approuvées à un niveau supérieur.
* Les données sont approuvées pour un plus grand nombre d'options de catégories.
* Les données sont approuvées pour toutes les sous-périodes de la période sélectionnée.
Dans les deux premiers cas, il existe un seul objet d'approbation des données qui couvre la sélection. Dans le troisième cas, il n'y en a pas.
ACCEPTÉ_ICI Les données sont approuvées et acceptées ici (elles pourraient donc être non approuvées ici).
ACCEPTÉ_AUTRE PART Les données sont approuvées et acceptées, mais à un autre endroit.

Notez que lorsque vous demandez l'état de l'approbation des données, vous pouvez spécifier toute combinaison de paramètres d'interrogation. La combinaison que vous spécifiez ne doit pas nécessairement décrire l'endroit où les données doivent être approuvées à l'un des niveaux d'approbation. Par exemple :

  • L'unité d'organisation peut ne pas être à un niveau d'approbation. Le statut d'approbation est déterminé par le fait que les données sont approuvées à un niveau d'approbation pour un ascendant de l'unité d'organisation.

  • Vous pouvez spécifier des options de catégories d'attributs individuelles. Le statut d'approbation est déterminé par le fait que les données sont approuvées pour une combinaison d'options de catégorie d'attributs qui comprend une ou plusieurs de ces options.

  • Vous pouvez spécifier une période plus longue que celle de l'ensemble de données, au cours de laquelle les données sont saisies et approuvées. Le statut d'approbation est déterminé par l'approbation des données pour toutes les périodes de l'ensemble de données au cours de la période spécifiée.

Pour les ensembles de données associés à une combinaison de catégories, il est possible de récupérer les enregistrements d'approbation des données pour les combinaisons d'options d'attributs individuels à partir de la ressource suivante, au moyen d'une requête GET :

/api/dataApprovals/categoryOptionCombos?wf=rIUL3hYOjJc&pe=201801&ou=YuQRtpLP10I

Obtenir le statut d'approbation en bloc

Pour obtenir une liste de plusieurs statuts d'approbation, vous pouvez envoyer une requête GET similaire à celle-ci :

/api/dataApprovals/approvals?wf=rIUL3hYOjJc&pe=201801,201802&ou=YuQRtpLP10I

Les paramètres wf, pe, ou, et aoc sont les mêmes que pour obtenir un statut d'approbation unique, sauf que vous pouvez fournir une liste séparée par des virgules d'une ou plusieurs valeurs pour chaque paramètre.

Vous obtiendrez une réponse contenant une liste de paramètres d'approbation et de statuts, comme suit :

[
  {
    "aoc": "HllvX50cXC0",
    "pe": "201801",
    "niveau": "KaTJLhGmU95",
    "ou": "YuQRtpLP10I",
    "permissions": {
      "peutApprouver": faux,
      "peutDésapprouver": vrai,
      "peutAccepter": vrai,
      "peutRefuser": faux,
      "peutLirelesdonnées": vrai,
      "approuvéPar": "Utilisateur A",
      "approuvéÀ": "2022-01-13T12:56:07.005",
      "acceptéPar": "Utilisateur A",
      "acceptéPar": "2022-01-13T12:56:07.005"      
    },
    "statut": "APPROUVÉ_ICI",
    "wf": "rIUL3hYOjJc"
  },
  {
    "aoc": "HllvX50cXC0",
    "pe": "201802",
    "ou": "YuQRtpLP10I",
    "permissions": {
      "peutApprouver": vrai,
      "peutDésapprouver": faux,
      "peutAccepter": faux,
      "peutRefuser": faux,
      "peutLirelesdonnées":  vrai
    },
    "statut": "DÉSAPPROUVÉ_PRÊT",
    "wf": "rIUL3hYOjJc"
  }
]

Les champs obtenus sont décrits dans le tableau ci-dessous.

Champ Description
aoc Identifiant de combinaison d'options d'attributs
pe Identifiant de période
ou Identifiant d'unité d'organisation
autorisations Les autorisations : mêmes définitions que pour l'obtention d'un statut d'approbation unique (voir le tableau Paramètres d'approbation des données renvoyés).
État Un des états d'approbation des données (comme pour obtenir un statut d'approbation unique.)
wf Identifiant du workflow d'approbation des données

Approuver les données

Pour approuver des données, vous pouvez envoyer une demande POST à la ressource dataApprovals. Pour annuler l'approbation des données, vous pouvez envoyer une demande SUPPRIMER à la ressource dataApprovals.

POST DELETE /api/33/dataApprovals

Pour accepter des données déjà approuvées, vous pouvez envoyer une demande POSTER à la ressource Acceptationdesdonnées. Pour annuler l'acceptation de données, vous pouvez envoyer une demande SUPPRIMER à la ressource Acceptationdesdonnées.

POST DELETE /api/33/dataAcceptances

Ces demandes contiennent les paramètres suivants :

Tableau : Paramètres d'action pour l'approbation des données

Paramètres d'action Obligatoire Description
wf Oui Identifiant du workflow d'approbation des données
pe Oui Identifiant de période
ou Oui Identifiant de l'unité d'organisation
aoc Non Identifiant de combinaison d'options d'attributs

Notez que, contrairement à la requête sur le statut d'approbation des données, vous devez spécifier des paramètres qui correspondent à une sélection de données susceptibles d'être approuvées. En particulier, les deux éléments suivants doivent être vrais :

  • Le niveau de l'unité d'organisation doit être spécifié par un niveau d'approbation dans le flux de travail.

  • La période spécifiée doit correspondre au type de période du flux de travail.

Approuver les données en bloc

Vous pouvez approuver un ensemble d'enregistrements de données en postant dans la ressource /api/dataApprovals/approvals.

POST /api/33/dataApprovals/approvals

Vous pouvez approuver un bloc d'enregistrements de données en postant dans la ressource /api/dataApprovals/approvals.

POST /api/33/dataApprovals/unapprovals

Vous pouvez accepter un grand nombre d'enregistrements en envoyant un message à la ressource /api/dataAcceptances/acceptances.

POST /api/33/dataAcceptances/acceptances

Vous pouvez refuser un bloc d'enregistrements en envoyant un message à la ressource /api/dataAcceptances/acceptances.

POST /api/33/dataAcceptances/unacceptances

La charge utile d'approbation est prise en charge en tant que JSON et ressemble à ceci :

{
  "wf": [
    "pBOMPrpg1QX", "lyLU2wR22tC"
  ],
  "pe": [
    "201601", "201602"
  ],
  "approvals": [
    {
      "ou": "cDw53Ej8rju",
      "aoc": "ranftQIH5M9"
    },
    {
      "ou": "cDw53Ej8rju",
      "aoc": "fC3z1lcAW5x"
    }
  ]
}

Obtenir les niveaux d'approbation des données

Pour récupérer les flux de travail d'approbation des données et leurs niveaux d'approbation, vous pouvez effectuer une requête GET similaire à celle-ci :

/api/dataApprovalWorkflows ? champs=identifiant, nom, type de période, niveau d'approbation des données [identifiant, nom, niveau, niveau de l'unité d'organisation]

Responsables de l'approbation des données

  • F_FLUX DE TRAVAIL_ DE L' APPROBATION_DES DONNÉES : permet à l'utilisateur d'ajouter/mettre à jour le flux de travail relatif à l'approbation des données.
  • F_NIVEAU_D'APPROBATION DES_DONNÉES : permet à l'utilisateur d'ajouter/mettre à jour le niveau d'approbation des données.