Schválení dat¶

Schválení dat¶

Tato část vysvětluje, jak schválit, zrušit schválení a zkontrolovat stav schválení pomocí prostředku dataApprovals. Schvalování se provádí podle pracovního postupu schvalování dat, období, organizační jednotky a kombinace možností atributů.

/api/33/dataApprovals

Pracovní postup schválení dat je přidružen k několika entitám:

• Typ období, který určuje četnost schválení
• Volitelná kombinace kategorií
• Jedna nebo více úrovní schválení dat, které jsou součástí pracovního postupu
• Jedna nebo více datových sad, které se používají pro sběr dat

Získejte stav schválení¶

Chcete-li získat informace o schválení sady dat, můžete vystavit požadavek GET:

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

Tabulka: Parametry dotazu na schválení dat

Poznámka

Z důvodu zpětné kompatibility může být pro pracovní tok v tomto a dalších požadavcích na schválení dat, jak je popsáno níže, místo parametru wf uveden parametr ds. Pokud je zadána datová sada, použije se pracovní postup přidružený k této datové sadě.

To způsobí odpověď podobnou této:

{
  "mayApprove": false,
  "mayUnapprove": false,
  "mayAccept": false,
  "mayUnaccept": false,
  "state": "APPROVED_HERE",
  "approvedBy": "User A",
  "approvedAt": "2022-01-13T12:56:07.005",
  "acceptedBy": "User A",
  "acceptedAt": "2022-01-13T12:56:07.005"
}

Vrácené parametry jsou:

Tabulka: Vrácené parametry schválení dat

Tabulka: Stavy schválení dat

Upozorňujeme, že při dotazování na stav schválení dat můžete určit libovolnou kombinaci parametrů dotazu. Kombinace, kterou zadáte, nemusí popisovat místo, kde mají být údaje schváleny na jedné ze úrovní schválení. Například:

• The organisation unit might not be at an approval level. The approval status is determined by whether data is approved at an approval level for an ancestor of the organisation unit.

• Můžete zadat jednotlivé možnosti kategorií atributů. Schválení stav je určen tím, zda jsou data pro atribut schválena kombinace možností kategorie, která zahrnuje jednu nebo více z nich options.

• You may specify a time period that is longer than the period for the data set at which the data is entered and approved. The approval status is determined by whether the data is approved for all the období datových souborů ve vámi určeném období.

For data sets which are associated with a category combo you might want to fetch data approval records for individual attribute option combos from the following resource with a GET request:

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

Hromadně získat stav schválení¶

Chcete-li získat seznam několika stavů schválení, můžete vystavit požadavek GET podobný tomuto:

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

Parametry wf, pe, ou a aoc jsou stejné jako pro získání jediného stavu schválení, kromě toho, že pro každý parametr můžete poskytnout seznam jedné nebo více hodnot oddělených čárkami.

Získáte odpověď obsahující seznam parametrů schválení a stavů, například:

[
  {
    "aoc": "HllvX50cXC0",
    "pe": "201801",
    "level": "KaTJLhGmU95",
    "ou": "YuQRtpLP10I",
    "permissions": {
      "mayApprove": false,
      "mayUnapprove": true,
      "mayAccept": true,
      "mayUnaccept": false,
      "mayReadData": true,
      "approvedBy": "User A",
      "approvedAt": "2022-01-13T12:56:07.005",
      "acceptedBy": "User A",
      "acceptedAt": "2022-01-13T12:56:07.005"      
    },
    "state": "APPROVED_HERE",
    "wf": "rIUL3hYOjJc"
  },
  {
    "aoc": "HllvX50cXC0",
    "pe": "201802",
    "ou": "YuQRtpLP10I",
    "permissions": {
      "mayApprove": true,
      "mayUnapprove": false,
      "mayAccept": false,
      "mayUnaccept": false,
      "mayReadData": true
    },
    "state": "UNAPPROVED_READY",
    "wf": "rIUL3hYOjJc"
  }
]

Vrácená pole jsou popsána v tabulce níže.

Schválit data¶

To approve data you can issue a POST request to the dataApprovals resource. To un-approve data, you can issue a DELETE request to the dataApprovals resource.

POST DELETE /api/33/dataApprovals

To accept data that is already approved you can issue a POST request to the dataAcceptances resource. To un-accept data, you can issue a DELETE request to the dataAcceptances resource.

POST DELETE /api/33/dataAcceptances

Tyto požadavky obsahují následující parametry:

Tabulka: Parametry akce schválení dat

Note that, unlike querying the data approval status, you must specify parameters that correspond to a selection of data that could be approved. In particular, both of the following must be true:

• The organisation unit's level must be specified by an approval level v pracovním postupu.

• The time period specified must match the period type of the workflow.

Hromadně schvalovat data¶

Hromadné datové záznamy můžete schválit odesláním do zdroje /api/dataApprovals/approvals.

POST /api/33/dataApprovals/approvals

You can unapprove a bulk of data records by posting to the /api/dataApprovals/unapprovals resource.

POST /api/33/dataApprovals/unapprovals

You can accept a bulk of records by posting to the /api/dataAcceptances/acceptances resource.

POST /api/33/dataAcceptances/acceptances

Většinu záznamů můžete zrušit odesláním na zdroj /api/dataAcceptances/unacceptances.

POST /api/33/dataAcceptances/unacceptances

Schválení datového obsahu je podporováno jako JSON a vypadá takto:

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

Získejte úrovně schválení dat¶

To retrieve data approval workflows and their data approval levels you can make a GET request similar to this:

/api/dataApprovalWorkflows?
  fields=id,name,periodType,dataApprovalLevels[id,name,level,orgUnitLevel]

Authorities for data approval¶

• F_DATA_APPROVAL_WORKFLOW : povolit uživateli přidat / aktualizovat pracovní postup schvalování dat
• F_DATA_APPROVAL_LEVEL : povolit uživateli přidat / aktualizovat úroveň schválení dat