Beacon Trigger (DELETE)

Deletes the beacon trigger by using the triggerName.

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/beaconTriggers/trigger-name

Example

https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/beaconTriggers/mytrigger?locale=de_DE

Path Parameters

runtime-name: The name of the runtime. This is the context root of the runtime web application, without the leading slash.
trigger-name: The name of the beacon trigger.

Query Parameters

Query parameters are optional.

locale: The locale used for error messages.

Produces

application/json, application/xml, text/xml

Response

The status of the delete of the beacon trigger.

JSON Example

{
  "beaconTrigger" : {
    "actionPayload" : {
      "alert" : "Avail lowest interest rate of just 7.5% on home loans!",
    },
    "dwellingTime" : 5000,
    "proximityState" : "Far",
    "triggerName" : "DwellInsideLoanSection",
    "triggerType" : "Enter",
  },
  "productVersion" : "7.0.0",
  "transaction" : {
    "appServerId" : "Tomcat",
    "errors" : [
      {
      },
      ...
    ],
    "id" : 1,
    "project" : {
      "name" : "myproject",
    },
    "status" : "SUCCESS",
    "timeCreated" : "2014-11-14T05:21:13.404Z",
    "timeUpdated" : "2014-11-14T05:21:13.456Z",
    "type" : "DELETE_BEACON_TRIGGER",
    "userName" : "demouser",
    "warnings" : [
      {
      },
      ...
    ],
  },
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<delete-beacon-trigger-result productVersion="7.0.0">
  <beaconTrigger
    dwellingTime="5000"
    proximityState="Far"
    triggerName="DwellInsideLoanSection"
    triggerType="Enter">
    <actionPayload alert="Avail lowest interest rate of just 7.5% on home loans!"/>
  </beaconTrigger>
  <transaction
    appServerId="Tomcat"
    id="1"
    status="SUCCESS"
    timeCreated="2014-11-14T05:21:13.404Z"
    timeUpdated="2014-11-14T05:21:13.456Z"
    type="DELETE_BEACON_TRIGGER"
    userName="demouser">
    <errors>
      <error/>
      ...
    </errors>
    <project name="myproject"/>
    <warnings>
      <warning/>
      ...
    </warnings>
  </transaction>
</delete-beacon-trigger-result>

Response Properties

The response has the following properties:

beaconTrigger: The details of the beacon trigger that is deleted.
productVersion: The exact product version.
transaction: The details of the transaction.

The beaconTrigger has the following properties:

actionPayload: The details of an action to be taken when the trigger is activated.
dwellingTime: Optional: Applicable only for triggerTypes: DwellInside and DwellOutside. It should be specified in milliseconds and defines how long the device must be inside, or outside a beacon region before the dwellInside or dwellOutside trigger is activated. Mandatory with triggerType of DwellInside and DwellOutside.
proximityState: Optional: The proximity state that is specified for a beacon trigger. It can be either Immediate, Near, or Far. The default value is Far.
triggerName: An unique name for this beacon trigger.
triggerType: The type of beacon trigger. The value of the type can be either Enter, Exit, DwellInside, or DwellOutside.

The actionPayload has the following properties:

alert: The alert message to be sent when a trigger is activated.

The transaction has the following properties:

appServerId: The id of the web application server.
errors: Errors, if any, that occurred during the transaction.
id: The id of the transaction.
project: The current project.
status: The state of the transaction: SUCCESS, FAILURE.
timeCreated: The date in ISO 8601 format when the transaction was started.
timeUpdated: The date in ISO 8601 format when the transaction was completed.
type: The type of the transaction: DELETE_BEACON_TRIGGER.
userName: The user that initiated the transaction.
warnings: Warnings, if any, that occurred during the transaction.

The project has the following properties:

name: The name of the project, which is the context root of the runtime.

Errors

401

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

404

Not Found - A beacon trigger with the specified triggerName is not found.

500

An internal error occurred.