Get all of the notifications received by the current user

You can use this operation to get all of the notifications that were received by the current user. This operation supports only the user to get notification items in the z/OSMF Notifications task. This does not apply to the get mail operation in a user's email account.

HTTP method and URI path

GET /zosmf/notifications/inbox

Query Parameters

None.

Request

None.

Response Content

On successful completion, the service returns a response body, which contains details about the notifications. Table 1 lists the fields in the response body.

Table 1. Response content from the notifications received by the current user
Field	Type	Description
taskId	String	This is the ID of the task where the notification is initiated.
pluginId	String	This is the ID of the plug-in where the notification is initiated.
appLinkEventId	String	This is the event ID for an application event.
assignees	String	The user IDs and group names of all the recipients. These values are represented as a string, and are separated by a comma.
descriptionParms	String	These are the parameters which substitute the description.
defaultDescription	String	This is the default description of the notification.
descriptionId	String	This is the message ID of the description.
descriptionBundleURL	String	This is the bundle file where the description of the notification can be found.
appLinkParms	String	This is the map of the parameters, which are sent with an event.

Authorization Requirements

Use of the Notification RESTful services API requires the client to be authenticated. For information about client authentication in z/OSMF. See Authenticating to z/OSMF.

You will also need SAF authority, as described in Appendix A in IBM z/OS Management Facility Configuration Guide

HTTP status codes

On successful completion, HTTP status code 200 OK is returned and the response body is provided, see Table 1.

The HTTP status codes and error handling are described in Error handling.

Example HTTP interaction

Request

GET /zosmf/notifications/inbox

Response

{"items":[{"appLinkHandlers":true,
      "taskID":"Workflows",
      "pluginID":"workflow",
      "descriptionBundle":"WorkflowMessages",
      "appLinkEventID":"IBM.ZOSMF.WORKFLOWS.CREATE_WORKFLOW", 
      "userRead":false, 
      "assignees":"zosmfad", 
      "descriptionParms":["testing -service"], 
      "defaultDescription":"One or more steps in workflow \"testing -service\" have been assigned to you.",
      "descriptionID":"IZUWF0040I", 
      "timestamp":"1429860854757", 
      "notificationID":"1429860854756",
      "bundleUrl":"\/zosmf\/workflow\/js\/zosmf",
      "descriptionBundleURL":"\/zosmf\/workflow\/js\/zosmf\/", 
      "defaultTaskName":"Workflows", 
      "appLinkParms":{"workflow_name":"testing -service"}, 
      "bundleName":"taskBundle"}], 
      "numUnreadNotification":1}