Webservice: Audit

auditing operations [Commercial editions only]

Index	Method	Request(s)	Response	Description

1	unsubscribe	sid ids type		unsubscribes the current user to notifications emitted by documents or folders

2	subscribe	sid ids type events		subscribes the current user to notifications emitted by documents or folders

3	saveDocumentHistory	sid history	history	saves a history gridRecord for a given document

4	markAsRead	sid ids		marks a set of messages as read by the current user

5	getHistory	sid folderId oldestDate events max	history	lists all the histories in the given tree

6	getUserHistories	sid username userId oldestDate events max	history	retrieves the user histories. Only those users with access to Last Changes report can invoke this method.

7	getSubscriptions	sid	subscription	lists all the subscriptions of the current user

8	getHistories	arg0 arg1 arg2 arg3 arg4 arg5 arg6 arg7		lists all the histories by the given criteria. Only those users with access to Last Changes report can invoke this method.

9	getLatestHistory	sid folderId oldestDate events max	history	lists all the latest histories in the given tree

10	getDocumentHistory	sid docId	history	gets the history of a given document

11	getMessages	sid	message	lists messages routed to the current user

Method #1: unsubscribe

unsubscribes the current user to notifications emitted by documents or folders

Request

Name	Type	Required	Multiple	Description

sid	String	Y

ids	Long	Y	Y	identifiers of folders or documents

type	String	Y		the type of subscription: folder or document

Method #2: subscribe

subscribes the current user to notifications emitted by documents or folders

Request

Name	Type	Required	Multiple	Description

sid	String	Y

ids	Long	Y	Y	identifiers of folders or documents

type	String	Y		the type of subscription: folder or document

events	String	Y		comma separated list of event codes you want to subscribe to

Method #3: saveDocumentHistory

saves a history gridRecord for a given document

Request

Name	Type	Required

sid	String	Y

history	WSHistory	Y

Response

Name		Type		Required		Multiple		Description

history		WSHistory		Y

Method #4: markAsRead

marks a set of messages as read by the current user

Request

Name	Type	Required	Multiple	Description

sid	String	Y

ids	Long	Y	Y	identifiers of the messages that have to be marked as read

Method #5: getHistory

lists all the histories in the given tree

Request

Name	Type	Required	Multiple	Description

sid	String	Y

folderId	Long	Y		the tree to inspect

oldestDate	String			oldest date to use as filter (use the format 'yyyy-MM-dd HH:mm:ss.SSS')

events	String		Y	array of event codes to use as filter

max	Integer			the maximum number of records

Response

Name		Type		Required		Multiple		Description

history		WSHistory		Y		Y

Method #6: getUserHistories

retrieves the user histories. Only those users with access to Last Changes report can invoke this method.

Request

Name	Type	Required	Multiple

sid	String	Y

username	String	Y

userId	Long	Y

oldestDate	String	Y

events	String	Y	Y

max	Integer	Y

Response

Name		Type		Required		Multiple		Description

history		WSHistory		Y		Y

Method #7: getSubscriptions

lists all the subscriptions of the current user

Request

Name		Type		Required		Multiple		Description

sid		String		Y

Response

Name		Type		Required		Multiple		Description

subscription		WSSubscription		Y		Y

Method #8: getHistories

lists all the histories by the given criteria. Only those users with access to Last Changes report can invoke this method.

Request

Name	Type	Required	Multiple

arg0	String	Y

arg1	String	Y

arg2	String	Y

arg3	Long	Y

arg4	String	Y

arg5	String	Y

arg6	String	Y	Y

arg7	Integer	Y

Response

Name		Type		Required		Multiple		Description

		WSHistory		Y		Y

Method #9: getLatestHistory

lists all the latest histories in the given tree

Request

Name	Type	Required	Multiple	Description

sid	String	Y

folderId	Long	Y		the tree to inspect

oldestDate	String			oldest date to use as filter (use the format 'yyyy-MM-dd HH:mm:ss.SSS')

events	String		Y	array of event codes to use as filter

max	Integer			the maximum number of records

Response

Name		Type		Required		Multiple		Description

history		WSHistory		Y		Y

Method #10: getDocumentHistory

gets the history of a given document

Request

Name	Type	Required

sid	String	Y

docId	Long	Y

Response

Name		Type		Required		Multiple		Description

history		WSHistory		Y		Y

Method #11: getMessages

lists messages routed to the current user

Request

Name		Type		Required		Multiple		Description

sid		String		Y

Response

Name		Type		Required		Multiple		Description

message		WSMessage		Y		Y