For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Retrieve Subscription to Push Service. (GET)

The subscription referenced by the subscription identifier is retrieved.

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/subscriptions/subscription-id

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications/myapplication/subscriptions/1

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.

subscription-id

The subscription id of the application register with Push

Produces

application/json, application/xml, text/xml

Response

Retrieves all push subscriptions for the application.

JSON Example

{
  "deviceId" : "12345-6789",
  "href" : "http://localhost:9080/imfpush/v1/apps/com.test.one/subscriptions/2",
  "productVersion" : "8.0",
  "subscriptionId" : "12",
  "tagName" : "SampleTag",
  "userId" : "Jeremy",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<push-subsciption
  deviceId="12345-6789"
  href="http://localhost:9080/imfpush/v1/apps/com.test.one/subscriptions/2"
  productVersion="8.0"
  subscriptionId="12"
  tagName="SampleTag"
  userId="Jeremy"/>

Response Properties

The response has the following properties:

deviceId

The unique identifier of the device.

href

The link to the subscription.

productVersion

The exact product version.

subscriptionId

The unique identifier of the subscription.

tagName

The tag name for which to retrieve subscriptions.

userId

The user identifier for which to retrieve subscriptions.

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.

Parent topic: REST API for the MobileFirst Server administration service