Activating the Blackouts – synthetic API

The POST method of the API activates a single or list of Blackouts.

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

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

GETRetrieve the details of applications
PUT

Update an existing application

POSTCreate a new application
DELETEDelete an application

Execution Plans



GETRetrieve the details of Execution Plans
PUT
DELETEDelete an Execution Plan
ScriptsGETRetrieve the details of scripts
LocationsGETRetrieve the details of all locations

Blackouts

POSTRetrieve the details of Blackouts
PUT
POSTActivate the Blackout
POSTDeactivate the Blackout
POSTDelete a Blackout

Time Frames

POSTRetrieve the details of Time Frames
PUT
POSTDelete Time Frames
 

To activate Blackouts

The API uses the POST method to activate Blackouts. Use the following request syntax:

Request syntax

https://<PresentationServerHostName>/tsws/10.0/api/appvis/synthetic/api/blackouts/activate

Sample request with REST client

After accessing the REST client, perform the following steps:

  1. Enter the URL for the API.
    An example of a request for activating a single Blackout is:
    https://localhost/tsws/10.0/api/appvis/synthetic/api/blackouts/activate
  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. Enter the Blackout ID in the request body.
  5. Click Send.

Request parameters

ElementDescription
authToken

Value of authToken

Request body

To activate, the request body must contain a single or list of Blackout IDs.

["95343ff6-e627-4874-91fd-bc3ed0c83873", "95343ff6-e627-4874-91fd-be3ed0c83872"]

Response

An empty array is returned by the API if the activate was successful.

If the activate operation fails, the response returns a collection of Blackout IDs that could not be activated. For example, 

"95343ff6-e627-4874-91fd-bc3ed0c83873""95343ff6-e627-4874-91fd-be3ed0c83872"]

Related topics

Developing

Was this page helpful? Yes No Submitting... Thank you

Comments