NSILM

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

Muutja: Andres Mill · 2024-05-09

Üldkirjeldus

Teenus muudab juhtimislaua komponendi andmeid.

Seotud andmeobjektid:

NSIL-424 - 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).
sectionId1UUID
  • Juhtimislaua sektsioon ei tohi olla kustutatud.
    • DashboardDefinitionSection.objectStatus = CURRENT
Juhtimislaua sektsiooni id (UUID).
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
GS: DashboardDefinitionSection: API: POST /quality-api/dashboard-definitions/{dashboardDefinitionId}/sections#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 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 otsib juhtimislaua sektsiooni andmed.
    • Süsteem otsib Objektid#DashboardDefinitionSection objekti, mille:
      • id = Sisendis esitatud sectionId väärtus.
      • objectStatus = CURRENT
        1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem muudab leitud juhtimislaua sektsiooni andmeid.
  6. Süsteem lisab loodud sektsiooni juhtimislaua komponentide järjestuses õigesse asukohta.
    • 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.
  7. Süsteem tagastab muudetud andmed.