NSILM

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

Muutja: Natalja Selivjorstova · 2025-03-25

Üldkirjeldus

Teenus väljastab eesmärgi, selle tegevuste ja tööülesannete märkmed. Päringu tulemustest on võimalik välja filtreerida ainult eesmärgiga, eesmärgi kõigi tegevustega või eesmärgi kõigi tööülesannetega seotud märkmed. Samuti on võimalik pärida ainult sisendis määratud tegevuse või tööülesande märkmed.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-939 - 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
Viide eesmärgile, mille märkmed päritakse.

goalActivityId

0..1String
  • Antud atribuut ei tohi olla täidetud, kui goalActivityTaskId on täidetud.
  • Tegevus peab eksisteerima ja olema seotud eesmärgiga.
    • GoalActivity.id = goalActivityId
    • GoalActivity.goalId = goalId
Viide eesmärgi tegevusele, mille märkmed päritakse.

goalActivityTaskId

0..1String
  • Antud atribuut ei tohi olla täidetud, kui goalActivityId atribuut on täidetud.
  • Tööülesanne peab eksisteerima ja olema seotud eesmärgiga.
    • GoalActivityTask.id = goalActivityTaskId
    • GoalActivityTask.goalId = goalId
Viide tööülesandele, mille märkmed päritakse.

Väljundid

Atribuut

Kohustuslikkus, mitmesus

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

Eesmärgi märkmed.

Array objekte vaata 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 otsib sisendis esitatud eesmärgi, tegevuse või tööülesande märkmeid:
    1. Kui "goalActivityId" ja "goalActivityTaskId" parameeterid pole sisendis määratud:
      1. Süsteem otsib kõiki eesmärgiga seotud märkmeid, sh ka neid, mis on seotud konkreetse tegevusega või tööülesandega:
        1. Süsteem otsib Objektid#GoalNote objekte, mille:
          1. goalId = Sisendis esitatud "goalId" väärtus.
          2. Kui visibilityType = "PRIVATE", siis personalCode peab vastama päringu käivitanud kasutaja isikukoodile.
          3. Kui ühtegi märget ei leita, tagastatakse tühi vastus.
    2. Kui "goalActivityId" parameeter on sisendis määratud:
      1. Süsteem otsib kõiki sisendis esitatud tegevusega seotud märkmeid: 
        1. Süsteem kontrollib, kas 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.
          2. Kui tegevust ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
        2. Süsteem otsib tegevuse märkmeid:
          1. Süsteem otsib Objektid#GoalNote objekte, mille:
            1. goalActivityId = Sisendis esitatud "goalActivityId" väärtus
            2. goalId = Sisendis esitatud "goalId" väärtus
            3. Kui visibilityType = "PRIVATE", siis personalCode peab vastama päringu käivitanud kasutaja isikukoodile.
          2. Kui ühtegi märget ei leita, tagastatakse tühi vastus.
    3. Kui "goalActivityTaskId" parameeter on sisendis määratud:
      1. Süsteem otsib kõiki sisendis esitatud tööülesandega seotud märkmeid: 
        1. Süsteem kontrollib, kas tööülesanne eksisteerib ja kas see on seotud eesmärgiga:
          1. Süsteem otsib Objektid#GoalActivityTask objekti, mille:
            1. id =  Sisendis esitatud "goalActivityTaskId" väärtus.
            2. goalId = Sisendis esitatud "goalId" väärtus.
          2. Kui tööülesannet ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
        2. Süsteem otsib tööülesande märkmeid:
          1. Süsteem otsib Objektid#GoalNotes objekte, mille:
            1. goalActivityTaskId = Sisendis esitatud "goalActivityTaskId" väärtus
            2. goalId = Sisendis esitatud "goalId" väärtus
            3. Kui visibilityType = "PRIVATE", siis personalCode peab vastama päringu käivitanud kasutaja isikukoodile.
          2. Kui ühtegi märget ei leita, tagastatakse tühi vastus.
  5. Süsteem tagastab leitud märkmed.