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 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.
6 rename sid
docId
name
renames the title of an existing document with the given identifier
7 getContent sid
docId
gets the content of an existing document with the given identifier; returns the raw content of the file
8 unlock sid
docId
unlocks an existing document with the given identifier
9 link sid
doc1
doc2
type
link creates a new link between two documents
10 reindex sid
docId
content
re-indexes(or indexes from scratch) a document
11 createPdf sid
docId
fileVersion
creates the PDF conversion of the given document; if the conversion was already created, nothing will happen
12 deleteLink sid
id
removes an existing link
13 getLinks sid
docId
link gets all the links of a specific document; returns an array of links
14 getRecentDocuments sid
maxHits
document lists of last modified documents in the current session
15 getVersionContent sid
docId
version
gets the content of a specific version of a document; returns the raw content of the file
16 getDocumentByCustomId sid
customId
document gets document metadata of an existing document with the given custom identifier
17 getDocuments sid
docIds
documents gets document metadata of a collection of existing documents with the given identifiers; returns an array of WSDocument
18 restore sid
docId
folderId
restores a deleted document
19 move sid
docId
folderId
moves an existing document with the given identifier
20 renameFile sid
docId
name
renames the filename of an existing document with the given identifier
21 createAlias sid
docId
folderId
type
document creates a new document alias for the given document inside a specified folder
22 getAliases sid
docId
aliases gets the aliases of the given document; returns an array of WSDocument that are aliases
23 getExtractedText sid
docId
text gets the document's text stored in the full-text index
24 checkin sid
docId
comment
filename
release
content
checks in an existing document to create a new version
25 isReadable sid
docId
tests if a document is readable
26 uploadResource sid
docId
fileVersion
suffix
content
uploads a new resource attached to the given document. If the resource already exists it is overwritten
27 listDocuments sid
folderId
fileName
document gets the documents in a specific folder
28 checkout sid
docId
checks out an existing document with the given identifier
29 getDocument sid
docId
document gets the metadata of an existing document with the given identifier; returns the document's representation
30 sendEmail sid
docIds
recipients
subject
message
sends a set of documents as mail attachments
31 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
32 getVersions sid
docId
document gets the versions' history of a document; returns an array of versions

Method #1: lock

locks an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y

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
     document
WSDocument Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'

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
     docId
Long Y
     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
     docId
Long Y

Method #5: 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
     document
WSDocument Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'
     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
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'

Method #6: rename

renames the title of an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y
     name
String Y

Method #7: 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
     docId
Long Y

Response

Name Type Required Multiple Description
    
DataHandler Y

Method #8: unlock

unlocks an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y

Method #9: link

creates a new link between two documents

Request

Name Type Required Multiple Description
     sid
String Y
     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 #10: reindex

re-indexes(or indexes from scratch) a document

Request

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

Method #11: 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
     docId
Long Y
     fileVersion
String the specific file version

Method #12: deleteLink

removes an existing link

Request

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

Method #13: getLinks

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

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y

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 #14: getRecentDocuments

lists of last modified documents in the current session

Request

Name Type Required Multiple Description
     sid
String Y
     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
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'

Method #15: 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
     docId
Long Y
     version
String Y the version to retrieve, eg: '1.0', '2.3'

Response

Name Type Required Multiple Description
    
DataHandler Y

Method #16: getDocumentByCustomId

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

Request

Name Type Required Multiple Description
     sid
String Y
     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
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'

Method #17: 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
     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
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'

Method #18: restore

restores a deleted document

Request

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

Method #19: move

moves an existing document with the given identifier

Request

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

Method #20: renameFile

renames the filename of an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y
     name
String Y

Method #21: createAlias

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

Request

Name Type Required Multiple Description
     sid
String Y
     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
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'

Method #22: 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
     docId
Long Y

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
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'

Method #23: getExtractedText

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

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y

Response

Name Type Required Multiple Description
     text
String Y

Method #24: checkin

checks in an existing document to create a new version

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y
     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 #25: isReadable

tests if a document is readable

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y

Response

Name Type Required Multiple Description
    
Boolean Y

Method #26: 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
     docId
Long Y
     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 taw content of the file

Method #27: listDocuments

gets the documents in a specific folder

Request

Name Type Required Multiple Description
     sid
String Y
     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
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'

Method #28: checkout

checks out an existing document with the given identifier

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y

Method #29: 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
     docId
Long 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
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'

Method #30: sendEmail

sends a set of documents as mail attachments

Request

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

Method #31: 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
     docId
Long 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 #32: getVersions

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

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y

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
          title
String Y
          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 to be applied to 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
               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)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          path
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String Current workflow's status where the document is in
          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'