NSILM

GS: DashboardDefinitionSection: API: POST /quality-api/dashboard-definitions/{dashboardDefinitionId}/elements

Muutja: Carolina Kask · 2024-08-13

Üldkirjeldus

Teenus salvestab juhtimislaua komponentide hulka elemendi andmed.

Seotud andmeobjektid:

NSIL-434 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kasutaja poolt valitud rollil peab olema juhtimislauaga seotud valdkonna haldamise õigus.
    • AssessmentModel.domainType = Klassifikaatorid#KlassifikaatorDOMAIN, mis on seotud DASHBOARD_MANAGE_PRIVILEGE  (attributeDefinitionCode) privileegiga, mis on kasutaja poolt valitud rollile lisatud.

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
dashboardDefinitionId1UUID
  • Juhtimislaud ei tohi olla kustutatud.
    • DashboardDefinition.objectStatus = CURRENT
Juhtimislaua id (UUID).
upperLevelSectionId1String
  • Määratud ülemsektsioon ei tohi olla kustutatud.
    • DashboardDefinitionSection.objectStatus = CURRENT, mille DashboardDefinitionSection.id = upperLevelSectionId
  • Määratud ülemsektsioonil ei tohi olla alakomponenti, mille tüüp on sektsioon.
    • DashboardDefinitionComponentOrder.components.type = SECTION
  • Määratud ülemsektsioon peab olema esimese või teise taseme juhtimislaua komponent.

Juhtimislaua komponendi elemendi seadistuse objekti ülemsektsiooni id. Saab olla ainult sektsiooni tüüpi juhtimislaua komponent.

previousComponent.id0..1String
  • Kui määratud, siis element ei tohi olla kustutatud.
    • Element:
      • DashboardDefinitionElement.objectStatus = CURRENT, mille DashboardDefinitionElement.id = previousComponent.id
  • Kohustuslik, kui previousComponent.type on määratud.

Juhtimislaua komponendi elemendi seadistuse objektile eelneva juhtimislaua komponendi (elemendi) id.

previousComponent.type0..1
  • Lubatud väärtused:
    • ELEMENT
  • Kohustuslik, kui previousComponent.id on määratud.

Juhtimislaua komponendi elemendi seadistuse objektile eelneva juhtimislaua komponendi (elemendi) tüüp.

name1String
  • Peab olema 3 - 250 tähemärki.

Juhtimislaua komponendi elemendi nimetus.

helpText0..1String
  • Lubatud kuni 1800 tähemärki.

Juhtimislaua elemendi selgitus.

filters0..*Array

Juhtimislaua elemendi filtrite andmed.

Kasutatakse juhtimislaua elemendi filtrite haldamiseks.

filters.key0..1String
  • Lubatud kuni 500 tähemärki.
  • Kohustuslik, kui filters.value väärtus on määratud.

Juhtimislaua elemendi filtri parameeter.

filters.value0..1String
  • Lubatud kuni 500 tähemärki.
  • Kohustuslik, kui filters.key väärtus on määratud.

Juhtimislaua elemendi filtri parameetri väärtus.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
id1String (PK)

Juhtimislaua elemendi id (UUID).

dashboardDefinitionId1String (FK)

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

name1String

Juhtimislaua elemendi nimetus.

helpText0..1String

Juhtimislaua elemendi selgitus.

filters0..*Array

Juhtimislaua elemendi filtrite andmed.

Kasutatakse juhtimislaua elemendi filtrite haldamiseks.

filters.key1String (PK).

Juhtimislaua elemendi filtri parameeter.

filters.value1String (PK).

Juhtimislaua elemendi filtri parameetri väärtus.

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 andmed.
    • Süsteem otsib Objektid#DashboardDefinition objekti, mille:
      • id = Sisendis esitatud dashboardDefinitionId väärtus.
      • objectStatus = CURRENT
        1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem lisab juhtimislaua komponentide hulka uue elemendi andmed.
    • Süsteem loob Objektid#DashboardDefinitionElement objekti:
      • id = UUID
      • dashboardDefinitionId = Sisendis esitatud dashboardDefinitionId väärtus.
      • helpText = Sisendis esitatud helpText väärtus.
      • filters = Sisendis esitatud filters väärtused.
      • objectStatus = CURRENT
      • audit (loomine) = audit (loomine)
  5. Süsteem lisab loodud elemendi juhtimislaua komponentide järjestuses õigesse asukohta.
    • Loodud element lisatakse upperLevelSectionId alaelemendiks.
    • Kui previousComponent väärtus ei ole määratud, siis lisatakse element vastava taseme juhtimislaua komponentide järjekorras esimeseks.
    • Kui previousComponent väärtus on määratud, siis lisatakse loodud element vastava taseme juhtimislaua komponentide järjekorras määratud juhtimislaua komponendi järele.
    • Andmed salvestatakse Objektid#DashboardDefinitionComponentOrder objekti.
  6. Süsteem tagastab loodud andmed.