GS: DashboardDefinition: API: GET /quality-api/dashboard-definitions
Üldkirjeldus
Teenus abil saab otsida juhtimislaudade definitsioone.
Seotud andmeobjektid:
NSIL-415 - 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 |
|---|---|---|---|---|
| code | 0..1 | String |
| |
| name | 0..1 | String |
| |
| domainTypes | 0..* | Array | Juhtimislaua valdkond. Väärtusena klassifikaatori Klassifikaatorid#KlassifikaatorDOMAIN elemendi viide. | |
| dashboardTypes | 0..* | Array | Nimekiri juhtimislaudade liikidest. Väärtusena klassifikaatori Klassifikaatorid#KlassifikaatorDASHBOARD_TYPE elemendi viited. | |
| statusTypes | 0..* | Array | Juhtimislaua staatus. Väärtusena klassifikaatori Klassifikaatorid#KlassifikaatorDASHBOARD_STATUS elementide viited. |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| dashboardDefinitions | 0..* | Array | Nimekiri juhtimislaudade definitsioonidest. Nimekirja objektid on samad, mis GS: DashboardDefinition: API: POST /quality-api/dashboard-definitions#V%C3%A4ljundid. |
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 üldandmed.
- Süsteem otsib Objektid#DashboardDefinition objekte , mille:
- code = Sisendis esitatud code väärtus.
- name = Sisendis esitatud name väärtus.
- dashboardType = Sisendis esitatud dashboardTypes väärtused.
- statusType = Sisendis esitatud statusTypes väärtused.
- objectStatus = CURRENT
- Süsteem otsib Objektid#DashboardDefinition objekte , mille:
- Süsteem tagastab leitud andmed.