Class: GetAllocatedWorkListItemsRequest

tibco.objectapi.service.request.GetAllocatedWorkListItemsRequest

new GetAllocatedWorkListItemsRequest(entityType, entityGuid, start, count)

Object GetAllocatedWorkListItemsRequest Usage: RestApiService.getWorkListService().getAllocatedWorkListItems(request, callback);
Parameters:
Name Type Description
entityType string Enumerated value that defines the type of organization model entity; for a complete list of entity types, see "AUDIT Option Attributes" in the developer guide.
entityGuid string GUID of the organization model entity.
start number (Java type: long) Position in the work item list from which to start this page. (The list is zero-based. To start at the first item, specify 0.)
count number (Java type: long) Number of work items (in the work item list) to include in this page.
Since:
  • 4.0.0

Members

enhancedAttributes :boolean

Query parameter: 'enhancedattributes' (optional) 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

entityVer :number

Query parameter: 'entityver' (Java type: int) (optional). Major version number of the organization model in which an organization model entity resides.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = -1

filterString :string

Query parameter: 'filterstring' (optional) Specification of filter criteria to be applied to a work item list.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

orderString :string

Query parameter: 'orderstring' (optional) Specification of sort criteria to be applied to a work item list.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

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