Updating an application -- synthetic API

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

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.
APIMethodDescription
Applications

GETRetrieve the details of applications
PUT

Update an existing application

POSTCreate a new application
DELETEDelete an application

Execution Plans



GETRetrieve the details of Execution Plans
PUT
DELETEDelete an Execution Plan
ScriptsGETRetrieve the details of scripts
LocationsGETRetrieve the details of all locations

Blackouts

POSTRetrieve the details of Blackouts
PUT
POSTActivate the Blackout
POSTDeactivate the Blackout
POSTDelete a Blackout

Time Frames

POSTRetrieve the details of Time Frames
PUT
POSTDelete Time Frames
 

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.

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) The ID of the application on the Presentation Server (not the synthetic application ID)String representing a numeric value
Was this page helpful? Yes No Submitting... Thank you

Comments