Get Push App Settings (GET)
Retrieves App Setting for the application registered with Push.
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/settings
Example
https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications/myapplication/settings?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.
Query Parameters
Query parameters are optional.
- locale
- The locale used for error messages.
Produces
application/json, application/xml, text/xml
Response
The metadata of the App settings.
JSON Example
{
"apnsConf" : "http://localhost:7869/imfpush/v1/apps/com.sample.app/settings/apnsConf",
"applicationId" : "com.sample.app",
"gcmConf" : "http://localhost:7869/imfpush/v1/apps/com.sample.app/settings/gcmConf",
"productVersion" : "8.0",
"wnsConf" : "http://localhost:7869/imfpush/v1/apps/com.sample.app/settings/wnsConf",
}
XML Example
<?xml version="1.0" encoding="UTF-8"?>
<appSetting
apnsConf="http://localhost:7869/imfpush/v1/apps/com.sample.app/settings/apnsConf"
applicationId="com.sample.app"
gcmConf="http://localhost:7869/imfpush/v1/apps/com.sample.app/settings/gcmConf"
productVersion="8.0"
wnsConf="http://localhost:7869/imfpush/v1/apps/com.sample.app/settings/wnsConf"/>
Response Properties
The response has the following properties:
- apnsConf
- The link to the APNS configuration
- applicationId
- The Id of the application
- gcmConf
- The link to the GCM configuration
- productVersion
- The exact product version.
- wnsConf
- The link to the WNS configuration
Errors
400The 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.