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

Get Tags (GET)

Retrieves all or a subset of tags in the application.

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

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications/myapplication/tags?expand=true&filter=tagName=@tag&locale=de_DE&offset=0&size=10&subscriptionCount=true

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

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 size.

size

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

subscriptionCount

If this parameter is set to true, the method retrieves the number of subscriptions for each platform.

Produces

application/json, application/xml, text/xml

Response

Retrieves tags of the application.

JSON Example

{
  "productVersion" : "8.0",
  "tags" : {
    "createdMode" : "API",
    "createdTime" : "2016-03-19T06:34:42Z",
    "description" : "This is a sample tag",
    "href" : "http://localhost:9080/imfpush/v1/apps/com.test.one/tags/SampleTag",
    "lastUpdatedTime" : "2016-03-22T06:34:42Z",
    "name" : "SampleTag",
    "uri" : "http://localhost:9080/imfpush/v1/apps/com.test.one/tags/SampleTag",
  },
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<push-tags productVersion="8.0">
  <tags
    createdMode="API"
    createdTime="2016-03-19T06:34:42Z"
    description="This is a sample tag"
    href="http://localhost:9080/imfpush/v1/apps/com.test.one/tags/SampleTag"
    lastUpdatedTime="2016-03-22T06:34:42Z"
    name="SampleTag"
    uri="http://localhost:9080/imfpush/v1/apps/com.test.one/tags/SampleTag"/>
</push-tags>

Response Properties

The response has the following properties:

productVersion

The exact product version.

tags

The list of tags of the application.

The push tags has the following properties:

createdMode

How the tag was created. The possible values are UI or API.

createdTime

The time at which the tag was created.

description

The description of the tag.

href

The link to the tag.

lastUpdatedTime

The time at which the tag was last updated.

name

The name of the tag.

uri

The link to the tag.

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