Notification services

The Notification services are provided for both a z/OSMF task and vendor application. These services are used to send a notification in the form of a notification record or email, to a single or multiple recipients. On a successful request, all of the recipients will get the notification in their z/OSMF Notification task as the default destination. A notification can also be sent to the inbox of the user's email account and their mobile application based on preferences.

Table 1. Notification methods
Operation	HTTP method and URI path
Get all of the notifications received by the current user	GET /zosmf/notifications/inbox
Send a notification from a z/OSMF task, when the content is the message from the bundle file	POST /zosmf/notifications/new
Send a notification and mail from a z/OSMF task or z/OSMF user	POST /zosmf/notifications/new
Send a notification from a third party product	POST /zosmf/notifications/new

Error handling

For errors that occur during the processing of a request, the API returns an appropriate HTTP status code to the calling client. An error is indicated by a 4nn code or a 5nn code. For example, HTTP/1.1 400 Bad Request or HTTP/1.1 500 Internal Server Error.

In addition, some errors might also include a returned JSON object that contains a message that describes the error. You can use this information to diagnose the error or provide it to IBM Support, if required. For the contents of the error report document, see Error report document.

The following HTTP status codes are valid:

HTTP 200 OK: Request was processed successfully.
HTTP 400 Bad request: Request could not be processed because it contains a syntax error or an incorrect parameter.
HTTP 401 Unauthorized: Request could not be processed because the client is not authorized. This status is returned if the request contained an incorrect user ID or password, or both, or the client did not authenticate to z/OSMF.
HTTP 404 Not found: Requested resource does not exist.
HTTP 500 Internal server error: Server encountered an error. See the response body for a JSON object with information about the error.

Error logging

Errors from the z/OSMF notifications services are logged in the z/OSMF log. You can use this information to diagnose the problem or provide it to IBM® Support, if required. For information about working with z/OSMF log files, see .