Page tree
Skip to end of metadata
Go to start of metadata

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

APIMethodDescription
Applications

GETRetrieve the details of one application or all applications
PUT

Update an existing application

POSTCreate a new application
DELETEDelete an application
Execution Plans

  
GETRetrieve the details of one or more Execution Plans
PUTCreate a new Execution Plan or
Update an existing Execution Plan
DELETEDelete an Execution Plan
ScriptsGETRetrieve the details of one script or all scripts
LocationsGETRetrieve the details of all locations
 

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.

{
	"data" : [2]
	0 : {
		"name" : "Loc0"
		"id" : 1
	}
	1 : {
		"name" : "Loc1"
		"id" : 2
	}
}

Response body parameters

ParameterDescriptionValue
name
Name of the locationString
id
IdD of the locationNumber