annotation-express-delete-doc-list

Deletes standard annotation contents, attributed to the specified user, from multiple documents in a collection. The SOAP name of this function is: AnnotationExpressDeleteDocList

Synopsis

void annotation-express-delete-doc-list(collection, subcollection, content, documents, username, synchronization, priority);
nmtoken collection;
enum subcollection;
content nodeset content;
document nodeset documents;
string username;
enum synchronization;
int priority;

Parameters

  • nmtoken collection - The name of the collection that holds the documents from which you want to delete an annotation. (Required)
  • enum subcollection - The subcollection in which to enqueue. Default value: live. Possible values: live|staging.
  • content nodeset content - The <content> node to be deleted from the documents. Needs a name attribute. If a value is specified, contents with that value are deleted. If no value is specified, all contents with this name that this user has added are deleted. (Required)
  • document nodeset documents - <document> nodes whose results should all get the specified content deleted from them. Minimally, each <document> requires a @vse-key attribute. (Required)
  • string username - The user name to which this annotation was attributed. (Required)
  • enum synchronization - The synchronization mode to use. Default value: indexed-no-sync. Possible values: enqueued|indexed|none|to-be-crawled|to-be-indexed|indexed-no-sync|none.
  • int priority - The priority that this content enqueue should be in relation to anything else being crawled at the same time. Default value: 1.

Exceptions

  • annotation-content-missing-name-attribute
  • annotation-document-missing-identifier
  • search-collection-invalid-name
  • search-collection-enqueue

Authentication

Like all Watson Explorer Engine API functions except for ping, the annotation-express-delete-doc-list 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 annotation-express-delete-doc-list 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 user name and password under which a function runs. An example of this in Java for a SOAP call to the annotation-express-delete-doc-list function is the following:


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

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

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