Difference between revisions of "REST API:Dynamic Search"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 1: Line 1:
:;Query Parameters:
:;Query Parameters:
:*<tt>fieldList</tt> - A comma-separated list of field names to retrieve  
:*<tt>fieldList</tt> - A comma-separated list of field names to retrieve <br>{{PAGENAME}}<br> 
{{#ifeq: {{PAGENAME}} | REST_API:composite_record_Resource |  <!--match--> {{PAGENAME}}<br>
{{#ifeq: {{PAGENAME}} | REST_API:composite_record_Resource |  <!--match-->  
::* The asterisk (<tt>*</tt>) wildcard specifies all fields in the primary record  
::* The asterisk (<tt>*</tt>) wildcard specifies all fields in the primary record  
::* <tt>{fieldname}</tt> specifies a field in the primary record (e.g. <tt>name</tt>)
::* <tt>{fieldname}</tt> specifies a field in the primary record (e.g. <tt>name</tt>)

Revision as of 00:41, 31 January 2012

Query Parameters
  • fieldList - A comma-separated list of field names to retrieve
    REST API:Dynamic Search
  • 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
  • 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.
  • 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.