This resource returns a list of available attribute categories.
get
/content/management/api/v1.1/personalization/categories
This resource returns a list of available attribute categories that can be filtered by the category's name and type. You can control the number of items to be fetched, paginated and sorted. Refer to the query syntax description to see the limitations.
Request
Query Parameters
-
default(optional): string
Default search query expression.
-
fields(optional): string
This parameter is used to control the returned fields for a attribute category. This parameter accepts a comma-separated list of field names or all. These fields will be returned for each category in the list. As all the field names are case-sensitive, users must provide the correct field names in the query. Each recommendation has both standard fields (id, name, description and type. When fields is specified as all (case-insensitive), all the standard and additional fields are returned. The standard fields are always returned in the response and cannot be filtered out. Users can only filter out the additional fields. This parameter is optional in the query and by default result shows only standard fields in the response. Any incorrect or invalid field name given in the query will result in an error.
Example: ?fields=all
This will return all standard fields and all additional fields for each category.
-
limit(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the size of the result.Default Value:
100
-
links(optional): string
This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby, first, last, prev, next
-
offset(optional): integer(int32)
This parameter accepts a non negative integer and is used to control the start index of the result.Default Value:
0
-
orderBy(optional): string
Order by results.Default Value:
name:asc
-
q(optional): string
This parameter accepts a query expression condition that matches the field values. Query conditions can be joined using AND operators and grouped with parentheses. The value of a query condition follows the format of {fieldName} {operator} "{fieldValue}". The only field names allowed are name and typeWhen listing categories, type can be equal to "standard", "custom" or "all". If type is equals to "all", all categories will be retrieved. The only value allowed in the operator is eq (Equals).
Example:
https://{cecsdomain}/content/management/api/v1.1/personalization/categories?q=(type eq "custom")
Example:
https://{cecsdomain}/content/management/api/v1.1/personalization/categories?q=(name eq "Some space") -
totalResults(optional): boolean
This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.Default Value:
false
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : AttributeCategories
Type:
object
AttributeCategories
Show Source
-
aggregationResults(optional):
array aggregationResults
Aggregation results.
-
count(optional):
integer(int32)
Total number of records in the current response.
-
hasMore(optional):
boolean
Check whether there are more pages to fetch.
-
items(optional):
array items
Singular resources contained in the collection.
-
limit(optional):
integer(int32)
Actual page size used by the server. This might not be the same as what the client requests.
-
links(optional):
array links
Links of the resource.
-
offset(optional):
integer(int32)
The actual index from which the singular resources are returned.
-
pinned(optional):
array pinned
Pinned items. Shows items pinned at the top of search list
-
scrollId(optional):
string
scrollId if the search resolved to a scroll search.
-
totalResults(optional):
integer(int32)
Total number of rows that satisfy the client request (excluding the paging parameters.)
Nested Schema : items
Type:
array
Singular resources contained in the collection.
Show Source
-
Array of:
object AttributeCategory
AttributeCatgegory
Nested Schema : links
Type:
array
Links of the resource.
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : pinned
Type:
array
Pinned items. Shows items pinned at the top of search list
Show Source
Nested Schema : AttributeCategory
Type:
object
AttributeCatgegory
Show Source
-
description(optional):
string
The description of the Category.
-
id:
string
The id of the Category. This is a required propety in the get response and ignored in post/put requests.
-
links(optional):
array links
Links
-
name:
string
The name of the Category. It is a required property in the get response and cannot be empty in post/put request.
-
type(optional):
string
The Type of the Category. This can be set to "standard" or "custom". Parameters can be added, updated and deleted in custom categories only.
Nested Schema : Link
Type:
object
Link of the resource.
Show Source
-
href(optional):
string
The target resource's URI. It could be template URI. It is a required property in the get response.
-
mediaType(optional):
string
Media type.
-
method(optional):
string
What HTTP method can be used to access the target resource.
-
profile(optional):
string
Link to the metadata that describes the target resource.
-
rel(optional):
string
Relation type. It is a required property in the get response.
-
templated(optional):
boolean
Whether the URI is a template.
400 Response
Bad request.
403 Response
Forbidden.
500 Response
Internal server error.