NSILM

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

Muutja: Andres Mill · 2025-09-24

Üldkirjeldus

Teenus lisab juhtimislaua raportile kasutaja kommentaari.

Seotud andmeobjektid:

NSIL-1134 - Getting issue details... STATUS NSIL-517 - 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
  • Juhtimislaud peab olema avalikustatud kasutajaga seotud asutusele.
    • DashboardDefinition.institutions.institutionType = Kasutaja rollidele määratud asutuse tüübid (EHIS x-tee teenus GET/users/v1/users.response.data.users.institution.type)
    • või DashboardDefinition.institutions.institutionIds = GET hsilm-gateway/userinfo.response.organizations.institutionId
Juhtimislaua id.
dashboardElementId1UUID
  • Aruande komponent ei tohi olla kustutatud.
    • DashboardDefinitionElement.objectStatus = CURRENT
Juhtimislaua aruande komponendi id.
institutionId1String
  • Kasutaja peab olema seotud asutusega.
    • EHIS x-tee teenus GET/users/v1/users.response.data.users.institution.id/token
  • Või kasutaja peab olema seotud sisendis esitatud pidajaga ja tal peab olema pidaja asutuses pidaja töölaua vaatamise õigus.
Asutus, millega juhtimislaud ja kasutaja seotud on.
comment1String
  • Peab olema 1 - 1000 tähemärki. 
Kommentaar.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info

id

1

UUIDÜhe kasutaja juhtimislaua aruande kommentaaride objekti id.
dashboardDefinitionId1String (FK)

Viide juhtumislaua objektile, millega juhtimislaua elemendi raport seotud on. Viitab DashboardDefinition.id väärtusele.

dashboardDefinitionElementId

1

String (FK)

Viide juhtumislaua elemendi objektile, millega juhtimislaua elemendi raport seotud on. Viitab DashboardDefinitionElement.id väärtusele.

comment1StringKommentaar.
institution

1

ObjectAsutus, millega kasutaja lemmikuks märgitud töölaud seotud on.
institution.id

1

StringViide hindamisega seotud asutusele EHISes.
institution.type1EHIS Classifier

Asutuste liik. (KOV, õppeasutus)

createdAt1Date and timeKommentaari lisamise aeg.

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 loob aruande elemendi kommentaari objekti.
    • Süsteem loob Objektid#DashboardDefinitionElementComment objekti:
      • id = UUID
      • userPersonalCode = Kasutaja isikukood tokenist.
      • institution.id = Sisendis esitatud institutionId väärtus.
      • institution.type = institutionId väärtusega seotud institutionType väärtus (EHIS päringust/tokenist)
      • dashboardDefinitionId = Sisendis esitatud dashboardId väärtus.
      • dashboardDefinitionElementId = Sisendis esitatud dashboardElementId väärtus.
      • comment = Sisendis esitatud comment väärtus.
      • audit (loomine) = audit (loomine)
  5. Süsteem tagastab loodud andmed.