NSILM

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

Muutja: Andres Mill · 2024-05-10

Üldkirjeldus

Teenus otsib juhtimislaua komponendi elemendi raporti andmed.

Seotud andmeobjektid:

NSIL-444 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kasutaja poolt valitud rollil peab olema ükskõik millise valdkonna haldamise õigus.
    • Ükskõik milline Klassifikaatorid#KlassifikaatorDOMAIN element, 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.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
reports0..*Array

Nimekiri juhtimislaua aruande komponendi aruannetest.

Nimekirja objektid on samad, mis 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.objectStatus = CURRENT
  5. Süsteem tagastab leitud andmed.