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

The PUT method of the applications API saves an application.

 

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 save an application

The applications API uses the PUT method to update an application.

Request syntax

https://localhost/tsws/10.0/api/appvis/synthetic/api/applications/update

Request with REST client

After accessing the REST client, perform the following steps:

  1. Enter the URL for API.
    An example of a request to update an application is:
    https://localhost/tsws/10.0/api/appvis/synthetic/api/applications/update
  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. Enter the json code in the request body.
  5. Click Send.

Request parameters

ElementDescription
authToken

Value of authToken

Request body

The following code is an example of the JSON code to send with the request.

 

	{
		"name":"MyApp2",
		"importance":"MEDIUM",
		"description":"",
		"synthetic":"ON",
		"id":"4"
	} 

 

Request body parameters

The following parameters are the parameters that are relevant for synthetic monitoring.

  • The id parameter is required.
  • All other parameters are optional. Include them only if you are updating them.
ParameterDescriptionValue
     name

Name of the application model

 

String

     importance
Importance level of the application
  • HIGH
  • MEDIUM
  • LOW
     description
Description of the applicationString
     synthetic
Indicates if synthetic monitoring is enabled for the application

ON

     id
(Required) ID of the applicationString representing a numeric value