NSILM

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

Muutja: Andres Mill · 2024-05-28

Üldkirjeldus

Teenus muudab juhtimislaua komponendi elemendi andmeid.

Seotud andmeobjektid:

NSIL-441 - Getting issue details... STATUS NSIL-498 - 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).
elementId1UUID
  • Element ei tohi olla kustutatud.
    • DashboardDefinitionElement.objectStatus = CURRENT
Juhtimislaua element.

reportType

1

EHIS Classifier
  • Lubatud klassifikaatori REPORT_TYPE kehtiva elemendi viide.

Juhtimislaua aruande tüüp.

pbiWorkspaceId

1

String
  • Lubatud kuni 250 tähemärki.
PBI aruande tööruumi identifikaator.

pbiReportId

1

String
  • Lubatud kuni 250 tähemärki.
PBI aruande identifikaator.

mainReport

1

Boolean
  • Lubatud väärtused:
    • true
    • false
Märge, et tegemist on näitaja põhiaruandega.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info

id

0..1

ObjectJuhtimislaua aruande komponendi aruande id.

reportType

1

EHIS Classifier

Juhtimislaua aruande tüüp.

Väärtusena klassifikaatori REPORT_TYPE elemendi viide.

pbiWorkspaceId

1

StringPBI aruande tööruumi identifikaator.

pbiReportId

1

StringPBI aruande identifikaator.

mainReport

1

booleanMärge, et tegemist on näitaja põhiaruandega.

seqNo

1

IntegerArvutatakse lisamise aja järgi ühe elemendi piires. Eespool on enne lisatud aruanded.
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 otsib juhtimislaua elemendi komponendi andmed.
    1. Süsteem otsib Objektid#DashboardDefinitionElement objekti, mille:
      • id = Sisendis esitatud elementId 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 lisab leitud juhtimislaua elemendile aruande andmeid.
    • Süsteem lisab leitud Objektid#DashboardDefinitionElement objekti reports objekti:
      • id = UUID
      • reportType = Sisendis esitatud reportType väärtus.
      • pbiWorkspaceId = Sisendis esitatud pbiWorkspaceId väärtus.
      • pbiReportId = Sisendis esitatud pbiReportId väärtus.
      • mainReport = Sisendis esitatud mainReport väärtus.
      • objectStatus = CURRENT
      • audit (lisamine) = audit (lisamine)
  6. Kui sisendis esitatud araunne on põhiaruanne (mainReport = true) ja elemendil oli enne päringu käivitamist mingi muu aruanne põhiaruandeks, siis muudab süsteem eelnevalt põhiaruandeks olnud aruande mittepõhiaruandeks (mainReport = false). 
  7. Süsteem tagastab lisatud andmed.