REST API for Documents

All REST Endpoints

Applinks

The Applinks API provides basic applink operations.

Create File Applink: Method: post
Path: /documents/api/1.2/applinks/file/{fileId}
Create Folder Applink: Method: post
Path: /documents/api/1.2/applinks/folder/{folderId}
Refresh Applink Token: Method: put
Path: /documents/api/1.2/applinks/token

Catalog

The Catalog API provides information about what resources are available for a particular version.

Get All Versions: Method: get
Path: /documents/api/
Get API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog
Get Applink API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog/applinks
Get Configuration API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog/configuration
Get File API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog/files
Get Folder API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog/folders
Get Metadata API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog/metadata
Get Public Links API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog/publiclinks
Get Share API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog/shares
Get Sites API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog/sites
Get Specific Version: Method: get
Path: /documents/api/{version}
Get Templates API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog/templates
Get User API Catalog: Method: get
Path: /documents/api/{version}/metadata-catalog/users

Client Applications

The operations from the Client Applications category.

Create a Client Application: Method: post
Path: /documents/api/1.2/config/clientApplications
Delete a Client Application: Method: delete
Path: /documents/api/1.2/config/clientApplications/{id}
Download a Client Application File: Method: get
Path: /documents/api/1.2/config/clientApplications/{id}/data
Get a Client Application: Method: get
Path: /documents/api/1.2/config/clientApplications/{id}
Get All Client Applications: Method: get
Path: /documents/api/1.2/config/clientApplications
Update a Client Application: Method: put
Path: /documents/api/1.2/config/clientApplications/{id}

Configuration

The Configuration API provides basic configuration operations.

Get CDN Configuration: Method: get
Path: /documents/api/1.2/config/sites/deliverycdn
Get Collaboration Configuration: Method: get
Path: /documents/api/1.2/config/collaboration
Get Email Notification Configuration: Method: get
Path: /documents/api/1.2/config/notification/email
Set Email Notification Configuration: Method: put
Path: /documents/api/1.2/config/notification/email

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

Folders

The Folders API provides basic folder operations.

Abort a Bulk Download Job: Method: delete
Path: /documents/api/1.2/folders/{folderId}/_download/{jobId}
Assign a Metadata Collection to a Folder: Method: post
Path: /documents/api/1.2/folders/{folderId}/metadata/{collectionName}
Assign Values to a Folder Metadata Collection: Method: post
Path: /documents/api/1.2/folders/{folderId}/metadata
Bulk Create Folders: Method: post
Path: /documents/api/1.2/folders/{folderId}/_bulkCreate
Bulk Download Folders and Files: Method: post
Path: /documents/api/1.2/folders/{folderId}/_download
Change Folder Ownership: Method: post
Path: /documents/api/1.2/folders/{folderId}/changeOwnership
Copy Folder: Method: post
Path: /documents/api/1.2/folders/{folderId}/copy
Create Folder: Method: post
Path: /documents/api/1.2/folders/{folderId}
Create Folder Conversation: Method: post
Path: /documents/api/1.2/folders/{folderId}/conversation
Delete All Folder Tags: Method: delete
Path: /documents/api/1.2/folders/{folderId}/tags
Delete Folder: Method: delete
Path: /documents/api/1.2/folders/{folderId}
Delete Values in a Folder Metadata Collection: Method: delete
Path: /documents/api/1.2/folders/{folderId}/metadata
Download a Bulk Download Job File: Method: get
Path: /documents/api/1.2/folders/{folderId}/_download/{jobId}/package
Edit Folder: Method: put
Path: /documents/api/1.2/folders/{folderId}
Edit Folder Tags: Method: put
Path: /documents/api/1.2/folders/{folderId}/tags
Get Folder: Method: get
Path: /documents/api/1.2/folders/{folderId}
Get Folder Assigned Metadata Collections: Method: get
Path: /documents/api/1.2/folders/{folderId}/metadataFields
Get Folder Metadata Collection: Method: get
Path: /documents/api/1.2/folders/{folderId}/metadata
Get Folder Tags: Method: get
Path: /documents/api/1.2/folders/{folderId}/tags
Get Home Folder Contents: Method: get
Path: /documents/api/1.2/folders/items
Get Information on Multiple Folders: Method: get
Path: /documents/api/1.2/folders/lists
Get Specific Folder Contents: Method: get
Path: /documents/api/1.2/folders/{folderId}/items
Get Status of a Bulk Download Job: Method: get
Path: /documents/api/1.2/folders/{folderId}/_download/{jobId}
Move Folder: Method: post
Path: /documents/api/1.2/folders/{folderId}/move
Search Folders or Files: Method: get
Path: /documents/api/1.2/folders/search/items
Search Folders or Files Under Specific Folder ID: Method: get
Path: /documents/api/1.2/folders/{folderId}/search/items
Set Folder Tags: Method: post
Path: /documents/api/1.2/folders/{folderId}/tags

Metadata Collection

The operations from the Metadata Collection category.

Assign a Metadata Collection to a File: Method: post
Path: /documents/api/1.2/files/{fileId}/metadata/{collectionName}
Assign a Metadata Collection to a Folder: Method: post
Path: /documents/api/1.2/folders/{folderId}/metadata/{collectionName}
Assign Values to a File Metadata Collection: Method: post
Path: /documents/api/1.2/files/{fileId}/metadata
Assign Values to a Folder Metadata Collection: Method: post
Path: /documents/api/1.2/folders/{folderId}/metadata
Create Metadata Collection: Method: post
Path: /documents/api/1.2/metadata/{collectionName}
Delete Metadata Collection: Method: delete
Path: /documents/api/1.2/metadata/{collectionName}
Delete Values in a Folder Metadata Collection: Method: delete
Path: /documents/api/1.2/folders/{folderId}/metadata
Delete Values in File Metadata Collection: Method: delete
Path: /documents/api/1.2/files/{fileId}/metadata
Edit Fields in a Metadata Collection: Method: put
Path: /documents/api/1.2/metadata/{collectionName}/field
Edit Metadata Collection: Method: put
Path: /documents/api/1.2/metadata/{collectionName}
Get Available Metadata Collections: Method: get
Path: /documents/api/1.2/metadata
Get File Assigned Metadata Collections: Method: get
Path: /documents/api/1.2/files/{fileId}/metadataFields
Get File Metadata Collection: Method: get
Path: /documents/api/1.2/files/{fileId}/metadata
Get Folder Assigned Metadata Collections: Method: get
Path: /documents/api/1.2/folders/{folderId}/metadataFields
Get Folder Metadata Collection: Method: get
Path: /documents/api/1.2/folders/{folderId}/metadata
Get Metadata Collection Definition: Method: get
Path: /documents/api/1.2/metadata/{collectionName}
Get Searchable Metadata Fields: Method: get
Path: /documents/api/1.2/metadata/searchFields
Set Searchable Metadata Fields: Method: post
Path: /documents/api/1.2/metadata/searchFields
Upload File: Method: post
Path: /documents/api/1.2/files/data
Upload File Version: Method: post
Path: /documents/api/1.2/files/{fileId}/data

Publiclinks

The Publiclinks API provides basic public links operations

Create File Public Link: Method: post
Path: /documents/api/1.2/publiclinks/file/{fileId}
Create Folder Public Link: Method: post
Path: /documents/api/1.2/publiclinks/folder/{folderId}
Delete Public Link: Method: delete
Path: /documents/api/1.2/publiclinks/{linkId}
Edit Public Link: Method: put
Path: /documents/api/1.2/publiclinks/{linkId}
Get File Public Link: Method: get
Path: /documents/api/1.2/publiclinks/file/{fileId}
Get Folder Public Link: Method: get
Path: /documents/api/1.2/publiclinks/folder/{folderId}
Get Public Link: Method: get
Path: /documents/api/1.2/publiclinks/{linkId}

The Shares API provides basic sharing operations.

Edit Shared Folder User Role: Method: put
Path: /documents/api/1.2/shares/{folderId}/role
Get Shared Folder Users: Method: get
Path: /documents/api/1.2/shares/{folderId}/items
Revoke Current User: Method: delete
Path: /documents/api/1.2/shares/{folderId}/myuser
Revoke User: Method: delete
Path: /documents/api/1.2/shares/{folderId}/user
Share Folder: Method: post
Path: /documents/api/1.2/shares/{folderId}
Unshare Folder: Method: delete
Path: /documents/api/1.2/shares/{folderId}

Sites

The Sites API provides basic site operations.

Create Site from Site: Method: post
Path: /documents/api/1.2/sites/{siteId}/site

Templates

The Templates API provides basic template operations.

Create Site from Template: Method: post
Path: /documents/api/1.2/templates/{templateId}/site

Users

The Users API provides basic information about users to identify them for folder and file sharing purposes.

Get User with Email Address: Method: get
Path: /documents/api/1.2/users/search/items
Get Users: Method: get
Path: /documents/api/1.2/users/items
Transfer User Content: Method: post
Path: /documents/api/1.2/users/{userID}/transferContent