wp - scheduleWorkItemWithModel

element scheduleWorkItemWithModel

diagram

namespace

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

properties

content

complex

children

itemSchedule itemContext itemBody dynamicEntities dynamicOrgAttributes allocateToMember

attributes

Name

Type

Use

Default

Fixed

Annotation

workModelUID

xs:string

required

documentation

The UID of the work model to scehdule this item against.

workModelVersion

xs:string

documentation

The OSGi version range string of the work model to use.

groupID

xs:long

documentation

The ID of the group associated with this operation, if there is one.

annotation

documentation

Request element for scheduleWorkItemWithModel operation.

source

<xsd:element name="scheduleWorkItemWithModel">
<xsd:annotation>
    <xsd:documentation>Request element for scheduleWorkItemWithModel operation.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
    <xsd:sequence>
      <xsd:element name="itemSchedule" type="ItemSchedule" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>The schedule period to be associated with the work item.   If no object is passed then the item with have no schedule and cannot be worked on.   If an empty object is passed BRM will default this to immediately available with no target date.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="itemContext" type="ItemContext">
        <xsd:annotation>
          <xsd:documentation>The work item's context, as supplied by the application that scheduled the work item.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="itemBody" type="ItemBody">
        <xsd:annotation>
          <xsd:documentation>The work item body, containing each data field (as a name/value pair) required by the data model in the work item's work type.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="dynamicEntities" type="xs:string" minOccurs="0" maxOccurs="unbounded">
        <xsd:annotation>
          <xsd:documentation>If specified, this will be used to determine the entity that is used to schedule the work item. It will override any settings associated with the work model being used.

This field describes 1 of the following dynamic entities:-

An single resource query that will resolve the entity or entities. The query must conform to the Resource Query Language (RQL) specification. See the product documentation for detailed information about RQL syntax.

1 or more entity GUIDS defining the who the item is scheduled too.
</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="dynamicOrgAttributes" type="orgdto:XmlDynamicIdField" minOccurs="0" maxOccurs="unbounded">
        <xsd:annotation>
          <xsd:documentation>If specified, this will specifiy the array of name / value pairs of attributes that DE will use to identify the correct dynamic instance for any template org model entity.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="allocateToMember" type="xs:string" minOccurs="0">
        <xsd:annotation>
          <xsd:documentation>If specified this Work Item will be allocated to this resource GUID, if the resource is in the offerset.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
    </xsd:sequence>
    <xsd:attribute name="workModelUID" type="xs:string" use="required">
      <xsd:annotation>
        <xsd:documentation>The UID of the work model to scehdule this item against.</xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute name="workModelVersion" type="xs:string">
      <xsd:annotation>
        <xsd:documentation>The OSGi version range string of the work model to use.</xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute name="groupID" type="xs:long">
      <xsd:annotation>
        <xsd:documentation>The ID of the group associated with this operation, if there is one.</xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
</xsd:complexType>
</xsd:element>

attribute scheduleWorkItemWithModel/@workModelUID

type

xs:string

properties

use

required

annotation

documentation

The UID of the work model to scehdule this item against.

source

<xsd:attribute name="workModelUID" type="xs:string" use="required">
<xsd:annotation>
<xsd:documentation>The UID of the work model to scehdule this item against.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

attribute scheduleWorkItemWithModel/@workModelVersion

type

xs:string

annotation

documentation

The OSGi version range string of the work model to use.

source

<xsd:attribute name="workModelVersion" type="xs:string">
<xsd:annotation>
<xsd:documentation>The OSGi version range string of the work model to use.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

attribute scheduleWorkItemWithModel/@groupID

type

xs:long

annotation

documentation

The ID of the group associated with this operation, if there is one.

source

<xsd:attribute name="groupID" type="xs:long">
<xsd:annotation>
<xsd:documentation>The ID of the group associated with this operation, if there is one.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

element scheduleWorkItemWithModel/itemSchedule

diagram

type

ItemSchedule

properties

minOcc	0
maxOcc	1
content	complex

children

startDate maxDuration targetDate

annotation

documentation

The schedule period to be associated with the work item. If no object is passed then the item with have no schedule and cannot be worked on. If an empty object is passed BRM will default this to immediately available with no target date.

source

<xsd:element name="itemSchedule" type="ItemSchedule" minOccurs="0">
<xsd:annotation>
<xsd:documentation>The schedule period to be associated with the work item. If no object is passed then the item with have no schedule and cannot be worked on. If an empty object is passed BRM will default this to immediately available with no target date.</xsd:documentation>
</xsd:annotation>
</xsd:element>

element scheduleWorkItemWithModel/itemContext

diagram

type

ItemContext

properties

content

complex

children

activityID activityName appInstance appName appID appInstanceDescription

annotation

documentation

The work item's context, as supplied by the application that scheduled the work item.

source

<xsd:element name="itemContext" type="ItemContext">
<xsd:annotation>
<xsd:documentation>The work item's context, as supplied by the application that scheduled the work item.</xsd:documentation>
</xsd:annotation>
</xsd:element>

element scheduleWorkItemWithModel/itemBody

diagram

type

ItemBody

properties

content

complex

children

parameter

annotation

documentation

The work item body, containing each data field (as a name/value pair) required by the data model in the work item's work type.

source

<xsd:element name="itemBody" type="ItemBody">
<xsd:annotation>
<xsd:documentation>The work item body, containing each data field (as a name/value pair) required by the data model in the work item's work type.</xsd:documentation>
</xsd:annotation>
</xsd:element>

element scheduleWorkItemWithModel/dynamicEntities

diagram

type

xs:string

properties

minOcc	0
maxOcc	unbounded
content	simple

annotation

documentation

If specified, this will be used to determine the entity that is used to schedule the work item. It will override any settings associated with the work model being used.

This field describes 1 of the following dynamic entities:-

An single resource query that will resolve the entity or entities. The query must conform to the Resource Query Language (RQL) specification. See the product documentation for detailed information about RQL syntax.

1 or more entity GUIDS defining the who the item is scheduled too.

source

<xsd:element name="dynamicEntities" type="xs:string" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>If specified, this will be used to determine the entity that is used to schedule the work item. It will override any settings associated with the work model being used.

This field describes 1 of the following dynamic entities:-

An single resource query that will resolve the entity or entities. The query must conform to the Resource Query Language (RQL) specification. See the product documentation for detailed information about RQL syntax.

1 or more entity GUIDS defining the who the item is scheduled too.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

element scheduleWorkItemWithModel/dynamicOrgAttributes

diagram

type

XmlDynamicIdField

properties

minOcc	0
maxOcc	unbounded
content	complex

attributes

Name	Type	Use	Default	Fixed	Annotation
name	xs:token	required
value	xs:string	optional

annotation

documentation

If specified, this will specifiy the array of name / value pairs of attributes that DE will use to identify the correct dynamic instance for any template org model entity.

source

<xsd:element name="dynamicOrgAttributes" type="orgdto:XmlDynamicIdField" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>If specified, this will specifiy the array of name / value pairs of attributes that DE will use to identify the correct dynamic instance for any template org model entity.</xsd:documentation>
</xsd:annotation>
</xsd:element>

element scheduleWorkItemWithModel/allocateToMember

diagram

type

xs:string

properties

minOcc	0
maxOcc	1
content	simple

annotation

documentation

If specified this Work Item will be allocated to this resource GUID, if the resource is in the offerset.

source

<xsd:element name="allocateToMember" type="xs:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>If specified this Work Item will be allocated to this resource GUID, if the resource is in the offerset.</xsd:documentation>
</xsd:annotation>
</xsd:element>

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