Index | BlackBerry Workspaces SDK |
Name | Path | Version | Description |
---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
addEntityToDocumentV30Adds permitted entity to workspace with no permissions outside of the given folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/documents/entity/add | ||
Request Body: | AddDocumentEntity | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addEntityToFolderV30Adds permitted entity to workspace with no permissions outside of the given folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/entity/add | ||
Request Body: | AddFolderEntity | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addEntityV30This call adds a new entity to a workspace. Only groups domains users and "everyone" may be direct members of a VDR. other entities (like distributionlists) need to be members of a room group in order to gain permission to the room. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/entities/add | ||
Request Body: | AddEntityVdr | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
roomId: String - The room to add the new entity to.
|
|||
|
addFolderPermissionRequestV30Adds a new permission request for folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/permissions/requests/add | ||
Request Body: | AddFolderPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addMembersToGroupV30Adds members (users) to a group. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/group/members/add | ||
Request Body: | AddMembersToGroupWithGroup | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
addMembersV30Adds members to a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/members/add | ||
Request Body: | AddRoomMembers | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
roomId: String - the workspace to add members to.
|
|||
|
addPermissionsV30Adds permissions for entities (users/groups/domains) to a set of files in a workspace. Permissions can be eg copy, print, edit, download etc. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/permissions/add | ||
Request Body: | VdrAddPermissions | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - the room id of the workspace containing the files.
|
|||
|
addTagsV30Adds tags to a list of files. Tags can be numerical, free text or datestamps. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/tag | ||
Request Body: | AddDocumentsTagValues | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - the workspace containing the files.
|
|||
|
changeDefaultPermissionsBulkV30Changes default permissions of a permitted entity in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/entities/permissions/change/bulk | ||
Request Body: | ChangeEntitiesVdr | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
changeDefaultPermissionsV30Changes default permissions of a permitted entity in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/entities/permissions/change | ||
Request Body: | ChangeEntityVdr | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
roomId: String - the room id of the workspace to change permissions for.
|
|||
|
copyDocumentsFromRoomsToExchangeAsyncV30Submits files in Sent items (asynchronous). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/copy/exchange/async | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ExternalDocumentsTransactionResult | ||
|
copyDocumentsFromRoomsToExchangeV30Submits files in Sent items. This submits room files to recipients within SDS the files will be copied from the room to SDS |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/copy/exchange | ||
Request Body: | CopyDocumentFromRoom | ||
Response Headers: | N/A | ||
Response Body: | Document | ||
|
copyMembershipV30Copies membership (of several users) to another existing user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/copyMembership | ||
Request Body: | CopyMembership | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - room containing the members (existing and new).
|
|||
|
createExternalFoldersTreeV30Creates a folder in a workspace for each external folder in the tree. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/external/create | ||
Request Body: | CreateWorkspaceExternalFolders | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
createFoldersBulkV30Creates a folder in a workspace with a specified path. the workspace in which the folder is to be created. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/create/bulk | ||
Request Body: | CreateFolderAsync | ||
Response Headers: | N/A | ||
Response Body: | TransactionStatus | ||
|
createFoldersInFolderIfNewV30Creates a folder in a workspace with a specified parent ID and name. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/create/check | ||
Request Body: | CreateFolder | ||
Response Headers: | N/A | ||
Response Body: | FolderSuggestedName | ||
|
createFoldersInFolderV30Creates a folder in a workspace with a specified parent ID and name. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/create | ||
Request Body: | CreateFolder | ||
Response Headers: | N/A | ||
Response Body: | Folder | ||
|
createFoldersTreeAsyncV30Creates a folder in a workspace for each folder in the tree asynchronous. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/tree/create/async | ||
Request Body: | CreateWorkspaceFolderTree | ||
Response Headers: | N/A | ||
Response Body: | ExternalFoldersTransactionResult | ||
|
createFoldersTreeV30Creates a folder in a workspace for each folder in the tree. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/tree/create | ||
Request Body: | CreateWorkspaceFolderTree | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
createNewDocumentV30Create new empty document |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/document/new/create | ||
Request Body: | CreateNewDocument | ||
Response Headers: | N/A | ||
Response Body: | SubmitIfNew | ||
|
createRoomV30Creates a workspace. Assign a name, description and list of administrators for the room. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/create | ||
Request Body: | CreateRoom | ||
Response Headers: | N/A | ||
Response Body: | Room | ||
|
deleteDocumentsBulkV30Deletes files and/or folders. The files and folders can be in different rooms (workspaces) ?? |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/documents/delete | ||
Request Body: | BulkDeleteWorkspaceDocuments | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteDocumentsV30Deletes files and/or folders from a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/delete | ||
Request Body: | DeleteDocumentsSelectionVdr | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - workspace containing the folder to be moved.
|
|||
|
deleteEntitiesV30Deletes entities from a workspace. All permissions for the entity in the room will be revoked as well. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/entities/delete | ||
Request Body: | DeleteRoomEntities | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
roomId: String - the room to remove the entities from.
|
|||
|
deleteFolderV30Deletes a folder and all of its subfolders and files from a workspace. The user must have sufficient rights to delete the folders. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/folders/delete | ||
Request Body: | DeleteFolder | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - the room containing the folder to be deleted.
|
|||
|
deleteRoomV30Deletes a workspace and all its contents. The deletion can be recoverable (from the recycle bin) or permanent. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/delete | ||
Request Body: | DeleteRoom | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
documentUploadCompleteV30Completes the already uploaded by chunks file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/{documentGuid}/upload/completed | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
documentGuid: String - the guid for the file.
roomId: String - the room into which the file will be uploaded. |
|||
|
downloadDocumentsWithRecycleBinV30Downloads files from the recycle bin for a given workspace. allowed for workspace admins only |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/recycleBin/download/zip | ||
Request Body: | DownloadWorkspaceDocumentsWithRecycleBin | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
downloadGenericDocumentsV30Creates and downloads a ZIP file containing all (original and protected) files in a specified workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/zip | ||
Request Body: | DownloadDocumentsSelectionVdr | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
roomId: String - room id of the workspace containing the files.
|
|||
|
downloadSingleRecycleBinDocumentV30Downloads the original version of the file. Allowed only for workspace admins |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/recycleBin/download | ||
Request Body: | DownloadSingleRecycleBinWorkspaceDocument | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
editFoldersAndDocumentsSettingsBulkV30Edit folder permission settings - whether the folder should inherit permissions from its parent, and whether to force descendants inherit. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/documents/settings/edit | ||
Request Body: | EditFoldersAndDocumentsSettingsBulk | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editManagersToGroupV30Edit managers on groups ( set or unset manager properties for users). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/group/managers/edit | ||
Request Body: | EditManagersOnGroup | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editPermissionsV30Edit permissions for a list of files for a list of entities (users, groups, etc). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/permissions/edit | ||
Request Body: | VdrEditPermissions | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - the room id of the workspace containing the files.
|
|||
|
editRoomV30Renames a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/edit | ||
Request Body: | EditRoom | ||
Response Headers: | N/A | ||
Response Body: | Room | ||
Path parameters:
roomId: String - room id of room to be renamed.
|
|||
|
entityListV30List the workspace entities (groups/domain/users) that are members of the workspace. This may only be done by users that have CRUD entities privileges. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /rooms/{roomId}/entities | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
Path parameters:
roomId: String - the requested room.
|
|||
|
entityPagedListV30List the room entities (groups/domain/everyone) that are members of the room. This may only be done by users that have CRUD entities privileges. This request returns a paged list |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/entities | ||
Request Body: | ListRoomEntities | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
exportGroupLogToJsonV30Exports the workspace groups log to JSON. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/grouplog/create | ||
Request Body: | BaseLog | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
Path parameters:
roomId: String - room id for workspace containing the files.
|
|||
|
exportGroupLogV30Exports the workspace groups log. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/log/csv/create | ||
Request Body: | BaseLog | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
roomId: String - room id for workspace containing the files.
|
|||
|
foldersReadConfirmationEditV30set the default read confirmation flag for folders |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/read/confirmation/edit | ||
Request Body: | FolderReadConfirmationEdit | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
generateGuidV30Creates a GUID for a new file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/create | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | Guid | ||
Path parameters:
roomId: String - - the GUID for the room to which the file will be added.
|
|||
|
getBulkEmailDataV30Gets data for bulk email notifications. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/documents/emails/get | ||
Request Body: | GetEmailBulkData | ||
Response Headers: | N/A | ||
Response Body: | EmailBulkData | ||
|
getDocumentGUIDV30Gets a document GUID. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/list/guid | ||
Request Body: | GetGuidByFolderAndName | ||
Response Headers: | N/A | ||
Response Body: | Guid | ||
Path parameters:
roomId: String - room id for workspace containing the files.
|
|||
|
getDocumentInfoV30Gets information about a specific file in a workspace. The information includes the file name, permissions, time of last update, date most recently viewed, expiry date, tags, etc. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /rooms/{roomId}/documents/{guid} | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | Document | ||
Path parameters:
guid: String - the guid of the file.
roomId: String - the room id of the workspace containing the file. |
|||
|
getDocumentLinksV30Gets links for a file in a workspace. The link is a URI for the file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/document/links | ||
Request Body: | Guid | ||
Response Headers: | N/A | ||
Response Body: | DocumentLinks | ||
|
getExternalTransactionStatusV30Gets external transaction status. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/external/transaction/status | ||
Request Body: | ExternalTransactionInput | ||
Response Headers: | N/A | ||
Response Body: | ExternalTransactionStatus | ||
|
getFolderInfoV30Get info for a folder if it has been updated later than a specified date. Info returned is folder name, subfolders, update date. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/info/list | ||
Request Body: | GetFolderInfo | ||
Response Headers: | N/A | ||
Response Body: | FolderInfo | ||
|
getFolderLinksV30Gets links for a folder in a workspace. The link is a URI for the folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/folder/links | ||
Request Body: | PathOrFolderId | ||
Response Headers: | N/A | ||
Response Body: | FolderLinks | ||
Path parameters:
roomId: String - Id workspace for which links are to be obtained.
|
|||
|
getFolderTreeV30Gets the tree of all folders and subfolders in a specified workspace. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /rooms/{roomId}/folders | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | Folder | ||
Path parameters:
roomId: String - the room for which the tree will be returned.
|
|||
Query parameters:
folderUuid: String.
|
|||
|
getGroupInfoV30Gets information about a group in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/group/info | ||
Request Body: | GetGroupInfo | ||
Response Headers: | N/A | ||
Response Body: | RoomEntity | ||
|
getGroupsV30Gets a list of all groups in a specified workspace. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /rooms/{roomId}/groups | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
Path parameters:
roomId: String - room id of workspace.
|
|||
|
getInfoForAdminV30Gets workspace info. The info includes the name, creation date, deletion date, URL, product, access level, whether workspace is shared, explicit |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/admin/{roomId}/info | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | WorkspaceInfo | ||
Path parameters:
roomId: String - room to obtain information about.
|
|||
Query parameters:
addExternalData: boolean - include external data. (optional, default: true).
fetchEvenIfDeleted: boolean - fetch even if deleted. (optional, default: false). includeWorkspacePolicyData: boolean - include workspace policy data. (optional, default: false). |
|||
|
getInfoV30Gets workspace info. The info includes the name, creation date, deletion date, URL, product, access level, whether workspace is shared, explicit |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/info | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | WorkspaceInfo | ||
Path parameters:
roomId: String - room to obtain information about.
|
|||
Query parameters:
addExternalData: boolean - include external data. (optional, default: true).
adminMode: boolean - admin mode. (optional, default: true). fetchEvenIfDeleted: boolean - fetch even if deleted. (optional, default: false). includeSyncData: boolean - include sync data. (optional, default: false). includeWorkspacePolicyData: boolean - include workspace policy data. (optional, default: false). |
|||
|
getInitialSyncStateForExternalRoomV30Applies a decision on a request. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/external/initialsync/status | ||
Request Body: | InitialSyncRoomData | ||
Response Headers: | N/A | ||
Response Body: | InitialSyncStatus | ||
|
getInviteTextV30Gets invite email message for file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/{guid}/invite/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | InviteText | ||
Path parameters:
emailSubject: String - subject line of invite email message.
guid: String - file guid. roomId: String - room containing file. |
|||
|
getInviteTextV30Gets invite email message for workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/invite/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | InviteText | ||
Path parameters:
emailSubject: String - subject line of invite email message.
roomId: String - room. |
|||
|
getPermissionsV30Returns all permitted entities permitted to the workspace. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /rooms/{roomId}/documents/{guid}/permissions | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
Path parameters:
guid: String - The file guid to get the recipients for.
roomId: String - room to obtain information about. |
|||
|
getRoomLinksV30Returns the URL link to a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/links | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | RoomLinks | ||
Path parameters:
roomId: String - the workspace.
|
|||
|
getRoomsTagValuesV30Gets a list of tags for a list of the user's workspaces. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/tags/values/get | ||
Request Body: | RoomList | ||
Response Headers: | N/A | ||
Response Body: | TagList | ||
|
inviteV30Invite groups to a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/invite | ||
Request Body: | Invite | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - room to which groups will be invited.
|
|||
|
inviteV30Invites groups to a specific file in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/{guid}/invite | ||
Request Body: | Invite | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
guid: String - guid for file.
roomId: String - room containing the file. |
|||
|
listDocumentsForAdminV30Lists all files in a specified workspace for admin console requests. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/admin/{roomId}/documents/list | ||
Request Body: | ListDocumentsVdr | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
Path parameters:
roomId: String - The workspace to get file list from.
|
|||
|
listDocumentsV30Requests a list of all files in a specified workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/list | ||
Request Body: | ListDocumentsVdr | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
Path parameters:
roomId: String - The workspace to get file list from.
|
|||
|
listFolderDefaultPermissionsV30Available for workspace admins only. Shows permissions for each of the default entities in given folder |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/permissionDetails/list/folder | ||
Request Body: | ListFolderDefaultPermissions | ||
Response Headers: | N/A | ||
Response Body: | FolderDefaultPermissions | ||
|
listFolderPermissionRequestsV30Lists existing permissions requests for folder or the entire workspace where the root folder is supplied. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/permissions/requests/list | ||
Request Body: | ListFolderPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listFolderPermissionsBulkV30Available for workspace admins only. Shows aggregation of permissions of folders (not including expiration date) |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/permissionDetails/list/ | ||
Request Body: | ListBulkFolderPermissions | ||
Response Headers: | N/A | ||
Response Body: | PermissionDetails | ||
|
listFoldersAndDocumentsV30Lists all folders and files in the specified workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/folders/documents/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | FoldersDocuments of type Document or Folder | ||
Path parameters:
roomId: String - Id of the room to obtain the information about.
|
|||
|
listLastResolvedFolderPermissionRequestsV30Lists last resolved permission requests on folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/permissions/requests/listLastResolve | ||
Request Body: | ListLastResolvedFolderPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listPermissionDetailsV30Lists permission details for files and folders bulkly for all entities in the room. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/permissionDetails/list | ||
Request Body: | ListPermissionDetails | ||
Response Headers: | N/A | ||
Response Body: | PermissionDetails | ||
|
listRoomsByTypeV30 |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/list | ||
Request Body: | ListRoomsByType | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listRoomsForAdminV30Retrieves a list of all the workspaces for a user with VIEW_ALL_ROOMS capability. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /rooms/admin/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
Query parameters:
addExternalData: boolean - add external data. (optional, default: true).
workspaceTypes: Set |
|||
|
listRoomsV30Retrieves a list of all the workspaces of the current user. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /rooms | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
Query parameters:
addExternalData: boolean - include external data. (optional, default: true).
adminMode: boolean - for backwards compatibility. (optional, default: true). includeSyncData: boolean - include sync data. (optional, default: false). includeWorkspacePolicyData: boolean - include workspace policy data. (optional, default: false). workspaceTypes: Set |
|||
|
listWorkspaceGroupMembershipsForUserV30Lists groups in the workspace for a user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/groups/memberships/list | ||
Request Body: | ListWorkspaceGroupMembershipsForUserRequest | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listWorkspacesRecycleBinDocumentsV30Lists files in the workspace Recycle bin. The recycle bin holds files from workspaces that have been deleted, but not permanently. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/recycleBin/documents/list | ||
Request Body: | ListWorkspaceRecycleBinDocuments | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listWorkspacesRecycleBinWorkspacesV30Lists workspaces in the workspaces Recycle bin. The recycle bin holds workspaces that have been deleted, but not permanently. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/recycleBin/rooms/list | ||
Request Body: | ListWorkspaceRecycleBinWorkspaces | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
loadToCacheV30Adds a workspace to cache (saved for offline). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/cache/load | ||
Request Body: | LoadToCache | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
lockDocumentsV30Locks files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/documents/lock | ||
Request Body: | LockDocumentsRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
markRoomAsExplicitV30Marks a workspace as explicit. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/mark | ||
Request Body: | RoomExplicit | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
roomId: String - the room to be marked.
|
|||
|
markV30Marks a specified list of files with a mark. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/documents/mark | ||
Request Body: | MarkDocumentsSelection | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
markV30Marks a specified list of files in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/mark | ||
Request Body: | MarkDocumentsSelectionVdr | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - room containing the files.
|
|||
|
modifyGroupV30Use this function when you wish to change a group that already exists in the workspace. You can change the group name and the group identifier with this function. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/group/modify | ||
Request Body: | ModifyGroupWithGroup | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
moveAllV30Moves all files from one folder in a workspace to another folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/moveAll | ||
Request Body: | MoveAll | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - the room (workspace) containing both source and target folders.
|
|||
|
moveDocumentV30Moves a file in a workspace to a new folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/{guid}/move | ||
Request Body: | PathOrFolderId | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
guid: String - guid of file to be moved.
roomId: String - room id of workspace containing the file. |
|||
|
moveFolderIntoFolderV30Moves a folder in a workspace (and its contents) to a new location within the same workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/move | ||
Request Body: | MoveFolderIntoFolder | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
moveFolderV30Moves a folder in a workspace (and its contents) to a new location within the same workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/folders/move | ||
Request Body: | MoveFolder | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - workspace containing the folder to be moved.
|
|||
|
moveV30Moves files in a workspace folder to a different folder within the same workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/move | ||
Request Body: | Move | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - the the workspace with the files to be moved.
|
|||
|
openForAllRoomV30Sets a workspace to be open to all entities (users, groups, domains etc). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/openForAllRoom/edit | ||
Request Body: | OpenForAllRoomEdit | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - the room id for the workspace to be opened.
|
|||
|
removeAllTagsV30Removes all tags for a specified file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/{documentGuid}/untagField | ||
Request Body: | TagField | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
documentGuid: String - the guid of file.
roomId: String - the workspace containing the file. |
|||
|
removeMembersFromGroupV30Removes members (users) from a group. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/group/members/remove | ||
Request Body: | RemoveMembersFromGroup | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
removeTagsV30Removes specified tags from a list of files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/untag | ||
Request Body: | RemoveDocumentsTagValues | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - the workspace containing the files.
|
|||
|
renameDocumentV30Renames a file in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/{guid}/rename | ||
Request Body: | UpdateDocument | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
guid: String - guid for file to be renamed.
roomId: String - room id for workspace containing the file. |
|||
|
renameFolderV30Renames a folder within a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/folders/rename | ||
Request Body: | RenameFolder | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
roomId: String - room (workspace) with original folder.
|
|||
|
resolveActionForFolderPermissionRequestV30Applies a decision on a request. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/permissions/requests/resolve | ||
Request Body: | ResolveActionForFolderPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
restoreWorkspaceRecycleBinAllDocumentsV30Restores all documentss from Recycle bin for the specified workspace uuid. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomUuid}/recycleBin/restoreall | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomUuid: String - the workspace (room) uuid of the workspace to have all it's recycle bin docs restored.
|
|||
|
restoreWorkspacesRecycleBinDocumentsV30Restores files from Recycle bin. Files are restored to their original workspaces and removed from the recycle bin. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/recycleBin/documents/restore | ||
Request Body: | RestoreWorkspacesRecycleBinDocument | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
restoreWorkspacesRecycleBinWorkspacesV30Restores workspaces from Recycle bin. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/recycleBin/rooms/restore | ||
Request Body: | RestoreWorkspacesRecycleBinWorkspaces | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
revokePermissionsV30Revokes all permissions for a list of entities (users, groups etc) for a list of files in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/permissions/revoke | ||
Request Body: | VdrRevokePermission | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - the room id for the workspace containing the files.
|
|||
|
searchDocumentsForAdminV30For use in Admin console: Search for files in workspaces according to a search string. In order to search Tag fields you should use the following syntax in the query String: query = "tagName1: (value1 OR value2) tagName2: (value3) This query will fetch all files that have value1 or value2 for tagName 1 and also have value 3 for tagName 2) it's also possible to put OR between the two tagNames. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/admin/documents/search | ||
Request Body: | SearchDocumentsVdr | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
searchDocumentsV30For use in MyDox: Search for files in workspaces according to a search string. In order to search Tag fields you should use the following syntax in the query String: query = "tagName1: (value1 OR value2) tagName2: (value3) This query will fetch all files that have value1 or value2 for tagName 1 and also have value 3 for tagName 2) it's also possible to put OR between the two tagNames. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/documents/search | ||
Request Body: | SearchDocumentsVdr | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
sendBulkEmailV30Sends bulk email notifications for a list of files to all permitted entities (users, groups etc) for each file. The emails are sent immediately. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/documents/emails/send | ||
Request Body: | SendEmailBulk | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
sendEmailV30Sends email to group of recipients with a message regarding a specific file in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/{guid}/email/send | ||
Request Body: | SendEmail | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
guid: String - guid of the file.
roomId: String - room id of the workspace containing the file. |
|||
|
setSharepointProtectorV30Sets protect anywhere policy for a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/protectAnywhere/set | ||
Request Body: | BulkWorkspaceProtectorSettings | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
setUpdateDataV30Sets files update data. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/setUpdateData | ||
Request Body: | DocumentsUpdateDataSet | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
submitDocumentIfNewV30Submits a file to a room if the file is new (ie not a new version of an existing file). The submit action follows a file upload to a room, and sends, for example, email notifications to entities (users, groups etc). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/submitIfNew | ||
Request Body: | SubmitDocumentVdr | ||
Response Headers: | N/A | ||
Response Body: | SubmitIfNew | ||
Path parameters:
roomId: String.
|
|||
|
submitDocumentsV30Submits files to a workspace. The submit action is requested after files have been uploaded to a workspace, to notify entities (users, groups etc) |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/submit | ||
Request Body: | SubmitDocumentsVdr | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
Path parameters:
roomId: String - the room id of the room (workspace) into which the files will be submitted.
|
|||
|
unlockDocumentsV30Unlock files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/documents/unlock | ||
Request Body: | UnlockDocumentsRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
uploadBlobV30Uploads a file to a workspace and generates a new GUID for it. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/upload | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | Guid | ||
Path parameters:
roomId: String - the room into which the file will be uploaded.
|
|||
Data form parameters:
data: File - information about the file to be uploaded: filename folder.
data2: FormDataContentDisposition. deviceType: DeviceType - device type. documentName: String - document name. fileName: String - file name. start: Long - start. |
|||
|
uploadDocumentBase64V30Uploads a file to a workspace in base64. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/{documentGuid}/uploadBase64 | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
documentGuid: String - the guid for the file.
roomId: String - the room into which the document will be uploaded. |
|||
Data form parameters:
data: InputStream - information about the file to be uploaded: filename folder.
data2: FormDataContentDisposition - used by https to copy files. deviceType: DeviceType - device type. documentName: String - name for the file. |
|||
|
uploadDocumentByPostV30Uploads a file to a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/{documentGuid}/upload | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
documentGuid: String - the guid for the file.
roomId: String - the room into which the file will be uploaded. |
|||
Data form parameters:
data: File - information about the file to be uploaded: filename folder.
data2: FormDataContentDisposition - used by https to copy files. deviceType: DeviceType - device type. documentName: String - name for the file. fileName: String - name of the file. start: Long - the start to the specified uploadedInputStream. |
|||
|
validateCreateFolderV30Validates the parameters are ok for adding folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/folders/validate | ||
Request Body: | ValidateCreateFolder | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
validateDocumentsToDownloadFromRecycleBinV30Validates files to download from a Recycle bin. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/recycleBin/download/validateDownload | ||
Request Body: | ValidateDownloadWorkspaceDocumentsWithRecycleBin | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
validateDocumentsToDownloadV30Validates the file versions for download from a list of files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/documents/versions/validateDownload | ||
Request Body: | ValidateDownloadDocumentVersionInVdrs | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
validateDocumentsToDownloadV30Validates a list of files for download from a specific workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /rooms/{roomId}/documents/validateDownload | ||
Request Body: | ValidateDownloadDocumentsSelectionVdr | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
roomId: String - room id for workspace containing the files.
|
|||
|