GS: DashboardDefinition: API: POST /quality-api/dashboard-definitions
Üldkirjeldus
Teenus salvestab juhtimislaua üldandmeid.
Seotud andmeobjektid:
NSIL-413 - Getting issue details... STATUS NSIL-1133 - Getting issue details... STATUS NSIL-1238 - Getting issue details... STATUS
Eeltingimused ja kasutusõigused
- Kasutajal peab olema õigus lisada valdkonna juhtimislaudu (Vaata Sisendid → dashboardType → Vaikeväärtus, valideerimine)
Sisendid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Vaikeväärtus, valideerimine | Kirjeldus, täiendav info |
|---|---|---|---|---|
| name | 1 | String |
| Juhtimislaua nimetus. |
| domainType | 1 | EHIS Classifier |
| Juhtimislaua valdkond. |
| dashboardType | 1 | EHIS Classifier |
| Juhtimislaua liik. |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| id | 1 | String (PK) | Hindamise id (UUID). |
| code | 1 | String | Juhtimislaua unikaalne äriline id ehk kood. |
| name | 1 | String | Juhtimislaua nimetus. |
| domainType | 1 | EHIS Classifier | Juhtimislaua valdkond. Väärtusena klassifikaatori Klassifikaatorid#KlassifikaatorDOMAIN element. |
| dashboardType | 1 | EHIS Classifier | Juhtimislaua liik. Väärtusena klassifikaatori Klassifikaatorid#KlassifikaatorDASHBOARD_TYPE element. |
| publishedAt | 0..1 | Date and time | Juhtimislaua avalikustamise aeg. |
| statusType | 1 | EHIS Classifier | Juhtimislaua staatus. Väärtusena klassifikaatori Klassifikaatorid#KlassifikaatorDASHBOARD_STATUS element. |
| institutions | 0..* | Array | Asutuste liikide nimekiri, mille kasutajatele juhtimislaud avaldatakse. Ühele juhtimislauale võidakse lisada mitu asutuse liiki. |
| institutions.institutionType | 1 | EHIS Classifier Object | Asutuse liigi objekt. |
| institutions.specificationTypes | 0..* | Array | Asutuse liigi täpsustused. Ühel asutuse liigil võib olla mitu täpsustust. |
| institutions.institutionIds | 0..* | Array | Asutuste nimekiri, mille kasutajatele juhtimislaud avaldatakse. Ühele juhtimislauale võidakse lisada mitu asutust. |
| visibleToOwner | 0..1 | Boolean | Määrab, kas juhtimislaud on õppeasutuse pidajale nähtav või mitte. true - juhtimislaud on pidajale õppeasutuse rollis nähtav. false - juhtimislaud ei ole pidajale õppeasutuse rollis nähtav. |
| htmStructureUnits | 0..* | Array | Määrab, millistele HTM struktuuriüksuste töötajatele juhtimislaud avaldatud on. |
| objectStatus | 1 | String | Objekti staatus.
|
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 valideerib sisendi.
- Kui sisend on ebakorrektne, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem loob juhtimislaua üldandmed.
- Süsteem loob Objektid#DashboardDefinition objekti:
- id = UUID
- domain = Sisendis esitatud domainType väärtus.
- dashboardType = Sisendis esitatud dashboardType väärtus.
- code = Sisendis esitatud dashboardType väärtusega seotud valdkonna kood (Klassifikaatorid#KlassifikaatorDOMAIN) + juhtimislaua järjekord valdkonnas. Näiteks NSILM1
- name = Sisendis esitatud name väärtus.
- publishedAt = null
- statusType = Mustand
- institutions = null
- visibleToOwner = false
- htmStructureUnits = null
- objectStatus = CURRENT
- audit (loomine) = audit (loomine)
- Süsteem loob Objektid#DashboardDefinition objekti:
- Süsteem tagastab loodud andmed.