Beacons (DELETE)

Deletes the beacon by using the UUID, the major number, and minor number.

Description

Each of these query parameters (uuid, major and minor) are mandatory. If any of them are missing, the request fails with 400 Bad Request.

Roles

Users in the following roles are authorized to perform this operation:

worklightadmin
worklightdeployer
worklightmonitor
worklightoperator

Method

DELETE

Path

/management-apis/1.0/beacons

Example

https://www.example.com/worklightadmin/management-apis/1.0/beacons?locale=de_DE&major=1&minor=4439&uuid=3d402cf0-3691-4bd9-97ff-0b0a93a160ef

Query Parameters

Query parameters are optional.

locale: The locale used for error messages.
major: Mandatory. The major number of the beacon.
minor: Mandatory. The minor number of the beacon.
uuid: Mandatory. The UUID of the beacon.

Produces

application/json, application/xml, text/xml

Response

The status of the delete of the beacon. The transaction details might be empty if there are no runtimes deployed.

JSON Example

{
  "beacon" : {
    "major" : 1,
    "minor" : 4439,
    "uuid" : "3d402cf0-3691-4bd9-97ff-0b0a93a160ef",
  },
  "ok" : false,
  "productVersion" : "7.0.0",
  "transactions" : [
    {
      "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",
      "userName" : "demouser",
      "warnings" : [
        {
        },
        ...
      ],
    },
    ...
  ],
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<remove-beacon-result
  ok="false"
  productVersion="7.0.0">
  <beacon
    major="1"
    minor="4439"
    uuid="3d402cf0-3691-4bd9-97ff-0b0a93a160ef"/>
  <transactions>
    <transaction
      appServerId="Tomcat"
      id="1"
      status="SUCCESS"
      timeCreated="2014-11-14T05:21:13.404Z"
      timeUpdated="2014-11-14T05:21:13.456Z"
      type="DELETE_BEACON"
      userName="demouser">
      <errors>
        <error/>
        ...
      </errors>
      <project name="myproject"/>
      <warnings>
        <warning/>
        ...
      </warnings>
    </transaction>
    ...
  </transactions>
</remove-beacon-result>

Response Properties

The response has the following properties:

beacon: The details of the beacon that is deleted.
ok: Whether all transactions were successful.
productVersion: The exact product version.
transactions: The details of the transactions, one for each runtime.

The beacon has the following properties:

major: The major number of the beacon.
minor: The minor number of the beacon.
uuid: The UUID of the beacon.

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

400

Bad Request - The request could not be understood by the server due to missing mandatory parameters uuid, major, minor.

401

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

404

A beacon with the specified uuid+major+minor numbers is not found.

500

An internal error occurred.