GS: DashboardDefinitionSection: API: GET /dashboard-api/dashboards/{dashboardId}/components-order
Üldkirjeldus
Teenus otsib juhtimislaua komponentide järjekorra andmed.
Seotud andmeobjektid:
NSIL-474 - Getting issue details... STATUS NSIL-1134 - Getting issue details... STATUS NSIL-1224 - Getting issue details... STATUS
Eeltingimused ja kasutusõigused
- Kasutajal peab olema autenditud ja autoriseeritud (Omab kehtivat tokenit).
Sisendid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Vaikeväärtus, valideerimine | Kirjeldus, täiendav info |
|---|---|---|---|---|
| dashboardId | 1 | UUID |
| Juhtimislaua id (UUID). |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| components | 0..* | Nested Array | Nimekiri juhtimislaua komponentidest (sektsioon, vormielement). Juhtimislaua komponendid on mitmetasandilised. See tähendab, et ühe juhtimislaua komponendi sees saab olla mitu alakomponenti ja alakomponentidel saab olla alakomponente lõpmatu sügavusega. Sektsiooni tüüpi komponent saab olla esimese ja teise taseme komponent, Sektsioon ei saa olla kolmanda taseme komponent. Vormielemendi tüüpi komponent saab olla teise ja kolmanda taseme komponent. Vormielement ei saa olla esimese taseme komponent. Sektsiooni tüüpi komponendil saab olla alakomponente, sh sektsioonid ja vormielemendid. Vormielementi tüüpi komponendil ei saa olla alakomponente. Samal tasemel ja sama ülemkomponendi all kuuluvad komponendid saavad olla ainult sama liiki komponent. |
| components.id | 1 | FK | Viide hindamise komponendile (sektsioonile või vormielemendile). Viitab DashboardDefinitionSection.Id (sektsioon) väärtusele või DashboardDefinitionElement.id (vormielement) väärtusele. |
| components.type | 1 | Enum | Hindamise komponendi tüüp. Võimalikud väärtused:
|
| components.level | 1 | Integer | Komponendi tase. Tasemed algavad ühest. |
| components.seqNo | 1 | Integer | Komponendi järjekorranumber. Järjekord algab ühest. |
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 otsib juhtimislaua üldandmed.
- Süsteem otsib Objektid#DashboardDefinition objekti, mille:
- Asutuse tüübile avaldatud juhtimislaud.
- statusType = PUBLIC
- institutions.institutionType =
- GET /hsilm-gateway/userinfo.response.organizations.institutionType
- Või GS: Classifiers: API: GET /hsilm-gateway/ehis/institutions.response.educationalInstitutions.type, mille educationalInstitutions.owner.regCode = GET hsilm-gateway/userinfo.response.organizations.regCode, mille privilegeList sisaldab privileegi HSILM_OWNER_DASHBOARD_SEARCH
- institutions.specificationTypes =
- GET /hsilm-gateway/userinfo.response.organizations.institutionSubType
- Või GS: Classifiers: API: GET /hsilm-gateway/ehis/institutions.response.educationalInstitutions.type, mille educationalInstitutions.owner.regCode = GET hsilm-gateway/userinfo.response.organizations.regCode, mille privilegeList sisaldab privileegi HSILM_OWNER_DASHBOARD_SEARCH
- specificationTypes järgi filtreerimist kasutatakse, kui asutuse tüüp on õppeasutus.
- GET /hsilm-gateway/userinfo.response.organizations.institutionType = EDUCATIONAL_INSTITUTION
- specificationTypes järgi filtreerimist kasutatakse, kui asutuse tüüp on õppeasutus.
- Kui kasutaja on pidaja rollis, siis visibleToOwner = true, muudel juhtudel visibleToOwner parameetri kitsendust ei rakendata.
- Kui kasutaja ei ole pidaja rollis, siis kitsendatakse päringut valdkondaega, mille vaatamise õigus kasutajal (pidaja rollis seda ei tehta) on ehk:
- domainType = Klassifikaatorid#KlassifikaatorDOMAIN väärtused, mille ClassifierAttributeValue.classifierAttributeDefinitionCode = DASHBOARD_VIEW_PRIVILEGE ja ClassifierAttributeValue.attributeValue = tokenist organizations.privilegeList, mille organizations.institutionId = Sisendis esitatud institutionId.
- objectStatus = CURRENT
- Registrikoodile avaldatud juhtimislauad.
- statusType = PUBLIC
- institutions.institutionId =
- GET /hsilm-gateway/userinfo.response.organizations.institutionId
- Või GS: Classifiers: API: GET /hsilm-gateway/ehis/institutions.response.educationalInstitutions.id, mille educationalInstitutions.owner.regCode = GET hsilm-gateway/userinfo.response.organizations.regCode, mille privilegeList sisaldab privileegi HSILM_OWNER_DASHBOARD_SEARCH
- Kui kasutaja on pidaja rollis, siis visibleToOwner = true, muudel juhtudel visibleToOwner parameetri kitsendust ei rakendata.
- Kui kasutaja ei ole pidaja rollis, siis kitsendatakse päringut valdkondaega, mille vaatamise õigus kasutajal (pidaja rollis seda ei tehta) on ehk:
- domainType = Klassifikaatorid#KlassifikaatorDOMAIN väärtused, mille ClassifierAttributeValue.classifierAttributeDefinitionCode = DASHBOARD_VIEW_PRIVILEGE ja ClassifierAttributeValue.attributeValue = tokenist organizations.privilegeList, mille organizations.institutionId = Sisendis esitatud institutionId.
- objectStatus = CURRENT
- HTM struktuuriüksusele avaldatud juhtimislaud
- id = dashboardId
- statusType = PUBLIC
- htmStructureUnits = GET /hsilm-gateway/userinfo.response.relatedHtmStructures.id
- objectStatus = CURRENT
- Kui juhtimislauda ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Asutuse tüübile avaldatud juhtimislaud.
- Süsteem otsib Objektid#DashboardDefinition objekti, mille:
- Süsteem otsib juhtimislaua komponentide järjekorra.
- Süsteem otsib Objektid#DashboardDefinitionComponentOrder objekte, mille:
- dashboardDefinitionId = Sisendis esitatud dashboardId väärtus.
- objectStatus = CURRENT
- Süsteem otsib Objektid#DashboardDefinitionComponentOrder objekte, mille:
- Süsteem tagastab leitud andmed.
- Kui ühtegi objekti ei leitud, siis tagastatakse tühi vastus.