For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.
Push Tags (GET)
Retrieves all tags of Push
Method
GET
Path
/apps/applicationId/tags
Example
https://example.com:443/imfpush/v1/apps/myapp/tags?expand=true&filter=platform==A&offset=0&size=10&subscriptionCount=10
Path Parameters
- applicationId
- The name or identifier of the application
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.
- subscriptionCount
- Retrieves the number of tag subscriptions
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
{ "pageInfo" : { "count" : "2", "next" : "", "previous" : "", "totalCount" : "10", }, "tags" : [ { "createdMode" : "API", "createdTime" : "2015-08-22T18:19:58Z", "description" : "Description about SampleTag", "href" : "https://example.com:443/imfpush/v1/apps/testApp/tags/SampleTag", "lastUpdatedTime" : "2015-08-22T18:19:58Z", "name" : "SampleTag", }, ... ], }
Response Properties
The response has the following properties:
- pageInfo
- The pagination information
- tags
- The array of applications.
The pageInfo has the following properties:
- count
- The number of tags that are retrieved
- next
- A hyperlink to the next page
- previous
- A hyperlink to the previous page
- totalCount
- The total number of application tags present for the given search criteria
The tagnames has the following properties:
- createdMode
- Defaults to API
- createdTime
- The time at which the tag was created
- description
- The description of the tag
- href
- The URL to the tag
- lastUpdatedTime
- The time at which the tag was last updated
- name
- An unique name of the tag in the application
Errors
401Unauthorized - The caller is either not authenticated or not authorized to make this request.404
A tag with the specified name 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