GS: DashboardDefinitionSection: API: GET /quality-api/dashboard-definitions/{dashboardDefinitionId}/components-order
Üldkirjeldus
Teenus otsib juhtimislaua komponentide järjekorra andmed.
Seotud andmeobjektid:
NSIL-427 - 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
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Vaikeväärtus, valideerimine | Kirjeldus, täiendav info |
|---|---|---|---|---|
| dashboardDefinitionId | 1 | UUID |
| Juhtimislaua id (UUID). |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| components | 0..* | Nested Array | Nimekiri juhtimislaua komponentidest (sektsioon, vormielement). Juhtimislaua komponendid on mitmetasandilised. See tähendab, et ühe juhtimislaua komponendi sees saab olla mitu alakomponenti ja alakomponentidel saab olla alakomponente lõpmatu sügavusega. Sektsiooni tüüpi komponent saab olla esimese ja teise taseme komponent, Sektsioon ei saa olla kolmanda taseme komponent. Vormielemendi tüüpi komponent saab olla teise ja kolmanda taseme komponent. Vormielement ei saa olla esimese taseme komponent. Sektsiooni tüüpi komponendil saab olla alakomponente, sh sektsioonid ja vormielemendid. Vormielementi tüüpi komponendil ei saa olla alakomponente. Samal tasemel ja sama ülemkomponendi all kuuluvad komponendid saavad olla ainult sama liiki komponent. |
| components.id | 1 | FK | Viide hindamise komponendile (sektsioonile või vormielemendile). Viitab DashboardDefinitionSection.Id (sektsioon) väärtusele või DashboardDefinitionElement.id (vormielement) väärtusele. |
| components.type | 1 | Enum | Hindamise komponendi tüüp. Võimalikud väärtused:
|
| components.level | 1 | Integer | Komponendi tase. Tasemed algavad ühest. |
| components.seqNo | 1 | Integer | Komponendi järjekorranumber. Järjekord algab ühest. |
Tegevused
- Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
- Kui kasutajal ei ole õigust päringut teostada, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem valideerib sisendi.
- Kui sisend on ebakorrektne, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem otsib juhtimislaua komponentide järjekorra.
- Süsteem otsib Objektid#DashboardDefinitionComponentOrder objekte, mille:
- dashboardDefinitionId = Sisendis esitatud dashboardDefinitionId väärtus.
- objectStatus = CURRENT
- Süsteem otsib Objektid#DashboardDefinitionComponentOrder objekte, mille:
- Süsteem tagastab leitud andmed.
- Kui ühtegi objekti ei leitud, siis tagastatakse tühi vastus.