Retrieving applications -- synthetic API

The GET method of the applications API retrieves the details of one application or all applications.

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.

API	Method	Description
Applications	GET	Retrieve the details of applications
	PUT	Update an existing application
	POST	Create a new application
	DELETE	Delete an application
Execution Plans	GET	Retrieve the details of Execution Plans
	PUT	Create a new Execution Plan Update an existing Execution Plan
	DELETE	Delete an Execution Plan
Scripts	GET	Retrieve the details of scripts
Locations	GET	Retrieve the details of all locations
Blackouts	POST	Retrieve the details of Blackouts
	PUT	Create a new Blackout Update an existing Blackout
	POST	Activate the Blackout
	POST	Deactivate the Blackout
	POST	Delete a Blackout
Time Frames	POST	Retrieve the details of Time Frames
	PUT	Create a new Time Frames Update an existing Time Frames
	POST	Delete Time Frames

To retrieve one application or all applications

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).
<SynStatus> indicates the synthetic status of the application. SynStatus can be the following:
- blank - all applications on the tenant
- TRUE - only applications that have synthetic monitoring set to ON
- FALSE - only applications that have syhtetic monitoring set to OFF

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 Application is:
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.
Enter the text authToken followed by the authToken generated through the login API.
Click Send.

Request parameters

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)

Response

The following sample is the JSON code returned by the API for a single application.

{"data":
{
"name":"MyApp2",
"displayName":"MyApp2",
"type":"MANUAL",
"severity":"OK",
"importance":"MEDIUM",
"description":"",
"source":null,
"synthetic":"ON",
"eumApp":"OFF",
"appVisOnlyMode":true,
"severitySince":1452777815203,
"computationModel":"HIGHEST",
"totalUsers":"",
"impactedUsers":"",
"id":"4",
"appId":"4",
"providerId":"0",
"portalId":"1",
"tenantId":"*"
}
}

Response body parameters

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	MANUAL - Application was created manually. AUTOMATIC - Application was automatically discovered by App Visibility.
severity	Current severity level of the application	Critical Minor OK
importance	Importance level of the application	High Medium Low
description	Description of the application	String
synthetic	Indicates if synthetic monitoring is enabled for the application	ON OFF
severitySince	UTC time of last change in severity	Number
id	ID of the application the Presentation Server	String representing a numeric value
appId	ID of the application in Synthetic Monitor	String
portalId	ID of the App Visibility portal where the application was defined	String representing a numeric value