StopRecording

Description

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 Search for Dynamic Parameters.
• GenericParameterSearch (optional): (true/false)
  Default value is false. When set to true, it searches for generic dynamic parameters.
  More information on Search for 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.

REST example

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

}}

Use case with Command Line Designer

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

Use case with Java Client Designer

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());

	}

}

Use case with C#Client

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());

        }

    }

}