complexType BaseWorkRequest

diagram |
namespace | http://base.api.wp.n2.tibco.com
type | extension of BaseRequest
properties |
base | BaseRequest
children | resourceId channelId channelType responsePayloadMode workListViewId getGlobalValues workItem workTypeDetail
used by |
element | baseWorkRequest
complexType | WorkRequest
attributes |
Name | Type | Use | Default | Fixed | Annotation
action | ActionType |  |  |  |
documentation
** PRIVATE API - Reserved for internal use** Defines the action for this request. (This is only required when calling WP Extender Servlet Chaning mechanism.)
annotation |
documentation
Base work request to retrieve details of a work item.
source | <xs:complexType name="BaseWorkRequest"> <xs:annotation> <xs:documentation>Base work request to retrieve details of a work item.</xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="BaseRequest"> <xs:sequence> <xs:element name="workItem" type="WorkItem"> <xs:annotation> <xs:documentation>Identifier of the work item on which the operation is to be performed.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="workTypeDetail"> <xs:annotation> <xs:documentation>Details of the work type associated with the specified work item. Note: workTypeDetail information is not mandatory for openWorkItem or cancelWorkItem operations.</xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="WorkType"> <xs:attribute name="openNextPiled" type="xs:boolean" default="true"> <xs:annotation> <xs:documentation>Boolean value specifying whether (if the current work item is piled) the next piled work item should be opened. This parameter is not applicable to openWorkItem, cancelWorkItem or closeWorkItem operations. It is currently only applicable to completeWorkItem.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>

element BaseWorkRequest/workItem

diagram |
type | WorkItem
properties |
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
id | xs:long | required |  |  |
documentation
Unique ID of the work item.
version | xs:long |  | -1 |  |
documentation
Version number of the work item.
annotation |
documentation
Identifier of the work item on which the operation is to be performed.
source | <xs:element name="workItem" type="WorkItem"> <xs:annotation> <xs:documentation>Identifier of the work item on which the operation is to be performed.</xs:documentation> </xs:annotation> </xs:element>

element BaseWorkRequest/workTypeDetail

diagram |
type | extension of WorkType
properties |
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
uid | xs:string | required |  |  |
documentation
Unique ID of the work type.
version | xs:string | required |  |  |
documentation
Version number of the work type.
openNextPiled | xs:boolean |  | true |  |
documentation
Boolean value specifying whether (if the current work item is piled) the next piled work item should be opened. This parameter is not applicable to openWorkItem, cancelWorkItem or closeWorkItem operations. It is currently only applicable to completeWorkItem.
annotation |
documentation
Details of the work type associated with the specified work item. Note: workTypeDetail information is not mandatory for openWorkItem or cancelWorkItem operations.
source | <xs:element name="workTypeDetail"> <xs:annotation> <xs:documentation>Details of the work type associated with the specified work item. Note: workTypeDetail information is not mandatory for openWorkItem or cancelWorkItem operations.</xs:documentation> </xs:annotation> <xs:complexType> <xs:complexContent> <xs:extension base="WorkType"> <xs:attribute name="openNextPiled" type="xs:boolean" default="true"> <xs:annotation> <xs:documentation>Boolean value specifying whether (if the current work item is piled) the next piled work item should be opened. This parameter is not applicable to openWorkItem, cancelWorkItem or closeWorkItem operations. It is currently only applicable to completeWorkItem.</xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType> </xs:element>

attribute BaseWorkRequest/workTypeDetail/@openNextPiled

type | xs:boolean
properties |
default | true
annotation |
documentation
Boolean value specifying whether (if the current work item is piled) the next piled work item should be opened. This parameter is not applicable to openWorkItem, cancelWorkItem or closeWorkItem operations. It is currently only applicable to completeWorkItem.
source | <xs:attribute name="openNextPiled" type="xs:boolean" default="true"> <xs:annotation> <xs:documentation>Boolean value specifying whether (if the current work item is piled) the next piled work item should be opened. This parameter is not applicable to openWorkItem, cancelWorkItem or closeWorkItem operations. It is currently only applicable to completeWorkItem.</xs:documentation> </xs:annotation> </xs:attribute>

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