API Method - RecordingNew

This method is used to create a new Scenario Recording.

Recording Naming Convention

A recording name should have the format of organizationName.recordingName. The organizationName is not mandatory; however adding some type of nameSpace prepended to the recordingName is advised.

Examples:

• Acme.TransactionHeader
• ComCo.UserRecording
• CableTron.AR

Exceptions

The following GenRocket exceptions may be thrown by this method:

• No Scenarios loaded. Call scenarioLoad() first.
• Cannot create a new recording while already recording; call recordingStop() first.
• Cannot overwrite existing recording when overwrite flag is set to false.

Runtime Method Signature

Use this method signature when directly accessing the GenRocket binary runtime.

recordingNew(String recordingName, Boolean overwrite)

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": "recordingNew",
  "parameters": {
    "recordingName": "",
    "overwrite": ""
  }
}

REST/Socket Payload Successful Payload Response

The API JSON response payload for this method will be empty.

{
  "responseType": "OK",
}