NSILM

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

Muutja: Natalja Selivjorstova · 2025-03-24

Üldkirjeldus

Teenus võimaldab salvestada eesmärgi tegevuse andmed. 

Seotud andmeobjektid:

Seotud Jira taskid

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

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

goalActivityId

1

String
  • Tegevus peab eksisteerima ja olema seotud eesmärgiga. 
    • GoalActivity.id = goalActivityId
    • GoalActivity.goalId = goalId
Tegevuse unikaalne identifikaator, mille andmeid muudetakse.

goalId

1

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

1

String
  • Peab olema 3-250 tähemärki pikk.
 Tegevuse pealkiri.
goalTeamMemberId

1

String
  • Peab olema üks eesmärgi meeskonnaliikmetest.
    • GoalTeamMember.id = goalTeamMemberId
    • GoalTeamMember.goalId = goalId
 Viide tegevuse vastutajaks määratud meeskonnaliikmele.
startDate

0..1

Date
  • Peab olema varasem või võrdne tegevuse lõpukuupäevaga.
 Tegevuse alguskuupäev.
endDate

1

Date
  • Peab olema täna või tulevikus. 
  • Kui tegevuse alguskuupäev on määratud, siis lõpukuupäev peab olema võrdne või hilisem alguskuupäevaga.
 Tegevuse lõpukuupäev.
activityDescription

0..1

String
  • Lubatud 3-2500 tähemärki.
 Tegevuse pikem kirjeldus.
themes

1..*

Array
  • Vähemalt üks teema peab olema lisatud.

Eesmärgi tegevusele märgitud teemad.

themes.themeType

1

String

Tegevusele märgitud teema.

Väärtusena klassifikaatori HSILM_THEME_LABEL elemendi viide.

fundings

0..*

Array

  • Tegevusel võib olla 0..n rahastuse allikat.

Tegevuse rahastuse allikas. 

fundings.year

1

Number

  • Peab olema neljakohaline number.
  • Aasta peab olema määratud lubatud vahemikku (eelmine aasta, jooksev aasta või järgmised 10 aastat).

Aasta, millesse rahastus planeeritud.

fundings.amount

1

Number

  • Peab olema positiivne number.
  • Võib olla täisarv või sisaldada komakohti.

Planeeritud rahastuse summa eurodes.

fundings.description

0..1

String

  • Lubatud 3-2500 tähemärki.

Rahastuse allika kirjeldus.

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 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 kontrollib, kas tegevuse eest vastutavaks määratud meeskonnaliige eksisteerib ja kas ta on eesmärgi meeskonnas.
    1. Süsteem otsib Objektid#Goal objekti, mille:
      • id = Sisendis esitatud "goalId" väärtus
      • teamMembers nimekirjas on sisendis esitatud "goalTeamMemberId" väärtus
    2. Kui tingimustele vastavat eesmärki ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  6. Süsteem uuendab tegevuse andmeid:   
    1. Süsteem otsib Objektid#GoalActivity objekti, mille:
      1. id = Sisendis esitatud "goalActivityId" väärtus.
    2. Süsteem uuendab leitud tegevuse andmeid:
      1. activityName =  Sisendis esitatud "activityName" väärtus.
      2. goalTeamMemberId =  Sisendis esitatud "goalTeamMemberId" väärtus.
      3. startDate =  Sisendis esitatud "startDate" väärtus.
      4. endDate =  Sisendis esitatud "endDate" väärtus.
      5. activityDescription =  Sisendis esitatud "activityDescription" väärtus.
      6. previousActivityId = jääb samaks nagu oli.
      7. Süsteem kirjutab üle tegevuse themes:
        1. themes.themeType = Sisendis esitatud "themes.themeType" väärtus.
      8. Süsteem kirjutab üle tegevuse fundings: 
        1. fundings.year = Sisendis esitatud "fundings.year" väärtus.
        2. fundings.amount = Sisendis esitatud "fundings.amount" väärtus.
        3. fundings.description = Sisendis esitatud "fundings.description" väärtus.
  7. Süsteem tagastab muudetud tegevuse andmed, sh tegevuse eest vastutavaks määratud meeskonnaliikme nime.