Read a specific category by id.
get
/content/management/api/v1.1/personalization/categories/{id}
Request
Path Parameters
-
id: string
Id of the category.
Query Parameters
-
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.
-
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
Response
Supported Media Types
- application/json
200 Response
OK.
Root 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.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Recommendation not found. The requested resource not found.
500 Response
Internal server error.