NSILM

PM: API: Goal: PATCH /planning-api/goals/{goalId}/activities/{goalActivityId}/tasks/{activityTaskId}/done

Muutja: Natalja Selivjorstova · 2025-06-11

Üldkirjeldus

Teenus võimaldab salvestada eesmärgi tööülesande lõpetatuks või eemaldada lõpetamise märgi.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-862 - Getting issue details... STATUS

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

goalActivityTaskId

1

String
  • Tööülesanne peab eksisteerima ja olema seotud eesmärgi ja tegevusega.
    • GoalActivityTask.id = goalActivityTaskId
    • GoalActivityTask.goalActivityId = goalActivityId
    • GoalActivityTask.goalId = goalId
Viide tööülesandele, mida määratakse lõpetatuks.

goalActivityId

1String
  • Tegevus peab eksisteerima ja olema seotud eesmärgiga.
    • GoalActivity.id = goalActivityId
    • GoalActivity.goalId = goalId

Viide eesmärgi tegevusele, millega tööülesanne on seotud.

goalId

1

String
  • Eesmärk peab eksisteerima ja ei tohi olla arhiveeritud.
    • Goal.id = goalId
    • Goal.archived = false
Viide eesmärgile, millega tööülesanne on seotud.
done

1

Boolean
  • Peab erinema süsteemis salvestatud olekust.
    • GoalActivityTask.done != done
Märge, kas tööülesanne on tehtud või mitte.

Väljundid

Atribuut

Kohustuslikkus, mitmesus

TüüpKirjeldus, täiendav info
goalActivityTaskId

1

StringEesmärgi tegevuse tööülesande unikaalne identifikaator.

goalId

1

StringViide eesmärgile, millega tööülesanne on seotud.
done

1

BooleanMärge, kas tööülesanne on tehtud või mitte.

Ärireegel

  1. Kui lõpetatakse tööülesanne, mille lõpu kuupäev on tulevikus, kirjutatakse see üle jooksva kuupäevaga. Muudel juhtudel jääb see muutmata. 

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 tööülesanne (goalActivityId) eksisteerib, on seotud eesmärgiga (goalId) ning selle olek (done) erineb sisendis esitatud väärtusest.
    1.  Süsteem otsib Objektid#GoalActivityTask objekti, mille:
      1. id =  Sisendis esitatud "goalActivityTaskId" väärtus
      2. goalActivityId =  Sisendis esitatud "goalActivityId" väärtus
      3. goalId =  Sisendis esitatud "goalId" väärtus
      4. done != Sisendis esitatud "done" väärtus
    2. Kui tööülesannet ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Kui sisendis esitatud done = true:
    1. Tööülesanne märgitakse lõpetatuks:
      1. Süsteem uuendab leitud Objektid#GoalActivityTask objekti:
        1. done = Sisendis esitatud "done" väärtus
        2. Kui endDate on tulevikus, kirjutatakse see üle jooksva kuupäevaga. 
  6. Kui sisendis esitatud done = false:
    1. Lõpetamise märge eemaldatakse:   
      1. Süsteem uuendab leitud Objektid#GoalActivityTask objekti:
        1. done = Sisendis esitatud "done" väärtus
  7. Süsteem tagastab muudetud tööülesande andmed.