annotation-express-update-query

Synopsis

void annotation-express-update-query(collection, subcollection, content, content-old, query, username, acl, num-docs-at-a-time, priority, datesecs);
nmtoken collection;
enum subcollection;
content nodeset content;
content nodeset content-old;
query nodeset query;
string username;
string acl;
string num-docs-at-a-time;
int priority;
int datesecs;

Parameters

• nmtoken collection - The name of the collection that holds the document to which you want to add an annotation. (Required)
• enum subcollection - The subcollection in which to enqueue. Default value: live. Possible values: live|staging.
• content nodeset content - The new <content> node to be put on the documents instead. Minimally needs a name attribute and a value. (Required)
• content nodeset content-old - The old <content> node to be changed on a document. Minimally needs a name attribute; if no value is specified, all documents that match the query are tagged with the new content and all <content> with this name from this user are overwritten. (Required)
• query nodeset query - A <query> node whose results should all get the specified content added to them. (Required)
• string username - The user name to which this annotation should be attributed. (Required)
• string acl - The ACL to use. (Required)
• string num-docs-at-a-time - The number of documents to request at a time and tag at a time. This might affect performance. Default value: 500.
• int priority - The priority that this content enqueue should be in relation to anything else being crawled at the same time. Default value: 1.
• int datesecs - The date and time, in seconds since the epoch, that the annotation is marked as having occurred. If not set, the current time is used. Useful for restoring annotations from a backup file.

Exceptions

• annotation-content-missing-name-attribute
• annotation-content-missing-value
• search-collection-invalid-name
• search-collection-enqueue

Authentication

Like all Watson Explorer Engine API functions except for ping, the annotation-express-update-query 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-update-query 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-update-query function is the following:

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

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

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