Üldkirjeldus

Teenus abil saab kasutaja otsida temaga seotud asutusele avaldatud juhtimislaua detailandmeid.

Seotud andmeobjektid:

Objektid#DashboardDefinition

NSIL-473 - Getting issue details... STATUS NSIL-1134 - Getting issue details... STATUS NSIL-1224 - Getting issue details... STATUS NSIL-1305 - 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	Juhtimislaud ei tohi olla kustutatud. DashboardDefinition.objectStatus = CURRENT Juhtimislaud peab olema avalikustatud staatused. DashboardDefinition.statusType = PUBLIC	Juhtimislaua id (UUID).

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
id	1	String (PK)	Hindamise id (UUID).
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.
objectStatus	1	String	Objekti staatus. CURRENT - Kehtiv DELETED - Kustutatud

Tegevused

Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
1. Kui kasutajal ei ole õigust päringut teostada, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem valideerib sisendi.
1. 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:
  - id = Sisendis esitatud dashboardId.
  - statusType = PUBLIC
  - objectStatus = CURRENT
  - Asutuse tüübile avaldatud juhtimislaud.
    - 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
    - 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.
  - Registrikoodile avaldatud juhtimislauad.
    - 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.
  - HTM struktuuriüksusele avaldatud juhtimislaud
    - - htmStructureUnits = GET /hsilm-gateway/userinfo.response.relatedHtmStructures.id
        Kui juhtimislauda ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem tagastab leitud andmed.

GS: DashboardDefinition: API: GET /dashboard-api/dashboards/{dashboardId}

Üldkirjeldus

Eeltingimused ja kasutusõigused

Sisendid

Väljundid

Tegevused