RPC API documentation v49.3.0

Saves PerunNotifReceiver to db and creates id. PerunNotifReceiver must contain: templateId. Parameters target, locale, type are optional.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/createPerunNotifReceiver

• see URL structure

Example params

{ "receiver" : { "templateId" : 7 } }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Saves PerunNotifReceiver to db and creates id.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/createPerunNotifReceiver

• see URL structure

Example params

{ "target" : "text" , "locale" : "text" , "templateId" : 80 , "type" : "text" }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Saves perunNotifRegex to db and creates id, also saves relation between regex and object.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/createPerunNotifRegex

• see URL structure

Example params

{ "regex" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Saves PerunNotifTemplate to db and saves all relations to db.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/createPerunNotifTemplate

• see URL structure

Example params

{ "template" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Saves perunNotifTemplateMessage to db and creates id.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/createPerunNotifTemplateMessage

• see URL structure

Example params

{ "message" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns all PerunNotifReceivers from db.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/getAllPerunNotifReceivers

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns all PerunNotifRegexes.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/getAllPerunNotifRegexes

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns all PerunNotifTemplateMessages.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/getAllPerunNotifTemplateMessages

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns all PerunNotifTemplates.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/getAllPerunNotifTemplates

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Return PerunNotifReceiver with given id from db. Object for PerunNotifReceiver.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/getPerunNotifReceiverById

• see URL structure

Example params

{ "id" : 56 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns PerunNotifRegex by id, returns also object related to regex. Methods for PerunNotifRegexp.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/getPerunNotifRegexById

• see URL structure

Example params

{ "id" : 65 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Return perunNotifTemplate from db, return also all filled collections. Methods for perunNotifTemplate.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/getPerunNotifTemplateById

• see URL structure

Example params

{ "id" : 92 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Gets PerunNotifTemplateMessage from db. Methods for perunNotifTemplateMessage.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/getPerunNotifTemplateMessageById

• see URL structure

Example params

{ "id" : 25 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Returns all regexes related to given template.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/getRelatedRegexesForTemplate

• see URL structure

Example params

{ "templateId" : 86 }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Method checks if the notifications module is running at the time.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/isNotificationsRunning

• see URL structure

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Removes PerunNotifReceiver from db.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/removePerunNotifReceiverById

• see URL structure

Example params

{ "id" : 4 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Removes PerunNotifRegex from db, if regex is referenced from template exception is thrown. Also removes relation between regex and objects.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/removePerunNotifRegexById

• see URL structure

Example params

{ "id" : 20 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Removes perunNotifTemplate from db.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/removePerunNotifTemplateById

• see URL structure

Example params

{ "id" : 62 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Removes PerunNotifTemplateMessage from db.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/removePerunNotifTemplateMessage

• see URL structure

Example params

{ "id" : 38 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Removes relation between PerunNotifRegex and PerunNotifTemplate.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/removePerunNotifTemplateRegexRelation

• see URL structure

Example params

{ "templateId" : 26 , "regexId" : 54 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Save relation between template and regex if not exists yet.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/saveTemplateRegexRelation

• see URL structure

Example params

{ "templateId" : 69 , "regexId" : 4 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Start notifications processing.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/startNotifications

• see URL structure

Example response

null

• see Return values
• see HTTP return codes

Stop notifications processing.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/stopNotifications

• see URL structure

Example params

{ "id" : 19 }

• see Passing params

Example response

null

• see Return values
• see HTTP return codes

Updates receiver in db.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/updatePerunNotifReceiver

• see URL structure

Example params

{ "receiver" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Updates PerunNotifRegex in db, also updates relation between regex and objects.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/updatePerunNotifRegex

• see URL structure

Example params

{ "regex" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Method will update perunNotifTemplate, also update relations, but not deletes them

Example URL

https://[hostname]/krb/rpc/json/notificationManager/updatePerunNotifTemplate

• see URL structure

Example params

{ "template" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes

Update perunNotifTemplateMessage in db.

Example URL

https://[hostname]/krb/rpc/json/notificationManager/updatePerunNotifTemplateMessage

• see URL structure

Example params

{ "message" : {...} }

• see Passing params

Example response

{ ... TODO ... }

• see Return values
• see HTTP return codes