The DELETE
method of the executionplans
API deletes an Execution Plan.
You must obtain an authToken by using the login
API. The token authenticates the user performing the operation. For details, see
TSWS authentication
.
API | Method | Description |
---|---|---|
Applications | GET | Retrieve the details of one application or all applications |
PUT | Update an existing application | |
POST | Create a new application | |
DELETE | Delete an application | |
Execution Plans | GET | Retrieve the details of one or more Execution Plans |
PUT | Create a new Execution Plan or Update an existing Execution Plan | |
DELETE | Delete an Execution Plan | |
Scripts | GET | Retrieve the details of one script or all scripts |
Locations | GET | Retrieve the details of all locations |
The executionplan
API uses the DELETE
method to delete an Execution Plan.
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.Element | Description |
---|---|
authToken | Value of
authToken
|
Query parameters | |
executionPlanId | ID of the Execution Plan that you want to delete |
After accessing the REST client, perform the following steps:
https://localhost/tsws/10.0/api/appvis/synthetic/api/executionplans/delete?executionPlanId=112
login
API. application/json
.If the delete operation is successful, the response is empty.
If the delete operation is not successful, the response is an error object.