NSILM

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

Muutja: Andres Mill · 2024-05-10

Üldkirjeldus

Teenus muudab juhtimislaua komponendi elemendi andmeid.

Seotud andmeobjektid:

NSIL-442 - 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.
reportId1UUID
  • Elemendi aruanne ei tohi olla kustutatud.
    • DashboardDefinitionElement.resports.objectStatus = CURRENT
Juhtimislaua aruande komponendi aruande id.

reportType

1

EHIS Classifier
  • Lubatud klassifikaatori REPORT_TYPE kehtiva elemendi viide.

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
GS: DashboardDefinitionSection: API: POST /quality-api/dashboard-definitions/{dashboardDefinitionId}/elements/{elementId}/reports#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 elemendi komponendi aruande andmed.
    1. Süsteem otsib Objektid#DashboardDefinitionElement.reports objekti, mille:
      • DashboardDefinitionElement.id = Sisendis esitatud elementId väärtus.
      • DashboardDefinitionElement.objectStatus = CURRENT
      • DashboardDefinitionElement.reports.id = Sisendis esitatud elementId väärtus.
      • DashboardDefinitionElement.reports.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 elemendi aruande andmeid.
    • Süsteem muudab leitud Objektid#DashboardDefinitionElement.reports objekti:
      • reportType = Sisendis esitatud reportType väärtus.
      • pbiWorkspaceId = Sisendis esitatud pbiWorkspaceId väärtus.
      • pbiReportId = Sisendis esitatud pbiReportId väärtus.
      • mainReport = Sisendis esitatud mainReport väärtus.
      • audit (muutmine) = audit (muutmine)
  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 muudetud andmed.