Webservice: Audit

auditing operations [Commercial editions only]

Index Method Request(s) Response Description
1 subscribe sid
ids
type
events
 subscribes the current user to notifications emitted by documents or folders
2 getSubscriptions sid
 subscription lists all the subscriptions of the current user
3 getHistory sid
folderId
oldestDate
events
max
 history lists all the histories in the given tree
4 getLatestHistory sid
folderId
oldestDate
events
max
 history lists all the latest histories in the given tree
5 getDocumentHistory sid
docId
 history gets the history of a given document
6 getMessages sid
 message lists messages routed to the current user
7 markAsRead sid
ids
 marks a set of messages as read by the current user
8 unsubscribe sid
ids
type
 unsubscribes the current user to notifications emitted by documents or folders
9 saveDocumentHistory sid
history
 history saves a history record for a given document

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

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

Method #5: getDocumentHistory

gets the history of a given document

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y

Response

Name Type Required Multiple Description
     history
WSHistory Y 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
          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

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

saves a history record for a given document

Request

Name Type Required Multiple Description
     sid
String Y
     history
WSHistory 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
          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

Response

Name Type Required Multiple Description
     history
WSHistory 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
          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