read for query parameters to be used as search criteria; use any combination of fields from the
customer table using a prefix of customer or no prefix.
For example,
/crm/prospects/search?customer.is_active=Y&name=mc*&customer.last_ship_date=>=t-100
would find active prospects having a name that starts with 'mc' who shipped something in the last
100 days.
Sorting: To sort the result set, you can provide the following reserved
query parameter: orderBy If the orderBy parameter is not provided a default sort of
customer.id+DESC will be applied.
For example,
/crm/prospects/search?customer.id=*&orderBy=customer.name+DESC
would return all prospect records sorted descending by the customer name. Multiple sort columns
can be provided in a comma delimited format.
orderBy=prefix.field+direction,prefix.field+direction
Pagination: To page the result set, you can provide the following
reserved query parameters: recordLength and recordOffset
For example,
/crm/prospects/search?customer.id=*&recordLength=100&recordOffset=50
would return 100 records starting at the 51st record in the return record set. If no recordLength
parameter is provided the search result maximum value in the mobile service control file will be
applied. Note: Result size is limited to 1000 records unless specifically configured using
the
-Dloadmaster.api.maxresultsize vmparam.
Changed After Date: To return only records that have been changed or
added since a specific date and time, you can provide the
changedAfterDate parameter. Dates are limited to the audit setting
and days to keep value in the table properties configuration.
For example,
/crm/prospects/search?customer.is_active=Y&changedAfterDate=t-1
would return active prospects that have been added or updated since the beginning of the previous
day.
Change Types: To further define the types
of changes you want to filter, use the changedAfterType parameter. This parameter is
to be used in conjunction with changedAfterDate to give the ability to specify if you
want added or updated records.
Allowed values: [Add, Update]. Any other value
will result in an exception. If the ChangedAfterType parameter is not provided, both
added and updated records will be returned. If you do not provide a corresponding
ChangedAfterDate the
ChangedAfterType parameter will be ignored.
For example,
/crm/prospects/search?customer.is_active=Y&changedAfterDate=t-1&changedAfterType=Add
would return active prospects that have been added since the beginning of the previous day. |