NSILM

PM: API: Goal: DELETE /planning-api/goals/{goalId}/notes/{goalNoteId}

Muutja: Natalja Selivjorstova · 2025-06-19

Üldkirjeldus

Teenus võimaldab kustutada eesmärgi, tegevuse või tööülesande märkme.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-940 - Getting issue details... STATUS

NSIL-974 - Getting issue details... STATUS

NSIL-1169 - 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 = 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 = 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
goalNoteId

1

String
  • Märge peab eksisteerima ja olema seotud kas ainult eesmärgiga või lisaks ka tegevuse või tööülesandega.
    • GoalNote.id = goalNoteId
    • GoalNote.goalId = goalId
    • GoalNote.goalActivityId = goalActivityId
    • GoalNote.goalActivityTaskId = goalActivityTaskId
Eesmärgi märkme unikaalne identifikaator, mida kustutatakse.

goalId

1

String
  • Eesmärk peab eksisteerima ja ei tohi olla arhiveeritud.
    • Goal.id = goalId
    • Goal.archived = false
Viide eesmärgile, millega märge on seotud.

Väljundid

Atribuut

Kohustuslikkus, mitmesus

TüüpKirjeldus, täiendav info

Samad mis teenusel PM: API: Goal: POST /planning-api/goals/{goalId}/notes

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 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, et sisendis esitatud märge (goalNoteId) eksisteerib ja on seotud sisendis esitatud eesmärgiga:  
    1. Süsteem otsib Objektid#GoalNote objekti, mille:
      1. id = Sisendis esitatud "goalNoteId" väärtus
      2. goalId =  Sisendis esitatud "goalId" väärtus
    2. Kui märget ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Kui eemaldatakse tööülesandele lisatud märget, kontrollib süsteem, et see ei oleks lõpetatud: 
    1. Kui leitud märkme Objektid#GoalNote.goalActivityTaskId on täidetud, siis:
      1. Süsteem otsib Objektid#GoalActivityTask objekti, mille:
        1. id =  Objektid#GoalNote.goalActivityTaskId
        2. goalId =  Sisendis esitatud "goalId" väärtus
        3. done = false
      2. Kui tingimustele vastavat tööülesannet ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  6. Süsteem kontrollib, kas päringu käivitanud kasutaja tohib märget eemaldada:
      1. Kui leitud märkme Objektid#GoalNote.visibilityType = "PRIVATE", kontrollitakse, et päringu käivitanud kasutaja oleks märkme looja:
        1. Objektid#GoalNote.personalCode = Päringu käivitanud kasutaja isikukood
      2. Kui tingimused pole täidetud, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  7. Süsteem eemaldab märkme:
    1. Süsteem kustutab Objektid#GoalNote objekti, mille id = Sisendis esitatud "goalNoteId" väärtus, andmebaasist jäädavalt.
  8. Märkme kustutamise kohta lisatakse logidesse kirje:
    1. kasutaja nimi, kes esialgselt lõi märkme
    2. kasutaja nimi, kes seda viimati muutis
    3. kastuaja nimi, kes märkme kustutas
    4. mis kuupäeval ja kell märge kustutati
    5. märkme kirjelduse tekst
    6. märkme nähtavus
  9. Süsteem tagastab kustutatud märkme andmed.