Webservice: Folder

---

Method #1: update

updates an existing folder; you need the RENAME permission

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
folder		WSFolder		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder

---

Method #2: merge

merges the contents of folder into a target

Request

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

---

Method #3: delete

deletes an existing folder

Request

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

---

Method #4: copy

copies an existing folder into another location

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
folderId		Long		Y
targetId		Long		Y				the new folder's parent
foldersOnly		Int		Y				0 = copy folders and files, 1 = copy just folders
securityOption		String		Y				null or none = no sec. policies are created, inherit: the new folder will point to the parent for the security policies, replicate = sec. policies are inherited from the new parent folder

---

Method #5: create

Creates a new folder; returns the newly created folder

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
folder		WSFolder		Y				definition of the new folder
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder

Response

Name		Type		Required		Multiple		Description
folder		WSFolder		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder

---

Method #6: getPath

computes the path from the root to the target folder; returns the array of folders, the first is the root

Request

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

Response

Name		Type		Required		Multiple		Description
folders		WSFolder		Y		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder

---

Method #7: rename

renames an existing folder

Request

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

---

Method #8: move

moves an existing folder with the given identifier

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
folderId		Long		Y
parentId		Long		Y				the new folder's parent

---

Method #9: isReadable

tests if a folder is readable

Request

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

Response

Name		Type		Required		Multiple		Description
		Boolean		Y

---

Method #10: isWritable

tests if a folder is writable

Request

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

Response

Name		Type		Required		Multiple		Description
		Boolean		Y

---

Method #11: getDefaultWorkspace

gets the default workspace

Request

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

Response

Name		Type		Required		Multiple		Description
workspace		WSFolder		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder

---

Method #12: getAccessControlList

retrieves the access control list

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
folderId		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
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

---

Method #13: setAccessControlList

sets the Access Control List

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
folderId		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
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

---

Method #14: createAlias

creates a new folder alias; returns the newly created alias

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
arg1		Long		Y				identifier of the folder in which the alias will be created
arg2		Long		Y				identifier of the referenced folder

Response

Name		Type		Required		Multiple		Description
folder		WSFolder		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder

---

Method #15: isGranted

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

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
folderId		Long		Y
permission		String		Y				the permissions' integer representation

Response

Name		Type		Required		Multiple		Description
		Boolean		Y

---

Method #16: getRootFolder

gets the root folder

Request

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

Response

Name		Type		Required		Multiple		Description
folder		WSFolder		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder

---

Method #17: listChildren

lists all direct children of a parent folder: readable only sub-folders are returned

Request

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

Response

Name		Type		Required		Multiple		Description
folder		WSFolder		Y		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder

---

Method #18: createFolder

creates a new folder; returns the newly created folder

Request

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

Response

Name		Type		Required		Multiple		Description
folderId		Long		Y

---

Method #19: getFolder

gets an existing folder

Request

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

Response

Name		Type		Required		Multiple		Description
folder		WSFolder		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder

---

Method #20: listWorkspaces

retrieves the list of all workspaces

Request

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

Response

Name		Type		Required		Multiple		Description
workspaces		WSFolder		Y		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder

---

Method #21: createPath

creates the folder for the specified path; all unexisting nodes will be created

Request

Name		Type		Required		Multiple		Description
sid		String		Y				identifier of the session
parentId		Long		Y
path		String		Y				the folder's path(for example /Default/dog/cat/mouse)

Response

Name		Type		Required		Multiple		Description
folder		WSFolder		Y
id		Long		Y				unique identifier of the folder
name		String		Y
parentId		Long		Y				identifier of the parent folder
description		String		Y
lastModified		String						the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
type		Int		Y				0 = Folder, 1 = Workspace
templateId		Long						template assigned to folder
templateLocked		Int		Y				0 = the template is unlocked, 1 = the template is locked
creation		String						the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
creator		String						who created the folder
position		Int		Y
hidden		Int		Y				0 = visible, 1 = hidden
foldRef		Long						the referenced folder, used in case of folder alias
securityRef		Long						another folder to inherit the security from
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)
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
storage		Integer						the storage to use for new files. Valid only in case of workspace.
tags		String				Y		tags applied to the document
ocrTemplateId		Long						identifier of the Zonal OCR template to use to process the documents inside this folder
barcodeTemplateId		Long						identifier of the barcode template to use to process the documents inside this folder
maxVersions		Integer						maximum number of versions maintaned in the workspace
color		String						optional color assigned to the folder
tile		String						optional tile image(Base64 encoded) of the folder