SOAP API - getWorkListItemsForGlobalData

The table summarizes the SOAP API - getWorkListItemsForGlobalData.

Request Uses the getWorkListItemsForGlobalData element (from the WorkListService schema)
Parameter notes
  • startPosition: The position in the work list to start the page of results. The list is zero-based. To start at the first item, specify 0.
  • numberOfItems: The number of items to include in the work list.
  • globalDataRef: Can be obtained from findCaseByCID or findCaseByCriteria
  • orderFilterCriteria: (Optional) Sort or filter criteria, or both, to determine how the work items are to be filtered and sorted. For details of the syntax and content of these criteria, see Sorting and Filtering Work Lists.
Response Returns a getWorkListItemsForGlobalDataResponse element (from the WorkListService 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:getWorkListItemsForGlobalData startPosition="0" numberOfItems="5">
         <globalDataRef>BDS-1-com.example.hastings.Customer-1-0</globalDataRef>
         <orderFilterCriteria>
            <order>id ASC</order>
            <filter>state=OFFERED</filter>
         </orderFilterCriteria>
      </api:getWorkListItemsForGlobalData>
   </soapenv:Body>
</soapenv:Envelope>
  Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <getWorkListItemsForGlobalDataResponse xmlns="http://api.brm.n2.tibco.com">
         <startPosition xmlns="">0</startPosition>
         <endPosition xmlns="">0</endPosition>
         <workItems xmlns="">
            <id id="1" version="0"/>
            <header distributionStrategy="OFFER" priority="50" startDate="2015-04-16T21:40:42.937Z">
               <name>VerifyEmployment</name>
               <description>VerifyEmployment</description>
               <flags>
                  <scheduleStatus>DURING</scheduleStatus>
               </flags>
               <itemContext>
                  <activityID>pvm:001ia</activityID>
                  <activityName>VerifyEmployment</activityName>
                  <appInstance>pvm:0a122</appInstance>
                  <appName>AutoLoanProcess</appName>
                  <appID>_0dRZQJ8OEeOgg76Ol2bTHw</appID>
               </itemContext>
            </header>
            <state>OFFERED</state>
            <visible>true</visible>
         </workItems>
      </getWorkListItemsForGlobalDataResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>