diagram | |||||||||||||||
namespace | http://api.wp.n2.tibco.com | ||||||||||||||
type | extension of Success | ||||||||||||||
properties |
|
||||||||||||||
children | payloadModel workTypeDetail presentation workItem pageFlowDetail | ||||||||||||||
attributes |
|
||||||||||||||
annotation |
|
||||||||||||||
source | <xsd:element name="workResponse"> <xsd:annotation> <xsd:documentation>Response element for cancelWorkItem, closeWorkItem, completeWorkItem, openWorkItem and openNextWorkItem operations.</xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:complexContent> <xsd:extension base="base:Success"> <xsd:sequence> <xsd:element name="payloadModel" type="df:dataPayload" nillable="true" minOccurs="0"> <xsd:annotation> <xsd:documentation>If the work item displays: - a form: payloadModel contains the data payload for the specified work item. - a pageflow: payloadModel is not used. (In this case, the data payload for the first page of the pageflow must be obtained separately by using a startPageFlow operation.) </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="workTypeDetail" nillable="true" minOccurs="0"> <xsd:annotation> <xsd:documentation>Details of the work type associated with this work item. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:complexContent> <xsd:extension base="base:WorkType"> <xsd:sequence> <xsd:element name="dataModel" type="dm:DataModel" minOccurs="0"> <xsd:annotation> <xsd:documentation>** PRIVATE API - Reserved for internal use **</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> <xsd:attribute name="typePiled" type="xs:boolean" use="required"> <xsd:annotation> <xsd:documentation>Boolean value specifying whether this work type is a piled work type.</xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="pilingLimit" type="xs:int"> <xsd:annotation> <xsd:documentation>Maximum number of piled work items of this work type (pecified only or a piled work type).</xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> <xsd:element name="presentation" nillable="true" minOccurs="0"> <xsd:annotation> <xsd:documentation>If the work item displays: - a form: presentation contains details of the form artifact associated with this work item. - a pageflow: presentation is not used. (In this case, the form artifact details for the pageflow are contained in thePageFlowDetail element.) </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:attribute name="type" use="required"> <xsd:annotation> <xsd:documentation>Type of form artifact. One of: - GWT_FORM - GI_FORM - PAGEFLOW - CUSTOM_FORM - FORM </xsd:documentation> </xsd:annotation> <xsd:simpleType> <xsd:restriction base="xs:string"> <xsd:enumeration value="GWT_FORM"/> <xsd:enumeration value="GI_FORM"/> <xsd:enumeration value="PAGEFLOW"/> <xsd:enumeration value="CUSTOM_FORM"/> <xsd:enumeration value="FORM"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attribute name="formIdenitifier" type="xs:string" use="optional"> <xsd:annotation> <xsd:documentation>Identifier for the JSON form artifact to be used to display the data for the work item. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="activityName" type="xs:string" use="optional"> <xsd:annotation> <xsd:documentation>Name of the process activity from which the work item was generated. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="version" type="xs:string"> <xsd:annotation> <xsd:documentation>Version number of the form artifact.</xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> </xsd:element> <xsd:element name="workItem" type="base:WorkItem" nillable="true" minOccurs="0"> <xsd:annotation> <xsd:documentation>In a response to a: - cancelWorkItem, closeWorkItem, openWorkItem or openNextWorkItem operation: Identifier of this work item. - completeWorkItem operation: Identifier of the next work item, if this work item is part of a chained group or is a piled work item. (If it is not, workItem is not returned.) </xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="pageFlowDetail" type="wp:pageFlowType" minOccurs="0"> <xsd:annotation> <xsd:documentation>Details of the pageflow (if the work item displays a pageflow).</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> |
diagram | |||||||||||||||
type | dataPayload | ||||||||||||||
properties |
|
||||||||||||||
children | serializedPayload XmlPayload | ||||||||||||||
attributes |
|
||||||||||||||
annotation |
|
||||||||||||||
source | <xsd:element name="payloadModel" type="df:dataPayload" nillable="true" minOccurs="0"> <xsd:annotation> <xsd:documentation>If the work item displays: - a form: payloadModel contains the data payload for the specified work item. - a pageflow: payloadModel is not used. (In this case, the data payload for the first page of the pageflow must be obtained separately by using a startPageFlow operation.) </xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||||||||||||||||||||||||||||
type | extension of WorkType | ||||||||||||||||||||||||||||||||||||||
properties |
|
||||||||||||||||||||||||||||||||||||||
children | dataModel | ||||||||||||||||||||||||||||||||||||||
attributes |
|
||||||||||||||||||||||||||||||||||||||
annotation |
|
||||||||||||||||||||||||||||||||||||||
source | <xsd:element name="workTypeDetail" nillable="true" minOccurs="0"> <xsd:annotation> <xsd:documentation>Details of the work type associated with this work item. </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:complexContent> <xsd:extension base="base:WorkType"> <xsd:sequence> <xsd:element name="dataModel" type="dm:DataModel" minOccurs="0"> <xsd:annotation> <xsd:documentation>** PRIVATE API - Reserved for internal use **</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> <xsd:attribute name="typePiled" type="xs:boolean" use="required"> <xsd:annotation> <xsd:documentation>Boolean value specifying whether this work type is a piled work type.</xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="pilingLimit" type="xs:int"> <xsd:annotation> <xsd:documentation>Maximum number of piled work items of this work type (pecified only or a piled work type).</xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> |
type | xs:boolean | ||
properties |
|
||
annotation |
|
||
source | <xsd:attribute name="typePiled" type="xs:boolean" use="required"> <xsd:annotation> <xsd:documentation>Boolean value specifying whether this work type is a piled work type.</xsd:documentation> </xsd:annotation> </xsd:attribute> |
type | xs:int | ||
annotation |
|
||
source | <xsd:attribute name="pilingLimit" type="xs:int"> <xsd:annotation> <xsd:documentation>Maximum number of piled work items of this work type (pecified only or a piled work type).</xsd:documentation> </xsd:annotation> </xsd:attribute> |
diagram | |||||||
type | DataModel | ||||||
properties |
|
||||||
children | inputs outputs inouts | ||||||
annotation |
|
||||||
source | <xsd:element name="dataModel" type="dm:DataModel" minOccurs="0"> <xsd:annotation> <xsd:documentation>** PRIVATE API - Reserved for internal use **</xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||||||||||||||||||||||||||||
properties |
|
||||||||||||||||||||||||||||||||||||||
attributes |
|
||||||||||||||||||||||||||||||||||||||
annotation |
|
||||||||||||||||||||||||||||||||||||||
source | <xsd:element name="presentation" nillable="true" minOccurs="0"> <xsd:annotation> <xsd:documentation>If the work item displays: - a form: presentation contains details of the form artifact associated with this work item. - a pageflow: presentation is not used. (In this case, the form artifact details for the pageflow are contained in thePageFlowDetail element.) </xsd:documentation> </xsd:annotation> <xsd:complexType> <xsd:attribute name="type" use="required"> <xsd:annotation> <xsd:documentation>Type of form artifact. One of: - GWT_FORM - GI_FORM - PAGEFLOW - CUSTOM_FORM - FORM </xsd:documentation> </xsd:annotation> <xsd:simpleType> <xsd:restriction base="xs:string"> <xsd:enumeration value="GWT_FORM"/> <xsd:enumeration value="GI_FORM"/> <xsd:enumeration value="PAGEFLOW"/> <xsd:enumeration value="CUSTOM_FORM"/> <xsd:enumeration value="FORM"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> <xsd:attribute name="formIdenitifier" type="xs:string" use="optional"> <xsd:annotation> <xsd:documentation>Identifier for the JSON form artifact to be used to display the data for the work item. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="activityName" type="xs:string" use="optional"> <xsd:annotation> <xsd:documentation>Name of the process activity from which the work item was generated. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="version" type="xs:string"> <xsd:annotation> <xsd:documentation>Version number of the form artifact.</xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> </xsd:element> |
type | restriction of xs:string | ||||||||||||||||||
properties |
|
||||||||||||||||||
facets |
|
||||||||||||||||||
annotation |
|
||||||||||||||||||
source | <xsd:attribute name="type" use="required"> <xsd:annotation> <xsd:documentation>Type of form artifact. One of: - GWT_FORM - GI_FORM - PAGEFLOW - CUSTOM_FORM - FORM </xsd:documentation> </xsd:annotation> <xsd:simpleType> <xsd:restriction base="xs:string"> <xsd:enumeration value="GWT_FORM"/> <xsd:enumeration value="GI_FORM"/> <xsd:enumeration value="PAGEFLOW"/> <xsd:enumeration value="CUSTOM_FORM"/> <xsd:enumeration value="FORM"/> </xsd:restriction> </xsd:simpleType> </xsd:attribute> |
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xsd:attribute name="formIdenitifier" type="xs:string" use="optional"> <xsd:annotation> <xsd:documentation>Identifier for the JSON form artifact to be used to display the data for the work item. </xsd:documentation> </xsd:annotation> </xsd:attribute> |
type | xs:string | ||
properties |
|
||
annotation |
|
||
source | <xsd:attribute name="activityName" type="xs:string" use="optional"> <xsd:annotation> <xsd:documentation>Name of the process activity from which the work item was generated. </xsd:documentation> </xsd:annotation> </xsd:attribute> |
type | xs:string | ||
annotation |
|
||
source | <xsd:attribute name="version" type="xs:string"> <xsd:annotation> <xsd:documentation>Version number of the form artifact.</xsd:documentation> </xsd:annotation> </xsd:attribute> |
diagram | |||||||||||||||||||||||
type | WorkItem | ||||||||||||||||||||||
properties |
|
||||||||||||||||||||||
attributes |
|
||||||||||||||||||||||
annotation |
|
||||||||||||||||||||||
source | <xsd:element name="workItem" type="base:WorkItem" nillable="true" minOccurs="0"> <xsd:annotation> <xsd:documentation>In a response to a: - cancelWorkItem, closeWorkItem, openWorkItem or openNextWorkItem operation: Identifier of this work item. - completeWorkItem operation: Identifier of the next work item, if this work item is part of a chained group or is a piled work item. (If it is not, workItem is not returned.) </xsd:documentation> </xsd:annotation> </xsd:element> |
diagram | |||||||||||||||||||||||||||||||||||||||||||||||
type | wp:pageFlowType | ||||||||||||||||||||||||||||||||||||||||||||||
properties |
|
||||||||||||||||||||||||||||||||||||||||||||||
children | wp:page-activity | ||||||||||||||||||||||||||||||||||||||||||||||
attributes |
|
||||||||||||||||||||||||||||||||||||||||||||||
annotation |
|
||||||||||||||||||||||||||||||||||||||||||||||
source | <xsd:element name="pageFlowDetail" type="wp:pageFlowType" minOccurs="0"> <xsd:annotation> <xsd:documentation>Details of the pageflow (if the work item displays a pageflow).</xsd:documentation> </xsd:annotation> </xsd:element> |