Update the Rendition Configuration - Hyland Content REST API - Current - Current - Ready - Content Innovation Cloud - external

Hyland Content REST API
Platform
Content Innovation Cloud
Product
Hyland Content REST API
Release
Current
License

Updates the rendition configuration for documents within the specified project.

Base Request

PUT /api/repository/renditions/project/[projectId]

where [projectId] is the alphanumeric ID for the project.

Query Parameters

Parameter Description Type Required Notes
validateOnly True/false indicator of only validating model changes without applying them. Boolean Optional Default is false.

Headers

Header Name Description Required Values
Authorization The access token Required Bearer [access_token]

where [access_token] is a string generated when you complete authentication (see Getting Started)
User-Agent Identity of the client making the request to the server Required [product]/[version]

where [product] is the name of the software you are using to make the request and [version] is the numbered version of the software (for example, MyCompanyProduct/1.0).

For information on other types of values commonly included in user-agent request headers, see the User-Agent HTTP header reference section on the Mozilla developer documentation website.
HXCS-REPOSITORY The repository ID Optional Any contributed repository name. Default is default.
Accept The format of the data to be returned Optional application/vnd.hxcs.v1+json
Content-Type The format of the data to be posted Optional application/json

Request Body

The request body follows the same structure as the response body.

Sample Request

PUT /api/repository/renditions/project/[projectId]?validateOnly=false

Authorization: Bearer [access_token]
User-Agent: MyCompanyProduct/1.0
HXCS-REPOSITORY: default
Accept: application/vnd.hxcs.v1+json
Content-Type: application/json

{
  "renditions": [
    {
      "renditionId": "string",
      "targetMimetype": "string",
      "projectId": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Response Body

Element Description Type Notes
renditions List of elements that apply to the rendition to be created. array None
renditionId Alphanumeric ID for the rendition. string None
targetMimetype The MIME type of the rendition to be created. string None
projectId Alphanumeric ID for the project containing documents whose rendition configuration has been updated. string None
options List of options that apply to the rendition to be created. array None
name The name of the option to be created for the rendition. string Some common examples include physical aspects of the rendition, such as the following:
  • resizeWidth
  • resizeHeight
  • allowEnlargement
  • maintainAspectRatio
  • autoOrient
  • thumbnail
  • startPage
  • endPage
value The value of the named option to be created for the rendition. string None

Sample Response

{
  "renditions": [
    {
      "renditionId": "string",
      "targetMimetype": "string",
      "projectId": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Status Codes and Errors

The following table lists the returned status codes.

Code Description Notes
200 OK Updates the rendition configuration for documents within the specified project.
401 Not Authorized Authentication has failed or was not provided.
403 Not Allowed Access permissions are invalid or missing.
404 Not Found The repository could not be found.
409 Conflict The proposed rendition update already exists.