NSILM

GS: AssessmentInstruction: API: POST /quality-api/assessment-models/{modelId}/assessment-instructions/{instructionId}/elements

Muutja: Andres Mill · 2025-10-02

Üldkirjeldus

Teenus abil saab luua hindamise juhendi sektsiooni elementi.

Seotud andmeobjektid:

NSIL-1256 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kasutajal peab olema õigus hallata valdkonna hindamismudeleid (Vaata Sisendid → instructionId → Vaikeväärtus, valideerimine).

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
modelId1String
  • Hindamismudel ei tohi olla kustutatud.
    • AssessmentModel.objectStatus = CURRENT

Hindamismudeli id (UUID).

instructionId1String
  • Kasutajal peab olema valdkonna haldamise õigus.
    • Valdkonnal (AssessmentInstruction.domainType) on seos kehtiva privileegiga (attributeDefinitionCode = ASSESSMENT_MODEL_MANAGE_PRIVILEGE), mis on kasutajale määratud.
  • Juhend ei tohi olla kustutatud.
    • Eksisteerib AssessmentInstruction objekt, mille id = instructionId
Hindamise juhendi id.
sectionId1UUID
  • Sektsioon ei tohi olla kustutatud.
    • AssessmentModelComponentSection.objectStatus = CURRENT
  • Sektsioon peab olema seotud juhendiga.
    • AssessmentInstructionSection objekt, mille id = sectionId ja assessmentInstructionId = sisendis instructionId väärtus.

Hindamise juhendi sektsiooni id (UUID), millega element seotud on.

previousComponent.id0..1String
  • Kui määratud, siis sektsioon või vormielement ei tohi olla kustutatud.
    • Sektsioon:
      • AssessmentInstructionSection.objectStatus = CURRENT, milleAssessmentInstructionSection.id = previousComponent.id
    • Element:
      • AssessmentInstructionElement.objectStatus = CURRENT, mille AssessmentInstructionElement.id = previousComponent.id
  • Kohustuslik, kui previousComponent.type on määratud.
  • Peab olema sisendis esitatud sectionId alamkomponent.

Hindamise juhendi sektsiooni seadistuse objektile eelneva hindamise komponendi (sektsiooni, vormielemendi) id.

previousComponent.type0..1
  • Lubatud väärtused:
    • SECTION
    • ELEMENT
  • Kohustuslik, kui previousComponent.id on määratud.

Hindamise juhendi sektsiooni seadistuse objektile eelneva hindamise komponendi (sektsiooni, vormielemendi) tüüp.

label

1

String
  • 3 - 250 tähemärki.
Vormielemendi silt
labelDisplayedOnAssessment

1

Boolean
  • Lubatud väärtused: 
    • true
    • false

Määrab, kas vormielemendi silti kuvatakse hindamise vormil või mitte.

  • true (Vaikimisi) - Silti kuvatakse hindamise vormil
  • false - Silti ei kuvata hindamise vormil.
helpText

0..1

String
  • Lubatud kuni 2500 tähemärki.
Vormielemendi selgitus/abitekst.

pbiMetadata

0..1

Object
  • Kohustuslik, kui elemendi tüüp on mudeli haldaja sisend () ja elemendi sisendi tüüp on PBI raport (inputType = REPORT). Muudel juhtudel ei tohi kasutada.
PBI aruande andmed. Kasutatakse kui elemendi sisendi tüüp on PBI aruanne (REPORT).

pbiMetadata.workspaceId

1

String
  • Peab olema 3 - 250 tähemärki.
PBI aruande tööruumi identifikaator.

pbiMetadata.reportId

1

String
  • Peab olema 3 - 250 tähemärki.
PBI aruande identifikaator.
inputType

1

EHIS Classifier
  • Peab olema mudeli haldaja sisendi formaat.
    • Peab olema INPUT_TYPE hulgas kehtiv kirje, mille contentType (klassifikaatori atribuut) = ADMIN_INPUT

Vormielemendi sisendi formaat.

hyperlinks

0..*Array
  • Lubatud kasutada kui vormielemendi sisendi tüüp on veebilehe link (inputType = HYPERLINK). Muudel juhtudel ei tohi kasutada.
  • Vähemalt üks veebilehe link peab olema lisatud, kui vormielemendi sisendi tüüp on veebilehe link (inputType = HYPERLINK).

Nimekiri veebilehe linkidest.

hyperlinks.name

1String
  • Peab olema 3-250 tähemärki pikk.

Lingi nimetus.

hyperlinks.url

1String
  • Peab vastama veebilehe lingi nõuetele.

Veebilehe link.

textAreaValue

0..1String
  • Lubatud kasutada kui vormielemendi sisendi tüüp on tekstiala (inputType = TEXT_AREA). Muudel juhtudel ei tohi kasutada.
  • Kohustuslik esitada kolm tähemärki, kui vormielemendi sisendi tüüp on tekstiala (inputType = TEXT_AREA).
  • Maksimaalne pikkus kuni 2500 tähemärki.

Elemendi väärtus, kui vormielement on tekstiala (TEXT_AREA).

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
id1String

Hindamise komponendi vormi sektsiooni lisatud vormielemendi id (UUID).

assessmentInstructionId1FK

Viide juhendile, millega komponendi seadistus on seotud. Viitab AssessmentInstruction.id väärtusele.

contentType1EHIS Classifier

Määrab elemendi tüübi. Väärtusena klassifikaatori CONTENT_TYPE elemendi viide.

inputType

1

EHIS Classifier

Vormielemendi sisendi formaat.

Väärtusena klassifikaatori INPUT_TYPE elemendi viide.

label

1

StringVormielemendi silt
labelDisplayedOnAssessment

1

Boolean

Määrab, kas vormielemendi silti kuvatakse hindamise vormil või mitte.

  • true (Vaikimisi) - Silti kuvatakse hindamise vormil
  • false - Silti ei kuvata hindamise vormil.
helpText

0..1

StringVormielemendi selgitus/abitekst.

pbiMetadata

0..1

ObjectPBI aruande andmed. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on PBI aruanne (inputType = REPORT).

pbiMetadata.workspaceId

1

StringPBI aruande tööruumi identifikaator.

pbiMetadata.reportId

1

StringPBI aruande identifikaator.

files

0..*Array

Nimekiri failidest. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on pilt (inputType = IMAGE).

files.fileId

1FKViide faili metaandmetele. Viitab File.id väärtusele.

files.title

0..1String

Failile lisatud pealkiri.

files.fileModifiedAt

0..1Date and time

Faili viimane muutmise aeg.

hyperlinks

0..*Array

Nimekiri veebilehe linkidest. Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on veebilehe link (inputType = HYPERLINK).

hyperlinks.name

1String

Lingi nimetus.

hyperlinks.url

1String

Veebilehe link.

textAreaValue

0..1String

Elemendi väärtus, kui vormielement on tekstiala (TEXT_AREA). Kasutatakse kui elemendi tüüp on mudeli haldaja sisend (contentType = ADMIN_INPUT) ja sisendi formaat on tekstiala (inputType = TEXT_AREA).

objectStatus1String

Objekti staatus.

  • CURRENT - Kehtiv
  • DELETED - Kustutatud

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 hindamismudeli andmed.
    • Süsteem otsib Objektid#AssessmentModel objekti, mille:
      • id = Sisendis esitatud modelId väärtus.
      • objectStatus = CURRENT
        1. Kui objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem otsib juhendi andmed.
    • Süsteem otsib Objektid#AssessmentInstruction objekti, mille:
      • id = Sisendis esitatud instructionId väärtus.
      • domainType = AssessmentModel.domainType
      • assessmentType = AssessmentModel.assessmentType
      • objectStatus = CURRENT
        1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem otsib sektsiooni andmed.
    • Süsteem otsib Objektid#AssessmentInstructionSection objekti:
      • id = Sisendis esitatud sectionId väärtus.
      • objectStatus = CURRENT
        1. Kui tingimustele vastavat objekti ei leita, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  6. Süsteem lisab hindamise komponentide hulka uue elemendi andmed.
    • Süsteem loob Objektid#AssessmentInstructionElement objekti:
      • id = UUID
      • assessmentInstructionId = Sisendis esitatud assessmentInstructionId väärtus.
      • contentType = ADMIN_INPUT
      • inputType = Sisendis esitatud inputType väärtus.
      • label = Sisendis esitatud label väärtus.
      • labelDisplayedOnAssessment = Sisendis esitatud labelDisplayedOnAssessment väärtus.
      • helpText = Sisendis esitatud helpText väärtus.
      • pbi.workspaceId = Sisendis esitatud pbi.workspaceId väärtus.
      • pbi.reportId = Sisendis esitatud pbi.reportId väärtus.
      • textAreaValue = Sisendis esitatud textAreaValue väärtus.
      • hyperlinks = Sisendis esitatud hyperlinks väärtused.
      • files = null
      • objectStatus = CURRENT
      • audit (loomine) = audit (loomine)
  7. Süsteem lisab loodud elemendi hindamise komponentide järjekorras õigesse asukohta.
    • sectionId väärtus määrab vormielemendi ülemtaseme hindamise komponendi, mille alla vormielement lisatakse.
    • Kui previousComponent väärtus ei ole määratud, siis lisatakse vormielement vastava taseme hindamise komponentide järjekorras esimeseks.
    • Kui previousComponent väärtus on määratud, siis lisatakse loodud vormielement vastava taseme hindamise komponentide järjekorras määratud hindamise komponendi järele.
    • Andmed salvestatakse Objektid#AssessmentInstructionComponentOrder objekti.
  8. Süsteem tagastab loodud andmed.