NSILM

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

Muutja: Natalja Selivjorstova · 2025-03-25

Üldkirjeldus

Teenus pärida eesmärgi tegevuse andmed tegevuse ID alusel. 

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-866 - 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

goalActivityId

1

String
  • Peab eksisteerima ja olema seotud eesmärgiga. 
Tegevuse unikaalne identifikaator, mille andmeid muudetakse.

goalId

1

String
  • Eesmärk peab eksisteerima ja ei tohi olla arhiveeritud.
    • Goal.id = goalId
Eesmärgi unikaalne identifikaator, mille tegevust muudetakse.

Väljundid

Atribuut

Kohustuslikkus, mitmesus

TüüpKirjeldus, täiendav info
Samad mis teenusel PM: API: Goal: POST /planning-api/goals/{goalId}/goal-activity#Väljundid

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 seda hallata.
    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 sisendis esitatud tegevus (goalActivityId) eksisteerib ja kas see on seotud eesmärgiga.
    1.  Süsteem otsib Objektid#GoalActivity objekti, mille:
      1. id =  Sisendis esitatud "goalActivityId" väärtus.
      2. goalId = Sisendis esitatud "goalId" väärtus.
      3. Kui tegevust ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem otsib tegevuse eest vastutava isiku nime. 
    1. Süsteem otsib Objektid#GoalTeamMember objekte, mille:
      1. id = leitud tegevuse Objektid#GoalActivity.goalTeamMemberId
    2. Kui vastavat meeskonnaliiget ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  6. Süsteem tagastab tegevuse andmed.