Saves PerunNotifReceiver to db and creates id
. PerunNotifReceiver must contain: templateId. Parameters target, locale, type are optional.
Parameter name | Data type | Description |
---|---|---|
receiver | PerunNotifReceiver | PerunNotifReceiver object without id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifReceiver | PerunNotifReceiver with new id set |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/createPerunNotifReceiver
Example params
{ "receiver" : { "templateId" : 7 } }
Example response
{ ... TODO ... }
Saves PerunNotifReceiver to db and creates id
.
Parameter name | Data type | Description |
---|---|---|
target | String | Defines target of receiver, usually contains function to get email |
locale | String | Locale of receiver - determines a language, which is used for sending messages |
templateId | int | Template Id to which receiver is connected |
type | String | Type of the receiver - 'EMAIL_USER' or 'EMAIL_GROUP' |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifReceiver | PerunNotifReceiver with new id set |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/createPerunNotifReceiver
Example params
{ "target" : "text" , "locale" : "text" , "templateId" : 69 , "type" : "text" }
Example response
{ ... TODO ... }
Saves perunNotifRegex to db and creates id
, also saves relation between regex and object.
Parameter name | Data type | Description |
---|---|---|
regex | PerunNotifRegex | PerunNotifRegex object without id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifRegex | PerunNotifRegex with new id set |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/createPerunNotifRegex
Example params
{ "regex" : {...} }
Example response
{ ... TODO ... }
Saves PerunNotifTemplate to db and saves all relations to db.
Parameter name | Data type | Description |
---|---|---|
template | PerunNotifTemplate | PerunNotifTemplate object without id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifTemplate | PerunNotifTemplate with new id set |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/createPerunNotifTemplate
Example params
{ "template" : {...} }
Example response
{ ... TODO ... }
Saves perunNotifTemplateMessage to db and creates id
.
Parameter name | Data type | Description |
---|---|---|
message | PerunNotifTemplateMessage | PerunNotifTemplateMessage object without id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifTemplateMessage | PerunNotifTemplateMessage with new id set |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/createPerunNotifTemplateMessage
Example params
{ "message" : {...} }
Example response
{ ... TODO ... }
Returns all PerunNotifReceivers from db.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<PerunNotifReceiver> | List of all PerunNotifReceivers |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/getAllPerunNotifReceivers
Example response
{ ... TODO ... }
Returns all PerunNotifRegexes.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<PerunNotifRegex> | List of all PerunNotifRegexes |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/getAllPerunNotifRegexes
Example response
{ ... TODO ... }
Returns all PerunNotifTemplateMessages.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<PerunNotifTemplateMessage> | List of all PerunNotifTemplateMessages |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/getAllPerunNotifTemplateMessages
Example response
{ ... TODO ... }
Returns all PerunNotifTemplates.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<PerunNotifTemplate> | List of all PerunNotifTemplates |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/getAllPerunNotifTemplates
Example response
{ ... TODO ... }
Return PerunNotifReceiver with given id from db. Object for PerunNotifReceiver.
Parameter name | Data type | Description |
---|---|---|
id | int | Receiver id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifReceiver | PerunNotifReceiver |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/getPerunNotifReceiverById
Example params
{ "id" : 23 }
Example response
{ ... TODO ... }
Returns PerunNotifRegex by id
, returns also object related to regex. Methods for PerunNotifRegexp.
Parameter name | Data type | Description |
---|---|---|
id | int | PerunNotifRegex id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifRegex | PerunNotifRegex |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/getPerunNotifRegexById
Example params
{ "id" : 37 }
Example response
{ ... TODO ... }
Return perunNotifTemplate from db, return also all filled collections. Methods for perunNotifTemplate.
Parameter name | Data type | Description |
---|---|---|
id | int | perunNotifTemplate id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifTemplate | PerunNotifTemplate |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/getPerunNotifTemplateById
Example params
{ "id" : 82 }
Example response
{ ... TODO ... }
Gets PerunNotifTemplateMessage from db. Methods for perunNotifTemplateMessage.
Parameter name | Data type | Description |
---|---|---|
id | int | PerunNotifTemplateMessage id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifTemplateMessage | PerunNotifTemplateMessage |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/getPerunNotifTemplateMessageById
Example params
{ "id" : 83 }
Example response
{ ... TODO ... }
Returns all regexes related to given template.
Parameter name | Data type | Description |
---|---|---|
templateId | int | Template id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
List<PerunNotifRegex> | List of regexes |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/getRelatedRegexesForTemplate
Example params
{ "templateId" : 72 }
Example response
{ ... TODO ... }
Method checks if the notifications module is running at the time.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
true | if running |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/isNotificationsRunning
Example response
{ ... TODO ... }
Removes PerunNotifReceiver from db.
Parameter name | Data type | Description |
---|---|---|
id | int | PerunNotifReceiver id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/removePerunNotifReceiverById
Example params
{ "id" : 28 }
Example response
null
Removes PerunNotifRegex from db, if regex is referenced from template exception is thrown. Also removes relation between regex and objects.
Parameter name | Data type | Description |
---|---|---|
id | int | PerunNotifRegex id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/removePerunNotifRegexById
Example params
{ "id" : 49 }
Example response
null
Removes perunNotifTemplate from db.
Parameter name | Data type | Description |
---|---|---|
id | int | PerunNotifTemplate id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/removePerunNotifTemplateById
Example params
{ "id" : 42 }
Example response
null
Removes PerunNotifTemplateMessage from db.
Parameter name | Data type | Description |
---|---|---|
id | int | PerunNotifTemplateMessage id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/removePerunNotifTemplateMessage
Example params
{ "id" : 78 }
Example response
null
Removes relation between PerunNotifRegex and PerunNotifTemplate.
Parameter name | Data type | Description |
---|---|---|
templateId | int | Template id |
regexId | int | Regex id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/removePerunNotifTemplateRegexRelation
Example params
{ "templateId" : 74 , "regexId" : 67 }
Example response
null
Save relation between template and regex if not exists yet.
Parameter name | Data type | Description |
---|---|---|
templateId | int | Template id |
regexId | int | Regex id |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/saveTemplateRegexRelation
Example params
{ "templateId" : 34 , "regexId" : 28 }
Example response
null
Start notifications processing.
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/startNotifications
Example response
null
Stop notifications processing.
Parameter name | Data type | Description |
---|---|---|
id | int | PerunNotifTemplate ID |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
void |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/stopNotifications
Example params
{ "id" : 16 }
Example response
null
Updates receiver in db.
Parameter name | Data type | Description |
---|---|---|
receiver | PerunNotifReceiver | PerunNotifReceiver to be updated with new properties |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifReceiver | Updated perunNotifReceiver |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/updatePerunNotifReceiver
Example params
{ "receiver" : {...} }
Example response
{ ... TODO ... }
Updates PerunNotifRegex in db, also updates relation between regex and objects.
Parameter name | Data type | Description |
---|---|---|
regex | PerunNotifRegex | PerunNotifRegex to be updated with new properties |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifRegex | Updated PerunNotifRegex |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/updatePerunNotifRegex
Example params
{ "regex" : {...} }
Example response
{ ... TODO ... }
Method will update perunNotifTemplate, also update relations, but not deletes them
Parameter name | Data type | Description |
---|---|---|
template | PerunNotifTemplate | PerunNotifTemplate object to be updated with new properties |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifTemplate | Updated perunNotifTemplate |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/updatePerunNotifTemplate
Example params
{ "template" : {...} }
Example response
{ ... TODO ... }
Update perunNotifTemplateMessage in db.
Parameter name | Data type | Description |
---|---|---|
message | PerunNotifTemplateMessage | PerunNotifTemplateMessage to be updated with new properties |
Thrown exception | Description |
---|---|
InternalErrorException | When unspecified error occur. See exception param message for explanation. |
PrivilegeException | When caller is not allowed to call this method. Result may vary based on caller identity and provided parameter values. |
RpcException | Wrong usage of API (wrong url, missing param etc.). See exception params message and type for explanation. |
Return type | Description |
---|---|
PerunNotifTemplateMessage | Updated PerunNotifTemplateMessage |
Example URL
https://[hostname]/krb/rpc/json/notificationManager/updatePerunNotifTemplateMessage
Example params
{ "message" : {...} }
Example response
{ ... TODO ... }