Index | BlackBerry Workspaces SDK |
Name | Path | Version | Description |
---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
addEntitiesV30Adds permitted entities to an imanage workspace or documents in an imanage workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/entities/add | ||
Request Body: | AddEntitiesIManage | ||
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/imanage/workspace/logAction | ||
Request Body: | CreateIManageActivityLogRecord | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addTransientDocumentPermissionRequestV30Add a permission request for a document in a imanage workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/permissions/requests/add | ||
Request Body: | AddIManageDocumentPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
addTransientFolderPermissionRequestV30Add a permission request for an imanage workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/folder/permissions/requests/add | ||
Request Body: | AddIManageFolderPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
changeDefaultPermissionsBulkV30Changes default permissions of a permitted entity in an imanage workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/entities/permissions/change | ||
Request Body: | ChangeEntitiesIManage | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
checkForCredentialV30Check if the logged in user has a valid Imanage credential stored. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/hasCredential | ||
Request Body: | CheckIManageCredential | ||
Response Headers: | N/A | ||
Response Body: | CheckIManageCredentialResult | ||
|
copyDocumentsFromRoomsToExchangeAsyncV30Copies a imanage file to Microsoft Exchange. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/copy/exchange/async | ||
Request Body: | CopyIManageDocumentToExchangeAsync | ||
Response Headers: | N/A | ||
Response Body: | IManageDocumentsTransactionResult | ||
|
createFolderV30Creates a new imanage folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/folder/create | ||
Request Body: | CreateIManageFolder | ||
Response Headers: | N/A | ||
Response Body: | IManageFolder | ||
|
createIManageDocumentV30Create new empty document. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/document/new/create | ||
Request Body: | CreateNewIManageDocument | ||
Response Headers: | N/A | ||
Response Body: | SubmitIfNewIManageDocument | ||
|
deleteDocumentsAndFoldersV30Deletes imanage folders and files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/delete | ||
Request Body: | DeleteIManageDocumentsAndFolders | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
deleteRoomV30Delete iManage workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/delete | ||
Request Body: | DeleteIManageWorkspace | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
documentUploadCompleteV30Complete uploaded file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/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. |
|||
|
downloadOriginalV30Returns a single file. |
|||
Version: | 3.0 | ||
Synopsis: | GET | ||
Path: | /3.0/imanage/workspace/{workspaceGuid}/download | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Path parameters:
workspaceGuid: String - workspace guid.
|
|||
Query parameters:
downloadType: String - download type. (optional, default: "ORIGINAL").
forceWatermarks: String - force water marks. (optional, default: "false"). itemId: String - imanage item id for the document. |
|||
|
downloadSingleDocumentForWebV30Downloads a single file for web (additional info is returned). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/downloadForWeb | ||
Request Body: | DownloadSingleIManageDocument | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
downloadSingleDocumentForWebV30Downloads a single file (for web). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/downloadForWeb | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
downloadType: String.
forceWatermarks: boolean. itemId: String. wdUniqueDownloadKey: String. workspaceUuid: String. |
|||
|
downloadSingleDocumentV30Downloads a single file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/download | ||
Request Body: | DownloadSingleIManageDocument | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
editFoldersAndDocumentsSettingsBulkV30Edit file permissions in bulk. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/folders/documents/settings/edit | ||
Request Body: | IManageEditFoldersAndDocumentsSettingsBulk | ||
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/imanage/workspace/activityHistory/csv/create | ||
Request Body: | ExportActivityHistoryForTransientRooms | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
exportActivityLogV30Gets activity log CSV for a file. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/activityLog/csv/create | ||
Request Body: | GetIManageDocumentActivityLogRequest | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
generateGuidV30Creates file GUID for new or updated files. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/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/imanage/workspace/documents/guid/create | ||
Request Body: | GenerateTransientDocumentGuid | ||
Response Headers: | N/A | ||
Response Body: | Guid | ||
|
getActivityLogV30Gets activity log for a file in IManage Workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/activityLog | ||
Request Body: | GetIManageDocumentActivityLogRequest | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
getActivityLogV30Gets activity log for a file in WD in CSV format. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/activityLog/csv/export | ||
Request Body: | N/A | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
Data form parameters:
documentItemId: String.
fromDate: String. lastActionPerUser: boolean. pageNumber: Integer. pageSize: Integer. toDate: String. workspaceUuid: String. |
|||
|
getDocumentInfoV30Retrieves file info. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/document/info | ||
Request Body: | IManageDocumentInfo | ||
Response Headers: | N/A | ||
Response Body: | IManageDocument | ||
|
getFolderInfoV30Gets single level info for a workspace or folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/folders/info/list | ||
Request Body: | GetIManageFolderInfo | ||
Response Headers: | N/A | ||
Response Body: | IManageFolderInfoResult | ||
|
getIManagePathInfoV30Get info for a path. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/path/info/list | ||
Request Body: | GetIManagePathInfo | ||
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/imanage/workspace/documents/permissions/ios | ||
Request Body: | GetIManageDocumentPermissionsForIos | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
getValidIManagePathInfoListV30Get info for a valid list paths. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/valid/path/info/list | ||
Request Body: | GetValidIManagePathInfoList | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
getWorkspaceInfoV30Return info on the workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/workspace/info | ||
Request Body: | GetIManageWorkspaceInfo | ||
Response Headers: | N/A | ||
Response Body: | IManageWorkspaceInfo | ||
|
initiateConversionV30Initiates conversion to PDF for a document |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/conversion/initiate | ||
Request Body: | IManageInitiateConversion | ||
Response Headers: | N/A | ||
Response Body: | TransientInitiateConversionResult | ||
|
inviteV30Invites groups or users to a specific file in a workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/invite | ||
Request Body: | IManageDocumentInvite | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
inviteV30Invite groups and users to an imanage workspace or a folder |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/invite | ||
Request Body: | IManageInvite | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
listFoldersAndDocumentsV30Retrieves a list of iManage files and folders for a workspace or a folder. If the user doesn't have workspace level permissions, it returns all shared documents in the workspace in flat(no folder tree strutures) |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/folders/documents/list | ||
Request Body: | ListIManageFoldersAndDocuments | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listFoldersSingleLevelV30Gets the tree of all folders. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/folders/list | ||
Request Body: | ListIManageFolders | ||
Response Headers: | N/A | ||
Response Body: | ListIManageFoldersSingleLevelResult | ||
|
listLastResolvedTransientDocumentPermissionRequestsV30Retrieves a list of resolved document permission requests for all imanage workspaces. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/permissions/requests/listLastResolve | ||
Request Body: | ListLastResolvedTransientDocumentPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listLastResolvedTransientFolderPermissionRequestsV30Retrieves a list of resolved folder permission requests for all iManage workspaces. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/folder/permissions/requests/listLastResolve | ||
Request Body: | ListLastResolvedTransientFolderPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listMattersV30Retrieves a list of imanage top level matters and workspaces. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/matters/list | ||
Request Body: | ListIManageMatters | ||
Response Headers: | N/A | ||
Response Body: | PagingItemListJson |
||
|
listOrganizationPolicyV30Returns the organization policy for the given workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/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/imanage/workspace/permissionDetails/list | ||
Request Body: | ListIManagePermissionDetails | ||
Response Headers: | N/A | ||
Response Body: | PermissionDetails | ||
|
listTransientDocumentsPermissionRequestsV30Lists existing document permission requests for all imanage workspaces. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/permissions/requests/list | ||
Request Body: | ListTransientDocumentsPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
listTransientFolderPermissionRequestsV30Lists existing folder permission requests for all imanage workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/folder/permissions/requests/list | ||
Request Body: | ListTransientFolderPermissionRequests | ||
Response Headers: | N/A | ||
Response Body: | ItemListJson |
||
|
markWorkspaceFavoriteV30Marks iManage Workspace(s) as starred or unstarred (favorite). |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/markFavorite | ||
Request Body: | MarkIManageWorkspaceStarred | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
renameDocumentV30Renames a file in an imanage workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/document/rename | ||
Request Body: | RenameIManageDocument | ||
Response Headers: | N/A | ||
Response Body: | IManageDocument | ||
|
renameFolderV30Renames an imanage folder. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/folder/rename | ||
Request Body: | RenameIManageFolder | ||
Response Headers: | N/A | ||
Response Body: | RenameIManageFolderResult | ||
|
resolveActionForTransientDocumentPermissionRequestV30Applies a decision on a request. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/permissions/requests/resolve | ||
Request Body: | ResolveActionForIManageDocumentPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
resolveActionForTransientFolderPermissionRequestV30Applies a decision on an imanage workspace permission request. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/folder/permissions/requests/resolve | ||
Request Body: | ResolveActionForIManageFolderPermissionRequest | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
saveTransientWorkspaceCredentialsV30Saves the credentials for a given workspace. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/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/imanage/workspace/documents/emails/send | ||
Request Body: | SendEmailsToIManageDocuments | ||
Response Headers: | N/A | ||
Response Body: | N/A | ||
|
signInIManageWorkspaceV30Sign in to an imanange repository. It validates the credential and create/update imanage credential. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/signIn | ||
Request Body: | CreateiManageWorkspaceCredentials | ||
Response Headers: | N/A | ||
Response Body: | SignInIManageResult | ||
|
signOutIManageWorkspaceV30Sign out imanange repository. It deletes all imanage workspaces owned by the user and deletes the credential for the user. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/signOut | ||
Request Body: | CheckIManageCredential | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|
submitDocumentIfNewV30Submits a new document version. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/{roomId}/documents/submitIfNew | ||
Request Body: | SubmitIManageDocumentVdr | ||
Response Headers: | N/A | ||
Response Body: | SubmitIfNewIManageDocument | ||
Path parameters:
roomId: String.
|
|||
|
submitVersionV30Submits a new file version. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/submitVersion | ||
Request Body: | SubmitIManageVersionVdr | ||
Response Headers: | N/A | ||
Response Body: | SubmitIManageDocumentResult | ||
|
uploadDocumentByPostV30Uploads new file data. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/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. |
|||
|
validateDocumentsToDownloadV30Validates files for download. |
|||
Version: | 3.0 | ||
Synopsis: | POST | ||
Path: | /3.0/imanage/workspace/documents/validateDownload | ||
Request Body: | ValidateDownloadIManageDocuments | ||
Response Headers: | N/A | ||
Response Body: | BulkOperationResult | ||
|