select
Without the select
parameter, queries return a default set of attributes. The select
parameter specifies which attributes to provide in the response. Whenever possible, use select
to explicitly choose specific attributes, thereby reducing the load put on the application.
rest-1 URL Syntax
In rest-1.v1/Data and rest-1.oauth.v1/Data, the select
parameter is a URL query parameter as sel
. The set of attribute definitions are simply comma separated. The following shows how the select
is expressed in the query.
<Server Base URI>/rest.v1/Data/Story?sel=Name,Number
The order of attribute definitions provided to query does not change the order of attributes in the results. The order of attributes in the results is not deterministic so do not depend on attribute order.
query.v1 Syntax
In query.v1 and query.legacy.v1, the select
parameter is expressed as an array of attribute definitions.
YAML
from: Story
select:
- Name
- Number
JSON
{
"from": "Story",
"select":
[
"Name",
"Number"
]
}