NSILM

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

Muutja: Andres Mill · 2025-09-24

Üldkirjeldus

Teenus otsib juhtimislaua komponendi filtri andmed.

Seotud andmeobjektid:

NSIL-481 - 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

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
dashboardId1String
  • Juhtimislaud ei tohi olla kustutatud.
    • DashboardDefinition.objectStatus = CURRENT
  • Juhtimislaud peab olema avalikustatud staatused.
    • DashboardDefinition.statusType = PUBLIC
Juhtimislaua id (String).
sectionId1String
  • Juhtimislaua sektsioon ei tohi olla kustutatud.
    • DashboardDefinitionSection.objectStatus = CURRENT
Juhtimislaua sektsiooni id (String).

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
filters0..*Array

Nimekiri juhtimislaua sektsiooni filtritest.

filters.id1String (PK).

Juhtimislaua komponendi filtri id (UUID).

filters.dashboardDefinitionSectionId1String (FK)

Viide juhtumislaua sektsiooni objektile, millega juhtimislaua komponent seotud on. Viitab DashboardDefinitionSection.id väärtusele.

filters.inputType1EHIS Classifier

Juhtimislaua komponendi filtri sisendi formaat

Väärtusena klassifikaatori DASHBOARD_ELEMENT_INPUT_TYPE elemendi viide.

filters.label1String

Filtri silt.

filters.pbiFilterKey1String

PBI filtri viide.

filters.helpText0..1String

Filtri selgitus.

filters.optionTexts

0..*Array

Filtri valikud. Kasutatakse kui filtri tüüp on MULTIPLE_CHOICE (Mitmikvalik) või SINGLE_CHOICE (üksikvalik).

filters.period0..1Object

Perioodi andmete objekt. Kasutatakse juhul kui sisendi formaat väärtuseks on PERIOD (Periood).

filters.period.periodType1EHIS Classifier

Perioodi tüüp. Kasutatakse juhul kui sisendi formaat väärtuseks on "periood".

Väärtusena klassifikaatori DASHBOARD_ELEMENT_PERIOD_TYPE elemendi viide.

filters.period.valuesFrom

1

IntegerPerioodi väärtuste algus. 
filters.period.valuesUntil

1

IntegerPerioodi väärtuste lõpp. 
filters.seqNo1LongFiltri järjekorranumber ühe sektsiooni piires. Järjekord algab ühest.
filters.objectStatus1String

Objekti staatus.

  • CURRENT - Kehtiv
  • DELETED - Kustutatud

Tegevused

  1. 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.
  2. Süsteem valideerib sisendi.
    1. Kui sisend on ebakorrektne, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  3. 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 = 
        • 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
              1. Kui juhtimislauda ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem otsib juhtimislaua sektsiooni filtrid.
  5. Süsteem tagastab leitud andmed.