element getWorkListItemsForView
diagram wp_diagrams/wp_p3174.png
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 <xsd:element name="getWorkListItemsForView">
 
<xsd:annotation>
   
<xsd:documentation>Request element for getWorkListItemsForView operation.</xsd:documentation>
 
</xsd:annotation>
 
<xsd:complexType>
   
<xsd:attribute name="workListViewID" type="xs:long" use="required">
     
<xsd:annotation>
       
<xsd:documentation>The ID of the work list view from which to get the page of work items.</xsd:documentation>
     
</xsd:annotation>
   
</xsd:attribute>
   
<xsd:attribute name="startPosition" type="xs:long" use="required">
     
<xsd:annotation>
       
<xsd: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.)</xsd:documentation>
     
</xsd:annotation>
   
</xsd:attribute>
   
<xsd:attribute name="numberOfItems" type="xs:long" use="required">
     
<xsd:annotation>
       
<xsd:documentation>Number of work items (in the work item list) to include in this page.</xsd:documentation>
     
</xsd:annotation>
   
</xsd:attribute>
   
<xsd:attribute name="getTotalCount" type="xs:boolean" use="optional" default="true">
     
<xsd:annotation>
       
<xsd: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).
</xsd:documentation>
     
</xsd:annotation>
   
</xsd:attribute>
   
<xsd:attribute name="getAllocatedItems" type="xs:boolean">
     
<xsd:annotation>
       
<xsd: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.</xsd:documentation>
     
</xsd:annotation>
   
</xsd:attribute>
   
<xsd:attribute name="getEnhancedAttributes" type="xs:boolean">
     
<xsd:annotation>
       
<xsd:documentation>if true return a work item with all 40 Work Item attributes, otherwise only the original 14 Work Item Attributes.</xsd:documentation>
     
</xsd:annotation>
   
</xsd:attribute>
 
</xsd:complexType>
</xsd: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 <xsd:attribute name="workListViewID" type="xs:long" use="required">
 
<xsd:annotation>
   
<xsd:documentation>The ID of the work list view from which to get the page of work items.</xsd:documentation>
 
</xsd:annotation>
</xsd: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 <xsd:attribute name="startPosition" type="xs:long" use="required">
 
<xsd:annotation>
   
<xsd: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.)</xsd:documentation>
 
</xsd:annotation>
</xsd: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 <xsd:attribute name="numberOfItems" type="xs:long" use="required">
 
<xsd:annotation>
   
<xsd:documentation>Number of work items (in the work item list) to include in this page.</xsd:documentation>
 
</xsd:annotation>
</xsd: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 <xsd:attribute name="getTotalCount" type="xs:boolean" use="optional" default="true">
 
<xsd:annotation>
   
<xsd: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).
</xsd:documentation>
 
</xsd:annotation>
</xsd: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 <xsd:attribute name="getAllocatedItems" type="xs:boolean">
 
<xsd:annotation>
   
<xsd: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.</xsd:documentation>
 
</xsd:annotation>
</xsd: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 <xsd:attribute name="getEnhancedAttributes" type="xs:boolean">
 
<xsd:annotation>
   
<xsd:documentation>if true return a work item with all 40 Work Item attributes, otherwise only the original 14 Work Item Attributes.</xsd:documentation>
 
</xsd:annotation>
</xsd:attribute>

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