NSILM

PM: API: Goal: PUT /planning-api/goals/{goalId}/metrics/{goalMetricsId}

Muutja: Natalja Selivjorstova · 2025-09-02

Üldkirjeldus

Teenus võimaldab salvestada eesmärgi mõõdiku detailandmed.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-830 - Getting issue details... STATUS

NSIL-913 - Getting issue details... STATUS

NSIL-1277 - 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 peab olema eesmärgi omanik ja tal peab olema 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.
  • Eesmärgi meeskonnaliikmel ei ole õigust mõõdikute andmeid muuta.

Planeerimise mooduli kasutusrollide ja õiguste kohta saab täpsemalt infot leida lehelt Kasutusõigused ja rollid.

Sisendid

Atribuut

Kohustuslikkus, mitmesus

TüüpVaikeväärtus, valideerimineKirjeldus, täiendav info

goalMetricsId

1

String
  •  Peab eksisteerima ja olema seotud eesmärgiga. 
    • GoalMetrics.id = goalMetricsId
    • GoalMetrics.goalId = goalId
Mõõdiku unikaalne identifikaator, mille andmeid muudetakse.

goalId

1

String
  • Eesmärk peab eksisteerima.
    • Goal.id = goalId.
  • Eesmärk ei tohi olla arhiveeritud.
    • goal.arhived = false.
Viide eesmärgile, millega mõõdik on seotud.

description

1

String
  • Peab olema 3 - 250 tähemärki.
Mõõdiku kirjelduse tekst. 

reports

 

1..*

Array
  • Vähemalt 1 näitaja (aruanne) on kohustuslik.

Mõõdiku näitajad (aruanded).

Eesmärgi mõõdikul võib olla 1..3 näitajat (aruannet).

reports.workspaceId

1

String
  • Peab olema 3 - 250 tähemärki.
PBI aruande tööruumi identifikaator.

reports.reportId

1

String
  • Peab olema 3 - 250 tähemärki.
PBI aruande identifikaator.

reports.bookmark

0..1

String
  • PBI aruande filtrite snapshot (bookmark) vastavalt kasutaja tehtud valikutele.
  • Sisu maksimaalne pikkus: 4000 tähemärki.
  • Sisu eeldatav formaat: base64.
 Aruandele rakendatud filtrite snapshot (base64 formaadis).

reports.meta

1

Object-Näitaja (aruande) metaandmed.

reports.meta.dashboardName

1

String
  • Peab olema 3 - 250 tähemärki.
Juhtimislaua nimetus.

reports.meta.elementName

1

String
  • Peab olema 3 - 250 tähemärki.
Vahelehe nimetus.

reports.meta.subelementName

1

String
  • Peab olema 3 - 250 tähemärki.
Alamteema nimetus.

reports.meta.isPinnedElement

1

Boolean

Võimalikud väärtused:

  • true - on juhtimislaual esiletõstetud
  • false - ei ole esiletõstetud
Määrab, kas näitaja on juhtimislaual esiletõstetud või mitte.
targets

0..*

Array
  • Eesmärgi mõõdikul võib olla 0..n sihttaset.

Eesmärgi mõõdikuga seotud sihttase.

Eesmärgi mõõdikul võib olla 0..n sihttaset.

targets.year

1

Number
  • Peab olema neljakohaline number.
  • Aasta peab olema määratud lubatud vahemikku: jooksev aasta kuni järgmised 10 aastat.
Sihttaseme aasta.

targets.description

1

String
  • Peab olema 3-2500 tähemärki.
Sihttaseme kirjeldus.

Väljundid

Atribuut

Kohustuslikkus, mitmesus

TüüpKirjeldus, täiendav info

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

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui kasutajal ei ole õigust, 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 hallata selle andmeid.
    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 mõõdik eksisteerib ja kas see on seotud eesmärgiga:
    1. Süsteem otsib Objektid#GoalMetrics objekti, mille:
      1. id =  Sisendis esitatud "goalMetricsId" väärtus.
      2. goalId = Sisendis esitatud "goalId" väärtus.
    2. Kui vastavat mõõdikut ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süstem uuendab mõõdiku detailandmeid:
    1. Süsteem uuendab leitud Objektid#GoalMetrics andmeid:
      1. description = Sisendis esitatud "description" väärtus.
      2. Süsteem kirjutab üle mõõdiku reports:
        1. reports.workspaceId = Sisendis esitatud "reports.workplaceId" väärtus.
        2. reports.reportId = Sisendis esitatud "reports.reportId" väärtus.
        3. reports.bookmark = Sisendis esitatud "reports.bookmark" väärtus.
        4. reports.meta.dashboardName = Sisendis esitatud "reports.meta.dashboardName" väärtus.
        5. reports.meta.elementName = Sisendis esitatud "reports.meta.elementName" väärtus.
        6. reports.meta.subelementName = Sisendis esitatud "reports.meta.subelementName" väärtus.
        7. reports.meta.isPinnedElement = Sisendis esitatud "reports.meta.isPinnedElement" väärtus.
      3. Süsteem kirjutab üle mõõdiku targets:
        1. targets.year = Sisendis esitatud "targets.year" väärtus;
        2. targets.description = Sisendis esitatud "targets.description" väärtus.
  6. Süsteem tagastab uuendatud mõõdiku andmed.