View Record Sorting
You can sort View records by using the sort parameter. You must specify the full identifier of a field or list of fields to which to apply sorting criteria. You can also specify ascending (asc) or descending (desc) order, with ascending as the default.
Sorting is supported for most but not all field data types. Following is a table of supported data types with usage examples for the Showcase object.
|
Data Type
|
Criteria
|
Example
|
|---|---|---|
|
Date
|
Sort by date.
|
sort=io_showcase_date (default ascending order)
|
|
Time
|
Sort by time.
|
sort=io_showcase_time.asc
|
|
Timestamp
|
Sort by timestamp.
|
sort=io_showcase_timestamp.desc
|
|
Interval
|
Sort by interval or period.
|
sort=io_showcase_interval
|
|
String
Text
|
Sort by alphabetical order (case-insensitive).
|
sort=io_showcase_string
sort=io_showcase_text
|
|
Unique Identifier
|
Sort by alphabetical order (case-insensitive).
|
sort=io_showcase_identifier
|
|
Email Address
|
Sort by alphabetical order (case-insensitive).
|
sort=io_showcase_email_address
|
|
Address
|
Sort by alphabetical order using the full address (array first element).
|
sort=io_showcase_address
|
|
Phone Number
|
Sort by alphabetical order.
|
sort=io_showcase_phone_number
|
|
URL
|
Sort by alphabetical order.
|
sort=io_showcase_url
|
|
Relationship
|
Sort by the specified field of the related record.
|
sort=io_showcase_relationship.io_name
or
sort=io_owner.io_username
|
|
Dynamic Relationship
|
Sort by the primary name of the related record. Order-by on other fields of the related record is not supported.
|
sort=io_dynamic_relationship (no need to specify the primary name field)
|
|
Status
|
Sort by status name.
|
sort=io_showcase_status
|
|
Option List
|
Sort by the ordering position of the option, or custom sort operation. Ordering of multiple selected options is also supported.
|
sort=io_showcase_option_list
sort=io_showcase_multiselect_option_list
|
|
Integer
Number
|
Sort by numerical order.
|
sort=io_showcase_integer
sort=io_showcase_number
|
|
Rollup
Percent
|
Sort by numerical order.
|
sort=io_showcase_rollup
sort=io_showcase_percent
|
|
Quantity
|
Sort by unit (UUID) and value.
|
sort=io_showcase_quantity
|
|
Currency Amount
|
Sort by currency (UUID) and amount.
|
sort=io_showcase_currency_amount
|
 |
Sorting is currently not supported for the String Localized, Text Localized, Document, and Image data types.
|
Response Error Messages
|
HTTP Status Code
|
Error Type
|
Error Message
|
|---|---|---|
|
400
|
missing_parameter_error
|
Missing or invalid required parameter
|
|
404
|
entity_not_found
|
Invalid or nonexisting View UUID specified
|
|
500
|
server_error
|
Server error
|
For more information: