Webservice: Document

---

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
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
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
workflowStatusDisplay		String						Current workflow's status display informations
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

---

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
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
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
workflowStatusDisplay		String						Current workflow's status display informations
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
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
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
workflowStatusDisplay		String						Current workflow's status display informations
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

---

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: 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 #11: 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
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
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
workflowStatusDisplay		String						Current workflow's status display informations
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

---

Method #12: createDownloadTicket

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

Request

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

Response

Name		Type		Required		Multiple		Description
ticket		String		Y

---

Method #13: 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
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
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
workflowStatusDisplay		String						Current workflow's status display informations
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

---

Method #14: 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 #15: 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 #16: 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 #17: 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
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
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
workflowStatusDisplay		String						Current workflow's status display informations
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

---

Method #18: 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 #19: 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 #20: 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
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
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
workflowStatusDisplay		String						Current workflow's status display informations
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

---

Method #21: unsetPassword

removes the password protection from the document

Request

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

---

Method #22: getNotes

gets the notes for the given document

Request

Name		Type		Required		Multiple		Description
sid		String		Y
docId		Long		Y

Response

Name		Type		Required		Multiple		Description
note		WSNote		Y		Y
id		Long		Y				unique identifier
docId		Long		Y				the referenced document
userId		Long		Y				id of the user that created the note
username		String		Y				name of the user that created the note
date		Date		Y
message		String		Y
page		Int		Y