source-test-stop

Synopsis

void source-test-stop(source, job-id);
nmtoken source;
nmtoken job-id;

Parameters

• nmtoken source - The source for which tests should be stopped.
• nmtoken job-id - The id for which tests should be stopped.

Exceptions

• source-test-name-or-id-required - Thrown if neither a name or job id were provided.
• source-test-stop - Thrown when there is an error starting the source testing service.

Authentication

Like all Watson Explorer Engine API functions with the exception of ping, the source-test-stop function requires authentication.

When using REST, you can simply pass v.username and v.password as CGI parameters via HTTP or HTTPS to authenticate the REST call to the source-test-stop function.

When using the SOAP API, you can pass credentials as parameters on an endpoint, or you can leverage the authentication method that is supported by all Watson Explorer Engine functions. Each provides a setAuthentication method that can be passed an authentication object to provide the username and password under which a function executes. An example of this in Java for a SOAP call to the source-test-stop function is the following:

    Authentication authentication = new Authentication();
    authentication.setUsername("joe-user");
    authentication.setPassword("joes-password");

    SourceTestStop foo = new SourceTestStop();
    foo.setAuthentication(authentication);

A single authentication object would typically be reused throughout each individual application.