Class: GetProcessInstanceReportRequest

tibco.objectapi.service.request.GetProcessInstanceReportRequest

new GetProcessInstanceReportRequest(reference)

Object GetProcessInstanceReportRequest Usage: RestApiService.getAuditService().getProcessInstanceReport(request, callback);
Parameters:
Name Type Description
reference string Process instance ID whose events you want to audit. Can be obtained from listProcessInstances, queryProcessInstances, or queryProcessInstancesAlt.
Since:
  • 4.0.0

Members

advancedOptions :string

Query parameter: 'advancedoptions' (not used)
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

details :string

Query parameter: 'details' (optional) Specify this to return the work items associated with the given process instance.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

fetchComments :boolean

Query parameter: 'fetchcomments'
Type:
  • boolean
Since:
  • 4.0.0
Default Value:
  • = ""

getTotalCount :string

Query parameter: 'gettotalcount' (optional) Whether to return the number of items that fit the query.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

numberOfItems :number

Query parameter: 'numberofitems' (Java type: int) (optional) How many responses to return. A value of -1 means return all responses.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = -1

populateAttributeNames :string

Query parameter: 'populateattributenames' (optional) Whether attribute names will be included in all returned attributes from the query.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

requireAllAttributes :string

Query parameter: 'requireallattributes' (optional) Whether or not all attributes should be included in the response.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

requiredAttributes :Array.<string>

Query parameter: 'requiredattribute' (Java type: List) List of attributes required.
Type:
  • Array.<string>
Since:
  • 4.0.0

sortOrder :string

Query parameter: 'sortorder' (optional) Attribute or attributes on which the results should be sorted, and in what direction the sort should run (ASCENDING or DESCENDING).
Type:
  • string
Since:
  • 4.0.0

startPosition :number

Query parameter: 'startposition' (Java type: int) (optional) The position in the work list from which to start the page of results. To start at the first item, specify 0.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = -1

subProcDepth :number

Query parameter: 'subprocdepth' (Java type: int) (optinal) Determines how many sub-processes to return. By default, this is set to -1 which returns all sub-processes. Note that numberOfItems and startPosition only apply to the first process instance. Any work items or sub processes are returned in full.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = -1