diagram | |||
namespace | http://api.wp.n2.tibco.com | ||
properties |
|
||
children | payloadMode previewWorkItemFromList channelId channelType | ||
annotation |
|
||
source | <xsd:element name="previewWorkItemRequest"> <xsd:annotation> <xsd:documentation>Request element for previewing a workItem</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element name="payloadMode" type="df:payloadModeType" default="JSON"> <xsd:annotation> <xsd:documentation>Enumerated value defining the format of the data payload to be used in the response message (XML or JSON). If none is specified , it defaults to JSON If not specified, the default value is JSON. (RSS is currently not supported.)</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="previewWorkItemFromList"> <xsd:annotation> <xsd:documentation>Request element for previewWorkItemFromList operation.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element name="entityID" type="orgdto:XmlModelEntityId"> <xsd:annotation> <xsd:documentation>ID of the organization model entity for whom work items are to be previewed.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="workItemID" type="brm:ObjectID" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>ID of a work item to be previewed.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="requiredField" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>Fieldname to be included in the returned data. This defines the set of fields for which preview data is to be to be returned: - If any fieldnames are specified, only those fields will be returned for each work item. - If no fieldnames are specified, all fields will be returned for each work item.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="channelId" type="xs:string"> <xsd:annotation> <xsd:documentation>Identifier of the channel to which the requesting client application is bound. See "Identifying the Client Channel in a Service Call" in the BPM Developer Guide for more information.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="channelType" type="ct:ChannelType"> <xsd:annotation> <xsd:documentation>Enumerated value defining the channel type (technology) associated with the specified channelId. One of: - openspaceChannel - MobileChannel - GIChannel - EmailChannel See "Identifying the Client Channel in a Service Call" in the BPM Developer Guide for more information. Note: JSPChannel, PageflowChannel and RssChannel are currently not supported.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </xsd:element> |
diagram | |||||||||||||
type | payloadModeType | ||||||||||||
properties |
|
||||||||||||
facets |
|
||||||||||||
annotation |
|
||||||||||||
source | <xsd:element name="payloadMode" type="df:payloadModeType" default="JSON"> <xsd:annotation> <xsd:documentation>Enumerated value defining the format of the data payload to be used in the response message (XML or JSON). If none is specified , it defaults to JSON If not specified, the default value is JSON. (RSS is currently not supported.)</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||
properties |
|
||
children | entityID workItemID requiredField | ||
annotation |
|
||
source | <xsd:element name="previewWorkItemFromList"> <xsd:annotation> <xsd:documentation>Request element for previewWorkItemFromList operation.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:sequence> <xsd:element name="entityID" type="orgdto:XmlModelEntityId"> <xsd:annotation> <xsd:documentation>ID of the organization model entity for whom work items are to be previewed.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="workItemID" type="brm:ObjectID" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>ID of a work item to be previewed.</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="requiredField" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>Fieldname to be included in the returned data. This defines the set of fields for which preview data is to be to be returned: - If any fieldnames are specified, only those fields will be returned for each work item. - If no fieldnames are specified, all fields will be returned for each work item.</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> </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 for whom work items are to be previewed.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||||
type | ObjectID | ||||||||||||||
properties |
|
||||||||||||||
attributes |
|
||||||||||||||
annotation |
|
||||||||||||||
source | <xsd:element name="workItemID" type="brm:ObjectID" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>ID of a work item to be previewed.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||
type | xs:string | ||||||
properties |
|
||||||
annotation |
|
||||||
source | <xsd:element name="requiredField" type="xs:string" minOccurs="0" maxOccurs="unbounded"> <xsd:annotation> <xsd:documentation>Fieldname to be included in the returned data. This defines the set of fields for which preview data is to be to be returned: - If any fieldnames are specified, only those fields will be returned for each work item. - If no fieldnames are specified, all fields will be returned for each work item.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xsd:element name="channelId" type="xs:string"> <xsd:annotation> <xsd:documentation>Identifier of the channel to which the requesting client application is bound. See "Identifying the Client Channel in a Service Call" in the BPM Developer Guide for more information.</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||||||||||||||
type | ChannelType | ||||||||||||||||||||||||
properties |
|
||||||||||||||||||||||||
facets |
|
||||||||||||||||||||||||
annotation |
|
||||||||||||||||||||||||
source | <xsd:element name="channelType" type="ct:ChannelType"> <xsd:annotation> <xsd:documentation>Enumerated value defining the channel type (technology) associated with the specified channelId. One of: - openspaceChannel - MobileChannel - GIChannel - EmailChannel See "Identifying the Client Channel in a Service Call" in the BPM Developer Guide for more information. Note: JSPChannel, PageflowChannel and RssChannel are currently not supported.</xsd:documentation> </xsd:annotation> </xsd:element> |