Jump to

• Request
• Response

Publish a Recommendation.

post

/content/management/api/v1.1/personalization/recommendations/{id}/publish

Publish a Recommendation to optional channel(s).

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" ]

Body ()

The information needed to publish a Recommendation.

Root Schema : RecommendationPublish

Type: object

Recommendation Publish Request

Show Source

• channels(optional): array channels
  List of publish channels. If channels is not empty, the recommendation and defaults are published to the given channels. If channels is empty, the recommendation and its defaults are published to the targeted channels.
• validation(optional): object PublishValidation
  PublishValidation

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "description":"List of publish channels. If channels is not empty, the recommendation and defaults are published to the given channels. If channels is empty, the recommendation and its defaults are published to the targeted channels.",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "validation":{
            "$ref":"#/definitions/PublishValidation"
        }
    },
    "description":"Recommendation Publish Request"
}

Nested Schema : channels

Type: array

List of publish channels. If channels is not empty, the recommendation and defaults are published to the given channels. If channels is empty, the recommendation and its defaults are published to the targeted channels.

Show Source

• Array of: object ChannelId
  ChannelId

{
    "type":"array",
    "description":"List of publish channels. If channels is not empty, the recommendation and defaults are published to the given channels. If channels is empty, the recommendation and its defaults are published to the targeted channels.",
    "items":{
        "$ref":"#/definitions/ChannelId"
    }
}

Nested Schema : PublishValidation

Type: object

PublishValidation

Show Source

• languageOnly(optional): boolean
• testOnly(optional): boolean
• verbosity(optional): string
  Allowed Values: [ "none", "terse", "normal", "verbose" ]

{
    "type":"object",
    "properties":{
        "verbosity":{
            "type":"string",
            "enum":[
                "none",
                "terse",
                "normal",
                "verbose"
            ]
        },
        "testOnly":{
            "type":"boolean"
        },
        "languageOnly":{
            "type":"boolean"
        }
    },
    "description":"PublishValidation"
}

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "isPrimaryChannel":{
            "type":"boolean",
            "description":"Indicates if channel is primary for an asset."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ChannelId"
}

Nested Schema : links

Type: array

Links

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

202 Response

Accepted.

400 Response

Bad request.

403 Response

Forbidden.

500 Response

Internal server error.

Back to Top