element getWorkListItems

diagram
namespace	http://api.brm.n2.tibco.com
properties	content  complex
children	resourcesRequired entityID orderFilterCriteria
attributes	Name   Type   Use   Default   Fixed   Annotation 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). 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 getWorkListItems operation.
source	<xs:element name="getWorkListItems">   <xs:annotation>     <xs:documentation>Request element for getWorkListItems operation.</xs:documentation>   </xs:annotation>   <xs:complexType>     <xs:sequence>       <xs:choice>         <xs:annotation>           <xs:documentation>Choice allows either:- - Specifying a resourcesRequired of ALL will return a Work List for all resources. - Specifying an entityID will return aWork List for that resource only.</xs:documentation>         </xs:annotation>         <xs:element name="resourcesRequired" type="ResourcesRequiredType">           <xs:annotation>             <xs:documentation>Enumeration specifying what if any resource processing is required on the Work List.</xs:documentation>           </xs:annotation>         </xs:element>         <xs:element name="entityID" type="orgdto:XmlModelEntityId">           <xs:annotation>             <xs:documentation>ID of the organization model entity requiring a  work item list.</xs:documentation>           </xs:annotation>         </xs:element>       </xs:choice>       <xs:element name="orderFilterCriteria" type="OrderFilterCriteria" minOccurs="0">         <xs:annotation>           <xs:documentation>Specification of sort/filter criteria to be applied to the work item list.</xs:documentation>         </xs:annotation>       </xs:element>     </xs:sequence>     <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="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 getWorkListItems/@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 getWorkListItems/@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 getWorkListItems/@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 getWorkListItems/@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>

element getWorkListItems/resourcesRequired

diagram
type	ResourcesRequiredType
properties	content  simple
facets	Kind  Value  Annotation enumeration  ALL enumeration  MINE
annotation	documentation Enumeration specifying what if any resource processing is required on the Work List.
source	<xs:element name="resourcesRequired" type="ResourcesRequiredType">   <xs:annotation>     <xs:documentation>Enumeration specifying what if any resource processing is required on the Work List.</xs:documentation>   </xs:annotation> </xs:element>

element getWorkListItems/entityID

diagram
type	XmlModelEntityId
properties	content  complex
children	dynamic-id-attr qualifierSet
attributes	Name   Type   Use   Default   Fixed   Annotation model-version   xs:int   optional   -1      documentation Major version number of the organization model in which an organization model entity resides. If not specified, the default value will be the latest version of the organization model. (Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.) entity-type   OrganisationalEntityType   required         documentation Enumerated value defining the type of the organization model entity. guid   xs:string   required         documentation Globally unique ID of the organization model entity. (Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.) qualifier   xs:string   optional         documentation Only applicable in certain circumstances, and only to organization model entities whose entity-type is PRIVILEGE or CAPABILITY. These entities can have an association with other entities - for example, a resource may hold many capabilities, or a position may have many privileges. These associations can have a qualifying value, according to their nature, to differentiate them. For example, the PRIVILEGE to sign off a purchase order may be qualified with the maximum amount that can be signed off.
annotation	documentation ID of the organization model entity requiring a  work item list.
source	<xs:element name="entityID" type="orgdto:XmlModelEntityId">   <xs:annotation>     <xs:documentation>ID of the organization model entity requiring a  work item list.</xs:documentation>   </xs:annotation> </xs:element>

element getWorkListItems/orderFilterCriteria

diagram
type	OrderFilterCriteria
properties	minOcc  0 maxOcc  1 content  complex
children	order filter
annotation	documentation Specification of sort/filter criteria to be applied to the work item list.
source	<xs:element name="orderFilterCriteria" type="OrderFilterCriteria" minOccurs="0">   <xs:annotation>     <xs:documentation>Specification of sort/filter criteria to be applied to the work item list.</xs:documentation>   </xs:annotation> </xs:element>

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