REST API:Dynamic Search

From AgileApps Support Wiki
Revision as of 02:01, 11 January 2011 by imported>Aeric
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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
  • page - Page number of the logical page in a database result set
  • pageSize - Number of records to retrieve from the result set in order to make a "page".
  • 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.