Retrieving locations -- API

The GET method of the locations API retrieves your locations.

 

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 locations

The locations  API uses the GET method to retrieve locations. Use the following request syntax:

 

https://<PresentationServerHostName>/tsws/10.0/api/appvis/synthetic/api/locations/getAll

In the above example,  <PresentationServerHostName>  indicates the host name of the TrueSight Presentation Server.

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 Execution Plan is:
    https://localhost/tsws/10.0/api/appvis/synthetic/api/locations/getAll
  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. Click Send.

Request parameter

ElementDescription
authToken

Value of authToken

Response

The following sample is the JSON code returned by the API for two locations.

Response body parameters

ParameterDescriptionValue
name
Name of the locationString
id
IdD of the locationNumber
Was this page helpful? Yes No Submitting... Thank you

Comments