dictionary-stop

Synopsis

void dictionary-stop(dictionary, kill);
nmtoken dictionary;
boolean kill;

Parameters

• nmtoken dictionary - The dictionary to build. (Required)
• boolean kill - When true, the build will be forcefully killed. Otherwise the build will be requested to stop. (Required) Default value: false.

Exceptions

• dictionary-invalid-name
• dictionary-service-not-started

Authentication

Like all Watson Explorer Engine API functions with the exception of ping, the dictionary-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 dictionary-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 dictionary-stop function is the following:

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

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

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