| diagram | ![]() |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace | http://api.brm.n2.tibco.com | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| attributes |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| annotation |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| source | <xsd:complexType name="ColumnDefinition"> <xsd:annotation> <xsd:documentation>Details of a field defined by BRM that can be used in sort/filter criteria expressions for work item lists.</xsd:documentation> </xsd:annotation> <xsd:attribute name="id" type="xs:short" use="required"> <xsd:annotation> <xsd:documentation>ID of the field.</xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="name" type="xs:string" use="optional"> <xsd:annotation> <xsd:documentation>Name of the field.</xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="description" type="xs:string" use="optional"> <xsd:annotation> <xsd:documentation>Textual description of the field.</xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="type" type="ColumnType"> <xsd:annotation> <xsd:documentation>Type of the field (for example, string or numeric).</xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="capability" type="ColumnCapability"> <xsd:annotation> <xsd:documentation>Enumerated value that defines whether the field can be used in expressions that define sort criteria and/or filter criteria.</xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="displayName" type="xs:string"> <xsd:annotation> <xsd:documentation>If requested by setting API Version > 1, then this attribute will provide the Display Name if this column is a Work Item Attribute and has an display name defined.</xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="isWorkListAttribute" type="xs:boolean"> <xsd:annotation> <xsd:documentation>If requested If requested by setting API Version > 1, this atrribute will be true if the specified field is a work list attribute.</xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> |
| type | xs:short | ||
| properties |
|
||
| annotation |
|
||
| source | <xsd:attribute name="id" type="xs:short" use="required"> <xsd:annotation> <xsd:documentation>ID of the field.</xsd:documentation> </xsd:annotation> </xsd:attribute> |
| type | xs:string | ||
| properties |
|
||
| annotation |
|
||
| source | <xsd:attribute name="name" type="xs:string" use="optional"> <xsd:annotation> <xsd:documentation>Name of the field.</xsd:documentation> </xsd:annotation> </xsd:attribute> |
| type | xs:string | ||
| properties |
|
||
| annotation |
|
||
| source | <xsd:attribute name="description" type="xs:string" use="optional"> <xsd:annotation> <xsd:documentation>Textual description of the field.</xsd:documentation> </xsd:annotation> </xsd:attribute> |
| type | ColumnType | ||||||||||||||||||||||||
| facets |
|
||||||||||||||||||||||||
| annotation |
|
||||||||||||||||||||||||
| source | <xsd:attribute name="type" type="ColumnType"> <xsd:annotation> <xsd:documentation>Type of the field (for example, string or numeric).</xsd:documentation> </xsd:annotation> </xsd:attribute> |
| type | ColumnCapability | |||||||||||||||
| facets |
|
|||||||||||||||
| annotation |
|
|||||||||||||||
| source | <xsd:attribute name="capability" type="ColumnCapability"> <xsd:annotation> <xsd:documentation>Enumerated value that defines whether the field can be used in expressions that define sort criteria and/or filter criteria.</xsd:documentation> </xsd:annotation> </xsd:attribute> |
| type | xs:string | ||
| annotation |
|
||
| source | <xsd:attribute name="displayName" type="xs:string"> <xsd:annotation> <xsd:documentation>If requested by setting API Version > 1, then this attribute will provide the Display Name if this column is a Work Item Attribute and has an display name defined.</xsd:documentation> </xsd:annotation> </xsd:attribute> |
| type | xs:boolean | ||
| annotation |
|
||
| source | <xsd:attribute name="isWorkListAttribute" type="xs:boolean"> <xsd:annotation> <xsd:documentation>If requested If requested by setting API Version > 1, this atrribute will be true if the specified field is a work list attribute.</xsd:documentation> </xsd:annotation> </xsd:attribute> |