NSILM

PM: API: DevelopmentPlan: GET /planning-api/public/development-plan-versions

Muutja: Natalja Selivjorstova · 2025-08-06

Üldkirjeldus

Teenus võimaldab pärida URL-ina jagatud arengukava versiooni andmed.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-1247 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Arengukava peab olema mittemuudetav.
    • DevelopmentPlan.editable = false

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
versionId

0..1

String
  • Kohustuslik esitada kas:
    • versionId, või 
    • publicUrlAlias ja institutionRegCode, või
    • publicUrlAlias ja personalCode.
Viide arengukava URL-versioonile, mille andmeid päritakse.
publicUrlAlias

0..1

StringVersioonile määratud alias'e väärtus.
institutionRegCode

0..1

StringAsutuse registrikood, millele arengukava versioon kuulub. 
personalCode

0..1

StringIsiku isikukood, kellele arengukava versioon kuulub. 

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
Samad nagu teenusel PM: API: DevelopmentPlan: POST /planning-api/development-plans.


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 otsib arengukava versioone, mis vastavad sisendis esitatud andmetele:
    1. Otsitakse objekti Objektid#DevelopmentPlanVersion, mille:
      1.  id =  sisendis esitatud versionId väärtus (kui on määratud), või
      2. publicUrlAlias =  sisendis esitatud publicUrlAlias väärtus (kui on määratud)
    2. Kui ühtegi versiooni ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  4. Iga leitud versiooni puhul kontrollitakse, kas leidub seotud mittemuudetav arengukava (DevelopmentPlan), mis vastab sisendis esitatud andmetele.
    1. Otsitakse Objektid#DevelopmentPlan objekti, mille:
      1. id = leitud versiooniga seotud arengukava ID (Objektid#DevelopmentPlanVersion.developmentPlanId)
      2. institutionRegCode =  sisendis esitatud institutionRegCode väärtus (kui on määratud)
      3. personalCode =  sisendis esitatud personalCode väärtus  (kui on määratud)
      4. editable = false
    2. Kui vastavat arengukava ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem tagastab leitud arengukava andmed.