GET

GET (using Query Parameters)

This service returns all testing tools that match the query parameters. If no query parameters are given all testing tools will be returned. The information about available Testing Tools can be accessed through this method. It returns the name, id, and information about the properties of all available Testing Tools.

QueryParams

http://host:port/flexdeploy/rest/v1/administration/testautomation/testingtool?

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

testingToolName={name}

Examples:

To search by testing tool name only:

http://host:port/flexdeploy/rest/v1/administration/testautomation/testingtool?testingToolName={name}

Request

Name	Type	Required	Description
testingToolName	String	No	name of testing tool, contains ignore case

Response

Name	Type	Description
testingToolId	Long	id of testing tool
testingToolName	String	name of testing tool
properties	List<PropertyDefintion>	properties of testing tool

Each JSON testing tool object contains a list of property definition with following attributes.

Attributes	Type	Description
name	String	This is the name of the property.
displayName	String	This is the display name of the property.
dataType	String	This is the data type of the property.
description	String	This is the description of the property.
isRequired	Boolean	This is the boolean which represents whether or not the property is required.
isEncrypted	Boolean	This is the boolean which represents whether or not the property is encrypted.
isActive	Boolean	This is the boolean which represents whether or not the property is active.

Response Codes

HTTP Code	Description
200	Search successful and results returned
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
500	Unexpected internal server error

Example

Testing tools

[
      {
      "testingToolName": "Apache JMeter",
      "properties":       [
                  {
            "name": "FDJM_JMETER_HOME_DIR",
            "displayName": "JMeter Home Directory",
            "description": "Apache JMeter Home directory. Make sure you have bin directory under this.",
            "dataType": "String",
            "isRequired": true,
            "isActive": true,
            "isEncrypted": false
         },
                  {
            "name": "FDJM_JMETER_PROPERTIES_FILE",
            "displayName": "Apache JMeter Properties File.",
            "description": "Apache JMeter Properties file.",
            "dataType": "String",
            "isRequired": true,
            "isActive": true,
            "isEncrypted": false
         }
      ],
      "testingToolId": 10001
   },
      {
      "testingToolName": "HP Unified Functional Testing (UFT)",
      "properties": [],
      "testingToolId": 10002
   },
      {
      "testingToolName": "JUnit",
      "properties": [],
      "testingToolId": 10003
   },
      {
      "testingToolName": "Oracle Application Test Suite (OATS)",
      "properties": [      {
         "name": "FDOAT_RUN_SCRIPT",
         "displayName": null,
         "description": "Oracle Application Test Suite run script file name (.sh or .bat) with full Path.",
         "dataType": "String",
         "isRequired": false,
         "isActive": true,
         "isEncrypted": false
      }],
      "testingToolId": 10004
   },
      {
      "testingToolName": "SoapUI",
      "properties": [      {
         "name": "FDSUI_SOAPUI_PATH_TO_TESTRUNNER_FILE",
         "displayName": "SoapUI Test Runner Path",
         "description": "Absolute path to the Testrunner script for SoapUI testing.",
         "dataType": "String",
         "isRequired": true,
         "isActive": true,
         "isEncrypted": false
      }],
      "testingToolId": 10005
   },
      {
      "testingToolName": "TestNG",
      "properties": [],
      "testingToolId": 10006
   },
      {
      "testingToolName": "utPLSQL",
      "properties": [],
      "testingToolId": 10007
   },
      {
      "testingToolName": "Postman",
      "properties":       [
                  {
            "name": "FDPMN_POSTMAN_PATH_TO_NEWMAN_UTILITY",
            "displayName": "Newman Executable Path",
            "description": "Absolute path to the newman command line utility for Postman testing.",
            "dataType": "String",
            "isRequired": false,
            "isActive": true,
            "isEncrypted": false
         },
                  {
            "name": "FDPMN_POSTMAN_PATH_TO_NODEJS",
            "displayName": "Node Executable Path",
            "description": "Absolute path to the Node executable.",
            "dataType": "String",
            "isRequired": false,
            "isActive": true,
            "isEncrypted": false
         }
      ],
      "testingToolId": 10008
   }
]

FlexDeploy 5.5

Testing Tool API

GET