REST API for Content Management 1.1

Files REST Endpoints

Files

The Files API provides basic file operations.

Assign a Metadata Collection to a File: Method: post

Path: /documents/api/1.1/files/{fileId}/metadata/{collectionName}
Assign Values to a File Metadata Collection: Method: post

Path: /documents/api/1.1/files/{fileId}/metadata
Copy File: Method: post

Path: /documents/api/1.1/files/{fileId}/copy
Create File Conversation: Method: post

Path: /documents/api/1.1/files/{fileId}/conversation
Delete All File Tags: Method: delete

Path: /documents/api/1.1/files/{fileId}/tags
Delete Custom Rendition: Method: delete

Path: /documents/api/1.1/files/{fileId}/data/rendition
Delete File: Method: delete

Path: /documents/api/1.1/files/{fileId}
Delete Values in File Metadata Collection: Method: delete

Path: /documents/api/1.1/files/{fileId}/metadata
Download File: Method: get

Path: /documents/api/1.1/files/{fileId}/data
Edit File: Method: put

Path: /documents/api/1.1/files/{fileId}
Edit File Tags: Method: put

Path: /documents/api/1.1/files/{fileId}/tags
Generate File Renditions: Method: post

Path: /documents/api/1.1/files/{fileId}/pages
Get File Accesses: Method: get

Path: /documents/api/1.1/files/{fileId}/accesses
Get File Assigned Metadata Collections: Method: get

Path: /documents/api/1.1/files/{fileId}/metadataFields
Get File HTML5 Preview: Method: get

Path: /documents/api/1.1/files/{fileId}/previewPath
Get File Information: Method: get

Path: /documents/api/1.1/files/{fileId}
Get File Metadata Collection: Method: get

Path: /documents/api/1.1/files/{fileId}/metadata
Get File Tags: Method: get

Path: /documents/api/1.1/files/{fileId}/tags
Get File Versions: Method: get

Path: /documents/api/1.1/files/{fileId}/versions
Get Information on Multiple Files: Method: get

Path: /documents/api/1.1/files/lists
Get Rendition: Method: get

Path: /documents/api/1.1/files/{fileId}/data/rendition
Get Rendition Page Count: Method: get

Path: /documents/api/1.1/files/{fileId}/pages
Get Thumbnail: Method: get

Path: /documents/api/1.1/files/{fileId}/data/thumbnail
List Renditions: Method: get

Path: /documents/api/1.1/files/{fileId}/data/renditions
Move File: Method: post

Path: /documents/api/1.1/files/{fileId}/move
Reserve File: Method: post

Path: /documents/api/1.1/files/{fileId}/reserve
Set File Tags: Method: post

Path: /documents/api/1.1/files/{fileId}/tags
Unreserve File: Method: post

Path: /documents/api/1.1/files/{fileId}/unreserve
Upload Custom Rendition: Method: post

Path: /documents/api/1.1/files/{fileId}/data/rendition
Upload File: Method: post

Path: /documents/api/1.1/files/data
Upload File Version: Method: post

Path: /documents/api/1.1/files/{fileId}/data

Files

The Files API provides basic file operations.

Upload File: Method: post

Path: /documents/api/1.1/files/data
Get Information on Multiple Files: Method: get

Path: /documents/api/1.1/files/lists
Delete File: Method: delete

Path: /documents/api/1.1/files/{fileId}
Get File Information: Method: get

Path: /documents/api/1.1/files/{fileId}
Edit File: Method: put

Path: /documents/api/1.1/files/{fileId}
Get File Accesses: Method: get

Path: /documents/api/1.1/files/{fileId}/accesses
Create File Conversation: Method: post

Path: /documents/api/1.1/files/{fileId}/conversation
Copy File: Method: post

Path: /documents/api/1.1/files/{fileId}/copy
Download File: Method: get

Path: /documents/api/1.1/files/{fileId}/data
Upload File Version: Method: post

Path: /documents/api/1.1/files/{fileId}/data
Delete Custom Rendition: Method: delete

Path: /documents/api/1.1/files/{fileId}/data/rendition
Get Rendition: Method: get

Path: /documents/api/1.1/files/{fileId}/data/rendition
Upload Custom Rendition: Method: post

Path: /documents/api/1.1/files/{fileId}/data/rendition
List Renditions: Method: get

Path: /documents/api/1.1/files/{fileId}/data/renditions
Get Thumbnail: Method: get

Path: /documents/api/1.1/files/{fileId}/data/thumbnail
Delete Values in File Metadata Collection: Method: delete

Path: /documents/api/1.1/files/{fileId}/metadata
Get File Metadata Collection: Method: get

Path: /documents/api/1.1/files/{fileId}/metadata
Assign Values to a File Metadata Collection: Method: post

Path: /documents/api/1.1/files/{fileId}/metadata
Assign a Metadata Collection to a File: Method: post

Path: /documents/api/1.1/files/{fileId}/metadata/{collectionName}
Get File Assigned Metadata Collections: Method: get

Path: /documents/api/1.1/files/{fileId}/metadataFields
Move File: Method: post

Path: /documents/api/1.1/files/{fileId}/move
Get Rendition Page Count: Method: get

Path: /documents/api/1.1/files/{fileId}/pages
Generate File Renditions: Method: post

Path: /documents/api/1.1/files/{fileId}/pages
Get File HTML5 Preview: Method: get

Path: /documents/api/1.1/files/{fileId}/previewPath
Reserve File: Method: post

Path: /documents/api/1.1/files/{fileId}/reserve
Delete All File Tags: Method: delete

Path: /documents/api/1.1/files/{fileId}/tags
Get File Tags: Method: get

Path: /documents/api/1.1/files/{fileId}/tags
Set File Tags: Method: post

Path: /documents/api/1.1/files/{fileId}/tags
Edit File Tags: Method: put

Path: /documents/api/1.1/files/{fileId}/tags
Unreserve File: Method: post

Path: /documents/api/1.1/files/{fileId}/unreserve
Get File Versions: Method: get

Path: /documents/api/1.1/files/{fileId}/versions

Files

The Files API provides basic file operations.

Delete File: Method: delete

Path: /documents/api/1.1/files/{fileId}
Delete Custom Rendition: Method: delete

Path: /documents/api/1.1/files/{fileId}/data/rendition
Delete Values in File Metadata Collection: Method: delete

Path: /documents/api/1.1/files/{fileId}/metadata
Delete All File Tags: Method: delete

Path: /documents/api/1.1/files/{fileId}/tags
Get Information on Multiple Files: Method: get

Path: /documents/api/1.1/files/lists
Get File Information: Method: get

Path: /documents/api/1.1/files/{fileId}
Get File Accesses: Method: get

Path: /documents/api/1.1/files/{fileId}/accesses
Download File: Method: get

Path: /documents/api/1.1/files/{fileId}/data
Get Rendition: Method: get

Path: /documents/api/1.1/files/{fileId}/data/rendition
List Renditions: Method: get

Path: /documents/api/1.1/files/{fileId}/data/renditions
Get Thumbnail: Method: get

Path: /documents/api/1.1/files/{fileId}/data/thumbnail
Get File Metadata Collection: Method: get

Path: /documents/api/1.1/files/{fileId}/metadata
Get File Assigned Metadata Collections: Method: get

Path: /documents/api/1.1/files/{fileId}/metadataFields
Get Rendition Page Count: Method: get

Path: /documents/api/1.1/files/{fileId}/pages
Get File HTML5 Preview: Method: get

Path: /documents/api/1.1/files/{fileId}/previewPath
Get File Tags: Method: get

Path: /documents/api/1.1/files/{fileId}/tags
Get File Versions: Method: get

Path: /documents/api/1.1/files/{fileId}/versions
Upload File: Method: post

Path: /documents/api/1.1/files/data
Create File Conversation: Method: post

Path: /documents/api/1.1/files/{fileId}/conversation
Copy File: Method: post

Path: /documents/api/1.1/files/{fileId}/copy
Upload File Version: Method: post

Path: /documents/api/1.1/files/{fileId}/data
Upload Custom Rendition: Method: post

Path: /documents/api/1.1/files/{fileId}/data/rendition
Assign Values to a File Metadata Collection: Method: post

Path: /documents/api/1.1/files/{fileId}/metadata
Assign a Metadata Collection to a File: Method: post

Path: /documents/api/1.1/files/{fileId}/metadata/{collectionName}
Move File: Method: post

Path: /documents/api/1.1/files/{fileId}/move
Generate File Renditions: Method: post

Path: /documents/api/1.1/files/{fileId}/pages
Reserve File: Method: post

Path: /documents/api/1.1/files/{fileId}/reserve
Set File Tags: Method: post

Path: /documents/api/1.1/files/{fileId}/tags
Unreserve File: Method: post

Path: /documents/api/1.1/files/{fileId}/unreserve
Edit File: Method: put

Path: /documents/api/1.1/files/{fileId}
Edit File Tags: Method: put

Path: /documents/api/1.1/files/{fileId}/tags