Jump to

• Request
• Response

Get html renditions of a published item.

get

/content/published/api/v1.1/items/{id}/renditions

Lists all available html renditions of a published item.

Request

Path Parameters

• id: string
  Unique identifier (ID) of an item.

Query Parameters

• links(optional): string
  Accepts a comma-separated list of rel (relation) links, which the client requires in the results. By default, all the applicable links in a resource are included in the response. Possible values are: self, canonical, describedby.
  Example: links=self,canonical will only return the links with the rel property self or canonical.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : RenditionsBean

Type: object

Show Source

• items(optional): array items
  Item renditions.
• links(optional): array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Item renditions.",
            "items":{
                "$ref":"#/definitions/RenditionBean"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Item renditions.

Show Source

• Array of: object RenditionBean

{
    "type":"array",
    "description":"Item renditions.",
    "items":{
        "$ref":"#/definitions/RenditionBean"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : RenditionBean

Type: object

Show Source

• apiName(optional): string
• formats(optional): array formats
• type(optional): string

{
    "type":"object",
    "properties":{
        "apiName":{
            "type":"string"
        },
        "formats":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RenditionFormatBean"
            }
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : formats

Type: array

Show Source

• Array of: object RenditionFormatBean

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RenditionFormatBean"
    }
}

Nested Schema : RenditionFormatBean

Type: object

Show Source

• format(optional): string
• links(optional): array links

{
    "type":"object",
    "properties":{
        "format":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "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."
}

400 Response

Bad Request. The server is unable to process the request on the client side due to malformed syntax, invalid data or message framing.

403 Response

Forbidden. Client is not authorized to perform this request.

404 Response

The requested resource was not found.

500 Response

Internal server error. An unexpected error condition encountered in the system.

Back to Top