Description

The TestDataCaseAdd method, adds a TestDataCase to a given Scenario.  The Scenario is then modified by the contents defined within the given TestDataCase.


Requirements 

The GenRocket API requires loading a valid Scenario in order to do security validation of the organization, user and licensing.


Exceptions

The following GenRocket exceptions may be thrown by this method:  

  • If the runtime instance is currently running another Scenario
  • If the file specified in the pathAndFilename is not found
  • If the categoryName is not found
  • If the caseName is not found


Runtime Method Signature

Use this method signature when directly accessing the GenRocket binary runtime. Note: all parameters are required.

  • pathAndFileName - location and name of the TestDataCase to load
  • categoryName - the name of the category the contains the case to run
  • caseName - the name of the case to run
  • excludeRules - when True, any rules defined within the case will be removed  (Default = False)
  • excludeQueries - when True, any queries defined within the case will be removed (Default = False) 
  • ruleFileNames - list of pathAndFilenames of TestDataRules (Default = EmptyList []) 
  • queryFileNames - list of pathAndFilenames of TestDataQuerys (Default = EmptyList [])


public void testDataCaseAdd(  
  String pathAndFileName, String categoryName, String caseName, 
  Boolean excludeRules, Boolean excludeQueries, 
  List<String> ruleFileNames, List<String> queryFileNames
)


REST/Socket Payload Request

Use this API JSON request payload when making an API call to the GenRocket REST or Socket Engine.

{
    "interfaceType": "Manual",
    "methodName": "testDataCaseAdd",
    "parameters": {
        "pathAndFileName": "",
        "categoryName": "",
        "caseName": "",
        "excludeRules": true,
        "excludeQueries": true,
        "ruleFileNames": [],
        "queryFileNames": []
    }
}


REST/Socket Payload Successful Payload Response

The API JSON response payload for this method will be empty.
{
    "responseType": "OK",
    "data": ""
}