Support

Description

This method is used to retrieve and show the methods and parameters of given 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:

• Recording was not found; check the name of the recording.

Runtime Method Signature

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

recordingLoad(String recordingName)

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

REST/Socket Payload Successful Payload Response

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

{
  "responseType": "OK",
  "data": [
    {
      "id": "",
      "organizationName": "",
      "recordingName": "",
      "projectName": "",
      "projectVersionNumber": "",
      "methods" : [ 
        {
          "methodName" : "",
          "parameters"  : [
            {
              "parameter": ""
            },
            {
              "parameter": ""
            },
            {
              "parameter": ""
            }
          ]
        },
        {
          "methodName" : "",
          "parameters"  : [
            {
              "parameter": ""
            },
            {
              "parameter": ""
            },
            {
              "parameter": ""
            }
          ]
        } 
      ]
    }
  ]
}