Üldkirjeldus

Teenus otsib juhtimislaua komponendi ühe elemendi raporti ja filtrite andmed.

Seotud andmeobjektid:

NSIL-1045 - 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	String	Juhtimislaud ei tohi olla kustutatud. DashboardDefinition.objectStatus = CURRENT Juhtimislaud peab olema avalikustatud staatused. DashboardDefinition.statusType = PUBLIC	Juhtimislaua id (UUID).
elementId	1	String	Element ei tohi olla kustutatud. DashboardDefinitionElement.objectStatus = CURRENT	Elemendi id.

Väljundid

Atribuut	Kohustuslikkus, mitmesus	Tüüp	Kirjeldus, täiendav info
id	1	String (PK)	Juhtimislaua elemendi id (UUID).
dashboardId	1	String (FK)	Viide juhtumislaua objektile, millega juhtimislaua element seotud on. Viitab DashboardDefinition.id väärtusele.
name	1	String	Juhtimislaua elemendi nimetus.
helpText	0..1	String	Juhtimislaua elemendi selgitus.
filters	0..*	Array	Juhtimislaua elemendi filtrite andmed. Kasutatakse juhtimislaua elemendi filtrite haldamiseks.
filters.key	1	String (PK).	Juhtimislaua elemendi filtri parameeter.
filters.value	1	String (PK).	Juhtimislaua elemendi filtri parameetri väärtus.
objectStatus	1	String	Objekti staatus. CURRENT - Kehtiv DELETED - Kustutatud
reports	0..*	Array	Nimekiri juhtimislaua aruande komponendi aruannetest.
reports.id	0..1	Object	Juhtimislaua aruande komponendi aruande id.
reports.reportType	1	EHIS Classifier	Juhtimislaua aruande tüüp. Väärtusena klassifikaatori REPORT_TYPE elemendi viide.
reports.pbiWorkspaceId	1	String	PBI aruande tööruumi identifikaator.
reports.pbiReportId	1	String	PBI aruande identifikaator.
reports.mainReport	1	boolean	Märge, et tegemist on näitaja põhiaruandega.
reports.seqNo	1	Integer	Arvutatakse lisamise aja järgi ühe elemendi piires. Eespool on enne lisatud aruanded.
reports.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 andmed.
- 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 otsib juhtimislaua elemendi komponendi andmed.
- Süsteem otsib Objektid#DashboardDefinitionElement objekti, mille:
  - id = Sisendis esitatud elementId väärtus.
  - dashboardDefinitionId = Sisendis esitatud dashboardId väärtus.
  - objectStatus = CURRENT
    1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
Süsteem otsib juhtimislaua iga elemendi aruande andmed.
- Süsteem otsib Objektid#DashboardDefinitionElementReport objekte, mille:
  - dashboardDefinitionId = Sisendis esitatud dashboardId väärtus.
  - dashboardDefinitionElementId = Leitud dashboardDefinitionElement.id väärtused.
  - objectStatus = CURRENT
Süsteem tagastab leitud andmed.

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

Üldkirjeldus

Eeltingimused ja kasutusõigused

Sisendid

Väljundid

Tegevused