REST API:Dynamic Search

Query Parameters

• fieldList - A comma-separated list of field names to retrieve

• The asterisk (*) wildcard specifies all fields
• Use the REST API:field Resource to get a complete list of fields
• Field lists for database views need to specify the object's alias, as well as the field name.

• filter - Filtering criteria to filter the records

• For more examples, see Filter Expressions in REST APIs and the REST API Examples.)

• pageSize - Number of records to retrieve from the result set in order to make a "page".
• page - Number of the logical page in a database result set. The first page is page "zero" (0).

Page zero is returned by default, so appending &pageSize=1 to your query returns a single record.

• getTotalRecordCount returns the number of total records. Causes the following structure to be returned, where N is the total number of records:

<syntaxhighlight lang="xml" enclose="div">

<platform>

  ...
  <message>
     0
     <description>Success</description>
  </message>
  <totalRecordCount>N</totalRecordCount> 

</platform> </syntaxhighlight>

• sortBy - Field name for primary sort
  Ex: &sortBy=name
• sortOrder - Sort order of the primary field, either "asc" or "desc" (ascending or descending)
  Ex: &sortOrder="desc"
• sortBy2 - Field name for secondary sort
• sortOrder2 - Sort order of the second field, either "asc" or "desc" (ascending or descending)

For more information, see: Specifying Query Parameters in REST APIs

---

This segment has two formats: One for normal searches, and another for searching Composite Objects. It generally isn't possible to embed templates and conditionals, so this page duplicates the format of Template:Query Parameters.