REST API for Documents

Files REST Endpoints

Files

The Files API provides basic file operations.

Abort an Extraction Job: Method: delete
Path: /documents/api/1.2/files/{fileId}/_extract/{jobId}
Assign a Metadata Collection to a File: Method: post
Path: /documents/api/1.2/files/{fileId}/metadata/{collectionName}
Assign Values to a File Metadata Collection: Method: post
Path: /documents/api/1.2/files/{fileId}/metadata
Copy File: Method: post
Path: /documents/api/1.2/files/{fileId}/copy
Create File Conversation: Method: post
Path: /documents/api/1.2/files/{fileId}/conversation
Delete All File Tags: Method: delete
Path: /documents/api/1.2/files/{fileId}/tags
Delete Custom Rendition: Method: delete
Path: /documents/api/1.2/files/{fileId}/data/rendition
Delete File: Method: delete
Path: /documents/api/1.2/files/{fileId}
Delete Values in File Metadata Collection: Method: delete
Path: /documents/api/1.2/files/{fileId}/metadata
Download File: Method: get
Path: /documents/api/1.2/files/{fileId}/data
Edit File: Method: put
Path: /documents/api/1.2/files/{fileId}
Edit File Tags: Method: put
Path: /documents/api/1.2/files/{fileId}/tags
Extract ZIP File into a Folder: Method: post
Path: /documents/api/1.2/files/{fileId}/_extract
Generate File Renditions: Method: post
Path: /documents/api/1.2/files/{fileId}/pages
Get File Accesses: Method: get
Path: /documents/api/1.2/files/{fileId}/accesses
Get File Assigned Metadata Collections: Method: get
Path: /documents/api/1.2/files/{fileId}/metadataFields
Get File HTML5 Preview: Method: get
Path: /documents/api/1.2/files/{fileId}/previewPath
Get File Information: Method: get
Path: /documents/api/1.2/files/{fileId}
Get File Metadata Collection: Method: get
Path: /documents/api/1.2/files/{fileId}/metadata
Get File Tags: Method: get
Path: /documents/api/1.2/files/{fileId}/tags
Get File Versions: Method: get
Path: /documents/api/1.2/files/{fileId}/versions
Get Information on Multiple Files: Method: get
Path: /documents/api/1.2/files/lists
Get Rendition: Method: get
Path: /documents/api/1.2/files/{fileId}/data/rendition
Get Rendition Page Count: Method: get
Path: /documents/api/1.2/files/{fileId}/pages
Get Responsive Large Image: Method: get
Path: /documents/api/1.2/files/{fileId}/data/largeImage
Get Responsive Medium Image: Method: get
Path: /documents/api/1.2/files/{fileId}/data/mediumImage
Get Responsive Small Image: Method: get
Path: /documents/api/1.2/files/{fileId}/data/smallImage
Get Responsive Thumbnail Image: Method: get
Path: /documents/api/1.2/files/{fileId}/data/thumbnailImage
Get Status of an Extraction Job: Method: get
Path: /documents/api/1.2/files/{fileId}/_extract/{jobId}
Get Thumbnail: Method: get
Path: /documents/api/1.2/files/{fileId}/data/thumbnail
List Renditions: Method: get
Path: /documents/api/1.2/files/{fileId}/data/renditions
Move File: Method: post
Path: /documents/api/1.2/files/{fileId}/move
Reserve File: Method: post
Path: /documents/api/1.2/files/{fileId}/reserve
Set File Tags: Method: post
Path: /documents/api/1.2/files/{fileId}/tags
Unreserve File: Method: post
Path: /documents/api/1.2/files/{fileId}/unreserve
Upload Custom Rendition: Method: post
Path: /documents/api/1.2/files/{fileId}/data/rendition
Upload File: Method: post
Path: /documents/api/1.2/files/data
Upload File Version: Method: post
Path: /documents/api/1.2/files/{fileId}/data