NSILM

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

Muutja: Andres Mill · 2024-05-09

Üldkirjeldus

Teenus salvestab juhtimislaua komponentide hulka sektsiooni andmed.

Seotud andmeobjektid:

NSIL-423 - 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).
upperLevelSectionId0..1String
  • 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 element.
    • DashboardDefinitionComponentOrder.components.type = ELEMENT
  • Määratud ülemsektsioon peab olema esimese taseme juhtimislaua komponent.

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

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

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

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

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

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

Juhtimislaua komponendi sektsiooni nimetus.

Väljundid

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

Juhtimislaua komponendi id (UUID).

dashboardDefinitionId1UUID

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

name1String

Juhtimislaua komponendi nimetus.

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 sektsiooni andmed.
    • Süsteem loob Objektid#DashboardDefinitionSection objekti:
      • id = UUID
      • dashboardDefinitionId = Sisendis esitatud dashboardDefinitionId väärtus.
      • name = Sisendis esitatud name väärtus.
      • filters = null
      • objectStatus = CURRENT
      • audit (loomine) = audit (loomine)
  5. Süsteem lisab loodud sektsiooni juhtimislaua komponentide järjestuses õigesse asukohta.
    • Kui upperLevelSectionId väärtus ei ole määratud, siis on tegemist esimese taseme sektsiooniga.
    • Kui upperLevelSectionId väärtus on määratud, siis lisatakse loodud sektsioon upperLevelSectionId alasektsiooniks.
    • Kui previousComponent väärtus ei ole määratud, siis lisatakse sektsioon vastava taseme juhtimislaua komponentide järjekorras esimeseks.
    • Kui previousComponent väärtus on määratud, siis lisatakse loodud sektsioon vastava taseme juhtimislaua komponentide järjekorras määratud juhtimislaua komponendi järele.
    • Andmed salvestatakse Objektid#DashboardDefinitionComponentOrder objekti.
  6. Süsteem tagastab loodud andmed.