REST API for Documents

Delete Custom Rendition

delete

/documents/api/1.2/files/{fileId}/data/rendition

Delete the specified custom rendition.

Request

Supported Media Types

application/json
application/xml

Path Parameters

fileId: string

Globally unique identifier (GUID) for the file.

Query Parameters

rendition: string

Rendition name given to a custom rendition in upload.
version(optional): string

Specify the version number of the file to use. If the version is not specified, the latest version is used. It is important to notice that custom renditions can exist for a specific file version only.

Header Parameters

accessToken(optional): string

Applink access token authorizing the current user to access the parent folder or this file. This parameter is mandatory if appLinkID is used. It can be used as accessToken or AccessToken.
appLinkID(optional): string

Applink ID authorizing the current user to access the parent folder or this file. Any time the parameter appLinkID is used, a parameter accessToken must be provided as well. To work, this applink must have at least the contributor role granted. It can be used as appLinkID or AppLinkID.
dAccessCode(optional): string

Access code needed to use protected public links. It needs to be sent as part of a Cookie header in the following format: dAccessCode-<linkID>=<passcodeValue>
linkID(optional): string

Public link ID of a public link authorizing the current user to access this file. It can be used as linkID or LinkID.

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled.

403 Response

Forbidden if the user does not have read permission.

404 Response

File ID or rendition is not found.

Examples

The following example deletes the custom rendition named small from the latest version of the given file.

DELETE .../files/D3C1C1F319CFE6B102095C5DT0000000000100000001/data/rendition?rendition=small

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "D3C1C1F319CFE6B102095C5DT0000000000100000001",
    "type": "file"
}

Example 2

The following example deletes the custom rendition named applinkRendition from the latest version of the given file. The example uses an applink ID because this file is under a folder structure not owned by or shared with the current user. The applink ID and access token are submitted in the request header.

DELETE .../files/DED694950C14AFF280419F9AB5D17B95F47087F4E518/data/rendition?rendition=applinkRendition&version=2

Request Header

appLinkID: LF5Bxj4TPo_p4n4qWn0tbKTicR2cTUJKv7X_ng9E7ry93rRuDokPqS1d6-wKwhb_wtcGYFDsI_cNMxeKQ-HR-FXQhiVoGRTYM_MPZY8qpICfYU94mmnMjM_cvsRhKMzc0NJgvwEJfqqDwPsAVrhc8cmg==
accessToken: 352FpiMmW66PeYI1Gh5b83I9CXRwZhLfYAu4TXdqpzD8uNKUBMZVVJ3ZvivUW8kQ

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "DED694950C14AFF280419F9AB5D17B95F47087F4E518",
    "type": "file"
}