element closeWorkItem
diagram wp_diagrams/wp_p261.png
namespace http://api.brm.n2.tibco.com
properties
content complex
children workItemID workItemPayload hiddenPeriod
annotation
documentation
Request element for closeWorkItem operation.
source <xs:element name="closeWorkItem">
 
<xs:annotation>
   
<xs:documentation>Request element for closeWorkItem operation.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence maxOccurs="unbounded">
     
<xs:element name="workItemID" type="ManagedObjectID">
       
<xs:annotation>
         
<xs:documentation>ID of a work item that is to be closed.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="workItemPayload" type="WorkItemBody">
       
<xs:annotation>
         
<xs:documentation>Complete body of the specified work item.</xs:documentation>
       
</xs:annotation>
     
</xs:element>
     
<xs:element name="hiddenPeriod" type="HiddenPeriod">
       
<xs:annotation>
         
<xs:documentation>Information about how long the specified work item is hidden.


NOTE: If a hiddenPeriod is specified the work item will transition to the PendHidden state, rather than Pended. Operations that work on the Pended state (e.g. reallocateWorkItem) cannot then access the work item until the hiddenPeriod expires, at which point the system automatically transitions the work item back to the Pended state.
</xs:documentation>
       
</xs:annotation>
     
</xs:element>
   
</xs:sequence>
 
</xs:complexType>
</xs:element>

element closeWorkItem/workItemID
diagram wp_diagrams/wp_p262.png
type ManagedObjectID
properties
content complex
attributes
Name  Type  Use  Default  Fixed  Annotation
id  xs:long  required      
documentation
Unique ID of the work item.
version  xs:long        
documentation
Version of the work item.

If not set, the latest version will be used.
annotation
documentation
ID of a work item that is to be closed.
source <xs:element name="workItemID" type="ManagedObjectID">
 
<xs:annotation>
   
<xs:documentation>ID of a work item that is to be closed.</xs:documentation>
 
</xs:annotation>
</xs:element>

element closeWorkItem/workItemPayload
diagram wp_diagrams/wp_p263.png
type WorkItemBody
properties
content complex
children dataModel
annotation
documentation
Complete body of the specified work item.
source <xs:element name="workItemPayload" type="WorkItemBody">
 
<xs:annotation>
   
<xs:documentation>Complete body of the specified work item.</xs:documentation>
 
</xs:annotation>
</xs:element>

element closeWorkItem/hiddenPeriod
diagram wp_diagrams/wp_p264.png
type HiddenPeriod
properties
content complex
children hiddenDuration visibleDate
annotation
documentation
Information about how long the specified work item is hidden.


NOTE: If a hiddenPeriod is specified the work item will transition to the PendHidden state, rather than Pended. Operations that work on the Pended state (e.g. reallocateWorkItem) cannot then access the work item until the hiddenPeriod expires, at which point the system automatically transitions the work item back to the Pended state.
source <xs:element name="hiddenPeriod" type="HiddenPeriod">
 
<xs:annotation>
   
<xs:documentation>Information about how long the specified work item is hidden.


NOTE: If a hiddenPeriod is specified the work item will transition to the PendHidden state, rather than Pended. Operations that work on the Pended state (e.g. reallocateWorkItem) cannot then access the work item until the hiddenPeriod expires, at which point the system automatically transitions the work item back to the Pended state.
</xs:documentation>
 
</xs:annotation>
</xs:element>


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