NSILM

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

Muutja: Natalja Selivjorstova · 2025-09-02

Üldkirjeldus

Teenus võimaldab pärida mõõdiku detailandmeid mõõdiku ID järgi.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-791 - Getting issue details... STATUS

NSIL-919 - 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 lisamise ja muutmise õigus. 
      • Goal.institution.id = Kasutaja poolt valitud rolliga seotud asutus
      • Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_MANAGE.
  • Kui tegemist on isikupõhise eesmärgiga (Goal.goalScope = INDIVIDUAL):
    • Kasutaja on eesmärgi omanik ja tal on seos eesmärgi asutuse ja ametikohaga.
      • Goal.personalCode = Päringu käivitanud kasutaja isikukood.
      • Goal.institution.id = Kasutaja poolt valitud rolliga seotud asutus
      • Goal.jobsite = Kasutaja poolt valitud rolliga seotud ametikoht
      • Eraldi privileegi ei ole vaja.
  • Või kasutaja on eesmärgi meeskonnas ja planeerimise meeskonna liikme rollil on eesmärkide lisamise ja muutmise õigus.
    • Goal.goalScope = INSTITUTIONAL või INDIVIDUAL
    • Goal.teamMembers.id = GoalTeamMember.id, mille personalCode = Päringu käivitanud kasutaja isikukood
    • Õigust reguleerib privileeg: HSILM_PLANNING_GOAL_MANAGE.

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

Sisendid

Atribuut

Kohustuslikkus, mitmesus

Tüüp

Vaikeväärtus, valideerimine

Kirjeldus, täiendav info

goalMetricsId

1

String
  • Mõõdik peab eksisteerima.
    • goalMetrics.id = goalMetricsId
Mõõdiku unikaalne identifikaator, mille detailandmeid päritakse. 

goalId

1

String
  • Eesmärk peab eksisteerima.
    • Goal.id = goalId
Viide eesmärgile, millele kuulub otsitav mõõdik.

Väljundid

Atribuut

Kohustuslikkus, mitmesus

TüüpKirjeldus, täiendav info
Sama mis teenusel PM: API: Goal: POST /planning-api/goals/{goalId}/metrics.

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui õigust pole, 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 viiakse läbi 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 kontrollib, kas sisendis esitatud mõõdik eksisteerib ja kas see on seotud eesmärgiga:
    1. Süsteem otsib Objektid#GoalMetrics objekti, mille:
      1. id =  Sisendis esitatud "goalMetricsId" väärtus.
      2. goalId = Sisendis esitatud "goalId" väärtus.
    2. Kui vastavat mõõdikut ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem tagastab mõõdiku andmed.