Push Device Subscription (DELETE)
Delete subscriptions of a combination of application, tag name, and device ID.
Description
The subscriptions that are deleted are for a combination of application, tag name, and device ID.
Roles
Users in the following roles are authorized to perform this operation:
- worklightadmin
- worklightdeployer
- worklightmonitor
- worklightoperator
Method
DELETE
Path
/management-apis/1.0/runtimes/runtime-name/notifications/applications/application-name/subscriptions
Example
https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/notifications/applications/myapplication/subscriptions?deviceId=45ccfd8e-ca97-3e9a-ad47-16f87c9e395b&locale=de_DE&tag-Name=Gold
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.
- deviceId
- The unique deviceId of the device.
- locale
- The locale used for error messages.
- tag-Name
- The tag name.
Produces
application/json, application/xml, text/xml
Response
The status of delete subscriptions.
JSON Example
{
"productVersion" : {
"productVersion" : "7.0.0",
},
"project" : {
"name" : "PushNotifications",
},
"status" : "Success",
"type" : "DELETE_SUBSCRIPTIONS",
}
XML Example
<?xml version="1.0" encoding="UTF-8"?>
<deleteSubscriptionsStatus
status="Success"
type="DELETE_SUBSCRIPTIONS">
<productVersion productVersion="7.0.0"/>
<project name="PushNotifications"/>
</deleteSubscriptionsStatus>
Response Properties
The response has the following properties:
- productVersion
- The exact product version.
- project
- Project name.
- status
- The subscription is deleted successfully.
- type
- Transaction type.
The productVersion has the following properties:
- productVersion
- The exact product version
The project has the following properties:
- name
- Name of the project
Errors
403The user is not authorized to call this service.
404 The corresponding runtime is not found or not running.
500 An internal error occurred.