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

Push Applications (GET)

Retrieves all the applications.

Method

GET

Path

/apps/

Example

https://example.com:443/imfpush/v1/apps/?expand=true&filter=platform==A&offset=0&size=10

Query Parameters

Query parameters are optional.

expand

Retrieves detailed information about applications.

filter

Search criteria filter. Refer to the filter section for detailed syntax.

offset

Pagination offset that is normally used along with the size.

size

Pagination size that is normally used along with the offset to retrieve a subset.

Header Parameters

Some header parameters are optional.

Accept-Language

(Optional) The preferred language to use for error messages. Default:en-US

Authorization

The token with the scope "apps.read" and "push.application.*" obtained using the confidential client in the format Bearer token.. This parameter has to be mandatorily set.

Content-Type

Specify the JSON content type. For example: application/json. This parameter has to be mandatorily set.

Produces

application/json

Response

The details of all the applications.

JSON Example

{
  "applications" : [
    {
      "applicationId" : "testApp",
    },
    ...
  ],
  "pageInfo" : {
    "count" : "2",
    "next" : "",
    "previous" : "",
    "totalCount" : "10",
  },
}

Response Properties

The response has the following properties:

applications

The array of applications.

pageInfo

The pagination information

The applications has the following properties:

applicationId

The applicationId.

The pageInfo has the following properties:

count

The number of applications that are retrieved

next

A hyperlink to the next page

previous

A hyperlink to the previous page

totalCount

The total number of applications present for the given search criteria

Errors

401

Unauthorized - The caller is either not authenticated or not authorized to make this request.

406

Unsupported Accept type - The content type specified in Accept header is not application/json.

500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server push service