Jump to

• Request
• Response
• Examples

Add rendition to a given item.

post

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

This is applicable only for Video plus items of DigitalAssetType category and only supports Asynchronous mode of interaction

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  id of the item.

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 ()

Rendition is added based on the given information in the payload.

Root Schema : rendition

Type: object

rendition

Show Source

• formats(optional): array formats
  formats of the rendition
• links(optional): array links
  Links of rendition resource
• name(optional): string
  name of the rendition
• source(optional): object renditionSource
  renditionSource
• type(optional): string
  type of the rendition

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name of the rendition"
        },
        "formats":{
            "type":"array",
            "description":"formats of the rendition",
            "items":{
                "$ref":"#/definitions/RenditionFormatBean"
            }
        },
        "type":{
            "type":"string",
            "description":"type of the rendition"
        },
        "links":{
            "type":"array",
            "description":"Links of rendition resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "source":{
            "description":"source details of rendition",
            "$ref":"#/definitions/renditionSource"
        }
    },
    "description":"rendition"
}

Nested Schema : formats

Type: array

formats of the rendition

Show Source

• Array of: object RenditionFormatBean

{
    "type":"array",
    "description":"formats of the rendition",
    "items":{
        "$ref":"#/definitions/RenditionFormatBean"
    }
}

Nested Schema : links

Type: array

Links of rendition resource

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : renditionSource

Type: object

renditionSource

Show Source

• externalId(optional): string
  externalId
• storageProvider(optional): string
  Allowed Values: [ "kaltura" ]

  source storageProvider of the externalId

{
    "type":"object",
    "properties":{
        "storageProvider":{
            "type":"string",
            "description":"source storageProvider of the externalId",
            "enum":[
                "kaltura"
            ]
        },
        "externalId":{
            "type":"string",
            "description":"externalId"
        }
    },
    "description":"renditionSource"
}

Nested Schema : RenditionFormatBean

Type: object

Show Source

• format(optional): string
  format
• links(optional): array links
• metadata(optional): object Metadata
  Metadata
• mimeType(optional): string
  mimeType of the rendition format
• size(optional): integer(int32)
  size

{
    "type":"object",
    "properties":{
        "format":{
            "type":"string",
            "description":"format"
        },
        "size":{
            "type":"integer",
            "format":"int32",
            "description":"size"
        },
        "mimeType":{
            "type":"string",
            "description":"mimeType of the rendition format"
        },
        "metadata":{
            "description":"metadata of the rendition format",
            "$ref":"#/definitions/Metadata"
        },
        "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 : Metadata

Type: object

Metadata

Show Source

• height(optional): integer(int32)
  height
• width(optional): integer(int32)
  width

{
    "type":"object",
    "properties":{
        "width":{
            "type":"integer",
            "format":"int32",
            "description":"width"
        },
        "height":{
            "type":"integer",
            "format":"int32",
            "description":"height"
        }
    },
    "description":"Metadata"
}

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.

404 Response

Not found.

500 Response

Internal server error.

Back to Top

Examples

Example:

The following example shows how to add rendition to an item by submission of a POST request on the REST resource using cURL:

curl -X POST -H 'Content-Type: application/json' -H 'X-Requested-With: XMLHttpRequest' 'https://host:port/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/renditions'

This add a new rendition to an item from an external source. Replace payload with your own data.

Request Payload

{
  "name": "renditionName",
  "source": {
    "externalId": "2342135",
    "storageProvider": "kaltura"
  }
}

Request Headers

{
     "Content-Type": "application/json",
     "X-Requested-With": "XMLHttpRequest"
}

Response Headers

{
   "Location": "https://<hostname>/content/management/api/v1.1/items/CONTFFFEC388CFD044D8A34D2F8C46EA5786/renditions/.status/205D91EAEEDD46E8AEF6065EDBD1BED2"
}

Back to Top