GS: Assessment: API: GET /quality-api/internal/assessments/events
Üldkirjeldus
Teenus tagastab muutunud hindamise tulemused raportite koostamiseks päringus määratud ajavahemikus.
Eeltingimused ja kasutusõigused
- Tegemist on masin-masin liidese päringuga. Vajalik eraldi autentimine süsteemse kasutajana.
- Autentimiseks on vajalik päringus päisesse lisada:
- X-API-TOKEN
- vajaliku keskkonnapõhise väärtuse saab Rakendused, keskkonnad ja ligipääsud lehelt
Sisendid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Vaikeväärtus, valideerimine | Kirjeldus, täiendav info |
|---|---|---|---|---|
| from | 1 | OffsetDateTime | Formaat: YYYY-MM-DDTHH:mm:ss.sssTZ | Muudatuste alguskuupäev ja kellaaeg (sisend query parameetrina) |
| to | 0..1 | OffsetDateTime | Formaat: YYYY-MM-DDTHH:mm:ss.sssTZ Vaikimisi hetkeaeg | Muudatuste lõppkuupäev ja kellaaeg (sisend query parameetrina) |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| events | 0..* | Array | Nimekirja objektid sisaldavad infot vahemikus muutunud hindamiste kohta. Vahemikus leidunud muudatustest tagastatakse viimase muudatuse info |
| events.assessmentId | 1 | String | Hindamise identifikaator (ID) |
| events.status | 1 | String | Hindamise staatus. Võimalikud väärtused:
|
| events.date | 1 | DateTime | Hindamisega seotud viimase muudatuse kuupäev ja kellaaeg (ajatsooni info puudub, andmed on alati Eesti aja järgi). |
Tegevused
- Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
- Kui kasutajal ei ole õigust päringut teostada, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem kontrollib, kas andmed vastavad nõuetele.
- Kui andmed ei vasta nõuetele, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem otsib hindamistega seotud muudatused.
- Süsteem otsib hindamise komponentide elemendid, mille:
- modifiedAt on sisendis esitatud kuupäevade vahemikus
- synchronizedToDwh = true
- Süsteem otsib komponentide elementidega seotud komponendid
- Süsteem otsib hindamise komponentide elemendid, mille:
- Süsteem tagastab leitud andmed.
Näidisväljund
NB! Väljundi andmestikku on vähendatud.