NSILM

GS: AssessmentModel: API: PUT /quality-api/assessment-models/{modelId}/notification-settings/{settingId}/

Muutja: Andres Mill · 2024-01-17

Üldkirjeldus

Teenus võimaldab muuta hindamismudeliga seotud hindamiste teavituste seadeid.

Seotud andmeobjektid:


Eeltingimused ja kasutusõigused

  • Kasutaja poolt valitud rollil peab olema hindamisega seotud valdkonna haldamise õigus.
    • AssessmentModel.domainType = Klassifikaatorid#KlassifikaatorDOMAIN, mis on seotud ASSESSMENT_MODEL_MANAGE_PRIVILEGE (attributeDefinitionCode) privileegiga, mis on kasutaja poolt valitud rollile lisatud.

Sisendid

AtribuutKohustuslikkus, mitmesusTüüpVaikeväärtus, valideerimineKirjeldus, täiendav info
modelId1UUID
  • Hindamismudel ei tohi olla kustutatud.
    • AssessmentModel.objectStatus = CURRENT
  • Hindamismudeli äriline staatus peab olema "Mustand" või "Kinnitatud" või "Kehtiv".
    • Mustand: AssessmentModel.isConfirmed = false
    • Kinnitatud: AssessmentModel.isConfirmed = true, validFrom > päringu teostamise aeg.
    • Kehtiv: AssessmentModel.isConfirmed = true, validFrom <= päringu teostamise aeg, validUntil > päringu teostamise aeg.

Hindamismudeli id (UUID).

settingId1UUID
  • Hindamise teavituse seadistus ei tohi olla kustutatud

Hindamise teavituse seadistuse id (UUID).

addresseeGroupTypes0..*EHIS Classifier list 

Teavituse saajate grupp, kellele teavitus saadetakse.

assessmentRoles0..*EHIS Classifier list 
  • Lubatud väärtustada, kui teavituse saajate hulgas on "Meeskonnaliikmed rolli järgi" tüüpi teavituse saaja määratud. Muudel juhtudel ei ole lubatud atribuuti väärtustada.
    • addresseeGroupTypes = ASSESSMENT_ROLE
  • Kohustuslik esitada vähemalt üks, kui teavituse saajate hulgas on "Meeskonnaliikmed rolli järgi" tüüpi teavituse saaja määratud.
  • Peab olema Klassifikaatorid#KlassifikaatorASSESSMENT_ROLE hulgas kehtiv kirje.

Meeskonnaliikme roll, kellele teavitus saadetakse. 

ehisPrivileges0..*Array
  • Lubatud väärtustada, kui teavituse saajate hulgas on "EHIS privileegiga kasutaja" tüüpi teavituse saaja määratud. Muudel juhtudel ei ole lubatud atribuuti väärtustada.
    • addresseeGroupTypes = EHIS_PRIVILEGE
  • Kohustuslik esitada vähemalt üks, kui teavituse saajate hulgas on "EHIS privileegiga kasutaja" tüüpi teavituse saaja määratud

EHIS privileeg, mida omavatele kasutajatele teavitus saadetakse. Kasutatakse juhul kui "Saajate grupid" väärtuseks on "EHIS privileegiga kasutaja".

Väärtusena EHIS privileegi kood.

adUserGroups0..*Array
  • Array elemente on lubatud väärtustada, kui teavituse saajate hulgas on "AD struktuuriüksus" tüüpi teavituse saaja määratud. Muudel juhtudel ei ole lubatud atribuuti väärtustada.
    • addresseeGroupTypes = AD_USER_GROUP
  • Kohustuslik esitada vähemalt üks array element, kui teavituse saajate hulgas on "AD struktuuriüksus" tüüpi teavituse saaja määratud

AD struktuuriüksus, mille alla kuuluvatele kasutajatele teavitus saadetakse. Kasutatakse juhul kui "Saajate grupid" väärtuseks on "AD struktuuriüksus".

adUserGroups.adUserGroup.code1String

AD struktuuriüksuse kood või mõni identifikaator AD-s.

adUserGroups.adUserGroup.name1String

AD struktuuriüksuse nimetus kasutajaliides kuvamiseks.

Väljundid

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

Teavituse seadistuse identifikaator (UUID).

messageActionType1EHIS Classifier

Tegevuse kirjeldus, millega teavituse saatmine seotud. Valida saab süsteemi sisse ehitatud tegevuste vahel - kasutaja ise uusi tegevusi defineerida ei saa. Väärtusena klassifikaatori NSILM_MESSAGE_ACTION elemendi viide.

phaseType0..1EHIS Classifier

Etapp, millega teavituse seadistus seotud on.

addresseeGroupTypes0..*EHIS Classifier list

Teavituse saajate grupp, kellele teavitus saadetakse.

Väärtusena klassifikaatori ADDRESSEE_GROUP elemendi viide.

assessmentRoles0..*EHIS Classifier list

Meeskonnaliikme roll, kellele teavitus saadetakse. Kasutatakse juhul kui "Saajate grupid" väärtuseks on "Meeskonnaliikmed rolli järgi".

Väärtusena klassifikaatori ASSESSMENT_ROLE elemendi viide.

ehisPrivileges0..*Array

EHIS privileeg, mida omavatele kasutajatele teavitus saadetakse. Kasutatakse juhul kui "Saajate grupid" väärtuseks on "EHIS privileegiga kasutaja".

Väärtusena EHIS privileegi kood.

adUserGroups0..*Array

AD struktuuriüksus, mille alla kuuluvatele kasutajatele teavitus saadetakse. Kasutatakse juhul kui "Saajate grupid" väärtuseks on "AD struktuuriüksus".

Väärtusena AD struktuuriüksuse nimetus.

adUserGroups.adUserGroup1Object

AD struktuuriüksuse objekt.

adUserGroups.adUserGroup.code1String

AD struktuuriüksuse kood või mõni identifikaator AD-s.

adUserGroups.adUserGroup.name1String

AD struktuuriüksuse nimetus kasutajaliides kuvamiseks.

objectStatus1String

Objekti staatus.

  • CURRENT - Kehtiv
  • DELETED - Kustutatud

Tegevused

  1. Süsteem kontrollib, kas kasutajal on õigust päringut teostada.
    1. Kui kasutajal ei ole õigust päringut teostada, siis lõpetatakse päringu töötlemine ja tagastatakse http veakood.
  2. Süsteem otsib päringus esitatud tingimustele vastava objekti.
    • Süsteem otsib Objektid#AssessmentModel.notificationSettings objekti, mille
      • AssessmentModel.id= Sisendis esitatud modelId väärtus.
      • AssessmentModel.objectStatus = CURRENT
      • AssessmentModel.notificationSettings.id = Sisendis esitatud settingId väärtus.
      • AssessmentModel.notificationSettings.objectStatus = CURRENT
        1. Kui tingimustele vastavat objekti ei leitud, siis lõpetab süsteem päringu töötlemise ja tagastab http veakoodi.
  3. Süsteem muudab hindamise teavituse seadeid.
    • Süsteem muudab leitud Objektid#AssessmentModel.notificationSettings objekti andmeid:
      • addresseeGroupTypes = Sisendis esitatud addresseeGroupTypes väärtused.
      • assessmentRoles = Sisendis esitatud assessmentRoles väärtused.
      • ehisPrivileges = Sisendis esitatud ehisPrivileges väärtused.
      • adUserGroups = Sisendis esitatud adUserGroups väärtused.
  4. Süsteem tagastab muudetud andmed.