You can refine query results using system query parameters, which begin with the $ character. Add system query parameters to the URL to control the amount and order of data in the response. Custom query parameters lists additional parameters specific to Hybrid Data Pipeline. In addition, topics in this section describe settings to optimize response times when paging through result sets or when using the $count system parameter.

The following table lists the OData query string parameters that Hybrid Data Pipeline supports. For detailed information about the system query parameters, refer to the OData specification.

Table 1. Supported system query parameters
Parameter Description Support in Hybrid Data Pipeline
$apply Triggers aggregation behavior. See Aggregation support for details. Supports a subset of OData aggregation functionality.
$count Returns the number of records in a collection, or if the collection has a filter, the number of records that match the filter.
Note: $count replaces the $inlinecount parameter for OData v4 and higher.
Supports all standard functionality.
$expand In addition to retrieving a record or collection, retrieve related records. At present, supports expanding one level deep.
$filter An expression or function that must evaluate to true for records that will be included in the response. Supports all functionality except the following scalar functions: fractionalseconds, geodistance, geointersects, geolength, isof, maxdatetime, mindatetime, totaloffsetminutes, totalseconds.
$orderby Determines the values used to order a collection of records.

Supports all standard functionality.
$top Identifies a subset of records to return from a collection. To form this subset, select only the first N items of the set, where N is a positive integer. See Paging through results for more information. Supports all standard functionality.
$skip Identifies a subset of records to return from a collection. Define the subset by seeking N entries into the Collection and selecting only the remaining entries (starting with Entry N+1), where N is a positive integer. Supports all standard functionality.
$search Searches for the specified expression in columns that are enabled for search in the schema map. Do not use $search and $filter in the same request. See Searching text-based columns for more information.
Note: $search replaces the DataDirect proprietary ddsearch parameter for OData v4 and higher.
Supports all standard functionality.
$value Gets the raw value of a property. Supports all standard functionality.
Note: Stored functions are supported only for DB2, Oracle, PostgreSQL, and SQL Server data stores. See Stored functions support for details on further restrictions.