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
API | Method | Description |
---|---|---|
Applications | GET | Retrieve the details of one application or all applications |
PUT | Update an existing application | |
POST | Create a new application | |
DELETE | Delete an application | |
Execution Plans | GET | Retrieve the details of one or more Execution Plans |
PUT | Create a new Execution Plan or Update an existing Execution Plan | |
DELETE | Delete an Execution Plan | |
Scripts | GET | Retrieve the details of one script or all scripts |
Locations | GET | Retrieve 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:
- 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
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. - Click Send.
Request parameter
Element | Description |
---|---|
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
Parameter | Description | Value |
---|---|---|
name | Name of the location | String |
id | IdD of the location | Number |
Was this page helpful? Yes No
Submitting...
Thank you
Comments
Log in or register to comment.