diagram | |||||||||||||||||||||||||||||||||||||||
namespace | http://api.brm.n2.tibco.com | ||||||||||||||||||||||||||||||||||||||
properties |
|
||||||||||||||||||||||||||||||||||||||
children | resourcesRequired entityID orderFilterCriteria | ||||||||||||||||||||||||||||||||||||||
attributes |
|
||||||||||||||||||||||||||||||||||||||
annotation |
|
||||||||||||||||||||||||||||||||||||||
source | <xsd:element name="getWorkListItems"> <xsd:annotation> <xsd:documentation>Request element for getWorkListItems operation.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:choice> <xsd:annotation> <xsd: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.</xsd:documentation> </xsd:annotation> <xsd:element name="resourcesRequired" type="ResourcesRequiredType"> <xsd:annotation> <xsd:documentation>Enumeration specifying what if any resource processing is required on the Work List.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="entityID" type="orgdto:XmlModelEntityId"> <xsd:annotation> <xsd:documentation>ID of the organization model entity requiring a work item list.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:choice> <xsd:element name="orderFilterCriteria" type="OrderFilterCriteria" minOccurs="0"> <xsd:annotation> <xsd:documentation>Specification of sort/filter criteria to be applied to the work item list.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> <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="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> |
type | xs:long | ||
properties |
|
||
annotation |
|
||
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> |
type | xs:long | ||
properties |
|
||
annotation |
|
||
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> |
type | xs:boolean | ||||
properties |
|
||||
annotation |
|
||||
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> |
type | xs:boolean | ||
annotation |
|
||
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> |
diagram | ||||||||||
type | ResourcesRequiredType | |||||||||
properties |
|
|||||||||
facets |
|
|||||||||
annotation |
|
|||||||||
source | <xsd:element name="resourcesRequired" type="ResourcesRequiredType"> <xsd:annotation> <xsd:documentation>Enumeration specifying what if any resource processing is required on the Work List.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||||||||||||||||||||||||||||
type | XmlModelEntityId | ||||||||||||||||||||||||||||||||||||||
properties |
|
||||||||||||||||||||||||||||||||||||||
children | dynamic-id-attr qualifierSet | ||||||||||||||||||||||||||||||||||||||
attributes |
|
||||||||||||||||||||||||||||||||||||||
annotation |
|
||||||||||||||||||||||||||||||||||||||
source | <xsd:element name="entityID" type="orgdto:XmlModelEntityId"> <xsd:annotation> <xsd:documentation>ID of the organization model entity requiring a work item list.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||
type | OrderFilterCriteria | ||||||
properties |
|
||||||
children | order filter | ||||||
annotation |
|
||||||
source | <xsd:element name="orderFilterCriteria" type="OrderFilterCriteria" minOccurs="0"> <xsd:annotation> <xsd:documentation>Specification of sort/filter criteria to be applied to the work item list.</xsd:documentation> </xsd:annotation> </xsd:element> |