getAllocatedWorkListItems
The getAllocatedWorkListItems operation gets an allocated work list for an organization model entity.
This operation is similar to getWorkListItems, except that:
- It returns only work items that are currently allocated to a specified resource, but were offered to an original offer set that included the specified organizational entity.
- It may not be used to get work list items for a resource (user).
The request element (getAllocatedWorkListItems) contains the following information:
- entityID—the GUID of the organizational entity in the original offer set. This must not be a Resource.
- 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.
Optionally, it can contain:
- getTotalCount—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—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.
The response for this operation returns the same element as getWorkListItems. It contains full details of all the allocated work list items that match the criteria specified in the request.
See Creating and Managing Supervised Work List Views - Example 2 for an example of the use of this operation.
For API reference information, see getAllocatedWorkListItems.