GS: AssessmentInstruction: API: GET /quality-api/assessment-instructions
Üldkirjeldus
Teenuse abil saab otsida hindamise juhendi objekti.
Seotud andmeobjektid:
NSIL-1265 - Getting issue details... STATUS
Eeltingimused ja kasutusõigused
- Kasutaja peab olema autenditud ja autoriseeritud.
Sisendid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Vaikeväärtus, valideerimine | Kirjeldus, täiendav info |
|---|---|---|---|---|
| domainType | 1 | EHIS Classifier | Hindamise valdkond. | |
| assessmentType | 1 | EHIS Classifier | Hindamise liik. |
Väljundid
| Atribuut | Kohustuslikkus, mitmesus | Tüüp | Kirjeldus, täiendav info |
|---|---|---|---|
| id | 1 | UUID | Objekti id (UUID). |
| name | 1 | String | Juhendi nimetus. |
| domainType | 1 | EHIS Classifier | Hindamise valdkonna klassifikaatori objekt. |
| assessmentType | 1 | EHIS Classifier Object | Hindamise liigi klassifikaatori objekt. |
| objectStatus | 1 | String | Objekti staatus.
|
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 juhendi üldandmed.
- Süsteem otsib Objektid#AssessmentInstruction objekti, mille:
- assessmentType = Sisendis esitatud assessmentType väärtus.
- domainType = Sisendis esitatud domainType väärtus.
- objectStatus = CURRENT
- Kui objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
- Süsteem otsib Objektid#AssessmentInstruction objekti, mille:
- Süsteem tagastab leitud andmed.