element getWorkListItemsForViewResponse

diagram |
namespace | http://api.brm.n2.tibco.com
properties |
content | complex
children | startPosition endPosition totalItems workListFacade workItems customData
annotation |
documentation
Response element for the getWorkListItemsForView operation.
source | <xs:element name="getWorkListItemsForViewResponse"> <xs:annotation> <xs:documentation>Response element for the getWorkListItemsForView operation.</xs:documentation> </xs:annotation> <xs:complexType> <xs:annotation> <xs:documentation>Contains a page of work item returned from a user request.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="startPosition" type="xs:long"> <xs:annotation> <xs:documentation>Position in the work item list of the first work item on this page.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="endPosition" type="xs:long"> <xs:annotation> <xs:documentation>Position in the work item list of the last work item on this page.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="totalItems" type="xs:long"> <xs:annotation> <xs:documentation>The value returned in this attribute depends on the value specified for the getTotalCount attribute in the request. If: - getTotalCount was 'true', totalItems returns the total number of work items in the work item list. - getTotalCount was 'false', totalItems returns -1 if the work item list contains at least one work item, or 0 (zero) if the work item list is empty.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="workListFacade" type="WorkListFacade" minOccurs="0"> <xs:annotation> <xs:documentation>If the request is made with getEnhancedAttributes set, and any are defined then this will list any display names that are specified for any Work Item Attributes.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="workItems" type="WorkItem" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Complete details of each work item in this page of the work item list.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="customData" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>A string attribute the caller can use to provide and custom data they wish to store with the work list view. BRM will not look at or use this attribute value but will just store it with the work view definition. If storing XML data the value should be wrapped in a CDATA section.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:element>

element getWorkListItemsForViewResponse/startPosition

diagram |
type | xs:long
properties |
content | simple
annotation |
documentation
Position in the work item list of the first work item on this page.
source | <xs:element name="startPosition" type="xs:long"> <xs:annotation> <xs:documentation>Position in the work item list of the first work item on this page.</xs:documentation> </xs:annotation> </xs:element>

element getWorkListItemsForViewResponse/endPosition

diagram |
type | xs:long
properties |
content | simple
annotation |
documentation
Position in the work item list of the last work item on this page.
source | <xs:element name="endPosition" type="xs:long"> <xs:annotation> <xs:documentation>Position in the work item list of the last work item on this page.</xs:documentation> </xs:annotation> </xs:element>

element getWorkListItemsForViewResponse/totalItems

diagram |
type | xs:long
properties |
content | simple
annotation |
documentation
The value returned in this attribute depends on the value specified for the getTotalCount attribute in the request. If: - getTotalCount was 'true', totalItems returns the total number of work items in the work item list. - getTotalCount was 'false', totalItems returns -1 if the work item list contains at least one work item, or 0 (zero) if the work item list is empty.
source | <xs:element name="totalItems" type="xs:long"> <xs:annotation> <xs:documentation>The value returned in this attribute depends on the value specified for the getTotalCount attribute in the request. If: - getTotalCount was 'true', totalItems returns the total number of work items in the work item list. - getTotalCount was 'false', totalItems returns -1 if the work item list contains at least one work item, or 0 (zero) if the work item list is empty.</xs:documentation> </xs:annotation> </xs:element>

element getWorkListItemsForViewResponse/workListFacade

diagram |
type | WorkListFacade
properties |
minOcc | 0
maxOcc | 1
content | complex
children | facade
annotation |
documentation
If the request is made with getEnhancedAttributes set, and any are defined then this will list any display names that are specified for any Work Item Attributes.
source | <xs:element name="workListFacade" type="WorkListFacade" minOccurs="0"> <xs:annotation> <xs:documentation>If the request is made with getEnhancedAttributes set, and any are defined then this will list any display names that are specified for any Work Item Attributes.</xs:documentation> </xs:annotation> </xs:element>

element getWorkListItemsForViewResponse/workItems

diagram |
type | WorkItem
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | id header attributes body workType state visible
annotation |
documentation
Complete details of each work item in this page of the work item list.
source | <xs:element name="workItems" type="WorkItem" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Complete details of each work item in this page of the work item list.</xs:documentation> </xs:annotation> </xs:element>

element getWorkListItemsForViewResponse/customData

diagram |
type | xs:string
properties |
minOcc | 0
maxOcc | 1
content | simple
annotation |
documentation
A string attribute the caller can use to provide and custom data they wish to store with the work list view. BRM will not look at or use this attribute value but will just store it with the work view definition. If storing XML data the value should be wrapped in a CDATA section.
source | <xs:element name="customData" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation>A string attribute the caller can use to provide and custom data they wish to store with the work list view. BRM will not look at or use this attribute value but will just store it with the work view definition. If storing XML data the value should be wrapped in a CDATA section.</xs:documentation> </xs:annotation> </xs:element>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy