LogicalDOC API - Document

Method #1: lock

locks an existing document with the given identifier

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	Document ID

Method #2: update

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

Request

Name	Type	Required	Multiple	Description

sid	String	Y		identifier of the session

document	WSDocument	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #3: list

gets the documents in a specific folder

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

folderId	Long	Y

fileName	String		file name filter

sort	String	Y	Optional sort criteria (eg date asc)

page	Integer	Y	Optional page number

max	Integer	Y	Optional maximum number of elements per page

Response

Name	Type	Required	Multiple	Description

document	WSDocument	Y	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #4: getResource

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

fileVersion	String	Y	the file version to retrieve, eg: '1.0', '2.3'

suffix	String	Y	suffix specification(it cannot be empty, use 'conversion.pdf' to get the PDF conversion)

Response

Name		Type		Required		Multiple		Description

		DataHandler		Y

Method #5: delete

deletes an existing document with the given identifier

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	Document ID

Method #6: copy

copies a document into a folder

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	Document ID

folderId	Long	Y	identifier of the new document's folder

links	Boolean	Y	if the links must be copied too

notes	Boolean	Y	if the notes and annotations must be copied too

security	Boolean	Y	if the security settings must be copied too

Response

Name	Type	Required	Multiple	Description

document	WSDocument	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #7: create

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

Request

Name	Type	Required	Multiple	Description

sid	String	Y		identifier of the session

document	WSDocument	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

content	DataHandler	Y		the raw content of the file

Response

Name	Type	Required	Multiple	Description

document	WSDocument	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #8: getContent

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	Document ID

Response

Name		Type		Required		Multiple		Description

		DataHandler		Y

Method #9: unlock

unlocks an existing document with the given identifier

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	identifier of the document

Method #10: rename

renames the title of an existing document with the given identifier

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	Document ID

name	String	Y

Method #11: link

creates a new link between two documents

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

doc1	Long	Y	ID of document 1

doc2	Long	Y	ID of document 2

type	String		type of the link (use 'pdf' to point to the pdf conversion)

Response

Name	Type	Required	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: move

moves an existing document with the given identifier

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	Document ID

folderId	Long	Y	identifier of the new document's folder

Method #13: getVersion

gets a version of a document; returns the version

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

version	String	Y	the version number

Response

Name	Type	Required	Multiple	Description

version	WSDocument	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #14: getVersions

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

Response

Name	Type	Required	Multiple	Description

version	WSDocument	Y	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #15: getAliases

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	Document ID

Response

Name	Type	Required	Multiple	Description

aliases	WSDocument	Y	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #16: getDocuments

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

Request

Name	Type	Required	Multiple	Description

sid	String	Y		identifier of the session

docIds	Long	Y	Y

Response

Name	Type	Required	Multiple	Description

documents	WSDocument	Y	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #17: getDocument

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	Document ID

Response

Name	Type	Required	Multiple	Description

document	WSDocument	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #18: uploadResource

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

fileVersion	String		the specific file version

suffix	String	Y	suffix specification(it cannot be empty, use 'conversion.pdf' to put the PDF conversion)

content	DataHandler	Y	raw content of the file

Method #19: checkin

checks in an existing document to create a new version

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

comment	String	Y

filename	String	Y

release	Boolean	Y	true if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)

content	DataHandler	Y

Method #20: getVersionContent

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

version	String	Y	the version to retrieve, eg: '1.0', '2.3'

Response

Name		Type		Required		Multiple		Description

		DataHandler		Y

Method #21: checkout

checks out an existing document with the given identifier

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

Method #22: restore

restores a deleted document

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

folderId	Long	Y	id of the folder in which the document must be restored

Method #23: getExtractedText

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

Response

Name		Type		Required		Multiple		Description

text		String		Y

Method #24: checkinDocument

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

Request

Name	Type	Required	Multiple	Description

sid	String	Y		identifier of the session

docId	Long	Y		the document id

comment	String	Y

filename	String	Y

release	Boolean	Y		true if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)

docVO	WSDocument	Y		optional, contains the metadata to update during the checkin

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

content	DataHandler	Y

Method #25: replaceFile

replaces the file associated to a given version

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

fileVersion	String	Y

comment	String	Y

content	DataHandler	Y

Method #26: upload

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	id of the document to update

folderId	Long		the folder's id, used in case of creation

release	Boolean	Y	true if this is a major release(eg: 2.0) rather than a minor release(eg: 1.12)

filename	String		used in case of creation

language	String	Y

content	DataHandler	Y	raw content of the file

Response

Name		Type		Required		Multiple		Description

docId		Long		Y

Method #27: promoteVersion

promotes an old version to the current default one

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

version	String	Y

Method #28: createDownloadTicket

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

suffix	String		can be null or 'conversion.pdf'

expireHours	Integer		expiration time expressed in hours

expireDate	String		exact expiration date expressed in the format yyyy-MM-dd

maxDownloads	Integer		maximum number of downloads allowed

Response

Name		Type		Required		Multiple		Description

ticket		String		Y

Method #29: getDocumentByCustomId

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

customId	String	Y

Response

Name	Type	Required	Multiple	Description

document	WSDocument	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #30: getAccessControlList

retrieves the access control list

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y

Response

Name	Type	Required	Multiple	Description

	WSAccessControlEntry	Y	Y

groupId	Long	Y		unique identifier of a group

userId	Long	Y		unique identifier of a user

read	Int	Y		permission to read

preview	Int	Y		permission to preview

write	Int	Y		permission to edit

download	Int	Y		permission to download

add	Int	Y		permission to add child elements

security	Int	Y		permission to change security policies

delete	Int	Y		permission to delete

rename	Int	Y		permission to rename

immutable	Int	Y		permission to mark a document as immutable

iimport	Int	Y		permission to import

export	Int	Y		permission to export

sign	Int	Y		permission to digitally sign

archive	Int	Y		permission to archive

workflow	Int	Y		permission to handle the workflow

calendar	Int	Y		permission to handle calendar events

subscription	Int	Y		permission to handle events subscription

password	Int	Y		permission to put a password

print	Int	Y		permission to print

move	Int	Y		permission to move

email	Int	Y		permission to send emails

automation	Int	Y		permission to handle the automation

storage	Int	Y		permission to handle the storage

readingreq	Int	Y		permission to send reading requests

customid	Int	Y		permission to edit the Custom ID

Method #31: setAccessControlList

sets the Access Control List

Request

Name	Type	Required	Multiple	Description

sid	String	Y		identifier of the session

docId	Long	Y

acl	WSAccessControlEntry	Y	Y	the complete Access Control List

groupId	Long	Y		unique identifier of a group

userId	Long	Y		unique identifier of a user

read	Int	Y		permission to read

preview	Int	Y		permission to preview

write	Int	Y		permission to edit

download	Int	Y		permission to download

add	Int	Y		permission to add child elements

security	Int	Y		permission to change security policies

delete	Int	Y		permission to delete

rename	Int	Y		permission to rename

immutable	Int	Y		permission to mark a document as immutable

iimport	Int	Y		permission to import

export	Int	Y		permission to export

sign	Int	Y		permission to digitally sign

archive	Int	Y		permission to archive

workflow	Int	Y		permission to handle the workflow

calendar	Int	Y		permission to handle calendar events

subscription	Int	Y		permission to handle events subscription

password	Int	Y		permission to put a password

print	Int	Y		permission to print

move	Int	Y		permission to move

email	Int	Y		permission to send emails

automation	Int	Y		permission to handle the automation

storage	Int	Y		permission to handle the storage

readingreq	Int	Y		permission to send reading requests

customid	Int	Y		permission to edit the Custom ID

Method #32: reindex

re-indexes(or indexes from scratch) a document

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

content	String		the content to be used (if null the file is parsed)

Method #33: setPassword

protects with a password the given document

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

password	String	Y

Method #34: addNote

adds a new note for the given document

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

note	String	Y

Response

Name	Type	Required	Description

note	WSNote	Y

id	Long	Y	unique identifier

docId	Long	Y	the referenced document

fileVersion	String	Y	the specific file version

userId	Long	Y	id of the user that created the note

username	String	Y	name of the user that created the note

fileName	String	Y	name of the document's file

date	Date	Y	when the note has been creates

message	String	Y	the text of the note

page	Int	Y	in which page the note was placed, 0 stays for no page

opacity	Int	Y	the opacity

color	String	Y	the background color

left	Double	Y	left position(0..1)

top	Double	Y	top position(0..1)

width	Double	Y	width(0..1)

height	Double	Y	height(0..1)

lineOpacity	Int	Y	the opacity of the line

lineColor	String	Y	the color of the line

rotation	Double	Y	rotation(-90, +90)

lineWidth	Int	Y	the width of the line

shape	String	Y	shape (square, circle, line, arrow, thickarrow, comment, label)

Method #35: deleteNote

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

noteId	Long	Y

Method #36: saveNote

adds/modifies a note for the given document

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

note	WSNote	Y

id	Long	Y	unique identifier

docId	Long	Y	the referenced document

fileVersion	String	Y	the specific file version

userId	Long	Y	id of the user that created the note

username	String	Y	name of the user that created the note

fileName	String	Y	name of the document's file

date	Date	Y	when the note has been creates

message	String	Y	the text of the note

page	Int	Y	in which page the note was placed, 0 stays for no page

opacity	Int	Y	the opacity

color	String	Y	the background color

left	Double	Y	left position(0..1)

top	Double	Y	top position(0..1)

width	Double	Y	width(0..1)

height	Double	Y	height(0..1)

lineOpacity	Int	Y	the opacity of the line

lineColor	String	Y	the color of the line

rotation	Double	Y	rotation(-90, +90)

lineWidth	Int	Y	the width of the line

shape	String	Y	shape (square, circle, line, arrow, thickarrow, comment, label)

Response

Name	Type	Required	Description

note	WSNote	Y

id	Long	Y	unique identifier

docId	Long	Y	the referenced document

fileVersion	String	Y	the specific file version

userId	Long	Y	id of the user that created the note

username	String	Y	name of the user that created the note

fileName	String	Y	name of the document's file

date	Date	Y	when the note has been creates

message	String	Y	the text of the note

page	Int	Y	in which page the note was placed, 0 stays for no page

opacity	Int	Y	the opacity

color	String	Y	the background color

left	Double	Y	left position(0..1)

top	Double	Y	top position(0..1)

width	Double	Y	width(0..1)

height	Double	Y	height(0..1)

lineOpacity	Int	Y	the opacity of the line

lineColor	String	Y	the color of the line

rotation	Double	Y	rotation(-90, +90)

lineWidth	Int	Y	the width of the line

shape	String	Y	shape (square, circle, line, arrow, thickarrow, comment, label)

Method #37: getNotes

gets the notes for the given document

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

Response

Name	Type	Required	Multiple	Description

note	WSNote	Y	Y

id	Long	Y		unique identifier

docId	Long	Y		the referenced document

fileVersion	String	Y		the specific file version

userId	Long	Y		id of the user that created the note

username	String	Y		name of the user that created the note

fileName	String	Y		name of the document's file

date	Date	Y		when the note has been creates

message	String	Y		the text of the note

page	Int	Y		in which page the note was placed, 0 stays for no page

opacity	Int	Y		the opacity

color	String	Y		the background color

left	Double	Y		left position(0..1)

top	Double	Y		top position(0..1)

width	Double	Y		width(0..1)

height	Double	Y		height(0..1)

lineOpacity	Int	Y		the opacity of the line

lineColor	String	Y		the color of the line

rotation	Double	Y		rotation(-90, +90)

lineWidth	Int	Y		the width of the line

shape	String	Y		shape (square, circle, line, arrow, thickarrow, comment, label)

Method #38: createPdf

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

fileVersion	String		the specific file version

Method #39: createViewTicket

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

suffix	String		can be null or 'conversion.pdf'

expireHours	Integer		expiration time expressed in hours

expireDate	String		exact expiration date expressed in the format yyyy-MM-dd

maxDownloads	Integer		maximum number of downloads allowed

maxViews	Integer		maximum number of views allowed

Response

Name		Type		Required		Multiple		Description

ticket		String		Y

Method #40: unsetPassword

removes the password protection from the document

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

currentPassword	String	Y

Method #41: createThumbnail

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

fileVersion	String		the specific file version

type	String		the thumbnail type(eg: thumbnail, tile, mobile, thumbXXX)

Method #42: unprotect

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

password	String	Y

Response

Name		Type		Required		Multiple		Description

unprotect		Boolean		Y

Method #43: getLinks

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

Response

Name	Type	Required	Multiple	Description

link	WSLink	Y	Y

id	Long	Y		unique identifier

type	String			just a string indicating the meaning of the link

doc1	Long	Y		itentifier of document 1

doc2	Long	Y		itentifier of document 2

Method #44: deleteLink

removes an existing link

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

id	Long	Y	identifier of the link

Method #45: getRecentDocuments

lists of last modified documents in the current session

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

maxHits	Integer		max number of returned records

Response

Name	Type	Required	Multiple	Description

document	WSDocument	Y	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #46: createAlias

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

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the original document's id

folderId	Long	Y

type	String		type of the alias (use 'pdf' to create an alias to the PDF conversion)

Response

Name	Type	Required	Multiple	Description

document	WSDocument	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #47: sendEmail

sends a set of documents as mail attachments

Request

Name	Type	Required	Multiple	Description

sid	String	Y		identifier of the session

docIds	Long	Y	Y

recipients	String	Y		comma separated list of email addresses

subject	String	Y

message	String	Y

Method #48: listDocuments

gets the documents in a specific folder

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

folderId	Long	Y

fileName	String		file name filter

Response

Name	Type	Required	Multiple	Description

document	WSDocument	Y	Y

id	Long	Y		unique identifier

fileSize	Long	Y

status	Int			0 = unlocked, 1 = checked out, 2 = locked

exportStatus	Int

version	String

fileVersion	String

date	String	Y		last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

publisher	String

publisherId	Long

creator	String

creatorId	Long

type	String	Y

lockUserId	Long

creation	String			the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

fileName	String	Y

indexed	Int			0 = to index, 1 = indexed, 2 = skip indexing

signed	Int

stamped	Int			1 if the document contains at least one stamp

tags	String		Y	tags applied to the document

folderId	Long	Y		parent folder

templateId	Long			id of the template assigned to the document

customId	String			unique custom identifier

immutable	Int			0 = not immutable, 1 = immutable

digest	String

exportName	String

exportId	Long

docRef	Long			used for aliases, refers to another document

docRefType	String			if used, defines the reference type (use pdf for the PDF Conversion)

deleteUserId	Long			user that has deleted the document

attributes	WSAttribute		Y	array of attributes

name	String	Y		name of the attribute

stringValue	String

intValue	Long

doubleValue	Double

dateValue	String			the date value; format must be 'yyyy-MM-dd'

type	Int	Y		0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section

mandatory	Int	Y

hidden	Int	Y

readonly	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

dependsOn	String			Name of another attribute on which the value of this attribute also depends, used for managing linked presets

stringValues	String			Read only. In case of multiple string values, contains the values separated by a comma

validation	String			Optional validation script

initialization	String			Optional initialization script

language	String			language of the document; See specification

summary	String			contains the snippet search text

score	Integer			full text search score

icon	String

comment	String

lastModified	String

rating	Integer

workflowStatus	String			current workflow's status where the document is in

workflowStatusDisplay	String			current workflow's status display informations

color	String			optional color assigned to the document

published	Int			if it is not set to 1, the document is marked as not published

startPublishing	String

stopPublishing	String

pages	Int			number of pages (default 1)

nature	Int			0 = document, 1 = form

formId	Long			the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

passwordProtected	Integer			indicates whether the document is protected by a password

ocrTemplateId	Long			identifier of the Zonal OCR template to use to process this document

ocrd	Int			indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

barcodeTemplateId	Long			identifier of the barcode template to use to process this document

barcoded	Int			indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #49: isDownload

tests if a folder is writable

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y

Response

Name		Type		Required		Multiple		Description

		Boolean		Y

Method #50: isRead

tests if a document is readable

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y

Response

Name		Type		Required		Multiple		Description

		Boolean		Y

Method #51: isGranted

tests if the current user has a specific permission on a document

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y

permission	String	Y	the permissions' integer representation

Response

Name		Type		Required		Multiple		Description

		Boolean		Y

Method #52: isWrite

tests if a folder is writable

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y

Response

Name		Type		Required		Multiple		Description

		Boolean		Y

Method #53: deleteVersion

deletes a version of a document with the given identifiers

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

version	String	Y	the version to retrieve, eg: '1.0', '2.3'

Response

Name		Type		Required		Multiple		Description

latestVersion		String		Y

Method #54: getRatings

gets all the ratings of the given document

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

Response

Name	Type	Required	Multiple	Description

rating	WSRating	Y	Y

docId	Long	Y		the referenced document

userId	Long	Y		id of the user that rated the document

username	String	Y		name of the user that rated the document

date	Date	Y

vote	Int	Y

Method #55: rateDocument

rates the given document

Request

Name	Type	Required	Description

sid	String	Y	identifier of the session

docId	Long	Y	the document id

vote	Int	Y

Response

Name	Type	Required	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

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	list	sid folderId fileName sort page max	document	gets the documents in a specific folder

4	getResource	sid docId fileVersion suffix		gets the content of a resource associated to the given document; returns the raw content of the file

5	delete	sid docId		deletes an existing document with the given identifier

6	copy	sid docId folderId links notes security	document	copies a document into a folder

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

8	getContent	sid docId		gets the content of an existing document with the given identifier; returns the raw content of the file

9	unlock	sid docId		unlocks an existing document with the given identifier

10	rename	sid docId name		renames the title of an existing document with the given identifier

11	link	sid doc1 doc2 type	link	creates a new link between two documents

12	move	sid docId folderId		moves an existing document with the given identifier

13	getVersion	sid docId version	version	gets a version of a document; returns the version

14	getVersions	sid docId	version	gets the versions' history of a document; returns an array of versions

15	getAliases	sid docId	aliases	gets the aliases of the given document; returns an array of WSDocument that are aliases

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

17	getDocument	sid docId	document	gets the metadata of an existing document with the given identifier; returns the document's representation

18	uploadResource	sid docId fileVersion suffix content		uploads a new resource attached to the given document. If the resource already exists it is overwritten

19	checkin	sid docId comment filename release content		checks in an existing document to create a new version

20	getVersionContent	sid docId version		gets the content of a specific version of a document; returns the raw content of the file

21	checkout	sid docId		checks out an existing document with the given identifier

22	restore	sid docId folderId		restores a deleted document

23	getExtractedText	sid docId	text	gets the document's text stored in the full-text index

24	checkinDocument	sid docId comment filename release docVO content		checks in an existing document to create a new version and also updates the metadata

25	replaceFile	sid docId fileVersion comment content		replaces the file associated to a given version

26	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

27	promoteVersion	sid docId version		promotes an old version to the current default one

28	createDownloadTicket	sid docId suffix expireHours expireDate maxDownloads	ticket	creates a new download ticket to the original document or it's PDF conversion

29	getDocumentByCustomId	sid customId	document	gets document metadata of an existing document with the given custom identifier

30	getAccessControlList	sid docId		retrieves the access control list

31	setAccessControlList	sid docId acl		sets the Access Control List

32	reindex	sid docId content		re-indexes(or indexes from scratch) a document

33	setPassword	sid docId password		protects with a password the given document

34	addNote	sid docId note	note	adds a new note for the given document

35	deleteNote	sid noteId		deletes a note, only the author or the administrator can delete the note

36	saveNote	sid docId note	note	adds/modifies a note for the given document

37	getNotes	sid docId	note	gets the notes for the given document

38	createPdf	sid docId fileVersion		creates the PDF conversion of the given document; if the conversion was already created, nothing will happen

39	createViewTicket	sid docId suffix expireHours expireDate maxDownloads maxViews	ticket	creates a new view ticket to the original document or it's PDF conversion

40	unsetPassword	sid docId currentPassword		removes the password protection from the document

41	createThumbnail	sid docId fileVersion type		creates the thumbail of the given document; if the thumbnail was already created, nothing will happen

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

43	getLinks	sid docId	link	gets all the links of a specific document; returns an array of links

44	deleteLink	sid id		removes an existing link

45	getRecentDocuments	sid maxHits	document	lists of last modified documents in the current session

46	createAlias	sid docId folderId type	document	creates a new document alias for the given document inside a specified folder

47	sendEmail	sid docIds recipients subject message		sends a set of documents as mail attachments

48	listDocuments	sid folderId fileName	document	gets the documents in a specific folder

49	isDownload	sid docId		tests if a folder is writable

50	isRead	sid docId		tests if a document is readable

51	isGranted	sid docId permission		tests if the current user has a specific permission on a document

52	isWrite	sid docId		tests if a folder is writable

53	deleteVersion	sid docId version	latestVersion	deletes a version of a document with the given identifiers

54	getRatings	sid docId	rating	gets all the ratings of the given document

55	rateDocument	sid docId vote	rating	rates the given document

Webservice: Document

documents handling and CRUD operations

Method #1: lock

Request

Method #2: update

Request

Method #3: list

Request

Response

Method #4: getResource

Request

Response

Method #5: delete

Request

Method #6: copy

Request

Response

Method #7: create

Request

Response

Method #8: getContent

Request

Response

Method #9: unlock

Request

Method #10: rename

Request

Method #11: link

Request

Response

Method #12: move

Request

Method #13: getVersion

Request

Response

Method #14: getVersions

Request

Response

Method #15: getAliases

Request

Response

Method #16: getDocuments

Request

Response

Method #17: getDocument

Request

Response

Method #18: uploadResource

Request

Method #19: checkin

Request

Method #20: getVersionContent

Request

Response

Method #21: checkout

Request

Method #22: restore

Request

Method #23: getExtractedText

Request

Response

Method #24: checkinDocument

Request

Method #25: replaceFile

Request

Method #26: upload

Request

Response

Method #27: promoteVersion

Request

Method #28: createDownloadTicket

Request

Response

Method #29: getDocumentByCustomId

Request

Response

Method #30: getAccessControlList

Request

Response

Method #31: setAccessControlList