Get Message (GET)

Retrieves information about a message identified by its messageId parameter.

Roles

Users in the following roles are authorized to perform this operation:

  • mfpadmin
  • mfpdeployer
  • mfpmonitor
  • mfpoperator

Method

GET

Path

/management-apis/2.0/runtimes/runtime-name/notifications/applications/application-name/messages/message-id

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications/myapplication/messages/1111?locale=de_DE

Path Parameters

runtime-name
The name of the runtime. This is the context root of the runtime web application, without the leading slash.
application-name
The name of the application.
message-id
The message id of push message in push server

Query Parameters

Query parameters are optional.

locale
The locale used for error messages.

Produces

application/json, application/xml, text/xml

Response

Retrieves the meta data of the message identified by the messageId parameter.

JSON Example

{
  "alert" : "New update available",
  "messageId" : "New update available",
  "productVersion" : "8.0",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<push-messages
  alert="New update available"
  messageId="New update available"
  productVersion="8.0"/>

Response Properties

The response has the following properties:

alert
A string to be displayed in the alert.
messageId
The identifier of the notification message sent.
productVersion
The exact product version.

Errors

400 
The request was not understood by the push server.
403 
The user is not authorized to call this service.
404 
The corresponding runtime or application is not found or not running.
500 
An internal error occurred.