Scripting API

• Test Script endpoint

  • List Methods
  • Expand Methods

  • POSTCreate a new simple Test Script/script/1.0/url
    Creates a single-step test script that opens a browser and loads to the given URL.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    url		string	The URL to generate the script from.

    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the Test Script
    name	string	The name of the Test Script

    
    
  • GETGet List of All Test Scripts/script/1.0/AllScripts/
    Retrieves a list of all scripts.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    offset		int	From which position in the return list you wish to start. At most, 1501 records will be returned.

    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the Test Script
    name	string	The name of the Test Script

    
    
  • GETGet List of Valid Test Scripts/script/1.0/ValidScripts/
    Retrieves a list of valid scripts.
    
    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the Test Script
    name	string	The name of the Test Script

    
    
  • GETGet List of Invalid Test Scripts/script/1.0/InvalidScripts/
    Retrieves a list of invalid scripts.
    
    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the Test Script
    name	string	The name of the Test Script

    
    
  • POSTUpload Test Script File/script/1.0/upload/body
    Uploads a script file.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    name		string	The name of the script being uploaded. Length of Script Name should not exceed 100 char limit
    scriptBody		string	The script being uploaded. Note: Ensure that line comments are not present while trying the api here

    
    
  • PUTUpdate the Test Scripts/script/1.0/:scriptID
    update the test script with mentioned id.
    
    

    Input Variables:

    URL Variable	Value
    scriptID

    
    

    Parameter	Value	Type	Description
    name		String	The name of the script need to be auto pushed to monitor.
    updateMonitors	truefalse	enumerated	Enables or disables the script need to be auto pushed to monitor.
    scriptBody		string	The script being updated with latest body.

    
    
  • GETGet a Data File/script/1.0/file/:fileId
    Get the data file for given Id
    
    

    Input Variables:

    URL Variable	Value
    fileId

    
    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the Data file
    name	string	The name of the Data file uploaded

    
    
  • DELETEDelete a Data File/script/1.0/file/:fileId
    Delete the data file for given Id
    
    

    Input Variables:

    URL Variable	Value
    fileId

    
    
    
  • GETGet a Script/script/1.0/:scriptID
    Get the script for given scriptID
    
    

    Input Variables:

    URL Variable	Value
    scriptID

    
    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the Test Script
    name	string	The name of the Test Script
    validationState	string	The validation state of the Test Script
    validationError	string	The reason for which the Test script validation failed

    
    
  • POSTUpload a Data File/script/1.0/file
    Upload the file
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    fileUpload		file	The data file being upload.

    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the Data file
    name	string	The name of the Data file uploaded

    
    
  • DELETEDelete a Script/script/1.0/:scriptID
    Delete the script for given scriptID
    
    

    Input Variables:

    URL Variable	Value
    scriptID

    
    
    
  • POSTClone Test Script File/script/1.0/clone
    Clones a script file.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    id		string	The id of the script being cloned.
    cloneName		string	The name of the new script. Length of Script Name should not exceed 100 char limit

    
    

    Output Variables:

    Variable	Possible Values	Description
    id	string	The ID of the new Test Script