Sort Results
This parameter allows you to specify the order in which objects of a particular type are retrieved.
Relative URL | HTTP Request Method |
---|---|
/api/v4/ backend-deployment-id /objects/ model .json?sort[ field ]= direction | GET |
- Replace
model
with the type of object that you wish to retrieve (as defined in your app's Data Model), for exampleperson
,job
orasset
. - Replace
field
with the desired field name. - Replace
direction
with a value defined below.
Sort criteria are specified as a URL-encoded
sort
hash. Valid keys for this hash are the names of the fields in that model. Sort directions can be expressed in JavaScript style: 1
or -1
- or human-readable: asc
, ASC
, desc
or DESC
The response will contain a list of objects sorted by the specified field. The format of the objects is the same as for listing all objects (please refer to the Retrieve all Objects section).
BASE-URL
The below examples contain a
BASE-URL
placeholder. Please refer to the HTTP Endpoints section to get the base URL relevant to your deployment.HTTP
curl
ruby
GET BASE-URL/api/v4/533bda53027894f69b001055/objects/tasks.json?sort[updated_at]=desc
When using curl with queries you have to either escape the square brackets with a backslash
\
or add the -g
option to turn off curl's globbing functionality.
curl "BASE-URL/api/v4/533bda53027894f69b001055/objects/tasks.json?sort[updated_at]=desc" \
-g -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
require 'rest-client'
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/tasks.json"].get :params => {:sort=>{:updated_at=>"desc"}}
HTTP
curl
ruby
GET BASE-URL/api/v4/533bda53027894f69b001055/objects/tasks.json?sort[updated_at]=-1
curl "BASE-URL/api/v4/533bda53027894f69b001055/objects/tasks.json?sort[updated_at]=-1" \
-g -u "533bda53027894f69b001055:7Ajj5htRY1uzw7b4w23V"
require 'rest-client'
journey = RestClient::Resource.new "BASE-URL/api/v4", "533bda53027894f69b001055", "7Ajj5htRY1uzw7b4w23V"
journey["533bda53027894f69b001055/objects/tasks.json"].get :params => {:sort=>{:updated_at=>-1}}
Last modified 6mo ago