NSILM

GS: DashboardDefinitionElementComment: API: GET /dashboard-api/dashboards/{dashboardId}/elements/{dashboardElementId}/comments

Muutja: Andres Mill · 2025-09-24

Üldkirjeldus

Teenus otsib juhtimislaua raportile lisatud kasutaja kommentaarid.

Seotud andmeobjektid:

NSIL-518 - 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
dashboardId1UUID
  • Juhtimislaud ei tohi olla kustutatud.
    • DashboardDefinition.objectStatus = CURRENT
  • Juhtimislaud peab olema avalikustatud staatused.
    • DashboardDefinition.statusType = PUBLIC
Juhtimislaua id.
dashboardElementId1UUID
  • Aruande komponent ei tohi olla kustutatud.
    • DashboardDefinitionElement.objectStatus = CURRENT
Juhtimislaua aruande komponendi id.
institutionId1StringViide juhtimislauaga seotud asutusele.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
comments

0..*

Array

Aruande elemendile lisatud kommentaaride nimekiri.

Nimekirja objektid on samad, mis https://projektid.edu.ee/pages/viewpage.action?pageId=235013170#GS:UserDashboardElementComment:API:POST/dashboardapi/userdashboardelementcomments-V%C3%A4ljundid

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.
        • id = dashboardId
        • 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.
        • id = dashboardId
        • 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 kasutaja poolt lisatud juhtimislaua aruande kommentaarid.
    • Süsteem otsib Objektid#DashboardDefinitionElementComment objekte, mille:
      • userPersonalCode = Kasutaja isikukood tokenist.
      • dashboardDefinitionId = Sisendis esitatud dashboardId väärtus.
      • dashboardDefinitionElementId = Sisendis esitatud dashboardElementId väärtus.
      • institution.id = Sisendis esitatud institutionId (kasutajal peab olema õigus antud asutuse alt päringut teha).
  5. Süsteem tagastab leitud andmed.