Class: GetWorkListItemsForViewRequest

tibco.objectapi.service.request.GetWorkListItemsForViewRequest

new GetWorkListItemsForViewRequest(viewId, startPosition, numberOfItems)

Object GetWorkListItemsForViewRequest Usage: RestApiService.getWorkListService().getWorkListItemsForView(request, callback);
Parameters:
Name Type Description
viewId number (Java type: long) The ID of the work list view from which to get the page of work items.
startPosition number (Java type: long) Position in the work view list from which to start this page. (The list is zero-based. To start at the first item, specify 0.)
numberOfItems number (Java type: long) Number of work views (in the work item list) to include in this page.
Since:
  • 4.0.0

Members

enhancedAttributes :boolean

Query parameter: 'enhancedattributes' (optional, default=false) If true, all 40 work item attributes are returned with the work items; if false, only work item attributes 1-14 are returned with the work items.
Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = false

getAllocated :boolean

Query parameter: 'getallocated' (optional, default=false) Whether to return allocated work items.
Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = false

totalReq :boolean

Query parameter: 'btotalreq' (optional, default=true). Boolean defining whether BRM builds a count of the total number of work items in the work item list. If 'false' is passed in this attribute, and:
  • there is at least one item in the list, the totalItems value returned in the response is -1.
  • there are no work items in the list, the totalItems value returned in the response is 0 (zero).

    If 'true' is passed in this attribute, 'count' must be set to one or more to provide a correct total. The total count of work items is only available when you are fetching one or more work items.

Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = true