Class: GetSearchCaseReportRequest

tibco.objectapi.service.request.GetSearchCaseReportRequest

new GetSearchCaseReportRequest(caseReference)

Object GetSearchCaseReportRequest Usage: RestApiService.getAuditService().getSearchCaseReport(request, callback);
Parameters:
Name Type Description
caseReference string The reference to the case object. Whenever a case object is created, a unique case reference is also created. Providing the case reference, provides access to the case data object. You can obtain case references using findAllCases.
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' (not used)
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 include a count of the total number of events 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 items in the list, the totalItems value in the response is 0 (zero).
  • If you pass true in this attribute but numberOfItems is set to zero, the totalItems value in the response is 0 regardless of how many items are actually in the list. The total count of items is only available when you are fetching one or more items.
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 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