new ExecuteRegisteredQueryRequest(options, identifierType, id)
Object ExecuteRegisteredQueryRequest
Usage:
RestApiService.getAuditService().executeRegisteredQuery(request, callback);
Parameters:
| Name | Type | Description |
|---|---|---|
options |
tibco.objectapi.ec.base.QueryOptions | The options for this query. |
identifierType |
string | Either "guid" or "tag", which specifies whether the GUID or the tag is used to identify the query, which was previously registered with the registerQuery function (both are returned by registerQuery). Note, however, passing the GUID makes a more efficient query. You can also determine the GUID using the lookupQueryByTag function. |
id |
string | The ID of the registered query. |
- Since:
- 4.0.0
Members
advancedOptions :string
Query parameter: 'advancedoptions' (not used)
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:
- = ""
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
version :string
Query parameter: 'version' (optional) Version of the API.
Type:
- string
- Since:
- 4.0.0
- Default Value:
- = ""