NSILM

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

Muutja: Andres Mill · 2025-10-02

Üldkirjeldus

Teenuse abil saab muuta hindamise juhendi sektsiooni elementi.

Seotud andmeobjektid:

NSIL-1262 - 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.
elementId1UUID
  • Element ei tohi olla kustutatud.
    • AssessmentInstructionElement.objectStatus = CURRENT

Elemendi id (UUID)

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 vormielemendi ülemtaseme sektsiooni alakomponent.

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 (contentType = ADMIN_INPUT) 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.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).

files

0..*Array
  • Lubatud kasutada kui vormielemendi sisendi tüüp on pilt või fail (inputType = IMAGE või FILE). Muudel juhtudel ei tohi kasutada.

Nimekiri failidest. 

files.fileId

1UUID
  • Kohustuslik esitada väärtus, kui vormielemendi sisendi tüüp on pilt (inputType = IMAGE).
  • Elemendi faili objekt peab olemas olema (AssessmentInstructionElement.files.id = Sisendis esitatud files.id).

Faili objekti id.

files.title

0..1String
  • Lubatud kuni 250 tähemärki.

Failile lisatud pealkiri.

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
GS: AssessmentInstruction: API: POST /quality-api/assessment-models/{modelId}/assessment-instructions/{instructionId}/elements#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 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 elemendi andmed.
    • Süsteem otsib Objektid#AssessmentInstructionElement objekti:
      • id = Sisendis esitatud elementId väärtus.
      • assessmentInstructionId = Sisendis esitatud assessmentInstructionId 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 muudab leitud elemendi andmeid.
    • Süsteem muudab leitud Objektid#AssessmentInstructionElement objekti andmeid:
      • 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.title (, mille files.id = sisendis esitatud files.id väärtused) = Sisendis esitatud files.title väärtused.
      • audit (muutmine) = audit (muutmine)
  7. Kui elemendi sisendi formaati muudeti (inputType) ja enne muudatust oli elemendiga oli seotud faile (AssessmentInstructionElement.files != null), siis:
    1. Süsteem kustutab faili metaandmestiku süsteemist.
      • Süsteem kustutab Objektid#File objektid, mille id = AssessmentInstructionElement.files.fileId ja objectStatus = CURRENT, füüsiliselt andmebaasist.
    2. Süsteem kustutab kustutatud failide metaandmetega seotud failid failisüsteemist.
    3. Süsteem kustutab elemendi viited failidele.
      • Süsteem uuendab leitud AssessmentInstructionElement objekti andmeid:
        • files = null
  8. Süsteem muudab muudetud elemendi hindamise komponentide järjekorda.
    • Kui previousComponent väärtus ei ole määratud, siis lisatakse vormielement elemendi tasemel hindamise komponentide järjekorras esimeseks.
    • Kui previousComponent väärtus on määratud, siis lisatakse vormielement elemendi tasemel hindamise komponentide järjekorras määratud hindamise komponendi järele.
    • Andmed salvestatakse Objektid#AssessmentInstructionComponentOrder objekti.
  9. Süsteem tagastab muudetud andmed.