SOAP API - getAllocatedWorkListItems

The table summarizes the SOAP API - getAllocatedWorkListItems.

Request Uses the getAllocatedWorkListItems element (from the WorkListService schema)
Parameter notes
  • entityID: the GUID of the organizational entity whose work list you want to retrieve.
  • startPosition: the position in the work list from which to start the page of results. The list is zero-based. To start at the first item, specify 0.
  • numberOfItems: the number of items from the work list to include.
  • getTotalCount: (Optional) whether to include a count of the total number of work items in the list. This defaults to true. The count is returned in the totalItems value in the response.

    You should set getTotalCount to false unless you specifically need the total figure, because setting it to true is expensive in terms of database access time.

    Note that if you pass false in this attribute, and there is at least one item in the list, the totalItems value returned in the response is -1. However, if you pass false and there are no work items in the list, the totalItems value in the response is 0 (zero).

  • orderFilterCriteria: (Optional) sort or filter criteria, or both, to determine how the work items are to be filtered and presented. See Sorting and Filtering Work Lists for details of the syntax and content of these criteria.
Response Returns a getWorkListItemsResponse 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:getAllocatedWorkListItems startPosition="0" numberOfItems="2" getTotalCount="true">

         <entityID model-version="-1" entity-type="POSITION" guid="_5i1V0CfLEeChutsy_vK9tg">

         </entityID>

         <orderFilterCriteria>

            <order>id DESC</order>

            <filter></filter>

         </orderFilterCriteria>

      </api:getAllocatedWorkListItems>

   </soapenv:Body>

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

   <SOAP-ENV:Header/>

   <SOAP-ENV:Body>

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

         <startPosition xmlns="">0</startPosition>

         <endPosition xmlns="">0</endPosition>

         <totalItems xmlns="">1</totalItems>

         <workItems xmlns="">

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

            <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>OPENED</state>

            <visible>true</visible>

         </workItems>

      </getWorkListItemsResponse>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>