SOAP API - reallocateWorkItem

The table summarizes the SOAP API - reallocateWorkItem.

Request Uses the reallocateWorkItem element (from the WorkItemManagementService schema)
Parameter notes
  • workItemID: ID of the work item to be reallocated.
  • version: (Optional) If it is omitted, the latest version is used.
  • resource: the GUID of the resource to whom the work item is to be reallocated. A resource’s GUID can be obtained from a previous lookupUser operation
  • The setting of revertData determines whether existing data is kept ("false") or whether it is discarded and the work item returned to its initial state when scheduled ("true").
Response Returns a reallocateWorkItemResponse element (from the WorkItemManagementService schema)
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.brm.n2.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:reallocateWorkItem>
         <workItemID id="51" version="2"/>
         <resource>3D9296E1-B1F8-4A09-A219-0285D43B3498</resource>
         <revertData>false</revertData>
      </api:reallocateWorkItem>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <reallocateWorkItemResponse xmlns="http://api.brm.n2.tibco.com">
         <workItem xmlns="">
            <id id="51" version="2"/>
            <header distributionStrategy="OFFER" priority="50">
               <name>DisplayMessage</name>
               <description>Display Message</description>
               <flags>
                  <scheduleStatus>DURING</scheduleStatus>
               </flags>
               <itemContext>
                  <activityID>pvm:001i11</activityID>
                  <activityName>DisplayMessage</activityName>
                  <appInstance>pvm:0a124</appInstance>
                  <appName>WelcomeUsers</appName>
                  <appID>_-fPYwCIVEeCnP8eZZTCDGg</appID>
               </itemContext>
            </header>
            <state>ALLOCATED</state>
            <visible>true</visible>
         </workItem>
      </reallocateWorkItemResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>