Webservice: Folder

folders handling and CRUD operations

Index Method Request(s) Response Description
1 getDefaultWorkspace sid
 workspace gets the default workspace
2 update sid
folder
 updates an existing folder; you need the RENAME permission
3 merge sid
sourceId
targetId
 merges the contents of folder into a target
4 delete sid
folderId
 deletes an existing folder
5 copy sid
folderId
targetId
foldersOnly
securityOption
 copies an existing folder into another location
6 create sid
folder
 folder Creates a new folder; returns the newly created folder
7 getPath sid
folderId
 folders computes the path from the root to the target folder; returns the array of folders, the first is the root
8 rename sid
folderId
name
 renames an existing folder
9 move sid
folderId
parentId
 moves an existing folder with the given identifier
10 isReadable sid
folderId
 tests if a folder is readable
11 isWritable sid
folderId
 tests if a folder is writable
12 createAlias sid
arg1
arg2
 folder creates a new folder alias; returns the newly created alias
13 getFolder sid
folderId
 folder gets an existing folder
14 createFolder sid
parentId
name
 folderId creates a new folder; returns the newly created folder
15 getGrantedUsers sid
folderId
 retrieves the list of granted users for the given folder
16 isGranted sid
folderId
permission
 tests if the current user has a specific permission on a folder
17 listChildren sid
folderId
 folder lists all direct children of a parent folder: readable only sub-folders are returned
18 grantGroup sid
folderId
groupId
permissions
recursive
 grants group permission to the folder
19 getRootFolder sid
 folder gets the root folder
20 getGrantedGroups sid
folderId
 retrieves the list of granted groups for the given folder
21 grantUser sid
folderId
userId
permissions
recursive
 grants user permission to the folder
22 createPath sid
parentId
path
 folder creates the folder for the specified path; all unexisting nodes will be created
23 findByPath sid
path
 folder finds the folder at the specified path
24 listWorkspaces sid
 workspaces retrieves the list of all workspaces

Method #1: 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)
               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: 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)
               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 #3: 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 #4: delete

deletes an existing folder

Request

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

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

retrieves the list of granted users for the given folder

Request

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

Response

Name Type Required Multiple Description
    
WSRight Y Y
          id
Long Y unique identifier of a user or a group
          permissions
Int Y permissions mask.
this is an integer representation of a list of 17 bits. Each bit refers to a permission: 0 to deny, 1 to grant the permission.
This list represent the bit array starting from left to right:
  1. Storage
  2. Automation
  3. Email
  4. Move
  5. Password
  6. Print
  7. Subscription
  8. Calendar
  9. Workflow
  10. Archive
  11. Sign
  12. Export
  13. Import
  14. Rename
  15. Delete
  16. Immutable
  17. Security
  18. Add
  19. Write
  20. Download
  21. Read
In particular, 'Read' is represented by the last right bit while 'Download' is represented by the first left bit.
Here are two examples:

A) if you want to assign to a user the permissions Read, Write, Immutable, Rename, Sign, Download, the 'permissions' value must be 2215, in fact it is 000000000100010100111 in binary representation.

B) if you want to assign to a group the permissions Read, Write, Add, Security, Import, Archive, Workflow, the 'permissions' value must be 6421, in fact it is 000000001100100010101 in binary representation.

Method #16: 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
Int Y the permissions' integer representation

Response

Name Type Required Multiple Description
    
Boolean Y

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)
               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: grantGroup

grants group permission to the folder

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     folderId
Long Y
     groupId
Long Y
     permissions
Int Y the permission integer representation; if '0', the group will be not granted to access the folder
     recursive
Boolean Y the grant operation is applied also to the subfolders

Method #19: 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)
               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: getGrantedGroups

retrieves the list of granted groups for the given folder

Request

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

Response

Name Type Required Multiple Description
    
WSRight Y Y
          id
Long Y unique identifier of a user or a group
          permissions
Int Y permissions mask.
this is an integer representation of a list of 17 bits. Each bit refers to a permission: 0 to deny, 1 to grant the permission.
This list represent the bit array starting from left to right:
  1. Storage
  2. Automation
  3. Email
  4. Move
  5. Password
  6. Print
  7. Subscription
  8. Calendar
  9. Workflow
  10. Archive
  11. Sign
  12. Export
  13. Import
  14. Rename
  15. Delete
  16. Immutable
  17. Security
  18. Add
  19. Write
  20. Download
  21. Read
In particular, 'Read' is represented by the last right bit while 'Download' is represented by the first left bit.
Here are two examples:

A) if you want to assign to a user the permissions Read, Write, Immutable, Rename, Sign, Download, the 'permissions' value must be 2215, in fact it is 000000000100010100111 in binary representation.

B) if you want to assign to a group the permissions Read, Write, Add, Security, Import, Archive, Workflow, the 'permissions' value must be 6421, in fact it is 000000001100100010101 in binary representation.

Method #21: grantUser

grants user permission to the folder

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     folderId
Long Y
     userId
Long Y
     permissions
Int Y the permission integer representation; if '0', the user will be not granted to access the folder
     recursive
Boolean Y the grant operation is applied also to the subfolders

Method #22: 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)
               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 #23: findByPath

finds the folder at the specified path

Request

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