NSILM

GS: DashboardDefinition: API: GET /quality-api/dashboard-definitions/{dashboardDefinitionId}

Muutja: Andres Mill · 2024-05-03

Üldkirjeldus

Teenus tagastab ühe juhtimislaua üldandmeid.

Seotud andmeobjektid:

NSIL-414 - 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).

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
Sama, mis GS: DashboardDefinition: API: POST /quality-api/dashboard-definitions#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 üldandmed.
  4. Süsteem tagastab leitud andmed.