Class: ExecuteQueryAuditRequest

tibco.objectapi.service.request.ExecuteQueryAuditRequest

new ExecuteQueryAuditRequest(query)

Object ExecuteQueryAuditRequest Usage: RestApiService.getAuditService().executeQuery(request, callback);
Parameters:
Name Type Description
query tibco.objectapi.ec.base.QueryPayload The query to execute.
Since:
  • 4.0.0

Members

advancedOptions :string

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

correlate :string

Query parameter: 'correlate' (optional) Whether the response should be correlated.
Type:
  • string
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

parameters :string

Query parameter: 'parameters' (optional) Names and values of query parameters.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""

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

target :string

Query parameter: 'target' (optional) Target of the query. For a list of the valid targets, including information about which Event Collector database tables each target value queries, see "Using Attributes in Query Filters" in the Developer Guide.
Type:
  • string
Since:
  • 4.0.0

version :string

Query parameter: 'version' (optional) Version of the API.
Type:
  • string
Since:
  • 4.0.0
Default Value:
  • = ""