Push Device Registration (GET)

Retrieves all or a subset of existing device registrations to the push service.

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/devices

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications/myapplication/devices?expand=true&filter=platform==A&locale=de_DE&offset=0&size=10&userId=admin

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.

expand
Whether to retrieve detailed information about the device.
filter
The search criteria.
locale
The locale used for error messages.
offset
From where to start listing entries, depending on the value of the size parameter.
size
The maximum number of entries to be listed per page. For example: 10.
userId
The user identifier of the device.

Produces

application/json, application/xml, text/xml

Response

Retrieves all or a subset of existing device registration to the push service.

JSON Example

{
  "devices" : [
    {
      "deviceId" : "JeremyiOSPhone",
      "href" : "http://localhost:9080/imfpush/v1/apps/com.test.one/devices/JeremyiOSPhone",
      "userId" : "Jeremy",
    },
    ...
  ],
  "productVersion" : "8.0",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<push-devices productVersion="8.0">
  <devices>
    <device
      deviceId="JeremyiOSPhone"
      href="http://localhost:9080/imfpush/v1/apps/com.test.one/devices/JeremyiOSPhone"
      userId="Jeremy"/>
    ...
  </devices>
</push-devices>

Response Properties

The response has the following properties:

devices
The list of devices registered with the application
productVersion
The exact product version.

The device-list has the following properties:

deviceId
The unique identifier of the device.
href
The link to the device identifier
userId
The user identifier of the device.

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.
406 
Unsupported Accept type - The content type specified in Accept header is not application/json.
500 
An internal error occurred.