NSILM

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

Muutja: Natalja Selivjorstova · 2025-03-25

Üldkirjeldus

Teenus võimaldab pärida eesmärgi tegevuste andmed eesmärgi ID järgi.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-842 - 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 tegevusi otsitakse.

Väljundid

Atribuut

Kohustuslikkus, mitmesus

TüüpKirjeldus, täiendav info
goalActivities0..*Array

Eesmärgi tegevuste nimekiri.

Array objekte vaata PM: API: Goal: POST /planning-api/goals/{goalId}/activities#V%C3%A4ljundid

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigus 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 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 kontrollib, kas eesmärgiga on seotud vähemalt üks tegevus.
    1. Süsteem otsib Objektid#GoalActivity objekte, mille:
      1. goalId = Sisendis esitatud "goalId" väärtus.
    2. Kui ühtegi tegevust ei leita, tagastatakse tühi vastus.  
  5. Iga leitud tegevuse puhul otsib süsteem vastutava isiku nime. 
    1. Süsteem otsib Objektid#GoalTeamMember objekte, mille:
      1. id = leitud tegevuse Objektid#GoalActivity.goalTeamMemberId
    2. Kui mõnda tegevuse meeskonnaliiget ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  6. Süsteem tagastab kõigi leitud tegevuste andmeid koos vastutavate isikute nimedega.