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

Push Device Subscription (GET)

Retrieves all or a subset of existing subscriptions.

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

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications/myapplication/subscriptions?deviceId=12345-6789&expand=true&filter=tagName=@tag&locale=de_DE&offset=0&size=10&tagName=sports&userId=user1

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.

deviceId

Retrieves subscriptions only for the specified device.

expand

Retrieves additional metadata for every subscription that is returned in the response.

filter

The filter specifies the search criteria. Refer to the filter section for the detailed syntax.

locale

The locale used for error messages.

offset

The pagination offset that is normally used in association with the page size.

size

The pagination size that is normally used in association with the offset to retrieve a subset.

tagName

Retrieves subscriptions only for the specified tag.

userId

Retrives subscriptions only for the specified user.

Produces

application/json, application/xml, text/xml

Response

Retrieves all push subscriptions for the application.

JSON Example

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

XML Example

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

Response Properties

The response has the following properties:

productVersion

The exact product version.

subscriptions

The list of push subscriptions.

The push subcriptions has the following properties:

deviceId

The unique identifier of the device.

href

The link to the subscription.

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