Folders REST Endpoints
Folders
The Folders API provides basic folder operations.
- Abort a Bulk Download Job
- Method: deletePath:
/documents/api/1.2/folders/{folderId}/_download/{jobId}
- Assign a Metadata Collection to a Folder
- Method: postPath:
/documents/api/1.2/folders/{folderId}/metadata/{collectionName}
- Assign Values to a Folder Metadata Collection
- Method: postPath:
/documents/api/1.2/folders/{folderId}/metadata
- Bulk Create Folders
- Method: postPath:
/documents/api/1.2/folders/{folderId}/_bulkCreate
- Bulk Download Folders and Files
- Method: postPath:
/documents/api/1.2/folders/{folderId}/_download
- Change Folder Ownership
- Method: postPath:
/documents/api/1.2/folders/{folderId}/changeOwnership
- Copy Folder
- Method: postPath:
/documents/api/1.2/folders/{folderId}/copy
- Create Folder
- Method: postPath:
/documents/api/1.2/folders/{folderId}
- Create Folder Conversation
- Method: postPath:
/documents/api/1.2/folders/{folderId}/conversation
- Delete All Folder Tags
- Method: deletePath:
/documents/api/1.2/folders/{folderId}/tags
- Delete Folder
- Method: deletePath:
/documents/api/1.2/folders/{folderId}
- Delete Values in a Folder Metadata Collection
- Method: deletePath:
/documents/api/1.2/folders/{folderId}/metadata
- Download a Bulk Download Job File
- Method: getPath:
/documents/api/1.2/folders/{folderId}/_download/{jobId}/package
- Edit Folder
- Method: putPath:
/documents/api/1.2/folders/{folderId}
- Edit Folder Tags
- Method: putPath:
/documents/api/1.2/folders/{folderId}/tags
- Get Folder
- Method: getPath:
/documents/api/1.2/folders/{folderId}
- Get Folder Assigned Metadata Collections
- Method: getPath:
/documents/api/1.2/folders/{folderId}/metadataFields
- Get Folder Metadata Collection
- Method: getPath:
/documents/api/1.2/folders/{folderId}/metadata
- Get Folder Tags
- Method: getPath:
/documents/api/1.2/folders/{folderId}/tags
- Get Home Folder Contents
- Method: getPath:
/documents/api/1.2/folders/items
- Get Information on Multiple Folders
- Method: getPath:
/documents/api/1.2/folders/lists
- Get Specific Folder Contents
- Method: getPath:
/documents/api/1.2/folders/{folderId}/items
- Get Status of a Bulk Download Job
- Method: getPath:
/documents/api/1.2/folders/{folderId}/_download/{jobId}
- Move Folder
- Method: postPath:
/documents/api/1.2/folders/{folderId}/move
- Search Folders or Files
- Method: getPath:
/documents/api/1.2/folders/search/items
- Search Folders or Files Under Specific Folder ID
- Method: getPath:
/documents/api/1.2/folders/{folderId}/search/items
- Set Folder Tags
- Method: postPath:
/documents/api/1.2/folders/{folderId}/tags