read for query parameters to be used as search criteria; use any combination of fields from the
location table using a prefix of tractor or no prefix.
For example,
/tractors/search?service_status=A&tractor.current_hub=>1000000&tractor.inspection_date=<=t-100
would find active tractors with over one million miles that haven't been inspected 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
tractor.id+ASC will be applied.
For example,
/tractors/search?service_status=A&orderBy=tractor.id+DESC would
return all in service tractors sorted ascending by the tractor id. 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,
/tractors/search?tractor.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,
/tractors/search?service_status=A&changedAfterDate=t-1 would return
all in service tractors 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,
/tractors/search?service_status=A&changedAfterDate=t-1&changedAfterType=Add
would return all in service tractors that have been added since the beginning of the previous
day. |