SOAP API - reallocateWorkItemData

The table summarizes the SOAP API - reallocateWorkItemData

Request Uses the reallocateWorkItemData 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
  • workItemPayload: the complete body of the work item, containing the new data to be written to the work item as part of this action.

    If complexSpec business data is passed into this operation, see Valid Format for ComplexSpec Business Data for information about the valid format.

Response Returns a reallocateWorkItemDataResponse 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:reallocateWorkItemData>

         <workItemID id="3" version="12"/>

         <resource>846D100C-77C8-42DE-BD01-C23D214D2BB4</resource>

         <workItemPayload>

            <dataModel>

               <inputs name="Message" type="String" optional="?" array="false">

                  <simpleSpec length="?" decimal="?">

                     <value>Please call An Lushan at 01799887256.</value>

                  </simpleSpec>

                  <complexSpec className="?">

                     <value>?</value>

                  </complexSpec>

               </inputs>

               <outputs name="?" type="?" optional="?" array="?">

                  <simpleSpec length="?" decimal="?">

                     <value>?</value>

                  </simpleSpec>

                  <complexSpec className="?">

                     <value>?</value>

                  </complexSpec>

               </outputs>

               <inouts name="?" type="?" optional="?" array="?">

                  <simpleSpec length="?" decimal="?">

                     <value>?</value>

                  </simpleSpec>

                  <complexSpec className="?">

                     <!--Zero or more repetitions:-->

                     <value>?</value>

                  </complexSpec>

               </inouts>

            </dataModel>

         </workItemPayload>

      </api:reallocateWorkItemData>

   </soapenv:Body>

</soapenv:Envelope>
  Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

   <SOAP-ENV:Header/>

   <SOAP-ENV:Body>

      <reallocateWorkItemDataResponse xmlns="http://api.brm.n2.tibco.com">

         <workItem xmlns="">

            <id id="3" version="16"/>

            <header distributionStrategy="OFFER" priority="50">

               <name>DisplayMessage</name>

               <description>Display Message</description>

               <flags>

                  <scheduleStatus>DURING</scheduleStatus>

               </flags>

               <itemContext>

                  <activityID>pvm:001io</activityID>

                  <activityName>DisplayMessage</activityName>

                  <appInstance>pvm:0a123</appInstance>

                  <appName>WelcomeUsers</appName>

                  <appID>_-fPYwCIVEeCnP8eZZTCDGg</appID>

               </itemContext>

            </header>

            <state>ALLOCATED</state>

            <visible>true</visible>

         </workItem>

      </reallocateWorkItemDataResponse>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>