AlertServiceRest Resource
Notifications
POST /alert/customEmailSender
media type | data type | description |
---|---|---|
application/json | string (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
POST /alert/action/execute
Execute an action of an alert.
media type | data type | description |
---|---|---|
application/json | AlertActionVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.3.0
GET /alert/alerts/countUnread
Counts the unread alerts.
- Available Since
- 1.3.0
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
GET /alert/appSender/findVoList
List the applications that send alerts.
media type | data type | description |
---|---|---|
application/json | array of AlertAppSenderVO (JSON) | Response List of JSON (example):
|
POST /alert/appSender/registerApp
Register an application to send alerts.
media type | data type | description |
---|---|---|
application/json | RegisterApplicationVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.3.6
POST /alert/appSender/registerApplication
Register an application to send alerts.
- Available Since
- 1.3.6
media type | data type | description |
---|---|---|
application/json | RegisterApplicationVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.4.3
GET /alert/application/actives
Return all actives sender applications.
- Available Since
- 1.4.3
media type | data type | description |
---|---|---|
application/json | object (JSON) | Request JSON (example):
|
POST /alert/application/enable
Activate or disable an application.
media type | data type | description |
---|---|---|
application/json | ActivateApplicationVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.3.6
POST /alert/event/changeStatus
Activate or disable an event.
- Available Since
- 1.3.6
media type | data type | description |
---|---|---|
application/json | ActivateEventVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
POST /alert/event/createEvent
It creates a new event to generate alerts and also creates default configuration for all users who matter use this event
OBS: Only tenant administrator user is allowed to call this procedure.
media type | data type | description |
---|---|---|
application/json | CreateEventVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
POST /alert/event/enable
Activate or disable an event.
media type | data type | description |
---|---|---|
application/json | ActivateEventVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
GET /alert/event/eventsByModule
Returns the alert events of a given module.
name | type | description |
---|---|---|
moduleKey | query | REQUIRED module's key |
media type | data type | description |
---|---|---|
application/json | array of AlertEventVO (JSON) | Response List of JSON (example):
|
POST /alert/module/create
It creates a new module to group alert events. Note: Only an user with admin privileges can execute this method.
media type | data type | description |
---|---|---|
application/json | CreateModuleVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
GET /alert/module/findVoList
Lists the alert modules.
media type | data type | description |
---|---|---|
application/json | array of AlertModuleVO (JSON) | Response List of JSON (example):
|
- Available Since
- 1.3.0
GET /alert/service/countGroupedUnreadAlerts
Counts the unread alerts grouped by modules for the logged user.
- Available Since
- 1.3.0
media type | data type | description |
---|---|---|
application/json | object (JSON) | Request JSON (example):
|
GET /alert/service/countUnreadAlerts
Counts the unread alerts.
media type | data type | description |
---|---|---|
application/json | number (JSON) |
|
GET /alert/service/findAll
It gets all the alerts ordered by creation date
name | type | description | constraints |
---|---|---|---|
limit | query | limit of records returned | required |
offset | query | the offset | required |
media type | data type | description |
---|---|---|
application/json | array of AlertVO (JSON) | Response List of JSON (example):
|
POST /alert/service/markAllAsRead
Marks all logged user's alerts as read.
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
POST /alert/service/markAsRead
Marks the given alerts as read.
media type | data type | description |
---|---|---|
application/json | MarkAlertAsReadVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
POST /alert/service/removeAlert
Removes the given alert.
media type | data type | description |
---|---|---|
application/json | RemoveAlertVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
POST /alert/service/removeAlerts
Removes the given alerts.
media type | data type | description |
---|---|---|
application/json | RemoveAlertsVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
POST /alert/service/sendAlert
Sends an alert.
media type | data type | description |
---|---|---|
application/json | SendAlertVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.3.6
POST /alert/service/sendNotification
Sends a notification.
- Available Since
- 1.3.6
media type | data type | description |
---|---|---|
application/json | SendAlertVO (JSON) | Request JSON (example):{
"eventKey" : "LIKE", //REQUIRED String that represents the event who generates the alert
"loginReceiver" : "placido.domingos", //REQUIRED User login (alias, idpId or userCode) who will receive the alert
"priority" : "NORMAL", // Options: NONE (Doesn't send notification), LOW, NORMAL and HIGH
"object" : { // the object of the alert, such as document, post, image or process
"alertObjectId" : "1", // the unique id number of the object
"alertObjectTypeDescriptionKey" : "Contract", // description of the object type
"alertObjectDescription" : "Agreement document", // the object description showed in the alert
"alertObjectLink" : "/ecmnavigation?app_ecm_navigation_doc=7", // the link to access the object
"alertObjectDetailKey" : "from last Monday", // (OPTIONAL) details of the key
"alertObjectNote" : "Approved by the board members" // (OPTIONAL) the object note for extra information, it allows up to 600 characters
},
"place" : { // (OPTIONAL) where the alert took action, such as communities, timeline, and so on...
"alertObjectId" : "1", // the unique id number of the object
"alertObjectDescription" : "ECM", // where the notification took place
"alertObjectLink" : "/ecmnavigation", // the link to access the place where the notification took place
"alertObjectDetailKey" : "In the folder 'contracts'"
},
"metadata" : {"FIRST-NAME" : "JOHNNY", "SURNAME" : "DEEP"} // (OPTIONAL) is a key-value map-list for metadata. Such metadata are used for the Central Alert, like SMS' and E-mails
} |
media type | data type | description |
---|---|---|
application/json | object (JSON) | This method just return HTTP 200 status |
POST /alert/action/execute/v2
Execute an action of an alert.
media type | data type | description |
---|---|---|
application/json | AlertActionVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.4.11
GET /alert/alerts/countUnread/v2
Counts the unread alerts.
- Available Since
- 1.4.11
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.4.3
GET /alert/application/isActive/{appKey}
Return if the application sender is active.
- Available Since
- 1.4.3
name | type | description |
---|---|---|
appKey | path | Application key |
media type | data type | description |
---|---|---|
application/json | object (JSON) | Request JSON (example):
|
GET /alert/sender/findSenders/{alertId}
Lists the users who have sent an alert
name | type | description | constraints |
---|---|---|---|
alertId | path | REQUIRED alert's id |
long |
media type | data type | description |
---|---|---|
application/json | array of AlertSenderVO (JSON) | Response List of JSON (example):
|
- Available Since
- 1.4.11
GET /alert/service/countGroupedUnreadAlerts/v2
Counts the unread alerts grouped by modules for the logged user.
- Available Since
- 1.4.11
media type | data type | description |
---|---|---|
application/json | object (JSON) | Request JSON (example):
|
- Available Since
- 1.4.11
GET /alert/service/findAll/v2
It gets all the alerts ordered by creation date
- Available Since
- 1.4.11
name | type | description | constraints |
---|---|---|---|
limit | query | limit of records returned | required |
offset | query | the offset | required |
media type | data type | description |
---|---|---|
application/json | object (JSON) | Response List of JSON (example):
|
GET /alert/service/findById/{alertId}
/** Finds an alert by its id.
name | type | description | constraints |
---|---|---|---|
alertId | path | - id do alerta | long |
media type | data type | description |
---|---|---|
application/json | AlertVO (JSON) | Alert Object of JSON (example):
|
- Available Since
- 1.4.11
POST /alert/service/markAllAsRead/v2
Marks all logged user's alerts as read.
- Available Since
- 1.4.11
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.4.11
POST /alert/service/markAsRead/v2
Marks the given alerts as read.
- Available Since
- 1.4.11
media type | data type | description |
---|---|---|
application/json | MarkAlertAsReadVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|
- Available Since
- 1.4.11
POST /alert/service/removeAlerts/v2
Removes the given alerts.
- Available Since
- 1.4.11
media type | data type | description |
---|---|---|
application/json | RemoveAlertsVO (JSON) | Request JSON (example):
|
media type | data type | description |
---|---|---|
application/json | object (JSON) |
|