NSILM

PM: API: DevelopmentPlan: GET /planning-api/development-plans/{developmentPlanId}/versions

Muutja: Natalja Selivjorstova · 2025-08-07

Üldkirjeldus

Teenus võimaldab pärida arengukavast jagatud versioonide nimekirja.

Seotud andmeobjektid:

Seotud Jira taskid

NSIL-1058 - Getting issue details... STATUS

Eeltingimused ja kasutusõigused

  • Kui tegemist on asutusepõhise arengukavaga (DevelopmentPlan.developmentPlanScope = INSTITUTIONAL):
    • Arengukava peab olema muudetav.
      • DevelopmentPlan.editable= true
    • Kasutajal peab olema seos arengukava asutusega ning sama asutuse arengukava lisamise ja muutmise õigus. 
      • DevelopmentPlan.institution.id = kasutaja poolt valitud rolliga seotud asutus,
      • Õigust reguleerib privileeg: HSILM_PLANNING_DEV_PLAN_MANAGE.
  • Kui tegemist on isikupõhise arengukavaga (DevelopmentPlan.developmentPlanScope = INDIVIDUAL):
    • Arengukava peab olema muudetav.
      • DevelopmentPlan.editable= true
    • Kasutaja peab olema arengukava omanik.
      • DevelopmentPlan.personalCode = kasutaja isikukood
    • Eraldi privileegi ei ole vaja.
  • Planeerimise meeskonnaliikme rolli kasutajatel ei ole ligipääsu arengukavadele ega nende versioonidele.

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

developmentPlanId

1

String
  • Peab eksisteerima ja olema muudetav.
    • developmentPlanId = DevelopmentPlan.id, mille editable = true
Viide arengukavale, mille versioone otsitakse.

versionType

0..1

String

Võimalikud väärtused:

  1. URL
  2. PDF
Määrab, mis tüüpi versioone otsitakse. 

Väljundid

AtribuutKohustuslikkus, mitmesusTüüpKirjeldus, täiendav info
developmentPlanVersions

0..*

Array

Arengukava versioonide nimekiri

Array objektid samad nagu teenusel PM: API: DevelopmentPlan: POST /planning-api/development-plans/{developmentPlanId}/url-versions.

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui õigus puudub, 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 sisendis esitatud arengukavast (developmentPlanId) genereeritud versioone:
    1. Otsitakse Objektid#DevelopmentPlan objekte, mille puhul kehtivad järgmised tingimused: 
      1. developmentPlanScope = Objektid#DevelopmentPlan.developmentPlanScope, mille id = sisendis esitatud developmentPlanId väärtus
      2. institution.id = Objektid#DevelopmentPlan.institution.id, mille id = sisendis esitatud developmentPlanId väärtus
      3. personalCode = Objektid#DevelopmentPlan.personalCode, mille id = sisendis esitatud developmentPlanId väärtus
      4. jobsite = Objektid#DevelopmentPlan.jobsite, mille id = sisendis esitatud developmentPlanId väärtus
      5. editable = false
    2. Kui ühtegi sobivat arengukava ei leita, tagastatakse tühi vastus.
  4. Süsteem otsib leitud arengukava versioonide andmeid:
    1. Kui sisendis on määratud versiooni tüüp (versionType), filtreeritakse välja ainult selle tüübiga versioonid. 
      1.  Otsitakse Objektid#DevelopmentPlanVersion objekte, mille puhul kehtivad järgmised tingimused:
        1. developmentPlanId =  üks leitud arengukava ID-dest (Objektid#DevelopmentPlan.id)
        2. versionType =  sisendis esitatud versionType väärtus (kui on määratud)
    2. Kui ühtegi sobivat versiooni ei leita, lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  5. Süsteem tagastab leitud arengukava versioonid.