SOAP API - allocateAndOpenNextWorkItem

The table summarizes the SOAP API - allocateAndOpenNextWorkItem.

Request Uses the allocateAndOpenNextWorkItem element (from the WorkItemManagementService schema)
Parameter notes
  • 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.
  • workListViewId(optional): the unique ID of the work view.

    It is not necessary to enter a value in this field as the default work list view is automatically used. To use the default work view, use

    0 or -1.
Response Returns an allocateAndOpenNextWorkItemResponse 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:allocateAndOpenNextWorkItem>
         <resource>tibco-admin</resource>
         <workListViewID>1</workListViewID>
      </api:allocateAndOpenNextWorkItem>
   </soapenv:Body>
</soapenv:Envelope>
  Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <allocateAndOpenNextWorkItemResponse xmlns="http://api.brm.n2.tibco.com">
         <workItem xmlns="">
            <id id="18" version="3"/>
            <header distributionStrategy="OFFER" priority="50" startDate="2015-09-02T14:35:30.017Z">
               <name>CollectData</name>
               <description>Collect Data</description>
               <flags>
                  <scheduleStatus>DURING</scheduleStatus>
               </flags>
               <itemContext>
                  <activityID>pvm:001i38</activityID>
                  <activityName>CollectData</activityName>
                  <appInstance>pvm:0a123</appInstance>
                  <appName>WedCreateProcess</appName>
                  <appID>_7WMysXcUEeSqkpEfkSe5mQ</appID>
               </itemContext>
            </header>
            <body>
               <dataModel>
                  <inouts array="false" name="Wed1DF" type="Complex">
                     <complexSpec/>
                  </inouts>
               </dataModel>
            </body>
            <workType version="1.0.0.20150902152400279" workTypeDescription="CollectData" workTypeID="WT__Uf2-wHcVEeSqkpEfkSe5mQ"/>
            <state>OPENED</state>
            <visible>true</visible>
         </workItem>
      </allocateAndOpenNextWorkItemResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>