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						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)
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
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: 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 #6: 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						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)
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
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						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)
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
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 #7: unlock

unlocks an existing document with the given identifier

Request

Name		Type		Required		Multiple		Description
sid		String		Y
docId		Long		Y

---

Method #8: 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 #9: 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 #10: 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 #11: 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 #12: 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						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)
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
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 #13: 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 #14: 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 #15: addNote

adds a new note for the given document

Request

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

---

Method #16: deleteNote

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

Request

Name		Type		Required		Multiple		Description
sid		String		Y
noteId		Long		Y

---

Method #17: deleteVersion

deletes a version of a document with the given identifiers

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
latestVersion		String		Y

---

Method #18: rateDocument

rates the given document

Request

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

adds/modifies a note for the given document

Request

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

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)

---

Method #20: 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 #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: 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
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)
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
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 #23: deleteLink

removes an existing link

Request

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

---

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

---

Method #25: getRatings

gets all the ratings of the given document

Request

Name		Type		Required		Multiple		Description
sid		String		Y
docId		Long		Y

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 #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: 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 #28: 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
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)
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
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