Index | BlackBerry Workspaces SDK |
Name | Path | Version | Description |
---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
addDocumentPermissionRequestV30Adds a new permission request. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/permissions/requests/add | ||
Request Body: | AddDocumentPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addPermissionsV30Adds permissions to entities (users, groups) for a file or a list of files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/permissions/add | ||
Request Body: | SdsAddPermissions | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addRecipientsV30Adds recipients to files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/recipients/add | ||
Request Body: | SdsAddRecipients | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
copyDocumentsFromInboxV30Submits files in the WD Exchange. This submits inbox files to recipients within SDS the files will be copied from the inbox, that is a new copy separate from the original file |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/copy | ||
Request Body: | CopyDocumentFromInbox | ||
Response Headers: | N/A | ||
Response Body: | Document | ||
|
copyMultipleDocumentsToExchangeV30
|
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/copy/multiple/exchange/async | ||
Request Body: | CopyMultipleDocumentsToExchangeAsync | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteDocumentsV30Deletes files from the WD Exchange server. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/delete | ||
Request Body: | DeleteDocumentsSelectionSds | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
documentReadConfirmedV30the user is updated that he had read the document |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/read/confirmed | ||
Request Body: | DocumentVersionReadConfirmed | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
documentUploadCompleteV30Completes the already uploaded by chunks file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/{documentGuid}/upload/completed | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
documentGuid: String - The file's guid.
|
|||
|
documentsReadConfirmationEditV30set the read confirmation flag for folders |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/read/confirmation/edit | ||
Request Body: | DocumentsReadConfirmationEdit | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
downloadGenericDocumentsV30Downloads generic files. THe files are downloaded into zip file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/download/zip | ||
Request Body: | DownloadDocumentsSelectionSds | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
downloadOriginalV30Downloads the original (un-protected) version of the file. May only be done if user is permitted to access original files (file owner always has this right) |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /documents/{guid}/download/original | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
guid: String - The guid of the file to be downloaded.
|
|||
|
downloadProtectedForWebV30Downloads a protected file. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /documents/{guid}/downloadForWeb | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
guid: String - The guid of the file to be downloaded.
|
|||
|
downloadProtectedV30Downloads a protected file. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /documents/{guid}/download | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
guid: String - The guid of the file to be downloaded.
|
|||
|
downloadSentItemsWithRecycleBinV30Downloads sent items of a user with it's recycle bin. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/recycleBin/download/zip | ||
Request Body: | DownloadSentItemsDocumentsWithRecycleBin | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
downloadSentItemsWithRecycleBinV30Downloads sent items of a user with it's recycle bin. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/recycleBin/download/form/zip | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
userAddress: String - Email address of the user.
|
|||
|
downloadSingleDocumentV30Downloads a single file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/download | ||
Request Body: | DownloadSingleDocumentSelection | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
editCollaborationV30Edits collaboration of files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/collaboration/edit | ||
Request Body: | EditCollaboration | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
editPermissionsV30Edits permissions of a file in the WD Exchange. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/permissions/edit | ||
Request Body: | SdsEditPermissions | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
generateGuidV30Generates a new GUID for a new file that is about to be uploaded. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/create | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | Guid | ||
|
getActivityLogV30Gets activity log for a file in WD. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/activityLog | ||
Request Body: | GetDocumentActivityLogRequest | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
getDocumentChunksStatusV30Gets file uploaded chunks status using GUID. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/{guid}/chunks | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | DocumentChunks | ||
Path parameters:
guid: String - Guid of file to get status of.
|
|||
|
getDocumentConversionStatusV30Gets file conversion status using GUID. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/{guid}/conversion/status | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | DocumentConversionStatus | ||
Path parameters:
guid: String - Guid of the file to get status of.
|
|||
|
getDocumentLinkInfoV30Gets information on encrypted doc link. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/doclink/info | ||
Request Body: | GetDocumentLinkInfoRequest | ||
Response Headers: | N/A | ||
Response Body: | DocumentLinkInfoResult | ||
|
getDocumentsActivityLogV30Gets activity log for files in WD. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/activityLog/list | ||
Request Body: | GetDocumentsActivityLogRequest | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
getDocumentsConversionStatusV30Gets file Conversion status. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/conversion/status | ||
Request Body: | GetDocumentsConversionStatus | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
getDocumentsInfoV30Returns a list of info of all the files that are specified and the current user is permitted to view . |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/info/list | ||
Request Body: | GetDocumentsGuidsInfo | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
getDownloadPrepareDocumentStatusV30Gets download file chunk status. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/download/prepare/status | ||
Request Body: | DownloadPrepareDocumentStatusInput | ||
Response Headers: | N/A | ||
Response Body: | DownloadPrepareDocumentStatusOutput | ||
|
getInfoUnauthV30Get information about an unauthorized document. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/unauth | ||
Request Body: | UnauthDocument | ||
Response Headers: | N/A | ||
Response Body: | GetInfoUnauthDocumentResult | ||
|
getInfoV30Gets information about the uploaded file. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /documents/{guid} | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | Document | ||
Path parameters:
guid: String - The file guid to get the information about.
|
|||
Query parameters:
fetchEvenIfDeleted: boolean - True to retrieve deleted document info. (optional, default: false).
markAsExplicit: boolean - True to mark this as explicit, false otherwise. (optional, default: false). |
|||
|
getLastDocsWithActivityV30Gets last document the user had activity with. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/last/list | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | LastDocsWithActivity | ||
|
getPdfOnDemandTimeEstimationV30Gets Time estimation for completion of PDF conversion task using GUID. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/{guid}/onDemand/pdf/timeEstimation | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | TimeEstimation | ||
Path parameters:
guid: String - Guid of file to check on.
|
|||
|
getPdfOnDemandTimeEstimationV30Gets Time estimation for completion of PDF conversion task. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/onDemand/pdf/timeEstimation | ||
Request Body: | OnDemandRequest | ||
Response Headers: | N/A | ||
Response Body: | TimeEstimation | ||
|
getPermissionsV30Returns a list of a file's current recipients and their permissions for the file. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /documents/{guid}/permissions | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
Path parameters:
guid: String - The guid for the file.
|
|||
|
getTransactionStatusV30Gets file transaction status. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/transaction/status | ||
Request Body: | TransactionInput | ||
Response Headers: | N/A | ||
Response Body: | TransactionStatus | ||
|
getValidDocumentsInfoV30Returns a list of info of all the valid files that are specified and the current user is permitted to view . |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/info/valid/list | ||
Request Body: | GetValidDocumentsGuidsInfo | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
getViewerInfoUnauthV30Get viewer information about an unauthorized document. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/unauth/info | ||
Request Body: | DocumentAndVersion | ||
Response Headers: | N/A | ||
Response Body: | UnauthDocumentInfo | ||
|
listDocumentsPermissionRequestsV30Lists existing permission requests for a file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/permissions/requests/list | ||
Request Body: | ListDocumentsPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listDocumentsVersionsReadConfirmedV30list the document versions read by specific user |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/read/confirmation/list | ||
Request Body: | ListVersionsReadConfirmation | ||
Response Headers: | N/A | ||
Response Body: | ListVersionsReadConfirmationRet | ||
|
listExchangesRecycleBinDocumentsV30Lists files in the Sent items recycle bin/Inbox hidden files. These are files that have been deleted from the exchange but not permanently deleted from the recycle bin. files in the recycle bin can be restored to their original folders in the exchange. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/recycleBin/list | ||
Request Body: | ListExchangesRecycleBinDocuments | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listLastResolvedDocumentPermissionRequestsV30Lists last resolved permission requests on files in workspaces and in Sent items. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/permissions/requests/listLastResolve | ||
Request Body: | ListLastResolvedFolderPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listRecipientsV30Lists recipients for a file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/recipients/list | ||
Request Body: | SdsGetRecipients | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listV30Returns a list of all the files that the current user is permitted to view (and are not part of a workspace). |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /documents | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
Query parameters:
filter:
ApiDocumentFilter - Define a sub-set of the files to be returned. Possible values: [ALL, ABOUT_TO_EXPIRE, RECENTLY_VIEWED, VALID_ONLY, SHARED_BY_ME, HIDDEN, RECENTLY_MODIFIED, SHARED_WITH_ME]. (optional, default: ALL).
order: ApiDocumentOrderSDS - How the list will be ordered. Possible values: [SCORE, SENDER, LAST_UPDATED, SIZE, SENDER_ADDRESS, FILE_NAME, TYPE, LAST_VIEWED, MODIFIED_DATE, NAME]. (optional, default: LAST_UPDATED). orderAscending: boolean - The alphabetical order of the files in the returned list. (optional, default: true). pageNumber: Integer - The number of the page to retrieve (zero-based, 0 is the first page). (optional, default: 0). pageSize: Integer - Size of a result page (lines). (optional, default: 20). |
|||
|
markV30Marks a set of files for a specific operation (e.g. delete, download). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/mark | ||
Request Body: | MarkDocumentsSelectionSds | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
renameDocumentV30Renames a file in the Sent items. The file remains in the same folder and with the same permissions. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/{guid}/rename | ||
Request Body: | UpdateDocument | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
guid: String - Guid of file to be renamed.
|
|||
|
resolveActionForDocumentPermissionRequestV30Applies a decision on a request. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/permissions/requests/resolve | ||
Request Body: | ResolveActionForDocumentPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
restoreExchangesRecycleBinDocumentsV30Restores files from the Sent items Recycle bin to their original folders. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/recycleBin/restore | ||
Request Body: | RestoreExchangesRecycleBinDocuments | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
revokePermissionsV30Revokes all permissions for entities (users, groups, lists) for files in Sent items. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/permissions/revoke | ||
Request Body: | SdsRevokePermissions | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
searchDocumentsV30Searches for a file in the Inbox/Sent items by name or string. The search string can be a full name or partial one. All folders that the user has access to are searched. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/search | ||
Request Body: | SearchDocumentsSds | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
sendEmailV30Sends an email to recipients for a file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/{guid}/email | ||
Request Body: | SendEmail | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
guid: String - The guid of document.
|
|||
|
submitDocumentsV30Submits files in Inbox/Sent items. The submit method is used after an upload, to set file disposition (for example, to send it to a recipient). This action can be done on a list of files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/submit | ||
Request Body: | SubmitDocumentSds | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
updateDocumentV30Updates the file on the server with a new version. Older versions are maintained, but the latest version is the one accessed by default. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/{guid}/update | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
guid: String - The guid of the file to be updated with a new version.
|
|||
Data form parameters:
data: File - Data stream to download the file from.
data2: FormDataContentDisposition - Standard parameter for uploading files over HTTP. deviceType: DeviceType - The device type. documentName: String - The name of the file to be uploaded(may be left null). mailBody: String - Body of email for notification email. mailSubject: String - Subject line for notification email. sendMail: Boolean - Flag indicating whether the server should notify recipients about the new version by email. |
|||
|
upgradePdfRequestToOnDemandV30Sets a request for PDF on demand using GUID. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/{guid}/onDemand/pdf | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
Path parameters:
guid: String - Guid of file to update.
|
|||
|
upgradePdfRequestToOnDemandV30Sets a request for PDF on demand. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/onDemand/pdf | ||
Request Body: | OnDemandRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
upgradePdfRequestToOnDemandV30Upgrade PDF request to on demand. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/unauth/conversion/onDemand/pdf | ||
Request Body: | Guid | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
uploadDocumentBase64V30Uploads a file to Sent items in base64 format. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/{guid}/uploadBase64 | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
guid: String - Guid for the file to be uploaded.
|
|||
Data form parameters:
data: InputStream - The file data.
data2: FormDataContentDisposition - Multipart form-data for file data. deviceType: DeviceType - The device type. documentName: String - The name of the file as a string (eg "filename.txt"). |
|||
|
uploadDocumentByPostV30Uploads to Sent items in base64 format. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/{guid}/upload | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
guid: String - The new file's guid (e.g. 'f627e7a8-5ec7-459f-ad93-182baa60d2b2').
|
|||
Data form parameters:
data: File - The binary data of the file.
data2: FormDataContentDisposition - The multipart form request data Note that both fileData and contDisp are part of the multipart form data request parameter which this method requires when invoked through HTTP. Since the whole request is mapped using a multipart form request (which is how HTTP tells the browsers to upload files, as explained in ), each parameter is mapped using a form data part: An example of an assembled HTTP request (not operational): POST http://www.watchdox.com/ HTTP/1.1 Host: ... User-Agent: .... Accept: ... ... Content-Type: multipart/form-data; boundary=---------------------------114782935826962 Content-Length: 454 -----------------------------114782935826962 Content-Disposition: form-data; name="documentName" testFile.doc -----------------------------114782935826962 Content-Disposition: form-data; name="data"; filename="acutalTestFilename.doc" Content-Type: application/octet-stream ... File data here ... -----------------------------114782935826962-- Therefore the parameters we need to have are: documentName, deviceType (optional), data - which includes the actual filename which is uploaded and the file's actual data. deviceType: DeviceType - The device type. documentName: String - The name of the uploaded file (e.g. 'filename1.doc' or 'exampleFileNameWithNoExtension'). fileName: String - The file name of the uploaded file. start: Long - The start. |
|||
|
validateDocumentsToDownloadV30Validates a list of files prior to requesting the download. The validation request checks whether all the files exist and whether the user as sufficient rights to download them. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/download/validateDownload | ||
Request Body: | ValidateDownloadDocumentsSelectionSds | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
validateDownloadSentItemsWithRecycleBinV30Validates sent items download of a user with it's recycle bin. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /documents/recycleBin/download/validateDownload | ||
Request Body: | ValidateDownloadSentItemsDocumentsWithRecycleBin | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|