Webservice: Document

documents handling and CRUD operations

Index Method Request(s) Response Description
1 lock sid
docId
locks an existing document with the given identifier
2 update sid
document
updates an existing document with the value object containing the document's metadata
3 getResource sid
docId
fileVersion
suffix
gets the content of a resource associated to the given document; returns the raw content of the file
4 delete sid
docId
deletes an existing document with the given identifier
5 copy sid
docId
folderId
document copies a document into a folder
6 getContent sid
docId
gets the content of an existing document with the given identifier; returns the raw content of the file
7 create sid
document
content
document creates a new document; the user can completely customize the document through a value object containing the document's metadata; returns the newly created document.
8 unlock sid
docId
unlocks an existing document with the given identifier
9 getVersion sid
docId
version
version gets a version of a document; returns the version
10 move sid
docId
folderId
moves an existing document with the given identifier
11 link sid
doc1
doc2
type
link creates a new link between two documents
12 rename sid
docId
name
renames the title of an existing document with the given identifier
13 isReadable sid
docId
tests if a document is readable
14 getAliases sid
docId
aliases gets the aliases of the given document; returns an array of WSDocument that are aliases
15 getDocuments sid
docIds
documents gets document metadata of a collection of existing documents with the given identifiers; returns an array of WSDocument
16 getExtractedText sid
docId
text gets the document's text stored in the full-text index
17 getDocument sid
docId
document gets the metadata of an existing document with the given identifier; returns the document's representation
18 getVersionContent sid
docId
version
gets the content of a specific version of a document; returns the raw content of the file
19 createDownloadTicket sid
docId
suffix
expireHours
expireDate
maxDownloads
ticket creates a new download ticket to the original document or it's PDF conversion
20 getDocumentByCustomId sid
customId
document gets document metadata of an existing document with the given custom identifier
21 checkout sid
docId
checks out an existing document with the given identifier
22 createPdf sid
docId
fileVersion
creates the PDF conversion of the given document; if the conversion was already created, nothing will happen
23 replaceFile sid
docId
fileVersion
comment
content
replaces the file associated to a given version
24 upload sid
docId
folderId
release
filename
language
content
docId creates a new document or updates an existing one; returns the newly created document's ID
25 getLinks sid
docId
link gets all the links of a specific document; returns an array of links
26 createThumbnail sid
docId
fileVersion
type
creates the thumbail of the given document; if the thumbnail was already created, nothing will happen
27 uploadResource sid
docId
fileVersion
suffix
content
uploads a new resource attached to the given document. If the resource already exists it is overwritten
28 restore sid
docId
folderId
restores a deleted document
29 getVersions sid
docId
version gets the versions' history of a document; returns an array of versions
30 rateDocument sid
docId
vote
rating rates the given document
31 getRatings sid
docId
rating gets all the ratings of the given document
32 checkinDocument sid
docId
comment
filename
release
docVO
content
checks in an existing document to create a new version and also updates the metadata
33 getRecentDocuments sid
maxHits
document lists of last modified documents in the current session
34 getNotes sid
docId
note gets the notes for the given document
35 listDocuments sid
folderId
fileName
document gets the documents in a specific folder
36 reindex sid
docId
content
re-indexes(or indexes from scratch) a document
37 setPassword sid
docId
password
protects with a password the given document
38 unprotect sid
docId
password
unprotect unprotects a document that is password protected. If the given password is right, the document remains unprotected for the duration of the session.
39 deleteNote sid
noteId
deletes a note, only the author or the administrator can delete the note
40 deleteLink sid
id
removes an existing link
41 addNote sid
docId
note
note adds a new note for the given document
42 promoteVersion sid
docId
version
promotes an old version to the current default one
43 saveNote sid
docId
note
note adds/modifies a note for the given document
44 checkin sid
docId
comment
filename
release
content
checks in an existing document to create a new version
45 sendEmail sid
docIds
recipients
subject
message
sends a set of documents as mail attachments
46 unsetPassword sid
docId
currentPassword
removes the password protection from the document
47 createAlias sid
docId
folderId
type
document creates a new document alias for the given document inside a specified folder
48 deleteVersion sid
docId
version
latestVersion deletes a version of a document with the given identifiers

Method #1: lock

locks an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y Document ID

Method #2: update

updates an existing document with the value object containing the document's metadata

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     document
WSDocument Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #3: getResource

gets the content of a resource associated to the given document; returns the raw content of the file

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     fileVersion
String Y the file version to retrieve, eg: '1.0', '2.3'
     suffix
String Y suffix specification(it cannot be empty, use 'conversion.pdf' to get the PDF conversion)

Response

Name Type Required Multiple Description
    
DataHandler Y

Method #4: delete

deletes an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y Document ID

Method #5: copy

copies a document into a folder

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y Document ID
     folderId
Long Y identifier of the new document's folder

Response

Name Type Required Multiple Description
     document
WSDocument Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #6: getContent

gets the content of an existing document with the given identifier; returns the raw content of the file

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y Document ID

Response

Name Type Required Multiple Description
    
DataHandler Y

Method #7: create

creates a new document; the user can completely customize the document through a value object containing the document's metadata; returns the newly created document.

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     document
WSDocument Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed
     content
DataHandler Y the raw content of the file

Response

Name Type Required Multiple Description
     document
WSDocument Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #8: unlock

unlocks an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y identifier of the document

Method #9: getVersion

gets a version of a document; returns the version

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     version
String Y the version number

Response

Name Type Required Multiple Description
     version
WSDocument Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #10: move

moves an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y Document ID
     folderId
Long Y identifier of the new document's folder

Method #11: link

creates a new link between two documents

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     doc1
Long Y ID of document 1
     doc2
Long Y ID of document 2
     type
String type of the link (use 'pdf' to point to the pdf conversion)

Response

Name Type Required Multiple Description
     link
WSLink Y
          id
Long Y unique identifier
          type
String just a string indicating the meaning of the link
          doc1
Long Y itentifier of document 1
          doc2
Long Y itentifier of document 2

Method #12: rename

renames the title of an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y Document ID
     name
String Y

Method #13: isReadable

tests if a document is readable

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id

Response

Name Type Required Multiple Description
    
Boolean Y

Method #14: getAliases

gets the aliases of the given document; returns an array of WSDocument that are aliases

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y Document ID

Response

Name Type Required Multiple Description
     aliases
WSDocument Y Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #15: getDocuments

gets document metadata of a collection of existing documents with the given identifiers; returns an array of WSDocument

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docIds
Long Y Y

Response

Name Type Required Multiple Description
     documents
WSDocument Y Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #16: getExtractedText

gets the document's text stored in the full-text index

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id

Response

Name Type Required Multiple Description
     text
String Y

Method #17: getDocument

gets the metadata of an existing document with the given identifier; returns the document's representation

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y Document ID

Response

Name Type Required Multiple Description
     document
WSDocument Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #18: getVersionContent

gets the content of a specific version of a document; returns the raw content of the file

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     version
String Y the version to retrieve, eg: '1.0', '2.3'

Response

Name Type Required Multiple Description
    
DataHandler Y

Method #19: createDownloadTicket

creates a new download ticket to the original document or it's PDF conversion

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     suffix
String can be null or 'conversion.pdf'
     expireHours
Integer expiration time expressed in hours
     expireDate
String exact expiration date expressed in the format yyyy-MM-dd
     maxDownloads
Integer maximum number of downloads allowed

Response

Name Type Required Multiple Description
     ticket
String Y

Method #20: getDocumentByCustomId

gets document metadata of an existing document with the given custom identifier

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     customId
String Y

Response

Name Type Required Multiple Description
     document
WSDocument Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #21: checkout

checks out an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id

Method #22: createPdf

creates the PDF conversion of the given document; if the conversion was already created, nothing will happen

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     fileVersion
String the specific file version

Method #23: replaceFile

replaces the file associated to a given version

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     fileVersion
String Y
     comment
String Y
     content
DataHandler Y

Method #24: upload

creates a new document or updates an existing one; returns the newly created document's ID

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y id of the document to update
     folderId
Long the folder's id, used in case of creation
     release
Boolean Y true if this is a major release(eg: 2.0) rather than a minor release(eg: 1.12)
     filename
String used in case of creation
     language
String Y
     content
DataHandler Y raw content of the file

Response

Name Type Required Multiple Description
     docId
Long Y

Method #25: getLinks

gets all the links of a specific document; returns an array of links

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id

Response

Name Type Required Multiple Description
     link
WSLink Y Y
          id
Long Y unique identifier
          type
String just a string indicating the meaning of the link
          doc1
Long Y itentifier of document 1
          doc2
Long Y itentifier of document 2

Method #26: createThumbnail

creates the thumbail of the given document; if the thumbnail was already created, nothing will happen

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     fileVersion
String the specific file version
     type
String the thumbnail type(eg: thumbnail, tile, mobile, thumbXXX)

Method #27: uploadResource

uploads a new resource attached to the given document. If the resource already exists it is overwritten

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     fileVersion
String the specific file version
     suffix
String Y suffix specification(it cannot be empty, use 'conversion.pdf' to put the PDF conversion)
     content
DataHandler Y raw content of the file

Method #28: restore

restores a deleted document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     folderId
Long Y id of the folder in which the document must be restored

Method #29: getVersions

gets the versions' history of a document; returns an array of versions

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id

Response

Name Type Required Multiple Description
     version
WSDocument Y Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #30: rateDocument

rates the given document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     vote
Int Y

Response

Name Type Required Multiple Description
     rating
WSRating Y
          docId
Long Y the referenced document
          userId
Long Y id of the user that rated the document
          username
String Y name of the user that rated the document
          date
Date Y
          vote
Int Y

Method #31: getRatings

gets all the ratings of the given document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id

Response

Name Type Required Multiple Description
     rating
WSRating Y Y
          docId
Long Y the referenced document
          userId
Long Y id of the user that rated the document
          username
String Y name of the user that rated the document
          date
Date Y
          vote
Int Y

Method #32: checkinDocument

checks in an existing document to create a new version and also updates the metadata

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     comment
String Y
     filename
String Y
     release
Boolean Y true if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)
     docVO
WSDocument Y optional, contains the metadata to update during the checkin
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed
     content
DataHandler Y

Method #33: getRecentDocuments

lists of last modified documents in the current session

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     maxHits
Integer max number of returned records

Response

Name Type Required Multiple Description
     document
WSDocument Y Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #34: getNotes

gets the notes for the given document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id

Response

Name Type Required Multiple Description
     note
WSNote Y Y
          id
Long Y unique identifier
          docId
Long Y the referenced document
          fileVersion
String Y the specific file version
          userId
Long Y id of the user that created the note
          username
String Y name of the user that created the note
          fileName
String Y name of the document's file
          date
Date Y when the note has been creates
          message
String Y the text of the note
          page
Int Y in which page the note was placed, 0 stays for no page
          opacity
Int Y the opacity
          color
String Y the background color
          left
Double Y left position(0..1)
          top
Double Y top position(0..1)
          width
Double Y width(0..1)
          height
Double Y height(0..1)
          lineOpacity
Int Y the opacity of the line
          lineColor
String Y the color of the line
          rotation
Double Y rotation(-90, +90)
          lineWidth
Int Y the width of the line
          shape
String Y shape (square, circle, line, arrow, thickarrow, comment, label)

Method #35: listDocuments

gets the documents in a specific folder

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     folderId
Long Y
     fileName
String file name filter

Response

Name Type Required Multiple Description
     document
WSDocument Y Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #36: reindex

re-indexes(or indexes from scratch) a document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     content
String the content to be used (if null the file is parsed)

Method #37: setPassword

protects with a password the given document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     password
String Y

Method #38: unprotect

unprotects a document that is password protected. If the given password is right, the document remains unprotected for the duration of the session.

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     password
String Y

Response

Name Type Required Multiple Description
     unprotect
Boolean Y

Method #39: deleteNote

deletes a note, only the author or the administrator can delete the note

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     noteId
Long Y

Method #40: deleteLink

removes an existing link

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     id
Long Y identifier of the link

Method #41: addNote

adds a new note for the given document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     note
String Y

Response

Name Type Required Multiple Description
     note
WSNote Y
          id
Long Y unique identifier
          docId
Long Y the referenced document
          fileVersion
String Y the specific file version
          userId
Long Y id of the user that created the note
          username
String Y name of the user that created the note
          fileName
String Y name of the document's file
          date
Date Y when the note has been creates
          message
String Y the text of the note
          page
Int Y in which page the note was placed, 0 stays for no page
          opacity
Int Y the opacity
          color
String Y the background color
          left
Double Y left position(0..1)
          top
Double Y top position(0..1)
          width
Double Y width(0..1)
          height
Double Y height(0..1)
          lineOpacity
Int Y the opacity of the line
          lineColor
String Y the color of the line
          rotation
Double Y rotation(-90, +90)
          lineWidth
Int Y the width of the line
          shape
String Y shape (square, circle, line, arrow, thickarrow, comment, label)

Method #42: promoteVersion

promotes an old version to the current default one

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     version
String Y

Method #43: saveNote

adds/modifies a note for the given document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     note
WSNote Y
          id
Long Y unique identifier
          docId
Long Y the referenced document
          fileVersion
String Y the specific file version
          userId
Long Y id of the user that created the note
          username
String Y name of the user that created the note
          fileName
String Y name of the document's file
          date
Date Y when the note has been creates
          message
String Y the text of the note
          page
Int Y in which page the note was placed, 0 stays for no page
          opacity
Int Y the opacity
          color
String Y the background color
          left
Double Y left position(0..1)
          top
Double Y top position(0..1)
          width
Double Y width(0..1)
          height
Double Y height(0..1)
          lineOpacity
Int Y the opacity of the line
          lineColor
String Y the color of the line
          rotation
Double Y rotation(-90, +90)
          lineWidth
Int Y the width of the line
          shape
String Y shape (square, circle, line, arrow, thickarrow, comment, label)

Response

Name Type Required Multiple Description
     note
WSNote Y
          id
Long Y unique identifier
          docId
Long Y the referenced document
          fileVersion
String Y the specific file version
          userId
Long Y id of the user that created the note
          username
String Y name of the user that created the note
          fileName
String Y name of the document's file
          date
Date Y when the note has been creates
          message
String Y the text of the note
          page
Int Y in which page the note was placed, 0 stays for no page
          opacity
Int Y the opacity
          color
String Y the background color
          left
Double Y left position(0..1)
          top
Double Y top position(0..1)
          width
Double Y width(0..1)
          height
Double Y height(0..1)
          lineOpacity
Int Y the opacity of the line
          lineColor
String Y the color of the line
          rotation
Double Y rotation(-90, +90)
          lineWidth
Int Y the width of the line
          shape
String Y shape (square, circle, line, arrow, thickarrow, comment, label)

Method #44: checkin

checks in an existing document to create a new version

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     comment
String Y
     filename
String Y
     release
Boolean Y true if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)
     content
DataHandler Y

Method #45: sendEmail

sends a set of documents as mail attachments

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docIds
Long Y Y
     recipients
String Y comma separated list of email addresses
     subject
String Y
     message
String Y

Method #46: unsetPassword

removes the password protection from the document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the document id
     currentPassword
String Y

Method #47: createAlias

creates a new document alias for the given document inside a specified folder

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y the original document's id
     folderId
Long Y
     type
String type of the alias (use 'pdf' to create an alias to the PDF conversion)

Response

Name Type Required Multiple Description
     document
WSDocument Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id)
               mandatory
Int Y
               hidden
Int Y