NSILM

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

Muutja: Natalja Selivjorstova · 2025-09-02

Üldkirjeldus

Teenus võimaldab pärida eesmärgi mõõdikute nimekirja eesmärgi ID alusel.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-790 - Getting issue details... STATUS

NSIL-918 - Getting issue details... STATUS

NSIL-1277 - 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 mõõdikuid otsitakse.

Väljundid

Atribuut

Kohustuslikkus, mitmesus

TüüpKirjeldus, täiendav info

goalId

1

StringViide eesmärgile, millele mõõdikud kuuluvad.

goalMetrics

 

0..*

Array

Eesmärgi mõõdikud.

Array objekte vaata PM: API: Goal: POST /planning-api/goals/{goalId}/metrics

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 sisendandmed vastavad nõuetele.
    1. Kui andmed ei vasta nõuetele, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  3. 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 toimub 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.
  4. Süsteem otsib eesmärgi mõõdikuid.
    1. Süsteem otsib Objektid#GoalMetrics objekte, mille:
      • goalId = Sisendis esitatud "goalId" väärtus.
  5. Süsteem tagastab eesmärgi mõõdikute nimekirja.
    • Kui eesmärgiga pole seotud ühtegi mõõdikut, tagastatakse tühi vastus.