Retrieving Blackout details – synthetic API

The POST method of the API retrieves the details of single, multiple, or all 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 retrieve one Blackout or all Blackouts

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

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

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 a single Blackout is:
    https://localhost/tsws/10.0/api/appvis/synthetic/api/blackouts/get
  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

Request bodyDescription
Blackout IDEnter single or list of Blackout IDs.
EmptyGet all the Blackout configurations in the system.


The following sample is the JSON code requested by the API for multiple Blackouts. Returns a list of Blackout configurations:

["c66cc9eb-8e6d-4428-96b8-957d73116caf", "a3c8e770-2cdf-401b-92ab-aa8447f81112"]


Response

The response returns the Blackout configuration.


Response body parameters

The following parameters descriptions are relevant for retrieving the Synthetic Blackout configuration:

ParameterDescriptionValue
versionThe version is the Blackout configuration number.Configuration number
BlackoutsMap

Blackouts configuration.

List of Blackouts.
idThe Blackout ID

Blackout ID

status

Blackout status: ACTIVE or INACTIVE.

  • ACTIVE
  • INACTIVE
name
Name of the Blackout.String

description

Description of the Blackout.String
scopeThe Blackout Type.

SUSPEND_EXECUTIONS

timeZoneSchedule the Blackout according to the UTC time zone or TEA Agent Local time zone where the Execution Plan runs.
  • UTC
  • AGENT_LOCAL 

Applications



    quantity
Indicates whether single, multiple, or all Applications are configured in the Blackout.
  • ALL
  • SINGLE
  • MULTIPLE
    set
Application ID. Used only when the quantity parameter is set to SINGLE or MULTIPLE.
  • SINGLE -
    • "appId"
    • "syntheticId": -1 
  • MULTIPLE - (comma-separated list)
    • "appId"
    • "syntheticId": -1 
executionPlans


    quantity
Indicates whether single, multiple, or all Execution Plans are configured in the Blackout.
  • ALL
  • SINGLE
  • MULTIPLE
    set
Execution Plan ID. Used only when the quantity parameter is set to SINGLE or MULTIPLE.
  • No value
  • Execution Plan ID
  • Execution Plan IDs (comma-separated list)
timeframes

Time Frame IDs

  • Time Frame ID
  • List of Time Frame IDs

Related topics

Developing

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

Comments