Get Event Driven Notification
GET /ws/rest/service/v1/event/notification
Purpose
Get all notification events based on user configuration/request.
Request Format
All parameters are optional.
Filter parameters include: "object_type", "event_date", "object_name", "old_status","new_status", "record_no", "project_id" & "shell_number"
Supported event date formats are: "2019-11-13T10:42" and with milliseconds "2019-11-13T10:42:19.799"
"max_records": (Optional) The maximum records that can be included in the request. If not provided, system returns 1000 records by default.
Sample Filter Condition
"filter":{event_date:"2015-07-04T12:08:56.235",object_type:"Business Process", shell_number:"XTB-100"}
Response Format
A JSON object is returned in the following format.
{
"data": [],
"message": [],
"status": <REST status code value>,
"latest_event_date": <value>,
"total_records": "<value>",
"fetched_records": "<value>"
}
A successful response displays a status code 200.
A failed response displays a message with a status code.
Sample Success Response
This is an example of successful response with a status code 200.
{
"data":
{
"latest_event_date": "2019-12-05T16:01:04.062",
"total_records": 2,
"items": [
{
"workflow_from": "Review",
"workflow_action": "To Approver",
"workflow_to": "Approve",
"object_type": "Business Process",
"shell_number": "XTB-100",
"object_prefix": "uxsov",
"project_id": 1002,
"object_name": "SOV-W-100",
"record_no": "uxsov-0031",
"event_date": "2019-12-05T11:16:26.918",
"object_subtype": "WorkFlow",
"old_status": "Rejected",
"new_status": "Pending"
},
{
"workflow_from": null,
"workflow_action": null,
"workflow_to": null,
"object_type": "Business Process",
"shell_number": "XTB-100",
"object_prefix": "uxnwf1",
"project_id": 1002,
"object_name": "Commit NWF1",
"record_no": "uxnwf1-0004",
"event_date": "2019-12-04T08:47:46.994",
"object_subtype": null,
"old_status": "Pending",
"new_status": "Pending"
}
],
"fetched_records": 2
},
"message": [ "Success"],
"status": 200
}
Related Topics
Last Published Wednesday, April 9, 2025