Jump to

• Request
• Response

Unpublish a Recommendation.

post

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

Unpublish a Recommendation from 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 unpublish a Recommendation.

Root Schema : RecommendationUnpublish

Type: object

Recommendation Unpublish Request

Show Source

• allowUnpublishFromActiveSite(optional): boolean
  whether to allow active site items (recommendtion and defaults) to be unpublished.(defaults to false)
• channels(optional): array channels
  List of unpublish channels. If channels are not empty, the recommendation is unpublished to the given channels. If the channels are empty, the recommendation is unpublished from its targeted channels.

{
    "type":"object",
    "properties":{
        "channels":{
            "type":"array",
            "description":"List of unpublish channels. If channels are not empty, the recommendation is unpublished to the given channels. If the channels are empty, the recommendation is unpublished from its targeted channels.",
            "items":{
                "$ref":"#/definitions/ChannelId"
            }
        },
        "allowUnpublishFromActiveSite":{
            "type":"boolean",
            "description":"whether to allow active site items (recommendtion and defaults) to be unpublished.(defaults to false)"
        }
    },
    "description":"Recommendation Unpublish Request"
}

Nested Schema : channels

Type: array

List of unpublish channels. If channels are not empty, the recommendation is unpublished to the given channels. If the channels are empty, the recommendation is unpublished from its targeted channels.

Show Source

• Array of: object ChannelId
  ChannelId

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

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

202 Response

Accepted.

400 Response

Bad request.

403 Response

Forbidden.

500 Response

Internal server error.

Back to Top