API Examples and Methods

Runtime Application Interface (API) Overview

The GenRocket Runtime Application Interface (API) allows programmers to access th...

Curl Commands for accessing the GenRocket Artifacts

CURL Commands can be used to do the following in the REST API: Login API CURL COM...

Index Of API Methods

Attribute API Methods public List<String> attributes(String domainName) pub...

API Groovy Interface

The following code defines the Groovy Interface for the GenRocket API. The Groovy...

API Payload Formats for REST & Socket Engines

This section describes the three API JSON payload request and response formats fo...

API Example - Minimum Scenario

This a Groovy example that shows how to use the GenRocket API to build an absolut...

API Example - Modifying Scenario Conditions

This is an example of how the conditions of a Scenario can be modified, using the...

API Example - Generate 10,000 Users

This a Groovy code example that shows how to use the GenRocket API to build a sce...

API Example - Testing ATM Account Transactions

This example shows a complete end to end test of an ATM Banking Application. By W...

API Example - Modify GenRocket Scenario at Runtime in Java

Prerequisites: Java (See GenRocket Runtime Overview for Supported Versions) GenRo...

API Example - Add Business Rules & Conditions

There are 2 ways you can add Business Rules to existing Scenarios: Using G-Rules ...

--api-file

The GenRocket API helps to update the Scenario at runtime just before execution f...

API Method - Initialize

This method is used to initialize a Scenario prior to calling the method scenario...

API Method - ScenarioLoad

This method is used to load a GenRocket Scenario, Scenario Chain & Scenario C...

API Method Scenarios

This method returns the list of Scenario names. This method is useful for retriev...

API Method ScenarioClear

This method is used to remove all Domains and Receivers from a Scenario; this wil...

API Method ScenarioRun

This method is used to run a Scenario. Exceptions The following GenRocket excepti...

API Method ScenarioRunInMemory

This method is used to run Scenario and returns the results in memory only. In th...

API Method ScenarioRename

This method renames the current name of a Scenario. Requirements The GenRocket AP...

API Method ScenarioExecuteLoop

This method is used to execute a single loop of the GenRocket engine. Use this me...

API Method ExecuteShutdown

The executeShutdown method must be used in conjunction with the API Method Scenar...

API Method Domains

This method returns the list of Domain names. Exceptions This method does not thr...

API Method DomainAdd

This method is used to add a Domain to a Scenario. The following actions will als...

API Method DomainSetLoopCount

This method is used to set a Domain's loopCount. Exceptions The following GenRock...

API Method DomainRemove

This method is used to remove a Domain from a Scenario. Exceptions The following ...

API Method DomainsRemove

This method is used to remove all Domains from a Scenario. Exceptions The followi...

API Method DomainParameterGet

This method returns the value of a given domain parameter. Exceptions The followi...

API Method DomainParameterSet

This method sets the value of a given Domain parameter. Exceptions The following ...

API Method DomainParentAdd

This method adds a Domain as a parent to a given Domain. Exceptions The following...

API Method DomainParentRemove

This method removes a Domain as a parent from a given Domain. Exceptions The foll...

API Method DomainParent

This method returns the name of the parent Domain for the given Domain or null if...

API Method DomainRename

This method renames the current name of a Domain. Exceptions The following GenRoc...

API Method DomainSiblingAdd

This method adds a Domain as a Sibling to a given Domain. Exceptions The followin...

API Method DomainSiblingRemove

This method removes a Domain as a Sibling from a given Domain. Exceptions The fol...

API Method DomainSiblings

This method returns the name of the all Sibling Domains for the given Domain or n...

API Method Attributes

This method is used to list the Attribute names of a given Domain. Attribute Nami...

API Method AttributeAdd

This method adds an Attribute to a given Domain. Original Name vs GenRocket Name ...

API Method AttributesAdd

This method adds one or more attributes to a Domain. This method does not add Gen...

API Method AttributeGenRocketName

This method converts the name of the attributeName to its GenRocket equivalent na...

API Method AttributePrimary

This method returns the name of the primary Attribute for the given domainName. E...

API Method AttributeRemove

This method removes an Attribute from a given Domain. Attribute Naming Convention...

API Method AttributesRemove

This method removes all sibling Domains from a given Domain. Exceptions The follo...

API method AttributeRename

This method renames the current name of an Attribute. Exceptions The following Ge...

API Method Generators

This method is used to list the Generator names of a given Attribute. Exceptions ...

API Method GeneratorAdd

This method adds a Generator to a given Attribute. Generator Naming Convention A ...

API Method GeneratorName

This method returns the name of a Generator for a given Attribute for a given pos...

API Method GeneratorRemove

This method removes a Generator from a given Attribute. Exceptions The following ...

API Method GeneratorsRemove

This method removes all Generators from a given Attribute. Exceptions The followi...

API Method GeneratorParameterGet

This method returns the value of a given Generator parameter. Exceptions The foll...

API Method GeneratorParametersGet

This method returns the map of generatorParameterName/Value pairs for a given Gen...

API Method GeneratorParameterSet

This method sets the value of a given Generator parameter. Exceptions The followi...

API Method GeneratorParametersSet

This method sets one or more Generator parameter values by passing a map of param...

API Method GeneratorReplace

This method replaces a Generator within a given Attribute. The generatorPosition ...

API Method GeneratorType

This method is used to list the generatorType for a given Generator within a give...

API Method - Receivers

This method is used to list the Receiver names of a given Domain. Exceptions The ...

API Method ReceiverAdd

This method adds a Receiver to a given Domain. Exceptions The following GenRocket...

API Method ReceiverParameterSet

This method sets the value of a given Receiver parameter. Exceptions The followin...

API Method ReceiverParametersSet

This method sets the values of one or more Receiver parameters by passing a map o...

API method ReceiverRename

This method renames the current name of a Receiver. Exceptions The following GenR...

API Method ReceiverRemove

This method removes a Receiver from a given Domain. Exceptions The following GenR...

API Method ReceiversRemove

This method removes all Receivers from a given Domain. Exceptions The following G...

API Method ReceiverParameterGet

This method returns the value of a given receiver parameter. Exceptions The follo...

API Method ReceiverParametersGet

This method returns the map of receiverParameterName/Value pairs for a given Rece...

API Method ReceiverPropertyKeyValueGet

This method returns the value of a given ReceiverPropertyKey. Exceptions The foll...

API Method ReceiverPropertyKeyValueSet

This method sets the value of a given ReceiverPropertyKey. Exceptions The followi...

API Method ReceiverPropertyKeyValuesSet

This method sets the values of one or more Receiver parameters by passing a map o...

API Method ListOrganizationVariables

This method lists the Organization Variables that are being used in the Scenario....

API Method ListDomainVariables

This method lists the Domain Variables that are being used in the Scenario. Runti...

API Method OrganizationVariableSet

This method sets/updates the value of a given Organization Variable; any Attribut...

API Method DomainVariableSet

This method sets/updates the value of a given Domain Variable; any Attribute who'...

API Recording Features - Overview

The API Recording feature works just like a digital record to allow API method ca...

API Method - RecordingNew

This method is used to create a new Scenario Recording. Recording Naming Conventi...

API Method - RecordingStart

This method is used to start Recording. Exceptions The following GenRocket except...

API Method - RecordingPause

This method is used to pause a Recording. Exceptions The following GenRocket exce...

API Method - RecordingStop

This method is used to stop Recording. Exceptions The following GenRocket excepti...

API Method - RecordingPlay

This method is used to play a Recording. Exceptions The following GenRocket excep...

API Method - RecordingLoad

This method is used to create loads a Recording. Recording Naming Convention A re...

API Method - RecordingDelete

This method is used to delete a Recording. Recording Naming Convention A recordin...

API Method - Recordings

This method returns a list of all recordings by their recordName. Recording Namin...

API Method - RecordingShow

This method is used to retrieve and show the methods and parameters of a given Re...

API Method - ReceiverEnable

The ReceiverEnable method is used to enable or disable a Receiver. Exceptions The...

API Method TestDataCaseAdd

The TestDataCaseAdd method, adds a TestDataCase to a given Scenario. The Scenario...

API Method ListTestDataCaseNames

This method is used to list all the Test Data Case Names for a Test Data Category...

API Method TestDataRulesAdd

The TestDataRulesAdd method, adds a TestDataRules to the current TestDataCase loa...

API Method TestDataQueriesAdd

The TestDataQueriesAdd method, adds a TestDataQuery to the current TestDataCase l...

API Method - DomainToggle

The DomainToggle method is used to enable or disable a Domain row to be generated...

API method AttributeVisibleSet

This method allows you to change the visibility status of an Attribute. Runtime M...

API Method - clientRepoSet

This method sets the local repository the client will use. Exceptions The followi...

API Method - clientRepoScenarioLoad

This method loads the Scenario. Exceptions The following GenRocket Exception may ...

API Method - clientRepoChainLoad

This method loads the ScenarioChain. Exceptions The following GenRocket Exception...

API Method - clientRepoChainSetLoad

This method loads a ScenarioChainSet. Exceptions The following GenRocket Exceptio...

API Method - clientRepoCaseLoad

This method loads a Test Data Case to be used. Exceptions The following GenRocket...

API Method - clientRepoRuleLoad

This method loads a TestDataRule. Exceptions The following GenRocket Exception ma...

API Method - clientRepoQueryLoad

This method loads a Test Data Query. Exceptions The following GenRocket Exception...

API Method - clientRepoStoryRun

This method loads and runs a Test Data Story. Exceptions The following GenRocket ...

API Method - clientRepoEpicRun

This method loads and runs a Test Data Epic. Exceptions The following GenRocket E...

API Method - clientRepoRun

This method runs a Scenario, ScenarioChain, or ScenarioChainSet after the appropr...

API Method - clientRepoRun(String command)

This method runs any G-Repository Client commands as command-line arguments. Exce...

API Method - ReceiverAddDynamicFileConfig

This method is used to control the file creation event for a Receiver.  Example: ...

API Method - ReceiverAddDynamicDirConfig

This method is used to control the directory creation event for a Receiver. Examp...

API Method - ReceiverAddDynamicFileNameConfig

This method is used to control the naming convention used for the file(s) generat...

API Method - ReceiverAddDynamicDirNameConfig

This method is used to control the naming convention used for the directory(s) ge...

API Method - ReceiverAddDynamicConfig

This method is used to control the file/directory creation event and the naming c...

Error: Genrocket API Call on Spring Boot Application

Error: java.lang.NoClassDefFoundError: Could not initialize class com.genRocket.e...