Webservice: Document Metadata

handling of templates and attribute sets [Commercial editions only]

Index Method Request(s) Response Description
1 deleteTemplate sid
templateId
 deletes an existing template
2 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
3 listTemplates sid
 template lists all the templates
4 getTemplateById sid
templateId
 template gets an existing template by it's identifier
5 getAttributeSet sid
name
 attributeSet gets an attribute set by it's name
6 getTemplate sid
name
 template gets an existing template by it's name
7 listAttributeSets sid
 attributeSet lists all the attribute sets
8 getAttributeSetById sid
setId
 attributeSet gets an attribute set by it's identifier
9 deleteAttributeSet sid
setId
 deletes an existing attribute set
10 getAttributeOptions sid
setId
attribute
 retrieves the options for the given attribute
11 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
12 setAttributeOptions sid
setId
attribute
values
 saves the options for the given attribute

Method #1: deleteTemplate

deletes an existing template

Request

Name Type Required Multiple Description
     sid
String Y
     templateId
Long Y

Method #2: 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')
          attributes
WSAttribute Y
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set

Response

Name Type Required Multiple Description
     templateId
Long Y

Method #3: 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')
          attributes
WSAttribute Y
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set

Method #4: 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')
          attributes
WSAttribute Y
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set

Method #5: 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
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set

Method #6: 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')
          attributes
WSAttribute Y
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set

Method #7: 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
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set

Method #8: 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
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set

Method #9: deleteAttributeSet

deletes an existing attribute set

Request

Name Type Required Multiple Description
     sid
String Y
     setId
Long Y

Method #10: 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 #11: 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
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1)
               mandatory
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set

Response

Name Type Required Multiple Description
     setId
Long Y

Method #12: setAttributeOptions

saves the options for the given attribute

Request

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