Creates a new rendition for the specified document.
Base Request
POST /api/documents/[docId]/renditions
where [docId] is the alphanumeric ID for the document.
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
| Element | Description | Type | Required |
|---|---|---|---|
| sysrendition_id | The alphanumeric ID for the rendition to be created from the source document. | string | Required |
Sample Request
POST /api/documents/[docId]/renditions Authorization: Bearer [access_token] User-Agent: MyCompanyProduct/1.0 HXCS-REPOSITORY: default Accept: application/vnd.hxcs.v1+json Content-Type: application/json { "sysrendition_id": "string" }
Response
See Document for response body details and a sample response.
Status Codes and Errors
The following table lists the returned status codes.
| Code | Description | Notes |
|---|---|---|
| 200 | OK | Returns the information for the newly created rendition. |
| 400 | Bad Request | The server could not process the request due to a missing rendition ID. |
| 401 | Not Authorized | Authentication has failed or was not provided. |
| 403 | Not Allowed | Access permissions are invalid or missing. |
| 404 | Not Found | The source document could not be found. |
| 412 | Precondition Failed | The server did not allow the rendition to be created due to request header fields failing to meet the requestor's preconditions. |