Methods for communicating with the server

The following methods communicate with the server to disconnect, retrieve messages, or manage explicit transactions.

Transactions: begintran,session – abort,session – commit,session

Initialized the AEK: initcrypto,apisession[,location] [,passphrase]

Encrypts a password: encryptpass,session,password

Connect : connect,repository,user_auth_name,password|ticket [,domain]… – disconnect,session

Methods for system administration

Changes a user’s password: chagepassword,session,old_password,new_password

Get docbase/docbroker information: getdocbasemap,session|apisession… – getdocbrokermap,session|apisession – getservermap,session|apisession,repository…

Methods for handing objects

destroy,session,object_id

link,session,object_id,folder_specification|alias

fetch,session,object_id…

locate,session,object_id,attribute,value Returns the integer index for a particular repeating attribute value

save,sesion,object_id [,save_lock] [,version_label]

Methods for retrieving and setting attributes

datatype,session,object_id,attribute Return the datatype of an attribute

count,session,object_id Counts the number of attributes for an object

append,session,object_id, attribute [,pattern],”value” Adds a new value to a repeating attribute

get,session,object_id

describe,session,type,object_type

remove,session,object_id,attribute[index]

repeating,session,object_id,attribute

set,session,object_id,attribute[index],”value|alias” Note: alias is only allowed when attribute is one of owner_name,acl_name, or acl_domain

truncate,session,object_id,attribute Remove all values for a repeating attribute

values,session,object_id,attribute Returns the number of values for an attribute

Methods for searching the repository

execquery,session,[readquery_flag],dql_query Executes a DQL statement longer than 255 characters

execsql,session,sql_statement

next,session,collection_identifier Returns an item from a collection

query,session,dql_query Returns the identifier for the resulting collection. The method allows you to modify data in the repository during query result processing.

readquery,session,dql_query

retrieve,session,search_condition Fetch the object that satisfies a search condition and returns the object’s ID

To be continued.