Index | BlackBerry Workspaces SDK |
Name | Path | Version | Description |
---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DownloadCommentsV30Download a pdf contains all the comments of the given document |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/comment/download | ||
Request Body: | DownloadTransientComments | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
addEntitiesV30Adds permitted entities to workspace with no permissions outside of the given folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/entities/add | ||
Request Body: | AddEntitiesTransient | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addNotificationV30Adds a notification for a file action in the file's activity log file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/logAction | ||
Request Body: | CreateTransientActivityLogRecord | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addTransientDocumentPermissionRequestV30Add a permission request for a document in a transient workspace |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/permissions/requests/add | ||
Request Body: | AddTransientDocumentPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addTransientFolderPermissionRequestV30Add a permission request for a folder in a transient workspace |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/folder/permissions/requests/add | ||
Request Body: | AddTransientFolderPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
changeDefaultPermissionsBulkV30Changes default permissions of a permitted entity in a transient workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/entities/permissions/change | ||
Request Body: | ChangeEntitiesTransient | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
checkForBoxAccessTokenV30Check if the logged in user has a Box access token stored. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/hasBoxAccessToken | ||
Request Body: | ExternalRepositoryGuid | ||
Response Headers: | N/A | ||
Response Body: | CheckBoxAccessTokenResult | ||
|
checkForCredentialV30Check if the logged in user has a valid Dropbox access token stored. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/hasDropboxAccessToken | ||
Request Body: | GetDropboxWorkspace | ||
Response Headers: | N/A | ||
Response Body: | CheckDropboxAccessTokenResult | ||
|
copyDocumentsFromRoomsToExchangeAsyncV30Copies a transient file to Microsoft Exchange. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/copy/exchange/async | ||
Request Body: | CopyTransientDocumentToExchangeAsync | ||
Response Headers: | N/A | ||
Response Body: | TransientDocumentsTransactionResult | ||
|
createDropboxWorkspaceV30Creates a new transient workspace for Dropbox. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/createDropboxWorkspace | ||
Request Body: | CreateDropboxWorkspace | ||
Response Headers: | N/A | ||
Response Body: | TransientWorkspace | ||
|
createFolderV30Creates a new transient folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/folder/create | ||
Request Body: | CreateTransientFolder | ||
Response Headers: | N/A | ||
Response Body: | TransientFolder | ||
|
createNewCommentV30Add new comment to transient document |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/comment/create | ||
Request Body: | CreateNewTransientComment | ||
Response Headers: | N/A | ||
Response Body: | CreateNewTransientCommentResult | ||
|
createNewTransientDocumentV30Create new empty document |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/document/new/create | ||
Request Body: | CreateNewTransientDocument | ||
Response Headers: | N/A | ||
Response Body: | SubmitIfNewTransientDocument | ||
|
createRoomV30Creates a new transient workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/create | ||
Request Body: | CreateTransientWorkspace | ||
Response Headers: | N/A | ||
Response Body: | TransientWorkspace | ||
|
deleteCommentV30Update comment |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/comment/delete | ||
Request Body: | DeleteTransientComment | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteDocumentsAndFoldersV30Deletes transient folders and files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/delete | ||
Request Body: | DeleteTransientDocumentsAndFolders | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteRoomV30Delete transient workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/delete | ||
Request Body: | DeleteTransientWorkspace | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteUserDocumentAnnotationV30Delete annotations from transient file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/document/annotations/delete | ||
Request Body: | DeleteTransientDocumentAnnotations | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
documentUploadCompleteV30Complete uploaded file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/{roomId}/documents/{documentGuid}/upload/completed | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
documentGuid: String - document guid.
roomId: String - room id. |
|||
|
downloadDocumentAnnotationsOriginalV30Returns the annotations for a given file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/document/annotations/original | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
path: String.
user: String. workspaceGuid: String. |
|||
|
downloadDocumentsFormV30Downloads a set of specified files or all files in a set of specified folders and files in a transient workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/download/documents.zip | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
documentPaths: Set
downloadType: String. folderPaths: Set wdUniqueDownloadKey: String. workspaceUuid: String. |
|||
|
downloadOriginalV30Returns a single file. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /3.0/transient/workspace/{workspaceGuid}/download | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
workspaceGuid: String - workspace guid.
|
|||
Query parameters:
documentPath: String - document path.
downloadType: String - download type. (optional, default: "ORIGINAL"). forceWatermarks: String - force water marks. (optional, default: "false"). |
|||
|
downloadSingleDocumentForWebV30Downloads a single file (for web). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/downloadForWeb | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
documentPath: String.
downloadType: String. forceWatermarks: boolean. wdUniqueDownloadKey: String. workspaceUuid: String. |
|||
|
downloadSingleDocumentForWebV30Downloads a single file for web (additional info is returned). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/downloadForWeb | ||
Request Body: | DownloadSingleTransientDocumentForWeb | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
downloadSingleDocumentV30Downloads a single file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/download | ||
Request Body: | DownloadSingleTransientDocument | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
downloadUserDocumentAnnotationsInDocFormForWebV30Returns the annotations for a user file in PDF format. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/annotations/downloadInDocForWeb | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
path: String.
userAddress: String. wdUniqueDownloadKey: String. workspaceGuid: String. |
|||
|
downloadUserDocumentAnnotationsInDocFromV30Downloads document annotations in zip format. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/annotations/downloadInDocZip | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
path: String.
userAddresses: Set wdUniqueDownloadKey: String. workspaceGuid: String. |
|||
|
downloadUserDocumentAnnotationsInDocMultipleFromV30Downloads annotations for file in a user's workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/annotations/downloadInDocMultiple | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
path: String.
userAddresses: Set wdUniqueDownloadKey: String. workspaceGuid: String. |
|||
|
downloadUserDocumentAnnotationsV30Downloads user file annotations. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/document/annotations/download | ||
Request Body: | DownloadTransientDocumentAnnotations | ||
Response Headers: | N/A | ||
Response Body: | DocumentAnnotationsForUsers | ||
|
editFoldersAndDocumentsSettingsBulkV30Edit folder and file permissions in bulk. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/folders/documents/settings/edit | ||
Request Body: | TransientEditFoldersAndDocumentsSettingsBulk | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
exportActivityHistoryForRoomsV30Returns a CSV file of workspace activity history for the given set of rooms. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/activityHistory/csv/create | ||
Request Body: | ExportActivityHistoryForTransientRooms | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
exportActivityLogV30Gets activity log CSV for a file in WD. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/activityLog/csv/create | ||
Request Body: | GetTransientDocumentActivityLogRequest | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
exportSpecificUsersActivityHistoryByMailV30Exports a selected Activity history for a list of users in current user's organization to a CSV file as an attachment to an email. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/users/activityHistory/allProducts/csv/exportByMail | ||
Request Body: | ExportSpecificUsersTransientActivityHistoryByMail | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
exportUsersActivityHistoryV30Exports activity history for a list of users in current user's organization to a CSV file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/users/activityHistory/allProducts/csv/create | ||
Request Body: | ExportUsersTransientActivityHistory | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
generateGuidV30Creates file GUID for new or updated files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/guid/create | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | Guid | ||
|
generateGuidV30Creates file GUID for new file in a workspace context. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/guid/create | ||
Request Body: | GenerateTransientDocumentGuid | ||
Response Headers: | N/A | ||
Response Body: | Guid | ||
|
getActivityLogV30Gets activity log for a file in WD in CSV format. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/activityLog/csv/export | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
documentPath: String.
fromDate: String. lastActionPerUser: boolean. pageNumber: Integer. pageSize: Integer. toDate: String. workspaceUuid: String. |
|||
|
getActivityLogV30Gets activity log for a file in BlackBerry Workspaces. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/activityLog | ||
Request Body: | GetTransientDocumentActivityLogRequest | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
getBoxOAuthParametersV30Return Box OAuth Parameters. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /3.0/transient/workspace/boxOauthParams | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | BoxOAuthParams | ||
|
getDocumentInfoV30Retrieves file info. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/document/info | ||
Request Body: | TransientDocumentInfo | ||
Response Headers: | N/A | ||
Response Body: | TransientDocument | ||
|
getDropboxOAuthParametersV30Return Dropbox OAuth Parameters. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/getDropboxOauthParams | ||
Request Body: | GetDropboxWorkspace | ||
Response Headers: | N/A | ||
Response Body: | DropboxOAuthParams | ||
|
getFolderInfoV30Gets single level of folders. workspace to get a single level of folders from |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/folders/info/list | ||
Request Body: | GetTransientFolderInfo | ||
Response Headers: | N/A | ||
Response Body: | TransientFolderInfoResult | ||
|
getPathInfoV30Get info for a path. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/path/info/list | ||
Request Body: | GetPathInfo | ||
Response Headers: | N/A | ||
Response Body: | TransientPathInfo | ||
|
getPermissionsForIOSV30Returns the iOS-targeted list of permissions for a file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/permissions/ios | ||
Request Body: | GetTransientDocumentPermissionsForIos | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
getValidPathInfoListV30Get info for a valid list paths. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/valid/path/info/list | ||
Request Body: | GetValidPathInfoList | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
getWorkspaceInfoV30Return info on the workspace |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/workspace/info | ||
Request Body: | GetTransientWorkspaceInfo | ||
Response Headers: | N/A | ||
Response Body: | TransientWorkspaceInfo | ||
|
initiateConversionJsonV30Initiates conversion. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/conversion/initiate | ||
Request Body: | TransientInitiateConversion | ||
Response Headers: | N/A | ||
Response Body: | TransientInitiateConversionResult | ||
|
inviteV30Invite groups to a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/invite | ||
Request Body: | TransientInvite | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
inviteV30Invites groups to a specific file in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/invite | ||
Request Body: | TransientDocumentInvite | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
listCommentsV30List document comments hierarchy |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/comment/list | ||
Request Body: | ListTransientDocumentComments | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listFoldersAndDocumentsV30Retrieves a list of transient files and folders. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/folders/documents/list | ||
Request Body: | ListTransientFoldersAndDocuments | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listFoldersSingleLevelV30Gets the tree of all folders. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/folders/list | ||
Request Body: | ListTransientFolders | ||
Response Headers: | N/A | ||
Response Body: | ListTransientFoldersSingleLevelResult | ||
|
listLastResolvedTransientDocumentPermissionRequestsV30
|
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/permissions/requests/listLastResolve | ||
Request Body: | ListLastResolvedTransientDocumentPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listLastResolvedTransientFolderPermissionRequestsV30
|
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/folder/permissions/requests/listLastResolve | ||
Request Body: | ListLastResolvedTransientFolderPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listOrganizationPolicyV30Returns the organization policy for the given workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/policy/document/list | ||
Request Body: | ListTransientOrganizationPolicy | ||
Response Headers: | N/A | ||
Response Body: | OrganizationPolicy | ||
|
listPermissionDetailsV30List permission details for files and folders for all entities in the workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/permissionDetails/list | ||
Request Body: | ListTransientPermissionDetails | ||
Response Headers: | N/A | ||
Response Body: | PermissionDetails | ||
|
listStarredDocumentsV30List starred files in transient workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/starred/list | ||
Request Body: | ListStarredTransientDocuments | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listTransientDocumentsPermissionRequestsV30Lists existing permission requests for a document in a transient workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/permissions/requests/list | ||
Request Body: | ListTransientDocumentsPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listTransientFolderPermissionRequestsV30Lists existing permission requests for a folder in a transient workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/folder/permissions/requests/list | ||
Request Body: | ListTransientFolderPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listUnreadCommentsUserMentionPerDocumentV30List of unread comments of a certain document that user was mention in |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/comment/usermention/unread/list | ||
Request Body: | TransientListUserMentionInUnreadDocumentComments | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
mountDropboxSharedFolderV30provide the Dropbox shared folderId to add the folder to the workspace |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/mountDropboxSharedFolder | ||
Request Body: | DropboxMountSharedFolder | ||
Response Headers: | N/A | ||
Response Body: | DropboxMountSharedFolderResult | ||
|
moveV30Moves folders and files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/move | ||
Request Body: | TransientMove | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
renameDocumentV30Renames a file in a transient workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/document/rename | ||
Request Body: | RenameTransientDocument | ||
Response Headers: | N/A | ||
Response Body: | TransientDocument | ||
|
renameFolderV30Renames a transient folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/folder/rename | ||
Request Body: | RenameTransientFolder | ||
Response Headers: | N/A | ||
Response Body: | RenameTransientFolderResult | ||
|
resolveActionForTransientDocumentPermissionRequestV30Applies a decision on a request. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/permissions/requests/resolve | ||
Request Body: | ResolveActionForTransientDocumentPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
resolveActionForTransientFolderPermissionRequestV30Applies a decision on a request. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/folder/permissions/requests/resolve | ||
Request Body: | ResolveActionForTransientFolderPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
saveTransientWorkspaceCredentialsV30Saves the credentials for a given workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/credentials/save | ||
Request Body: | SaveTransientWorkspaceCredentials | ||
Response Headers: | N/A | ||
Response Body: | TransientFolder | ||
|
sendBulkEmailV30Sends emails to file users. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/emails/send | ||
Request Body: | SendEmailsToTransientDocuments | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
setupBoxAuthTokenV30Update existing Box workspace token info(re-authenticate) or create a new Box workspace with the Box token info(sign-in) |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/setupBoxAuthToken | ||
Request Body: | SetupBoxToken | ||
Response Headers: | N/A | ||
Response Body: | TransientWorkspace | ||
|
shareUserDocumentAnnotationV30Shares file annotations with the provided users and/or groups. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/annotations/share | ||
Request Body: | ShareTransientDocumentAnnotation | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
signOutBoxWorkspaceV30Sign out Box repository. It deletes Box workspace owned by the user and deletes the Box token info for the user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/signOutBox | ||
Request Body: | ExternalRepositoryGuid | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
signOutDropboxWorkspaceV30Sign out Dropbox repository. It deletes Dropbox workspace owned by the user and deletes the credential for the user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/signOutDropbox | ||
Request Body: | GetDropboxWorkspace | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
starDocumentsV30Marks a file with a star. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/star | ||
Request Body: | StarredTransientDocuments | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
submitDocumentIfNewV30Submits a new document version. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/{roomId}/documents/submitIfNew | ||
Request Body: | SubmitTransientDocumentVdr | ||
Response Headers: | N/A | ||
Response Body: | SubmitIfNewTransientDocument | ||
Path parameters:
roomId: String.
|
|||
|
submitVersionV30Submits a new file version. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/submitVersion | ||
Request Body: | SubmitTransientVersionVdr | ||
Response Headers: | N/A | ||
Response Body: | SubmitTransientDocumentResult | ||
|
unstarDocumentsV30Removes a star for a file |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/unstar | ||
Request Body: | UnStarredTransientDocuments | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
updateCommentV30Update comment |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/comment/update | ||
Request Body: | UpdateTransientComment | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
uploadDocumentByPostV30Uploads new file data. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/{roomId}/documents/{documentGuid}/upload | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
documentGuid: String - document guid.
roomId: String - room id. |
|||
Data form parameters:
data: File - file data.
data2: FormDataContentDisposition. deviceType: DeviceType - device type. documentName: String - document name. fileName: String - file name. start: Long - start. |
|||
|
uploadUserDocumentAnnotationV30Uploads annotations for a user file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/annotations/uploadWithDevice | ||
Request Body: | UploadUserTransientDocumentAnnotations | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
validateDocumentsToDownloadV30Validates files for download. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/documents/validateDownload | ||
Request Body: | ValidateDownloadTransientDocuments | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
validateDownloadUserDocumentAnnotationsInDocV30Validates user file annotations for download. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/annotations/validateDownloadInDoc | ||
Request Body: | ValidateDownloadUserTransientDocumentAnnotationsInDoc | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
validateKCDCredentialsV30validate the credentials for a kcd user on a given workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/kcd/credentials/validate | ||
Request Body: | ValidateKCDWorkspaceCredentials | ||
Response Headers: | N/A | ||
Response Body: | TransientFolder | ||
|
validateZipDownloadUserDocumentAnnotationsInDocV30Validates user document annotations for download. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/transient/workspace/annotations/download/validateDownloadInDocZip | ||
Request Body: | ValidateDownloadTransientDocumentsAnnotations | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|