NSILM

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

Muutja: Carolina Kask · 2024-08-19

Üldkirjeldus

Teenus muudab juhtimislaua komponendi filtri andmeid.

Seotud andmeobjektid:

NSIL-429 - 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).
filterId1UUID
  • Juhtimislaua sektsiooni filter ei tohi olla kustutatud.
    • DashboardDefinitionSectionFilter.objectStatus = CURRENT
Juhtimislaua sektsiooni filtri id (UUID).
inputType1EHIS Classifier

Juhtimislaua komponendi filtri sisendi formaat

Väärtusena klassifikaatori DASHBOARD_ELEMENT_INPUT_TYPE elemendi viide.

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

Filtri silt.

pbiFilterKey1String
  • Peab olema 1 - 250 tähemärki.

PBI filtri viide.

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

Filtri selgitus.

optionTexts

0..*Array
  • Vähemalt ühe teksti lisamine on kohustuslik, kui filtri tüüp on MULTIPLE_CHOICE (mitmikvalik) või SINGLE_CHOICE (üksikvalik).
  • Iga nimekirja elemendi maksimaalne pikkus saab olla kuni 250 tähemärki.

Filtri valikud. Kasutatakse kui filtri tüüp on MULTIPLE_CHOICE (mitmikvalik) või SINGLE_CHOICE (üksikvalik).

period0..1Object
  • Objekti esitamine on kohustuslik kui sisendi formaat väärtuseks on PERIOD (Periood).

Perioodi andmete objekt. Kasutatakse juhul kui sisendi formaat väärtuseks on PERIOD (Periood).

period.periodType0..1EHIS Classifier

Perioodi tüüp. Kasutatakse juhul kui sisendi formaat väärtuseks on "periood".

Väärtusena klassifikaatori DASHBOARD_ELEMENT_PERIOD_TYPE elemendi viide.

period.valuesFrom

0..1

Integer
  • Peab olema neljakohaline aastaarv.
  • period.valuesFrom< period.valuesUntil
Perioodi väärtuste algus. 
period.valuesUntil

0..1

Integer
  • Peab olema neljakohaline aastaarv.
  • period.valuesFrom< period.valuesUntil
Perioodi väärtuste lõpp. 

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
GS: DashboardDefinitionSection: API: POST /quality-api/dashboard-definitions/{dashboardDefinitionId}/sections/{sectionId}/filters#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 otsib juhtimislaua sektsiooni filtri andmed.
    • Süsteem otsib Objektid#DashboardDefinitionSectionFilter objekti, mille:
      • id = Sisendis esitatud filterId väärtus.
      • objectStatus = CURRENT
        1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  6. Süsteem muudab leitud juhtimislaua sektsiooni filtri andmeid.
    • Süsteem muudab leitud Objektid#DashboardDefinitionSectionFilter objekti andmeid:
      • inputType = Sisendis esitatud inputType väärtus.
      • label = Sisendis esitatud label väärtus.
      • helpText = Sisendis esitatud helpText väärtus.
      • pbiFilterKey = Sisendis esitatud pbiFilterKey väärtus.
      • optionTexts = Sisendis esitatud optionTexts väärtused.
      • period.periodType = Sisendis esitatud period.periodType väärtus.
      • period.valuesFrom = Sisendis esitatud period.valuesFrom väärtus.
      • period.valuesUntil = Sisendis esitatud period.valuesUntil väärtus.
      • objectStatus = CURRENT
      • audit (muutmine) = audit (muutmine)
  7. Süsteem tagastab muudetud andmed.