SOAP API - allocateWorkItem

The table summarizes the SOAP API - allocateWorkItem.

Request Uses the allocateWorkItem element (from the WorkItemManagementService schema)
Parameter notes
  • workItemID: ID of the work item to be allocated.
  • 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 allocated. A resource’s GUID can be obtained from a previous lookupUser operation.
Response Returns an allocateWorkItemResponse 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:allocateWorkItem>
         <workItemID id="22"/>
         <resource>ED72300B-F2FA-4E60-90D4-F829FB8DEA9D</resource>
      </api:allocateWorkItem>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <allocateWorkItemResponse xmlns="http://api.brm.n2.tibco.com">
         <workItem xmlns="">
            <id id="22" version="1"/>
            <header distributionStrategy="OFFER" priority="50">
               <name>ServicingMgr</name>
               <description>ServicingMgr</description>
               <flags>
                  <scheduleStatus>DURING</scheduleStatus>
               </flags>
               <itemContext>
                  <activityID>pvm:001i3a</activityID>
                  <activityName>ServicingMgr</activityName>
                  <appInstance>pvm:0a128</appInstance>
                  <appName>AMXSupervisor</appName>
                  <appID>_fQ0ZAHClEeCF3qXLa8gNUw</appID>
                  <appInstanceDescription>Oho</appInstanceDescription>
               </itemContext>
            </header>
            <state>ALLOCATED</state>
            <visible>true</visible>
         </workItem>
      </allocateWorkItemResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>