Webservice: Document Metadata

---

Method #1: 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)
mandatory		Int		Y
hidden		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
stringValues		String						Read only. In case of multiple string values, contains the values separated by a comma

---

Method #2: 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						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
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
stringValues		String						Read only. In case of multiple string values, contains the values separated by a comma

---

Method #3: 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						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
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
stringValues		String						Read only. In case of multiple string values, contains the values separated by a comma

---

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						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
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
stringValues		String						Read only. In case of multiple string values, contains the values separated by a comma

---

Method #5: 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

---

Method #6: 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 #7: 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						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
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
stringValues		String						Read only. In case of multiple string values, contains the values separated by a comma

Response

Name		Type		Required		Multiple		Description
templateId		Long		Y

---

Method #8: deleteAttributeSet

deletes an existing attribute set

Request

Name		Type		Required		Multiple		Description
sid		String		Y
setId		Long		Y

---

Method #9: 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)
mandatory		Int		Y
hidden		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
stringValues		String						Read only. In case of multiple string values, contains the values separated by a comma

---

Method #10: 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)
mandatory		Int		Y
hidden		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
stringValues		String						Read only. In case of multiple string values, contains the values separated by a comma

Response

Name		Type		Required		Multiple		Description
setId		Long		Y

---

Method #11: 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)
mandatory		Int		Y
hidden		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
stringValues		String						Read only. In case of multiple string values, contains the values separated by a comma

---

Method #12: deleteTemplate

deletes an existing template

Request

Name		Type		Required		Multiple		Description
sid		String		Y
templateId		Long		Y