Saving an Execution Plan -- API
Synthetic Blackouts in versions 11.3.02 and later
- Starting from version 11.3.02, the Blackout configuration is no longer part of the Execution Plan APIs. You can use the dedicated Synthetic Blackout and Synthetic Time Frames APIs for that purpose.
- If you are using version 11.3.01 or earlier, you can continue to use the Execution Plan APIs to access the Blackouts.
The PUT
method of the executionplans
API saves 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
.
Notes:
- If you have upgraded to version 11.3.02, you can access the Synthetic Blackout and Synthetic Time Frames APIs listed in this table.
- If you are using version 11.3.01 or earlier, you can continue to use the Execution Plan APIs to access the Blackouts.
API | Method | Description |
---|---|---|
Applications | GET | Retrieve the details of applications |
PUT | Update an existing application | |
POST | Create a new application | |
DELETE | Delete an application | |
Execution Plans | GET | Retrieve the details of Execution Plans |
PUT | ||
DELETE | Delete an Execution Plan | |
Scripts | GET | Retrieve the details of scripts |
Locations | GET | Retrieve the details of all locations |
Blackouts | POST | Retrieve the details of Blackouts |
PUT | ||
POST | Activate the Blackout | |
POST | Deactivate the Blackout | |
POST | Delete a Blackout | |
Time Frames | POST | Retrieve the details of Time Frames |
PUT | ||
POST | Delete Time Frames |
To save an Execution Plan
The executionplan
API uses the PUT
method to save an Execution Plan.
Request syntax
https://<PresentationServerHostName>/tsws/10.0/api/appvis/synthetic/api/executionplans/save
In the above example,
<PresentationServerHostName>
indicates the host name of the TrueSight Presentation Server.
Request with REST client
After accessing the REST client, perform the following steps:
- Enter the URL for API.
An example of a request for a single Execution Plan is:https://localhost/tsws/10.0/api/appvis/synthetic/api/executionplans/save
Add a new header row and select Authorization as the header type.
- Enter the text authToken followed by the authToken generated through the
login
API. - Make sure you have a Content-Type header row with the value
application/json
. - Insert the JSON code in the request body.
- Click Send.
Request parameters
Element | Description |
---|---|
authToken | Value of
authToken
|
Request body (applicable to versions 11.3.02 and later)
Request body (applicable to versions 11.3.01 and earlier)
Comments