API Examples and Methods

The GenRocket runtime application interface allows programmers to access the GenRocket runtime directly create scenarios from their own programs.

API Method ReceiverParametersGet
Description This method returns the map of receiverParameterName/Value pairs for a given Receiver. Exceptions The following GenRocket exceptions may b...
Tue, 12 Dec, 2017 at 2:38 PM
API Method ReceiverPropertyKeyValueGet
Description This method returns the value of a given ReceiverPropertyKey. Exceptions The following GenRocket exceptions may be thrown by this method: ...
Mon, 2 Jan, 2017 at 11:35 AM
API Method ReceiverPropertyKeyValueSet
Description This method sets the value of a given ReceiverPropertyKey. Exceptions The following GenRocket exceptions may be thrown by this method:   ...
Wed, 31 Oct, 2018 at 9:07 AM
API Method ReceiverPropertyKeyValuesSet
Description This method sets the values of one or more Receiver parameters by passing a map of propertyKeyName/value pairs. Exceptions The following G...
Sun, 23 Apr, 2017 at 11:14 PM
API Method ListOrganizationVariables
Description This method lists the Organization Variables that are being used in the Scenario. Runtime Method Signature Use this method signature when ...
Sun, 2 Sep, 2018 at 10:14 AM
API Method ListDomainVariables
Description This method lists the Domain Variables that are being used in the Scenario. Runtime Method Signature Use this method signature when direct...
Sun, 2 Sep, 2018 at 10:17 AM
API Method OrganizationVariableSet
Description This method sets/updates the value of a given Organization Variable; any Attribute who's Generator parameters are referencing the Organizat...
Mon, 3 Sep, 2018 at 11:02 AM
API Method DomainVariableSet
Description This method sets/updates the value of a given Organization Variable; any Attribute who's Generator parameters are referencing the Domain va...
Mon, 3 Sep, 2018 at 11:01 AM
API Recording Features - Overview
Description The API Recording feature works just like a digital record to allow API method calls to be recorded before the API scenarioRun() method is call...
Thu, 16 Mar, 2023 at 8:27 PM
API Method - RecordingNew
Description This method is used to create a new Scenario Recording. Recording Naming Convention A recording name should have the format of organizatio...
Fri, 3 May, 2024 at 4:47 PM