search-collection-clean

Synopsis

void search-collection-clean(collection, subcollection);
nmtoken collection;
enum subcollection;

Parameters

• nmtoken collection - Name of the collection. (Required)
• enum subcollection - Name of the subcollection. Default value: live. Possible values: live|staging.

Exceptions

• search-collection-invalid-name
• search-collection-clean

Authentication

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

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

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

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