element scheduleWorkItem
diagram wp_diagrams/wp_p432.png
namespace http://api.brm.n2.tibco.com
properties
content complex
children item itemSchedule itemContext itemBody dynamicOrgAttributes
annotation
documentation
Request element for scheduleWorkItem operation.
source <xs:element name="scheduleWorkItem">
 
<xs:annotation>
   
<xs:documentation>Request element for scheduleWorkItem operation.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="item" type="Item">
       
<xs:annotation>
         
<xs:documentation>Basic, participant and work type information about the work item</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="itemSchedule" type="ItemSchedule" minOccurs="0">
       
<xs:annotation>
         
<xs: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.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="itemContext" type="ItemContext">
       
<xs:annotation>
         
<xs:documentation>The work item's context, as supplied by the application that scheduled the work item.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="itemBody" type="ItemBody">
       
<xs:annotation>
         
<xs: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. </xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="dynamicOrgAttributes" type="orgdto:XmlDynamicIdField" minOccurs="0" maxOccurs="unbounded">
       
<xs:annotation>
         
<xs: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.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element scheduleWorkItem/item
diagram wp_diagrams/wp_p433.png
type Item
properties
content complex
children name description entities entityQuery
attributes
Name  Type  Use  Default  Fixed  Annotation
distributionStrategy  DistributionStrategy  required      
documentation
Distribution strategy to be used for the work item - either OFFER or ALLOCATE.
priority  xs:int        
documentation
Priority of the work item.
groupID  xs:long  optional      
documentation
ID of the work group that the work item belongs to.
workTypeUID  xs:string  required      
documentation
ID of the work type that defines the data specification for this work item.
workTypeVersion  xs:string        
documentation
OSGi version range string of the work type that is to be used.
annotation
documentation
Basic, participant and work type information about the work item
source <xs:element name="item" type="Item">
 
<xs:annotation>
   
<xs:documentation>Basic, participant and work type information about the work item</xs:documentation>
 
</xs:annotation>
</xs:element>

element scheduleWorkItem/itemSchedule
diagram wp_diagrams/wp_p434.png
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 <xs:element name="itemSchedule" type="ItemSchedule" minOccurs="0">
 
<xs:annotation>
   
<xs: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.</xs:documentation>
 
</xs:annotation>
</xs:element>

element scheduleWorkItem/itemContext
diagram wp_diagrams/wp_p435.png
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 <xs:element name="itemContext" type="ItemContext">
 
<xs:annotation>
   
<xs:documentation>The work item's context, as supplied by the application that scheduled the work item.</xs:documentation>
 
</xs:annotation>
</xs:element>

element scheduleWorkItem/itemBody
diagram wp_diagrams/wp_p436.png
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 <xs:element name="itemBody" type="ItemBody">
 
<xs:annotation>
   
<xs: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. </xs:documentation>
 
</xs:annotation>
</xs:element>

element scheduleWorkItem/dynamicOrgAttributes
diagram wp_diagrams/wp_p437.png
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 <xs:element name="dynamicOrgAttributes" type="orgdto:XmlDynamicIdField" minOccurs="0" maxOccurs="unbounded">
 
<xs:annotation>
   
<xs: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.</xs:documentation>
 
</xs:annotation>
</xs:element>


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