Filter Attribute Sets

Filters the tenant's Attribute Set resources using OData query options ($select, $expand, $filter, $orderby, $skip, $top, $skipToken). Result's paging is done using the default paging size options.

Parameters details

X-API-KEY

Custom HTTP request header containing the API key used for authentication.

Accept-Language

Standard HTTP request header that indicates the natural language and locale that the client prefers. It can take one of the following values:

• null: The content localized in the default culture is available in the result.
• culture-code: The content localized in the specified culture is available in the result.

Specifying various culture codes or q-factor weighting are currently disabled.

Examples:

• Expression es returns the content localized in the culture es.
• Expression en-us returns the content localized in the culture en-us.

$select

Expression describing the list of Attribute Set resource properties to be included in the result. The full list of the available Attribute Set resource properties is available in the JSON schema returned by the /AttributeSets/$metadata endpoint.

Examples:

• Expression typ_title includes in the result only the property typ_title of the current resource (Attribute Set).
• Expression typ_stat,typ_title includes in the result only the properties typ_stat and typ_title of the current resource (Attribute Set).

$expand

Expression describing the list of collections embedded in the Attribute Set resource (Products) to be included in the result. By default, the result doesn't include the embedded collections (Products).

Example:

• Expression Products includes in the result the number elements of the Products resource, embedded in the current resource (Attribute Set).

$filter

Expression describing the filters applied to the resources included in the result. By default, no filters are applied.

The expression follows the ODATA version 4.01 URI conventions. The following filter options are currently supported:

• logical operators (eq, ne, gt, lt, ge, le, or, and, in)
• functions: string functions (contains, startswith, endswith)

Examples:

• contains(property1, 'stringValue1')
• property1 gt integerValue1 and property2 eq 'stringValue1'

$orderby

Expression describing the ordering applied to the properties of resources included in the result. By default, no sorting is applied. The expression follows the format: RESOURCE_PROPERTY_NAME (asc)|desc.

Examples:

• Expression typ_title orders the result ascendingly on the property typ_title of the current resource (Attribute Set).

$skip

Expression setting up result's paging according to the limit and offset paging strategy. The page size for the Attribute Set resource is limited by default to 100 items.

Example:

• Expression 1000 returns the Attribute Set items starting from the 1001st element in the result.

$skipToken

Expression setting up the continuation token used in paging the result. The page size for the Attribute Set resource is limited to 1 item.

Example:

• Expression 123456789 limits the Attribute Set items to the next default number of items, starting from the continuation token 123456789.

$top

Expression setting up the number of items in the result. The page size for the Attribute Set resource is limited to 1 item.

Example:

• Expression 10 limits the Attribute Set items to the first 10 elements, given the other filter, sorting and paging criteria.