element getWorkListItemsForView

diagram |
namespace | http://api.brm.n2.tibco.com
properties |
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
workListViewID | xs:long | required |  |  |
documentation
The ID of the work list view from which to get the page of work items.
startPosition | xs:long | required |  |  |
documentation
Position in the work item list from which to start this page. (The list is zero-based. To start at the first item, specify 0.)
numberOfItems | xs:long | required |  |  |
documentation
Number of work items (in the work item list) to include in this page.
getTotalCount | xs:boolean | optional | true |  |
documentation
Boolean defining whether BRM builds a count of the total number of work items in the work item list. If ‘false’ is passed in this attribute, and: - there is at least one item in the list, the totalItems value returned in the response is -1. - there are no work items in the list, the totalItems value returned in the response is 0 (zero).
getAllocatedItems | xs:boolean |  |  |  |
documentation
Optional default behaviour is false. If true then this is a request for allocated Work Items. If false then the request is for offered Work Items.
getEnhancedAttributes | xs:boolean |  |  |  |
documentation
if true return a work item with all 40 Work Item attributes, otherwise only the original 14 Work Item Attributes.
annotation |
documentation
Request element for getWorkListItemsForView operation.
source | <xs:element name="getWorkListItemsForView"> <xs:annotation> <xs:documentation>Request element for getWorkListItemsForView operation.</xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="workListViewID" type="xs:long" use="required"> <xs:annotation> <xs:documentation>The ID of the work list view from which to get the page of work items.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="startPosition" type="xs:long" use="required"> <xs:annotation> <xs:documentation>Position in the work item list from which to start this page. (The list is zero-based. To start at the first item, specify 0.)</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="numberOfItems" type="xs:long" use="required"> <xs:annotation> <xs:documentation>Number of work items (in the work item list) to include in this page.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="getTotalCount" type="xs:boolean" use="optional" default="true"> <xs:annotation> <xs:documentation>Boolean defining whether BRM builds a count of the total number of work items in the work item list. If ‘false’ is passed in this attribute, and: - there is at least one item in the list, the totalItems value returned in the response is -1. - there are no work items in the list, the totalItems value returned in the response is 0 (zero).</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="getAllocatedItems" type="xs:boolean"> <xs:annotation> <xs:documentation>Optional default behaviour is false. If true then this is a request for allocated Work Items. If false then the request is for offered Work Items.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="getEnhancedAttributes" type="xs:boolean"> <xs:annotation> <xs:documentation>if true return a work item with all 40 Work Item attributes, otherwise only the original 14 Work Item Attributes.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element>

attribute getWorkListItemsForView/@workListViewID

type | xs:long
properties |
use | required
annotation |
documentation
The ID of the work list view from which to get the page of work items.
source | <xs:attribute name="workListViewID" type="xs:long" use="required"> <xs:annotation> <xs:documentation>The ID of the work list view from which to get the page of work items.</xs:documentation> </xs:annotation> </xs:attribute>

attribute getWorkListItemsForView/@startPosition

type | xs:long
properties |
use | required
annotation |
documentation
Position in the work item list from which to start this page. (The list is zero-based. To start at the first item, specify 0.)
source | <xs:attribute name="startPosition" type="xs:long" use="required"> <xs:annotation> <xs:documentation>Position in the work item list from which to start this page. (The list is zero-based. To start at the first item, specify 0.)</xs:documentation> </xs:annotation> </xs:attribute>

attribute getWorkListItemsForView/@numberOfItems

type | xs:long
properties |
use | required
annotation |
documentation
Number of work items (in the work item list) to include in this page.
source | <xs:attribute name="numberOfItems" type="xs:long" use="required"> <xs:annotation> <xs:documentation>Number of work items (in the work item list) to include in this page.</xs:documentation> </xs:annotation> </xs:attribute>

attribute getWorkListItemsForView/@getTotalCount

type | xs:boolean
properties |
use | optional
default | true
annotation |
documentation
Boolean defining whether BRM builds a count of the total number of work items in the work item list. If ‘false’ is passed in this attribute, and: - there is at least one item in the list, the totalItems value returned in the response is -1. - there are no work items in the list, the totalItems value returned in the response is 0 (zero).
source | <xs:attribute name="getTotalCount" type="xs:boolean" use="optional" default="true"> <xs:annotation> <xs:documentation>Boolean defining whether BRM builds a count of the total number of work items in the work item list. If ‘false’ is passed in this attribute, and: - there is at least one item in the list, the totalItems value returned in the response is -1. - there are no work items in the list, the totalItems value returned in the response is 0 (zero).</xs:documentation> </xs:annotation> </xs:attribute>

attribute getWorkListItemsForView/@getAllocatedItems

type | xs:boolean
annotation |
documentation
Optional default behaviour is false. If true then this is a request for allocated Work Items. If false then the request is for offered Work Items.
source | <xs:attribute name="getAllocatedItems" type="xs:boolean"> <xs:annotation> <xs:documentation>Optional default behaviour is false. If true then this is a request for allocated Work Items. If false then the request is for offered Work Items.</xs:documentation> </xs:annotation> </xs:attribute>

attribute getWorkListItemsForView/@getEnhancedAttributes

type | xs:boolean
annotation |
documentation
if true return a work item with all 40 Work Item attributes, otherwise only the original 14 Work Item Attributes.
source | <xs:attribute name="getEnhancedAttributes" type="xs:boolean"> <xs:annotation> <xs:documentation>if true return a work item with all 40 Work Item attributes, otherwise only the original 14 Work Item Attributes.</xs:documentation> </xs:annotation> </xs:attribute>

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