Get Properties

Description

Get a set of properties associated with an object. See properties for a discussion of properties.

All properties are retrieved, including comments and private properties. Marked up properties are not formatted. Numbered list properties are not expanded.

Input

<GetProperties>
<userLogonReference>userid</userLogonReference>
<password>password</password>
<objectType>type of object</objectType>
<objectReference>reference for object</objectReference>
</GetProperties>

Output

<Properties>
<errorNumber>0</errorNumber>
<objectType>anObjectType</objectType>
<objectReference>anObjectReference</objectReference>
<objectTypeName>Object type</objectTypeName>
<objectName>Object Name</objectName>
<propertyAuthority>update|read</propertyAuthority>
<propertyReadMessage>Message</propertyReadMessage> (only when propertyAuthority is read)
<PropertyList>
<Property> (repeats)
<name>propertyName</name>
<value>Property value</value>
</Property>
</PropertyList>
</Properties>

propertyAuthority indicates whether the user can read or update the properties.  If they can only read the properties, propertyReadMessage will contain a suitable reason why.  (It may be that the user has authority but that the object is in the wrong state, for example a frozen criterion).

Properties are returned in ascending order of property name.

Errors

101 - Not authorised
102 - Not found
103 - Parameter error

Class

com.metrici.xerula.GetPropertiesService