Page tree

Skip to end of metadata
Go to start of metadata

The DELETE method of the executionplans API deletes an Execution Plan.

 

Before you begin

 

You must obtain an authToken by using the login API. The token authenticates the user performing the operation. For details, see  TSWS authentication .

Synthetic configuration APIs

APIMethodDescription
Applications

GETRetrieve the details of one application or all applications
PUT

Update an existing application

POSTCreate a new application
DELETEDelete an application
Execution Plans

  
GETRetrieve the details of one or more Execution Plans
PUTCreate a new Execution Plan or
Update an existing Execution Plan
DELETEDelete an Execution Plan
ScriptsGETRetrieve the details of one script or all scripts
LocationsGETRetrieve the details of all locations
 

To delete an Execution Plan

The executionplan API uses the DELETE method to delete an Execution Plan. 

Request syntax

https://<PresentationServerHostName>/tsws/10.0/api/appvis/synthetic/api/executionplans/delete?executionPlanId=<EPID>

In the above example:

  • <PresentationServerHostName> indicates the host name of the TrueSight Presentation Server.

  • <EPID> indicates the ID of the Execution Plan.

Request parameters

ElementDescription
authToken

Value of authToken

Query parameters
executionPlanIdID of the Execution Plan that you want to delete

Sample request with REST client

After accessing the REST client, perform the following steps:

  1. Enter the URL for the API.
    The generic format is as follows:
    https://localhost/tsws/10.0/api/appvis/synthetic/api/executionplans/delete?executionPlanId=112
  2. Add a new header row and select Authorization as the header type.
  3. Enter the text authToken followed by the authToken generated through the login API. 
  4. Make sure you have a Content-Type header row with the value application/json.
  5. Click Send.

Response

If the delete operation is successful, the response is empty.

If the delete operation is not successful, the response is an error object.