Register Application with Push Service (POST)

Registers an application with the push server.

Description

Creates a new server application for a push service. The applicationId is a unique identifier for this application. The application is a parent resource for devices, subscriptions, tags, and messages. The application must be created before it can access any of the child resources. If the application is deleted, all the children are deleted. The application holds the configurations, such as the Apple Push Notification Service (APNS) or Google Cloud Message (GCM) configuration, which is required by the push service to send messages. The API first creates the application and then sets the APNS and GCM credentials.

Roles

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

  • mfpadmin
  • mfpdeployer
  • mfpoperator

Method

POST

Path

/management-apis/2.0/runtimes/runtime-name/notifications/applications

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications?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.

Query Parameters

Query parameters are optional.

locale
The locale used for error messages.

Consumes

application/json

Produces

application/json, application/xml, text/xml

Payload

JSON Example

{
  "Enabled" : true,
  "applicationId" : "com.sample.bankApp",
}

Payload Properties

The payload has the following properties:
Enabled
Whether the application is enabled or disabled.
applicationId
The bundleId/PackageName/ProjectIdentityName of the application

Errors

400
The request was not understood by the push server. An invalid JSON object could result in this error code.
403
The user is not authorized to call this service.
404
The corresponding runtime or application is not found or not running.
409
An application with the specified identifier already exists.
415
Unsupported Media Type - The content type specified in Content-Type header is not application/json.
500
An internal error occurred.