annotation-permissions

Synopsis

string annotation-permissions(type, username);
enum type;
string username;

Parameters

• enum type - The kind of permissions to generate for annotation contents, shared folder documents and saved query documents. This function is called by the annotation api functions as well as the annotation rights input. "All" should be the union of all other permissions and is used for the input in the rights function to indicate at query time the permissions the current user has. "No-acls" should be used for cases in which the documents of the collection have no acls so none should be used on the contents. This will make the annotations public but will not impose the requirement of all documents needing ACLs on a collection that doesn't need them. This function may be overridden in order to implement a custom annotation permission scheme. Default value: all. Possible values: public|private|all|no-acls.
• string username - Specify a Watson Explorer Engine username here if you would like to generate permissions for a user other than the currently authenticated user. Default value: {viv:authenticated-user()}.

Return Value

• string - A newline separated list of permissions/rights for the given user and the given type of rights.

Exceptions

• There are no exceptions specific to this function.

Authentication

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

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

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

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