Recording actions

StartRecording

The StartRecording method starts a recording in proxy mode (tunnel mode is not supported by the Design API). This call is synchronous - it blocks until the recording has started.

Parameters:

  • Name (optional): The name of the User Path to create (the default value is "UserPath"). If the name is already used, then it is automatically renamed using a “X” suffix, where X is an integer. If the name has invalid characters then they will be escaped as an underscore () and no error is thrown.

  • BaseContainer (optional): The Init/Actions container where we want to start the recording (default container is Actions).

  • ProtocolWebSocket (optional): Default value is “true”.

  • ProtocolAdobeRTMP (optional): Default value is "false".

  • UserAgent (optional)

  • ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

  • ProtocolSAPGUI (optional): Allows starting an SAP GUI recording. If there is no SAPConnectionString or SAPSessionID provided, NeoLoad will attach to the first SAP session. Default value is "false".

  • SAPConnectionString (optional): The SAP GUI connection string. NeoLoad will create a new session when starting the recording.

  • SAPSessionID (optional): The ID of an existing SAP session. NeoLoad will attach to this session when starting the recording.

POST http://localhost:7400/Design/v1/Service.svc/StartRecording HTTP/1.1
Accept: application/json
Content-Type:application/json
Cache-Control:nocache
Pragma: nocache
User-Agent:Java/1.7.0_10
Host: localhost:7400
Connection: keepalive
Content-Length:276
{"d": {
     "VirtualUser": "myVirtualUserName",
     "BaseContainer": "Init",
     "ProtocolWebSocket": true,
     "ProtocolAdobeRTMP": false,
     "UserAgent": null
}}
POST http://localhost:7400/Design/v1/Service.svc/StartRecording HTTP/1.1
Accept: application/json
Content-Type:application/json
Cache-Control:nocache
Pragma: nocache
User-Agent:Java/1.7.0_10
Host: localhost:7400
Connection: keepalive
Content-Length:276
{"d":{
      "ProtocolSAPGUI": true,
      "SAPSessionID": "/app/con[0]/ses[0]"
    }
}
java -cp "api/Common/java/*;api/Design API Client/java/*" com.neotys.rest.design.client.CommandLineDesigner -designAPIURL http://localhost:7400/Design/v1/Service.svc/ -command StartRecording -VirtualUser myVU -BaseContainer Init -ProtocolWebSocket -ProtocolAdobeRTMP -UserAgent myUserAgent
import com.neotys.rest.design.client.DesignAPIClient;
import com.neotys.rest.design.client.DesignAPIClientFactory;
import com.neotys.rest.design.model.StartRecordingParams.StartRecordingBuilder;
public class Main {
    public static void main(String[] args) throws Exception {
        final String url = "http://localhost:7400/Design/v1/Service.svc";
        final DesignAPIClient client = DesignAPIClientFactory.newClient(url);
        final StartRecordingBuilder builder = new StartRecordingBuilder().virtualUser("VirtualUserName");
        client.startRecording(builder.build());
    }
}
import com.neotys.rest.design.client.DesignAPIClient;
import com.neotys.rest.design.client.DesignAPIClientFactory;
import com.neotys.rest.design.model.StartRecordingParams.StartRecordingBuilder;
import com.neotys.rest.design.model.StartRecordingInfo;
public class Main {
    public static void main(String[] args) throws Exception {
        final String url = "http://localhost:7400/Design/v1/Service.svc";
        final DesignAPIClient client = DesignAPIClientFactory.newClient(url);
        final StartRecordingBuilder builder = new StartRecordingBuilder().isSapGuiProtocol(true)
                .sapConnectionString("/SAPCODEPAGE=1100  /FULLMENU  127.0.0.1 45 /3 /UPDOWNLOADCP=2");

        final StartRecordingInfo info = client.startRecording(builder.build());
System.out.println("sap session ID: "+info.getSapSessionId().or("") );
    }
}
using Neotys.DesignAPI.Client;
using Neotys.DesignAPI.Model;
namespace Design
{
    class StartRecording
    {
        static void Main(string[] args)
        {
            string url = "http://localhost:7400/Design/v1/Service.svc/";
            IDesignAPIClient client = DesignAPIClientFactory.NewClient(url);
            client.StartRecording(new StartRecordingParamsBuilder()
.virtualUser("VirtualUserName")
.Build());
        }
    }
}
using Neotys.DesignAPI.Client;
using Neotys.DesignAPI.Model;
namespace TestDesignApi
{
    class Program
    {
        static void Main(string[] args)
        {
            IDesignAPIClient client = DesignAPIClientFactory.NewClient("http://localhost:7400/Design/v1/Service.svc/");
            var info = client.StartRecording(new StartRecordingParamsBuilder().isSapGuiProtocol(true)
                   .sapConnectionString("/SAPCODEPAGE=1100  /FULLMENU  127.0.0.1 45 /3 /UPDOWNLOADCP=2")
                   .Build());
             System.Console.WriteLine("session id "+ info.SapSessionId);
        }
    }
}

StopRecording

The StopRecording method sends a request to stop a recording. This call is synchronous - it blocks until the end of the recording and post-recording processes.

Parameters:

  • FrameworkParameterSearch (optional): (true/false)
    Default value is false. When set to true, it searches for specific framework dynamic parameters. More information on Dynamic parameters.

  • GenericParameterSearch (optional): (true/false)
    Default value is false. When set to true, it searches for generic dynamic parameters. More information on Dynamic parameters.

  • UpdateUserPathParams (optional)
    Allows to launch a User Path Update at the end of the post-recording wizard. If no values are provided for MatchingThreshold, UpdateSharedContainer, IncludeVariables and DeleteRecording, the latest options used manually to update the User Path are used.

    • Name (mandatory)
      The name of the User Path to update.

    • MatchingThreshold (optional): (between 0 and 100)
      Default value is 60. The higher the threshold is, the more matches will be found but higher the risk to display elements as matches while they are new.

    • UpdateSharedContainer (optional): (true/false)
      Default value is false. When set to true, the shared Containers of the original User Path are updated.

    • IncludeVariables (optional): (true/false)
      Default value is true. When set to true, variable extractors and variables are included during the merge of matching requests.

    • DeleteRecording (optional): (true/false)
      Default value is false. When set to true, the recording used to update the User Path is removed.
      More information on User Path Update.

  • ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

POST http://localhost:7400/Design/v1/Service.svc/StopRecording HTTP/1.1
Accept: application/json
Content-Type:application/json
Cache-Control:nocache
Pragma: nocache
User-Agent:Java/1.7.0_10
Host: localhost:7400
Connection: keepalive
Content-Length:237
{"d": {
    "FrameworkParameterSearch": false,
    "GenericParameterSearch": false,
"Name": "BrowserUser_Create_report",
"MatchingThreshold": 50,
"UpdateSharedContainers": true,
"IncludeVariables": true,
"DeleteRecording": true
}}
java -cp "api/Common/java/*;api/Design API Client/java/*" com.neotys.rest.design.client.CommandLineDesigner -designAPIURL http://localhost:7400/Design/v1/Service.svc/ -command StopRecording -FrameworkParameterSearch -GenericParameterSearch -UpdateUserPath -Name BrowserUser_Create_report -MatchingThreshold 50 -IncludeVariables true -UpdateSharedContainers true -DeleteRecording true
import com.neotys.rest.design.client.DesignAPIClient;
import com.neotys.rest.design.client.DesignAPIClientFactory;
import com.neotys.rest.design.model.StopRecordingParams.StopRecordingBuilder;
import com.neotys.rest.design.model.UpdateUserPathParams;
public class Main {
    public static void main(String[] args) throws Exception {
        final String url = "http://localhost:7400/Design/v1/Service.svc";
        final DesignAPIClient client = DesignAPIClientFactory.newClient(url);
        client.stopRecording(new StopRecordingBuilder()
                    .updateParams(new UpdateUserPathParams.UpdateUserPathParamsBuilder()
                            .name("BrowserUser_Create_report")
                            .deleteRecording(true)
                            .matchingThreshold(50)
                            .updateSharedContainers(true)
                            .includeVariables(true)
                            .build())
                    .build());
    }
}
using Neotys.DesignAPI.Client;
using Neotys.DesignAPI.Model;
namespace Design
{
    class StopRecording
    {
        static void Main(string[] args)
        {
            string url = "http://localhost:7400/Design/v1/Service.svc/";
            IDesignAPIClient client = DesignAPIClientFactory.NewClient(url);
            client.StopRecording(new StopRecordingParamsBuilder()
                                    .updateParams(new UpdateUserPathParamsBuilder()
                                        .name("BrowserUser_Create_report")
                                        .deleteRecording(true)
                                        .matchingThreshold(50)
                                        .updateSharedContainers(true)
                                        .includeVariables(true)
                                        .Build())
                                    .Build());
        }
    }
}

SetContainer

The SetContainer method specifies the current Transaction name to record in. It is just a single level Transaction (there is no way to specify a tree of Transactions).

Parameters:

  • Name (required): The name of the Transaction (if the name is already used then it will be made unique by adding _1, _2, etc.).

  • ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

POST http://localhost:7400/Design/v1/Service.svc/SetContainer HTTP/1.1
Accept: application/json
Content-Type:application/json
Cache-Control:nocache
Pragma: nocache
User-Agent:Java/1.7.0_10
Host: localhost:7400
Connection: keepalive
Content-Length:212
{"d": {
     "Name": "myContainerName"
}}
java -cp "api/Common/java/*;api/Design API Client/java/*" com.neotys.rest.design.client.CommandLineDesigner -designAPIURL http://localhost:7400/Design/v1/Service.svc/ -command SetContainer -Name myContainerName
import com.neotys.rest.design.client.DesignAPIClient;
import com.neotys.rest.design.client.DesignAPIClientFactory;
import com.neotys.rest.design.model.SetContainerParams;
public class Main {
    public static void main(String[] args) throws Exception {
        final String url = "http://localhost:7400/Design/v1/Service.svc";
        final DesignAPIClient client = DesignAPIClientFactory.newClient(url);
        final SetContainerParams setContainer = new SetContainerParams("containerName");
        client.setContainer(setContainer);
    }
}
using Neotys.DesignAPI.Client;
using Neotys.DesignAPI.Model;
namespace Design
{
    class SetContainer
    {
        static void Main(string[] args)
        {
            string url = "http://localhost:7400/Design/v1/Service.svc/";
            IDesignAPIClient client = DesignAPIClientFactory.NewClient(url);
            client.SetContainer(new SetContainerParams("containerName"));
        }
    }
}

SetScreenshot

The SetScreenshot method specifies the current screenshot to use for the current page.

Parameters:

  • Image (required): the image data to use for the screenshot. Any supported format can be used: BMP, JPG, PNG, JPEG, WBMP, GIF, etc.

  • ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

Binary images have to be encoded using Base64 format.

POST http://localhost:7400/Design/v1/Service.svc/SetScreenshot HTTP/1.1
Accept: application/json
Content-Type:application/json
Cache-Control:nocache
Pragma: nocache
User-Agent:Java/1.7.0_10
Host: localhost:7400
Connection: keepalive
Content-Length:207
{"d": {
     "Image": "iVBORw0KGgoAAAANSUhEUgAAAHgAAAAbCAIAAAA4ZtxxAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAACMBJREFUeNrsWX9wFNUd3729zV2Sy10wkAAhyRkCJWMgWNQqOPLDaZzQTklwOsYpQmwdix1b4yD+5UDofxU70mkppXVsLHa0fxRibWWgmtJCGHEkAmYwkIAXKJCLkHiXu9zt7b63fnZfsrfc7V0uCbT+cS8vN3u7b9++93mf9/l+vnu8qqpcBuXsuQFO5dCWqirqfG+RK9/BZUvGhU8P9Pm+wQ/+0/vx2SuEqgqhMiGSTCMKichkpstRv3xBU8PdBa4s4tMGOhKRf/PasUv+ANVQpjEFQCtRmYyixpRQTMkRbB/++Wme57NQpi82y7PXAj3sIDdXfPapB8uK3bkOe57Dnptjd4p2h11wCDat2oWwTHr7rlNKs1CmL/bkU/1Dp84PHJ3jWWRgvemxe3f/8RhEQ98BHIFMUxDcJhIq2vhQSFI5XlGoINgmZPaR05fZgXe221visWxz6sLglyFp6fziQpeDHafqDQ3QjB2jGRrr7aPjV524yvoxPzpNwajQD2qa4bEH4cAYoW8gwM6wsqq2PPn2RKB9N7q6Lr8z111tPllSUlD30Df+efS8OgaxIAvUrlXebuM5/PFapIxFgqLI2UR3mpmsfuFtdlBbWXxq7ybLNi2/7fj3mcv/eqVpVW0ZO07V28olZUd+2cRu+dWBk6mabX9ieevGFcaj0xS0xOeOfcc9+Q7fmz8utAo/zTvfe+d4X0WJ+28/X79qy3unLw4mNMDt+NxUV9O2td4a6LA0/Mnld4GeYBMSbn5weWVP3+Dn/x2SFRvwFXSI8YeqKb0u93LwQuSLjsLFWzLZShjfrv0nW9Yvy6QxBu0tcVsRUGNN2+FuhvK65VUGwY0NhHXCzHGegWgU3NXvDyb0DDKiJbsEQNt3NCY8sb2zFyhrt29d+7PdH2AWWJLmuhrzkvj8wTcOd6OiK2OCNwHddaldoTGosTt3TvKsvr+udvfrndGYAoFgVeA51G8uncciqjhjcbBro6vycXv+3PTAAREMt/VPnQ0rqlLt0JtIVFcDdqe62nao26Bt8tWG7QfwLGCXgBrWQEPTqmeACPrjLrQxX4VotOzpwMFzjcsAIttq2JfJUyjMd2DtsSoG0PFgGJKGfMNn2LEoWGwZjyd37cPVE4IS7Nk9YZuW9fdg1wfCErb89OMMmzDImOpZGssGgpl3CHBBBaYS5ggBZmBtIBpYUSbKoLMlURpWLEjpOs5efX88HdGq5QiWLim9b3EZ1TIXVrh5hXk4rztElUTxbBr1H8xkMrt+sgafjDW3JKynoTxTqkn1BlIDRMC6a//Hxg5gArXrmTWFE6UO4DtiDJtjItBXAp9RlRKVEFVxigWpuvje2prSWW4tf0FV1dkzXDrIetIY8eNIJYMR/4kJZ4KhYAMy1nwN3RigZDBB3xl52eYD0xlbGdbYlD5/wPJ2LLw5YMQ1emDkAtSZ8HaF2s1AK+Er9vxS4yvc3pOP3bvt1UPDVALcC8qLNJx1dmtCrRL8x4Y/yy351oSTwQZsP94L1mBLWsqr2fClcmOZSPzUCuQb6g9dan75IGIJi3tgukEUfAXQDdvaWx5dZgzD7Dit7R2IrFDZBjdBBM4kHZL/mKSqed5Gfly4y8oKtz/37R+1tiMpr/LOZJEQn8rwJ1o3KpLIYKaseWZNY2s7WNP8SE0ayJ7f05HGt90+Xre9WH/nht8DYqY8sGtm0cDX5p0HcenJnYlqiTUA8c0iEwdaprExu8bzlDNpNJXl0MVQb5trQbOBtbfijj9sW/fCL/5RVTlLEw2q6tJxFSiD1Jm9pxoLGsyBgDXMEU/K3qUKgLeqYO2xlswXG6JhHryvthybEgmLkWfp9i7Qrzs8thgWQPOaKeZ1BYhDJYc+R5hTQhdHevYULNrMC052vvLOov2/26inMGORkQS7IRucKk9qMpBC5nZhhpKDdSb27rYW7BgGNHMvyZsSY7OY1P6T2IXA2gA6HgwFXoyRqESiMTJKNakdJ3RsWCURYC2HLoyc25vQI9XpTKkmHXL4hKqjLOTPmxRrmNnENkyTbX/dCoYKfqQKHsmJWBzoEldFjEjAOkqiZnun0ihQVqnEAevh06Hzr8dlneopuQa0Kg+d0ehMYzjvmFE9WdYgI0dgQVSczsz/l0ADYiQ1mecBcaAXznoAXJZIJEYi1KyyJMqqBjeRItcOQUPGUdbMIJMOEuxRdZQ5+0znHdWTHTfzUjCqqTiSpnj0nyBS3cjeMWEhbxPckwZ6SWl9lIzqNaxycenQdINGqUZqVO04cvXdkXOvAWBCxuisvWkaOsHU2Tln09TSDWarp5ArMvk2MotkudTcWNUtBhrOkvloS6zZQz2mH6HiwdApuh6qaDri20dUcXj0amnhXePSEWHuDSTmtKRR4VQl3N/GO8uF4tUMaLBbvr5PV/pZnkU/nHLYaTvcbfmuDuhbJmNwrNgKCFPwLajeDXuh+N7ZHlgUnz8IM8AMgKVoTt+QrFxShtHevfkNHCSIGLOD5jh500ulhxduPtr/dlQJXx+5BPi095/gvLNMCZ/Tkz+qAw24kRIqI2dfdIaetZdv0LLEwaOshzzvT0VTdjOFZCzZk06YQIPRB1obWvZ0AFPUhKWqKHHDz1omEdMs7TsaW3RrYUkObFCzx0/8Kavv2kevHHv8/nnf+cE9r+pv8flA11b5yxOM25rLGAMaNk6CKIvFG8SFL0mfblGG3rJ76mevfuv/6ATA34SXR8Zb/9sdGM2h2DI5tPjN8MOev/69+9cvffd97TLPhc5si904rKOs6okfpEPWP2PQa0i4kL+ChDuF/AeKV/5FyHFz2WJVLH7Kun/Ro0Sh4WggN0d742HLq1S/COkpDGGJ3zjQY4kJUM6Z2VR038tZlNOUlL+CQ6MlSZEVQq53jnZv1OOhjrIeEuP3O6oLFm51z1+fhXKKQJvhDnSuU0LHEy6JRU3OuXWeLMS3BGjTm6VA9EYPa2p3uCeb+2XLVwIMAD8HSVqGuof+AAAAAElFTkSuQmCC"
}} 

The Image argument is the absolute path of the image.

java -cp "api/Common/java/*;api/Design API Client/java/*" com.neotys.rest.design.client.CommandLineDesigner -designAPIURL http://localhost:7400/Design/v1/Service.svc/ -command SetScreenshot -Image C:\tmp\image.jpg
import java.io.File;
import javax.imageio.ImageIO;
import com.neotys.rest.design.client.DesignAPIClient;
import com.neotys.rest.design.client.DesignAPIClientFactory;
import com.neotys.rest.design.model.SetScreenshotParams;
public class Main {
    public static void main(String[] args) throws Exception {
        final String url = "http://localhost:7400/Design/v1/Service.svc";
        final DesignAPIClient client = DesignAPIClientFactory.newClient(url);
        final String imagePath = "imagePath";
        final File imageFile = new File(imagePath);
        final SetScreenshotParams setScreenshot = new SetScreenshotParams(ImageIO.read(imageFile));
        client.setScreenshot(setScreenshot);
    }
}
using Neotys.DesignAPI.Client;
using Neotys.DesignAPI.Model;
using System.Drawing;
using System.IO;
namespace Design
{
    class SetScreenshot
    {
        static void Main(string[] args)
        {
            string url = "http://localhost:7400/Design/v1/Service.svc/";
            IDesignAPIClient client = DesignAPIClientFactory.NewClient(url);
            Image img = Image.FromFile(@"imagePath");
            byte[] array;
            using (MemoryStream ms = new MemoryStream())
            {
                img.Save(ms, System.Drawing.Imaging.ImageFormat.Png);
                array = ms.ToArray();
            }
            client.SetScreenshot(new SetScreenshotParams(array));
        }
    }
}

PauseRecording

The PauseRecording method allows to pause the current recording.

Parameters:

  • ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

POST http://localhost:7400/Design/v1/Service.svc/PauseRecording HTTP/1.1
Accept: application/json
Content-Type:application/json
Cache-Control:nocache
Pragma: nocache
User-Agent:Java/1.7.0_10
Host: localhost:7400
Connection: keepalive
Content-Length:9

{"d": {}}
java -cp "api/Common/java/*;api/Design API Client/java/*" com.neotys.rest.design.client.CommandLineDesigner -designAPIURL http://localhost:7400/Design/v1/Service.svc/ -command PauseRecording
import com.neotys.rest.design.client.DesignAPIClient;
import com.neotys.rest.design.client.DesignAPIClientFactory;
public class Main {
    public static void main(String[] args) throws Exception {
        final String url = "http://localhost:7400/Design/v1/Service.svc";
        final DesignAPIClient client = DesignAPIClientFactory.newClient(url);
        client.pauseRecording();
    }
}
using Neotys.DesignAPI.Client;
namespace Design
{
    class PauseRecording
    {
        static void Main(string[] args)
        {
            string url = "http://localhost:7400/Design/v1/Service.svc/";
            IDesignAPIClient client = DesignAPIClientFactory.NewClient(url);
            client.PauseRecording();
        }
    }
}

ResumeRecording

The ResumeRecording method allows to resume the current recording.

Parameters:

  • ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

POST http://localhost:7400/Design/v1/Service.svc/ResumeRecording HTTP/1.1
Accept: application/json
Content-Type:application/json
Cache-Control:nocache
Pragma: nocache
User-Agent:Java/1.7.0_10
Host: localhost:7400
Connection: keepalive
Content-Length:9
{"d": {}}
java -cp "api/Common/java/*;api/Design API Client/java/*" com.neotys.rest.design.client.CommandLineDesigner -designAPIURL http://localhost:7400/Design/v1/Service.svc/ -command ResumeRecording
import com.neotys.rest.design.client.DesignAPIClient;
import com.neotys.rest.design.client.DesignAPIClientFactory;
public class Main {
    public static void main(String[] args) throws Exception {
        final String url = "http://localhost:7400/Design/v1/Service.svc";
        final DesignAPIClient client = DesignAPIClientFactory.newClient(url);
        client.resumeRecording();
    }
}
using Neotys.DesignAPI.Client;
namespace Design
{
    class ResumeRecording
    {
        static void Main(string[] args)
        {
            string url = "http://localhost:7400/Design/v1/Service.svc/";
            IDesignAPIClient client = DesignAPIClientFactory.NewClient(url);
            client.ResumeRecording();
        }
    }
}

SetBaseContainer

The SetBaseContainer method specifies the current base container (Init/Actions/End) to record in.

Parameters:

  • Name (required): The name of the base container (Init / Actions / End).

  • ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

POST http://localhost:7400/Design/v1/Service.svc/SetBaseContainer HTTP/1.1
Accept: application/json
Content-Type:application/json
Cache-Control:nocache
Pragma: nocache
User-Agent:Java/1.7.0_10
Host: localhost:7400
Connection: keepalive
Content-Length:216
{"d": {"Name": "Init"}}
java -cp "api/Common/java/*;api/Design API Client/java/*" com.neotys.rest.design.client.CommandLineDesigner -designAPIURL http://localhost:7400/Design/v1/Service.svc/ -command SetBaseContainer -BaseContainer Init
import com.neotys.rest.design.client.DesignAPIClient;
import com.neotys.rest.design.client.DesignAPIClientFactory;
import com.neotys.rest.design.model.SetBaseContainerParams;
import com.neotys.rest.design.model.SetBaseContainerParams.BaseContainer;
public class Main {
    public static void main(String[] args) throws Exception {
        final String url = "http://localhost:7400/Design/v1/Service.svc";
        final DesignAPIClient client = DesignAPIClientFactory.newClient(url);
        client.setBaseContainer(new SetBaseContainerParams(BaseContainer.Init));
    }
}
using Neotys.DesignAPI.Client;
using Neotys.DesignAPI.Model;
namespace Design
{
    class SetBaseContainer
    {
        static void Main(string[] args)
        {
            string url = "http://localhost:7400/Design/v1/Service.svc/";
            IDesignAPIClient client = DesignAPIClientFactory.NewClient(url);
            client.SetBaseContainer(new SetBaseContainerParams(BaseContainer.Init));
        }
    }
}

GetRecorderSettings

The GetRecorderSettings method provides the settings of the recorder, for example the port number of the recorder.

Parameters:

  • ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

Request:

POST http://localhost:7400/Design/v1/Service.svc/GetProxyRecorderSettings HTTP/1.1
Accept: application/json
Content-Type:application/json
Cache-Control:nocache
Pragma: nocache
User-Agent: Java/1.7.0_10
Host: localhost:7400
Connection: keepalive
Content-Length:9
{"d": {}}

Response:

HTTP/1.1 201 Created
ContentType:application/atom+xml;charset=utf8;type=
entry
DataServiceVersion: 2.0
Date: Wed, 17 Sep 2014 07:26:19 GMT
Location: http://localhost:7400/Design/v1/Service.svc/GetRecorderSettings('')
Server: Jetty(9.1.2.v20140210)
ContentLength:356
{"d":{"__metadata":{"id":"http://localhost:7400/Design/v1/Service.svc/GetRecorderSettings('')","uri":"http://localhost:7400/Recordi
ng/v1/Service.svc/GetRecorderSettings('')","type":"com.neotys.neoload.apis.design.GetRecorderSettings"},"ApiKey":"","ProxySet
tings":{"__metadata":{"type":"com.neotys.neoload.apis.design.ProxySettings"},"Port":8090}}}
java -cp "api/Common/java/*;api/Design API Client/java/*" com.neotys.rest.design.client.CommandLineDesigner -designAPIURL http://localhost:7400/Design/v1/Service.svc/ -command GetRecorderSettings
import com.neotys.rest.design.client.DesignerAPIClient;
import com.neotys.rest.design.client.DesignerAPIClientFactory;
import com.neotys.rest.design.model.RecorderSettings;
public class Main {
    public static void main(String[] args) throws Exception {
        final String url = "http://localhost:7400/Design/v1/Service.svc";
        final DesignerAPIClient client = DesignerAPIClientFactory.newClient(url);
        final RecorderSettings recorderSettings = client.getRecorderSettings();
        System.out.println(recorderSettings);
    }
}
using Neotys.DesignAPI.Client;
using Neotys.DesignAPI.Model;
using System;
namespace Design
{
    class GetRecorderSettings
    {
        static void Main(string[] args)
        {
            string url = "http://localhost:7400/Design/v1/Service.svc/";
            IDesignAPIClient client = DesignAPIClientFactory.NewClient(url);
            RecorderSettings recorderSettings = client.GetRecorderSettings();
            Console.WriteLine(recorderSettings);
        }
    }
}

GetRecordingStatus

The GetRecordingStatus method provides the current status of the recording:

  • Ready: when not recording, nor post-recording task is running, and starting a new recording is possible

  • Recording: when a recording is currently running

  • PostRecording: when a post-recording task is currently running

Parameters:

  • ApiKey (optional): To authenticate the command. Required if enabled on the Controller.

Request:

POST http://localhost:7400/Design/v1/Service.svc/GetRecordingStatus HTTP/1.1
Content-Type:application/json
User-Agent:Jakarta CommonsHttpClient/3.0.1
Host: localhost:7400
Content-Length:9
{"d": {}}

Response:

HTTP/1.1 201 Created
ContentType:application/atom+xml;charset=utf8;type=entry
DataServiceVersion: 2.0
Date: Tue, 16 Sep 2014 13:58:23 GMT
Location: http://localhost:7400/Design/v1/Service.svc/GetRecordingStatus('')
ContentLength:268
Server: Jetty(9.1.2.v20140210)
{"d":{"__metadata":{"id":"http://localhost:7400/Design/v1/Service.svc/GetRecordingStatus('')","uri":"http://localhost:7400/Recordin
g/v1/Service.svc/GetRecordingStatus('')","type":"com.neotys.neoload.apis.design.GetRecordingStatus"},"ApiKey":"","Status":"READY"}}
java -cp "api/Common/java/*;api/Design API Client/java/*" com.neotys.rest.design.client.CommandLineDesigner -designAPIURL http://localhost:7400/Design/v1/Service.svc/ -command GetRecordingStatus
import com.neotys.rest.design.client.DesignAPIClient;
import com.neotys.rest.design.client.DesignAPIClientFactory;
import com.neotys.rest.design.model.RecordingStatus;
public class Main {
    public static void main(String[] args) throws Exception {
        final String url = "http://localhost:7400/Design/v1/Service.svc";
        final DesignAPIClient client = DesignAPIClientFactory.newClient(url);
        final RecordingStatus recordingStatus = client.getRecordingStatus();
        System.out.println(recordingStatus);
    }
}
using Neotys.DesignAPI.Client;
using Neotys.DesignAPI.Model;
using System;
namespace Design
{
    class GetRecordingStatus
    {
        static void Main(string[] args)
        {
            string url = "http://localhost:7400/Design/v1/Service.svc/";
            IDesignAPIClient client = DesignAPIClientFactory.NewClient(url);
            RecordingStatus recordingStatus = client.GetRecordingStatus();
            Console.WriteLine(recordingStatus);
        }
    }
}