LogicalDOC API

Method #1: saveDocumentHistory

saves a history gridRecord for a given document

Request

Name	Type	Required	Description

sid	String	Y

history	WSHistory	Y

log	Logger	Y

type	String	Y

id	Long	Y

docId	Long		document identifier

folderId	Long	Y

userId	Long	Y

date	String	Y	format must 'yyyy-MM-dd HH:mm:ss.SSS' or 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

username	String	Y

userLogin	String	Y

event	String	Y

comment	String	Y

version	String	Y

fileVersion	String	Y

path	String	Y

pathOld	String	Y

sessionId	String	Y

filename	String	Y

filenameOld	String	Y

fileSize	Long	Y

ip	String	Y

color	String	Y

reason	String	Y

geolocation	String	Y

device	String	Y

keyLabel	String	Y

Response

Name	Type	Required	Description

history	WSHistory	Y

log	Logger	Y

type	String	Y

id	Long	Y

docId	Long		document identifier

folderId	Long	Y

userId	Long	Y

date	String	Y	format must 'yyyy-MM-dd HH:mm:ss.SSS' or 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

username	String	Y

userLogin	String	Y

event	String	Y

comment	String	Y

version	String	Y

fileVersion	String	Y

path	String	Y

pathOld	String	Y

sessionId	String	Y

filename	String	Y

filenameOld	String	Y

fileSize	Long	Y

ip	String	Y

color	String	Y

reason	String	Y

geolocation	String	Y

device	String	Y

keyLabel	String	Y

Method #2: 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 #3: 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

log	Logger	Y

type	String	Y

id	Long	Y

docId	Long			document identifier

folderId	Long	Y

userId	Long	Y

date	String	Y		format must 'yyyy-MM-dd HH:mm:ss.SSS' or 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

username	String	Y

userLogin	String	Y

event	String	Y

comment	String	Y

version	String	Y

fileVersion	String	Y

path	String	Y

pathOld	String	Y

sessionId	String	Y

filename	String	Y

filenameOld	String	Y

fileSize	Long	Y

ip	String	Y

color	String	Y

reason	String	Y

geolocation	String	Y

device	String	Y

keyLabel	String	Y

Method #4: 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 #5: 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

id	Long	Y		unique identifier

name	String	Y

description	String

creation	String	Y		the creation date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

objectId	Long	Y		identifier of the referenced object(a document or folder)

fileType	String			in case of document, it's file type

type	String	Y		must be document or folder

color	String	Y		the color of the subscription

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

Method #6: 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 #7: 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

log	Logger	Y

type	String	Y

id	Long	Y

docId	Long			document identifier

folderId	Long	Y

userId	Long	Y

date	String	Y		format must 'yyyy-MM-dd HH:mm:ss.SSS' or 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

username	String	Y

userLogin	String	Y

event	String	Y

comment	String	Y

version	String	Y

fileVersion	String	Y

path	String	Y

pathOld	String	Y

sessionId	String	Y

filename	String	Y

filenameOld	String	Y

fileSize	Long	Y

ip	String	Y

color	String	Y

reason	String	Y

geolocation	String	Y

device	String	Y

keyLabel	String	Y

Method #8: 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

log	Logger	Y

type	String	Y

id	Long	Y

docId	Long			document identifier

folderId	Long	Y

userId	Long	Y

date	String	Y		format must 'yyyy-MM-dd HH:mm:ss.SSS' or 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

username	String	Y

userLogin	String	Y

event	String	Y

comment	String	Y

version	String	Y

fileVersion	String	Y

path	String	Y

pathOld	String	Y

sessionId	String	Y

filename	String	Y

filenameOld	String	Y

fileSize	Long	Y

ip	String	Y

color	String	Y

reason	String	Y

geolocation	String	Y

device	String	Y

keyLabel	String	Y

Method #9: 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

log	Logger	Y

type	String	Y

id	Long	Y

docId	Long			document identifier

folderId	Long	Y

userId	Long	Y

date	String	Y		format must 'yyyy-MM-dd HH:mm:ss.SSS' or 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

username	String	Y

userLogin	String	Y

event	String	Y

comment	String	Y

version	String	Y

fileVersion	String	Y

path	String	Y

pathOld	String	Y

sessionId	String	Y

filename	String	Y

filenameOld	String	Y

fileSize	Long	Y

ip	String	Y

color	String	Y

reason	String	Y

geolocation	String	Y

device	String	Y

keyLabel	String	Y

Method #10: 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

id	Long	Y		unique identifier

messageText	String	Y

author	String			who wrote the message

subject	String	Y

date	String	Y		format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

read	Int	Y		can be 0 or 1

type	Int	Y		0 = system, 1 = notification

priority	Int	Y

Method #11: 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

log	Logger	Y

type	String	Y

id	Long	Y

docId	Long			document identifier

folderId	Long	Y

userId	Long	Y

date	String	Y		format must 'yyyy-MM-dd HH:mm:ss.SSS' or 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

username	String	Y

userLogin	String	Y

event	String	Y

comment	String	Y

version	String	Y

fileVersion	String	Y

path	String	Y

pathOld	String	Y

sessionId	String	Y

filename	String	Y

filenameOld	String	Y

fileSize	Long	Y

ip	String	Y

color	String	Y

reason	String	Y

geolocation	String	Y

device	String	Y

keyLabel	String	Y

Webservice: Audit

auditing operations [Commercial editions only]

Method #1: saveDocumentHistory

Request

Response

Method #2: markAsRead

Request

Method #3: getHistory

Request

Response

Method #4: subscribe

Request

Method #5: getSubscriptions

Request

Response

Method #6: unsubscribe

Request

Method #7: getLatestHistory

Request

Response

Method #8: getDocumentHistory

Request

Response

Method #9: getHistories

Request

Response

Method #10: getMessages

Request

Response

Method #11: getUserHistories

Request

Response

Index	Method	Request(s)	Response	Description

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

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

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

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

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

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

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

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

9	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.

10	getMessages	sid	message	lists messages routed to the current user

11	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.