Update a Recommendation.
put
/content/management/api/v1.1/personalization/recommendations/{id}
Update a Recommendation with given payload.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Id of the Recommendation.
Query Parameters
-
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
Header Parameters
-
X-Requested-With: string
A custom header to mitigate CSRF attacks.Allowed Values:
[ "XMLHttpRequest" ]
Update a Recommendation with the given information in the payload.
Root Schema : RecommendationInput
Type:
object
Recommendation Input Bean
Show Source
-
apiName(optional):
string
The reference name of the Recommendation. If a refrence name is not provided, one will be generated by the server. Reference names must be unique among all recommendations. This is the name that is used in API calls that invoke the recommendation.
-
channels(optional):
array channels
-
contentTypes(optional):
array contentTypes
Content types the Recommenation will return. It is a required property in the get response and post/put request.
-
defaults(optional):
array defaults
The default rule section.
-
description(optional):
string
The description of the Recommendation.
-
main(optional):
array main
The main rule section.
-
name:
string
The name of the Recommendation. It is a required property in the get response and cannot be empty in post/put request.
-
repositoryId:
string
Repositories of the Recommendation. It is a required property in the get response and post/put request.
Nested Schema : contentTypes
Type:
array
Content types the Recommenation will return. It is a required property in the get response and post/put request.
Show Source
Nested Schema : defaults
Type:
array
The default rule section.
Show Source
-
Array of:
object DefaultSection
Default Section
Nested Schema : main
Type:
array
The main rule section.
Show Source
-
Array of:
object MainRulesSection
Main Rules Section
Nested Schema : ChannelId
Type:
object
ChannelId
Show Source
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
links(optional):
array links
Links
-
name(optional):
string
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.
Nested Schema : ContentTypeId
Type:
Show Source
object
-
name(optional):
string
-
typeCategory(optional):
string
typeCategory of the asset type.
Nested Schema : DefaultSection
Type:
object
Default Section
Show Source
-
items(optional):
array items
List of items. This is optional and can be empty.
-
sort(optional):
array sort
This is a very simple sort based of the normal quiery syntax.
Example: [systemField | userDefinedfield]<:>
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Nested Schema : sort
Type:
array
This is a very simple sort based of the normal quiery syntax.
Example: [systemField | userDefinedfield]<:>
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Show Source
Example: [systemField | userDefinedfield]<:
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Nested Schema : ItemId
Type:
Show Source
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
Nested Schema : links
Type:
array
links of the item resource
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : MainRulesSection
Type:
object
Main Rules Section
Show Source
-
properties(optional):
object RulesProperties
RulesProperties
-
rules(optional):
array rules
Main list of Rules. This is optional and can be empty.
-
sort(optional):
array sort
This is a very simple sort based of the normal quiery syntax.
Example: [systemField | userDefinedfield]<:>
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Nested Schema : RulesProperties
Type:
object
RulesProperties
Show Source
-
operator(optional):
string
Allowed Values:
[ "ALL", "ANY" ]
The operator that will be used to combine the rules in this group. This is optional and defaults to ALL if omitted.
Nested Schema : rules
Type:
array
Main list of Rules. This is optional and can be empty.
Show Source
Nested Schema : sort
Type:
array
This is a very simple sort based of the normal quiery syntax.
Example: [systemField | userDefinedfield]<:>
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Show Source
Example: [systemField | userDefinedfield]<:
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : Recommendation
Type:
object
Recommendation
Show Source
-
apiName(optional):
string
The reference name of the Recommendation. If a refrence name is not provided, one will be generated by the server. Reference names must be unique among all recommendations. This is the name that is used in API calls that invoke the recommendation.
-
channels(optional):
array channels
-
contentTypes(optional):
array contentTypes
Content types the Recommenation will return. It is a required property in the get response and post/put request.
-
createdBy(optional):
string
The user who created the Recommendation.
-
createdDate(optional):
object date
date
-
defaults(optional):
array defaults
The default rule section.
-
description(optional):
string
The description of the Recommendation.
-
id:
string
The id of the Recommendation. This is a required propety in the get response and ignored in post/put requests.
-
isPublished(optional):
boolean
Whether the recommendation is ever published.
-
links(optional):
array links
Links
-
main(optional):
array main
The main rule section.
-
name:
string
The name of the Recommendation. It is a required property in the get response and cannot be empty in post/put request.
-
publishedChannels(optional):
array publishedChannels
-
publishInfo(optional):
object ItemSubResourceListPublishInfo
Item SubResource.
-
repositoryId:
string
Repositories of the Recommendation. It is a required property in the get response and post/put request.
-
status(optional):
string
Current status of the recommendation.
-
type(optional):
string
The type of the Recommendation as determined by the rule structure.
-
updatedBy(optional):
string
The user who last updated the Recommendation.
-
updatedDate(optional):
object date
date
-
version(optional):
string
The current revision version of this item.
Nested Schema : contentTypes
Type:
array
Content types the Recommenation will return. It is a required property in the get response and post/put request.
Show Source
Nested Schema : defaults
Type:
array
The default rule section.
Show Source
-
Array of:
object DefaultSection
Default Section
Nested Schema : main
Type:
array
The main rule section.
Show Source
-
Array of:
object MainRulesSection
Main Rules Section
Nested Schema : ChannelId
Type:
object
ChannelId
Show Source
-
id(optional):
string
-
isPrimaryChannel(optional):
boolean
Indicates if channel is primary for an asset.
-
links(optional):
array links
Links
-
name(optional):
string
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.
Nested Schema : ContentTypeId
Type:
Show Source
object
-
name(optional):
string
-
typeCategory(optional):
string
typeCategory of the asset type.
Nested Schema : DefaultSection
Type:
object
Default Section
Show Source
-
items(optional):
array items
List of items. This is optional and can be empty.
-
sort(optional):
array sort
This is a very simple sort based of the normal quiery syntax.
Example: [systemField | userDefinedfield]<:>
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Nested Schema : sort
Type:
array
This is a very simple sort based of the normal quiery syntax.
Example: [systemField | userDefinedfield]<:>
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Show Source
Example: [systemField | userDefinedfield]<:
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Nested Schema : ItemId
Type:
Show Source
object
-
id(optional):
string
id of the item.
-
links(optional):
array links
links of the item resource
-
name(optional):
string
name of the item.
Nested Schema : links
Type:
array
links of the item resource
Show Source
-
Array of:
object Link
Link of the resource.
Nested Schema : MainRulesSection
Type:
object
Main Rules Section
Show Source
-
properties(optional):
object RulesProperties
RulesProperties
-
rules(optional):
array rules
Main list of Rules. This is optional and can be empty.
-
sort(optional):
array sort
This is a very simple sort based of the normal quiery syntax.
Example: [systemField | userDefinedfield]<:>
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Nested Schema : RulesProperties
Type:
object
RulesProperties
Show Source
-
operator(optional):
string
Allowed Values:
[ "ALL", "ANY" ]
The operator that will be used to combine the rules in this group. This is optional and defaults to ALL if omitted.
Nested Schema : rules
Type:
array
Main list of Rules. This is optional and can be empty.
Show Source
Nested Schema : sort
Type:
array
This is a very simple sort based of the normal quiery syntax.
Example: [systemField | userDefinedfield]<:>
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Show Source
Example: [systemField | userDefinedfield]<:
Where:
standardAssetField - this is a predefined list of fields the user can choose to sort on. This can be given an ascneding and descending property by adding :asc or :desc
Examples:
publishedDate:asc - sort by published date ascneding
userAssetField - This refers to fields defined in the content type as created by the user.
field.myText or field.someThing:desc
If no systemField or userDefinedField is provided, :random and :relevance can be provided.
:relevance - Default. This will return assets ordered by their relevance.
:random - This will return assets in a random order irrespective of any rules or fields.
Nested Schema : PublishInfo
Type:
object
PublishInfo
Show Source
-
channel(optional):
string
Target name
-
links(optional):
array links
Links
-
publishedBy(optional):
string
Published by
-
publishedDate(optional):
object date
date
-
slug(optional):
string
Published slug
-
version(optional):
string
Published version
400 Response
Bad request.
403 Response
Forbidden.
404 Response
Recommendation not found. The requested resource not found.
500 Response
Internal server error.