Üldkirjeldus

Teenus abil saab kasutaja otsida tema asutusele avaldatud juhtimislaudade komponentide sektsiooni andmeid.

Seotud andmeobjektid:

NSIL-472 - 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	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
sections	0..*	Array	Juhtimislaua sektsioonid.
sections.id	1	UUID	Juhtimislaua komponendi id (UUID).
sections.dashboardId	1	UUID	Viide juhtumislaua objektile, millega juhtimislaua komponent seotud on. Viitab DashboardDefinition.id väärtusele.
sections.name	1	String	Juhtimislaua komponendi nimetus.
sections.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:
  - 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
    - 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.
Süsteem otsib juhtimislaua sektsioonid.
- Süsteem otsib Objektid#DashboardDefinitionSection objekte, mille:
  - dashboardDefinitionId = Sisendis esitatud dashboardId väärtus.
  - objectStatus = CURRENT
Süsteem tagastab leitud andmed.

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

Üldkirjeldus

Eeltingimused ja kasutusõigused

Sisendid

Väljundid

Tegevused