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

Push Tag (GET)

Retrieves an existing tag of Push

Method

GET

Path

/apps/applicationId/tags/tagName

Example

https://example.com:443/imfpush/v1/apps/myapp/tags/sports

Path Parameters

applicationId

The name or identifier of the application

tagName

The name of the tag

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 "tags.read" and "push.application.<applicationId>" obtained using the confidential client in the format Bearer token.. This parameter has to be mandatorily set.

Produces

application/json

Response

The details of the tag that is retrieved.

JSON Example

{
  "createdMode" : "API",
  "createdTime" : "2015-08-22T18:19:58Z",
  "description" : "Description about SampleTag",
  "lastUpdatedTime" : "2015-08-22T18:19:58Z",
  "name" : "SampleTag",
}

Response Properties

The response has the following properties:

createdMode

Defaults to API

createdTime

The time at which the tag was created

description

The description of the tag

lastUpdatedTime

The time at which the tag was last updated

name

An unique name of the tag in the application

Errors

401

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

404

The tag with the specified tagName is not found.

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