The GET
method of the applications API retrieves the details of one application or all applications.
You must obtain an authToken by using the login
API. The token authenticates the user performing the operation. For details, see
TSWS authentication
.
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 |
The applications API uses the GET
method to retrieve applications. Use the following request syntax:
For retrieving a single application | https://<PresentationServerHostName>/tsws/10.0/api/appvis/synthetic/api/applications/getById?applicationId=<AID> |
For retrieving all applications | https://<PresentationServerHostName>/tsws/10.0/api/appvis/synthetic/api/applications/getAll?isSynthetic=<SynStatus> |
In the above examples:
<PresentationServerHostName>
indicates the host name of the TrueSight Presentation Server.<AID>
indicates the ID of the application on the Presentation Server (not the synthetic application ID).After accessing the REST client, perform the following steps:
https://localhost/tsws/10.0/api/appvis/synthetic/api/applications/getById?applicationId=112
Add a new header row and select Authorization as the header type.
login
API. Element | Description |
---|---|
authToken | Value of authToken |
Query parameters | |
applicationId | ID of the application on the Presentation Server (not the synthetic application ID) (for retrieving a single application) |
isSynthetic | (Optional) Synthetic status of the retrieved applications (for retrieving multiple applications) |
The following sample is the JSON code returned by the API for a single application.
The following parameters are the parameters that are relevant for synthetic monitoring.
Parameter | Description | Value |
---|---|---|
data | ||
name | Name of the application model | String |
displayName | Name of the application | String |
type | Type of application |
|
severity | Current severity level of the application
|
|
importance | Importance level of the application |
|
description | Description of the application | String |
synthetic | Indicates if synthetic monitoring is enabled for the application |
|
severitySince | UTC time of last change in severity | Number |
id | ID of the application | Number |