wp - previewWorkItemRequest

element previewWorkItemRequest

diagram

namespace

http://api.wp.n2.tibco.com

properties

content

complex

children

payloadMode previewWorkItemFromList channelId channelType

annotation

documentation

Request element for previewing a workItem

source

<xs:element name="previewWorkItemRequest">
<xs:annotation>
    <xs:documentation>Request element for previewing a workItem</xs:documentation>
</xs:annotation>
<xs:complexType>
    <xs:sequence>
      <xs:element name="payloadMode" type="df:payloadModeType" default="JSON">
        <xs:annotation>
          <xs: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.)</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="previewWorkItemFromList">
        <xs:annotation>
          <xs:documentation>Request element for previewWorkItemFromList operation.</xs:documentation>
        </xs:annotation>
        <xs:complexType>
          <xs:sequence>
            <xs:element name="entityID" type="orgdto:XmlModelEntityId">
              <xs:annotation>
                <xs:documentation>ID of the organization model entity for whom work items are to be previewed.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="workItemID" type="brm:ObjectID" maxOccurs="unbounded">
              <xs:annotation>
                <xs:documentation>ID of a work item to be previewed.</xs:documentation>
              </xs:annotation>
            </xs:element>
            <xs:element name="requiredField" type="xs:string" minOccurs="0" maxOccurs="unbounded">
              <xs:annotation>
                <xs: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.</xs:documentation>
              </xs:annotation>
            </xs:element>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
      <xs:element name="channelId" type="xs:string">
        <xs:annotation>
          <xs: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.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="channelType" type="ct:ChannelType">
        <xs:annotation>
          <xs: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.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
</xs:complexType>
</xs:element>

element previewWorkItemRequest/payloadMode

diagram

type

payloadModeType

properties

content	simple
default	JSON

facets

Kind	Value	Annotation
enumeration	XML
enumeration	JSON
enumeration	RSS

annotation

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.)

source

<xs:element name="payloadMode" type="df:payloadModeType" default="JSON">
<xs:annotation>
<xs: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.)</xs:documentation>
</xs:annotation>
</xs:element>

element previewWorkItemRequest/previewWorkItemFromList

diagram

properties

content

complex

children

entityID workItemID requiredField

annotation

documentation

Request element for previewWorkItemFromList operation.

source

<xs:element name="previewWorkItemFromList">
<xs:annotation>
    <xs:documentation>Request element for previewWorkItemFromList operation.</xs:documentation>
</xs:annotation>
<xs:complexType>
    <xs:sequence>
      <xs:element name="entityID" type="orgdto:XmlModelEntityId">
        <xs:annotation>
          <xs:documentation>ID of the organization model entity for whom work items are to be previewed.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="workItemID" type="brm:ObjectID" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>ID of a work item to be previewed.</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="requiredField" type="xs:string" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs: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.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
</xs:complexType>
</xs:element>

element previewWorkItemRequest/previewWorkItemFromList/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 for whom work items are to be previewed.

source

<xs:element name="entityID" type="orgdto:XmlModelEntityId">
<xs:annotation>
<xs:documentation>ID of the organization model entity for whom work items are to be previewed.</xs:documentation>
</xs:annotation>
</xs:element>

element previewWorkItemRequest/previewWorkItemFromList/workItemID

diagram

type

ObjectID

properties

minOcc	1
maxOcc	unbounded
content	complex

attributes

Name

Type

Use

Default

Fixed

Annotation

xs:long

required

documentation

Unique ID of the work item.

annotation

documentation

ID of a work item to be previewed.

source

<xs:element name="workItemID" type="brm:ObjectID" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>ID of a work item to be previewed.</xs:documentation>
</xs:annotation>
</xs:element>

element previewWorkItemRequest/previewWorkItemFromList/requiredField

diagram

type

xs:string

properties

minOcc	0
maxOcc	unbounded
content	simple

annotation

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.

source

<xs:element name="requiredField" type="xs:string" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs: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.</xs:documentation>
</xs:annotation>
</xs:element>

element previewWorkItemRequest/channelId

diagram

type

xs:string

properties

content

simple

annotation

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.

source

<xs:element name="channelId" type="xs:string">
<xs:annotation>
<xs: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.</xs:documentation>
</xs:annotation>
</xs:element>

element previewWorkItemRequest/channelType

diagram

type

ChannelType

properties

content

simple

facets

Kind	Value	Annotation
enumeration	JSPChannel
enumeration	GIChannel
enumeration	PageflowChannel
enumeration	EmailChannel
enumeration	RssChannel
enumeration	openspaceChannel
enumeration	MobileChannel

annotation

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.

source

<xs:element name="channelType" type="ct:ChannelType">
<xs:annotation>
<xs: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.</xs:documentation>
</xs:annotation>
</xs:element>

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