Webservice: Document Metadata

handling of templates and attribute sets

Index Method Request(s) Response Description
1 isReadable sid
templateId
 tests if a template is readable
2 isWritable sid
templateId
 tests if a template is writable
3 getAttributeOptionsByCategory sid
setId
attribute
category
 retrieves the options for the given attribute inside a given category
4 getAttributeOptions sid
setId
attribute
 retrieves the options for the given attribute
5 getAttributeSetById sid
setId
 attributeSet gets an attribute set by it's identifier
6 setAttributeOptions sid
setId
attribute
options
 saves the options for the given attribute
7 getAccessControlList sid
templateId
 retrieves the access control list
8 setAccessControlList sid
templateId
acl
 sets the Access Control List
9 getTemplateById sid
templateId
 template gets an existing template by it's identifier
10 getTemplate sid
name
 template gets an existing template by it's name
11 deleteTemplate sid
templateId
 deletes an existing template
12 listTemplates sid
 template lists all the templates
13 storeTemplate sid
template
 templateId creates/updates a template; you can completely customize the template through a value object; returns the identifier of the created/updated template
14 addAttributeOption sid
setId
attribute
option
 Adds a new option for the given attribute
15 deleteAttributeSet sid
setId
 deletes an existing attribute set
16 storeAttributeSet sid
attributeSet
 setId creates/updates an attribute set; you can completely customize the set through a value object; returns the identifier of the created/updated set
17 getAttributeSet sid
name
 attributeSet gets an attribute set by it's name
18 listAttributeSets sid
 attributeSet lists all the attribute sets

Method #1: isReadable

tests if a template is readable

Request

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

Response

Name Type Required Multiple Description
    
Boolean Y

Method #2: isWritable

tests if a template is writable

Request

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

Response

Name Type Required Multiple Description
    
Boolean Y

Method #3: getAttributeOptionsByCategory

retrieves the options for the given attribute inside a given category

Request

Name Type Required Multiple Description
     sid
String Y
     setId
Long Y
     attribute
String Y
     category
String Y

Response

Name Type Required Multiple Description
    
WSAttributeOption Y Y
          serialVersionUID
Long Y
          value
String Y the value
          category
String the category

Method #4: getAttributeOptions

retrieves the options for the given attribute

Request

Name Type Required Multiple Description
     sid
String Y
     setId
Long Y
     attribute
String Y

Response

Name Type Required Multiple Description
    
String Y Y

Method #5: getAttributeSetById

gets an attribute set by it's identifier

Request

Name Type Required Multiple Description
     sid
String Y
     setId
Long Y

Response

Name Type Required Multiple Description
     attributeSet
WSAttributeSet Y
          id
Long Y unique identifier
          name
String Y
          description
String
          lastModified
String the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          attributes
WSAttribute Y
               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

Method #6: setAttributeOptions

saves the options for the given attribute

Request

Name Type Required Multiple Description
     sid
String Y
     setId
Long Y
     attribute
String Y
     options
WSAttributeOption Y Y
          serialVersionUID
Long Y
          value
String Y the value
          category
String the category

Method #7: getAccessControlList

retrieves the access control list

Request

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

sets the Access Control List

Request

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

gets an existing template by it's identifier

Request

Name Type Required Multiple Description
     sid
String Y
     templateId
Long Y

Response

Name Type Required Multiple Description
     template
WSTemplate Y
          id
Long Y unique identifier
          name
String Y
          description
String
          lastModified
String Y
          docsCount
Int the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          validation
String
          attributes
WSAttribute Y
               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

Method #10: getTemplate

gets an existing template by it's name

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y

Response

Name Type Required Multiple Description
     template
WSTemplate Y
          id
Long Y unique identifier
          name
String Y
          description
String
          lastModified
String Y
          docsCount
Int the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          validation
String
          attributes
WSAttribute Y
               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

Method #11: deleteTemplate

deletes an existing template

Request

Name Type Required Multiple Description
     sid
String Y
     templateId
Long Y

Method #12: listTemplates

lists all the templates

Request

Name Type Required Multiple Description
     sid
String Y

Response

Name Type Required Multiple Description
     template
WSTemplate Y Y
          id
Long Y unique identifier
          name
String Y
          description
String
          lastModified
String Y
          docsCount
Int the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          validation
String
          attributes
WSAttribute Y
               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

Method #13: storeTemplate

creates/updates a template; you can completely customize the template through a value object; returns the identifier of the created/updated template

Request

Name Type Required Multiple Description
     sid
String Y
     template
WSTemplate Y
          id
Long Y unique identifier
          name
String Y
          description
String
          lastModified
String Y
          docsCount
Int the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          validation
String
          attributes
WSAttribute Y
               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

Response

Name Type Required Multiple Description
     templateId
Long Y

Method #14: addAttributeOption

Adds a new option for the given attribute

Request

Name Type Required Multiple Description
     sid
String Y
     setId
Long Y
     attribute
String Y
     option
WSAttributeOption Y
          serialVersionUID
Long Y
          value
String Y the value
          category
String the category

Method #15: deleteAttributeSet

deletes an existing attribute set

Request

Name Type Required Multiple Description
     sid
String Y
     setId
Long Y

Method #16: storeAttributeSet

creates/updates an attribute set; you can completely customize the set through a value object; returns the identifier of the created/updated set

Request

Name Type Required Multiple Description
     sid
String Y
     attributeSet
WSAttributeSet Y
          id
Long Y unique identifier
          name
String Y
          description
String
          lastModified
String the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          attributes
WSAttribute Y
               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

Response

Name Type Required Multiple Description
     setId
Long Y

Method #17: getAttributeSet

gets an attribute set by it's name

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y

Response

Name Type Required Multiple Description
     attributeSet
WSAttributeSet Y
          id
Long Y unique identifier
          name
String Y
          description
String
          lastModified
String the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          attributes
WSAttribute Y
               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

Method #18: listAttributeSets

lists all the attribute sets

Request

Name Type Required Multiple Description
     sid
String Y

Response

Name Type Required Multiple Description
     attributeSet
WSAttributeSet Y Y
          id
Long Y unique identifier
          name
String Y
          description
String
          lastModified
String the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          attributes
WSAttribute Y
               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