NSILM

PM: API: Goal: GET /planning-api/goals/{goalId}/assessment-challenges

Muutja: Natalja Selivjorstova · 2025-03-25

Üldkirjeldus

Teenus võimaldab pärida eesmärgiga seotud väljakutsete detailandmeid eesmärgi ID alusel. 

Seotud andmeobjektid: 

Seotud Jira taskid

NSIL-776 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kui tegemist on asutusepõhise eesmärgiga (Goal.goalScope = INSTITUTIONAL):
    • Kasutajal on seos eesmärgi asutusega ja sama asutuse eesmärkide vaatamise õigus. 
      • Goal.institution.id = Kasutaja poolt valitud rolliga seotud asutus
      • Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_VIEW.
  • Kui tegemist on isikupõhise eesmärgiga (Goal.goalScope = INDIVIDUAL):
    • Kasutaja on eesmärgi omanik.
      • Goal.personalCode = Päringu käivitanud kasutaja isikukood.
      • Eraldi privileegi ei ole vaja.
  • Või kasutaja on eesmärgi meeskonnas ja planeerimise meeskonna liikme rollil on eesmärkide vaatamise õigus.
    • Goal.goalScope = INSTITUTIONAL või INDIVIDUAL
    • Goal.teamMembers.id = GoalTeamMember.id, mille personalCode = Kasutaja isikukood
    • Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_VIEW.

Planeerimise mooduli kasutusrollide ja õiguste kohta saab täpsemalt infot leida lehelt Kasutusõigused ja rollid.

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info

goalId

1

String
  • Eesmärk peab eksisteerima.
    • Goal.id = goalId
Eesmärgi unikaalne identifikaator, mille väljakutseid otsitakse.

Väljundid

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

Eesmärgi unikaalne identifikaator, mille väljakutsed väljastatakse.

assessmentChallenges0..*Array

Eesmärgiga seotud väljakutsed.

assessmentChallenges.id1String

Väljakutse identifikaator

assessmentChallenges.elements1..*Array

 Väljakutse elemendid.

elements.id

1

UUIDElemendi id.
elements.assessmentResultSectionElementId

1

FKHindamise käigus elemendile antud id.
elements.code

1

Enum

Vaikimisi lisatud elemendi kood. 

Väärtused:

  • CHALLENGE_TYPE - Väljakutse liik
  • CHALLENGE - Väljakutse
  • TOPIC - Teema
  • IMPORTANCE - Olulisus
elements.label

1

StringVormielemendi silt.
elements.inputType

1

EHIS Classifier

Vormielemendi sisendi formaat.

Väärtusena klassifikaatori INPUT_TYPE elemendi viide.

elements.scale

0..1Object

Skaala objekt. Kasutatakse kui sisendi formaat väärtuseks on "punktid" (SCORE).

elements.scale.valuesFrom

1

IntegerSkaala väärtuste algus. 
elements.scale.valuesUntil

1

IntegerSkaala väärtuste lõpp. 

elements.scale.selectedValue

0..1Integer

Skaalal valitud väärtus.

elements.textAreaValue

0..1String

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

elements.ehisClassifierCode

0..1

StringEHISe klassifikaatori definitsiooni kood. Kasutatakse kui sisendi formaat väärtuseks on "klassifikaator" (CLASSIFIER).
elements.selectedEhisClassifierItems

0..*

EHIS Classifier ArrayValitud ehise klassifikaatori elemendi objektid. Kasutatakse kui sisendi formaat väärtuseks on "klassifikaator" (CLASSIFIER).

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui kasutajal ei ole õigust, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  2. Süsteem kontrollib, kas sisendis esitatud eesmärk (goalId) eksisteerib ja kas päringu käivitanud kasutajal on õigus selle andmeid pärida.
    1. Kontroll teostatakse vastavalt üldreeglites kirjeldatud loogikale.
    2. Kui eesmärki ei leita või see ei vasta üldreeglitele, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  3. Süsteem otsib leitud eesmärgi külge seotud väljakutsete andmeid.  
    1. Süsteem otsib Objektid#AssessmentChallenge objekti, mille:
      1. id = üks leitud eesmärgi assessmentChallengeIds ID-dest.
    2. Kui ühtegi vastavat väljakutset ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Süsteem tagastab leitud väljakutsete detailandmed.
    1. Kui eesmärgiga pole seotud ühtegi väljakutset, tagastatakse tühi vastus.