public class IManageWorkspaces extends Object
Constructor and Description |
---|
IManageWorkspaces(NetworkConnectionManager connection,
APISession apiSession) |
Modifier and Type | Method and Description |
---|---|
BulkOperationResultJson |
addEntitiesV30(AddEntitiesIManageJson addEntitiesIManageJson)
Adds permitted entities to an imanage workspace or documents in an
imanage workspace.
|
BulkOperationResultJson |
addNotificationV30(CreateIManageActivityLogRecordJson createIManageActivityLogRecordJson)
Adds a notification for a file action in the file's activity log file.
|
BulkOperationResultJson |
addTransientDocumentPermissionRequestV30(AddIManageDocumentPermissionRequestJson addIManageDocumentPermissionRequestJson)
Add a permission request for a document in a imanage workspace.
|
BulkOperationResultJson |
addTransientFolderPermissionRequestV30(AddIManageFolderPermissionRequestJson addIManageFolderPermissionRequestJson)
Add a permission request for an imanage workspace.
|
BulkOperationResultJson |
changeDefaultPermissionsBulkV30(ChangeEntitiesIManageJson changeEntitiesIManageJson)
Changes default permissions of a permitted entity in an imanage
workspace.
|
CheckIManageCredentialResultJson |
checkForCredentialV30(CheckIManageCredentialJson checkIManageCredentialJson)
Check if the logged in user has a valid Imanage credential stored.
|
IManageDocumentsTransactionResultJson |
copyDocumentsFromRoomsToExchangeAsyncV30(CopyIManageDocumentToExchangeAsyncJson copyIManageDocumentToExchangeAsyncJson)
Copies a imanage file to Microsoft Exchange.
|
IManageFolderJson |
createFolderV30(CreateIManageFolderJson createIManageFolderJson)
Creates a new imanage folder.
|
SubmitIfNewIManageDocumentJson |
createIManageDocumentV30(CreateNewIManageDocumentJson createNewIManageDocumentJson)
Create new empty document.
|
BulkOperationResultJson |
deleteDocumentsAndFoldersV30(DeleteIManageDocumentsAndFoldersJson deleteIManageDocumentsAndFoldersJson)
Deletes imanage folders and files.
|
BulkOperationResultJson |
deleteRoomV30(DeleteIManageWorkspaceJson deleteIManageWorkspaceJson)
Delete iManage workspace.
|
BulkOperationResultJson |
documentUploadCompleteV30(String documentGuid,
String roomId)
Complete uploaded file.
|
InputStream |
downloadDocumentsFormV30(Set<String> documentItemIds,
String downloadType,
Set<String> folderItemIds,
String wdUniqueDownloadKey,
String workspaceUuid)
Downloads a set of specified files or all files in a set of specified
folders and files in a imanage workspace.
|
InputStream |
downloadOriginalV30(String workspaceGuid,
String downloadType,
String forceWatermarks,
String itemId)
Returns a single file.
|
InputStream |
downloadSingleDocumentForWebV30(DownloadSingleIManageDocumentJson downloadSingleIManageDocumentJson)
Downloads a single file for web (additional info is returned).
|
InputStream |
downloadSingleDocumentForWebV30(String downloadType,
boolean forceWatermarks,
String itemId,
String wdUniqueDownloadKey,
String workspaceUuid)
Downloads a single file (for web).
|
InputStream |
downloadSingleDocumentV30(DownloadSingleIManageDocumentJson downloadSingleIManageDocumentJson)
Downloads a single file.
|
BulkOperationResultJson |
editFoldersAndDocumentsSettingsBulkV30(IManageEditFoldersAndDocumentsSettingsBulkJson iManageEditFoldersAndDocumentsSettingsBulkJson)
Edit file permissions in bulk.
|
InputStream |
exportActivityHistoryForRoomsV30(ExportActivityHistoryForTransientRoomsJson exportActivityHistoryForTransientRoomsJson)
Returns a CSV file of workspace activity history for the given set of
rooms.
|
InputStream |
exportActivityLogV30(GetIManageDocumentActivityLogRequestJson getIManageDocumentActivityLogRequestJson)
Gets activity log CSV for a file.
|
GuidJson |
generateGuidV30()
Creates file GUID for new or updated files.
|
GuidJson |
generateGuidV30(GenerateTransientDocumentGuidJson generateTransientDocumentGuidJson)
Creates file GUID for new file in a workspace context.
|
PagingItemListJson<ActivityLogRecordJson> |
getActivityLogV30(GetIManageDocumentActivityLogRequestJson getIManageDocumentActivityLogRequestJson)
Gets activity log for a file in IManage Workspace.
|
InputStream |
getActivityLogV30(String documentItemId,
String fromDate,
boolean lastActionPerUser,
Integer pageNumber,
Integer pageSize,
String toDate,
String workspaceUuid)
Gets activity log for a file in WD in CSV format.
|
IManageDocumentJson |
getDocumentInfoV30(IManageDocumentInfoJson iManageDocumentInfoJson)
Retrieves file info.
|
IManageFolderInfoResultJson |
getFolderInfoV30(GetIManageFolderInfoJson getIManageFolderInfoJson)
Gets single level info for a workspace or folder.
|
TransientPathInfoJson |
getIManagePathInfoV30(GetIManagePathInfoJson getIManagePathInfoJson)
Get info for a path.
|
ItemListJson<EntityPermissionJson> |
getPermissionsForIOSV30(GetIManageDocumentPermissionsForIosJson getIManageDocumentPermissionsForIosJson)
Returns the iOS-targeted list of permissions for a file.
|
PagingItemListJson<IManageDocumentJson> |
getValidIManagePathInfoListV30(GetValidIManagePathInfoListJson getValidIManagePathInfoListJson)
Get info for a valid list paths.
|
IManageWorkspaceInfoJson |
getWorkspaceInfoV30(GetIManageWorkspaceInfoJson getIManageWorkspaceInfoJson)
Return info on the workspace.
|
TransientInitiateConversionResultJson |
initiateConversionV30(IManageInitiateConversionJson iManageInitiateConversionJson)
Initiates conversion to PDF for a document
|
BulkOperationResultJson |
inviteV30(IManageDocumentInviteJson iManageDocumentInviteJson)
Invites groups or users to a specific file in a workspace.
|
BulkOperationResultJson |
inviteV30(IManageInviteJson iManageInviteJson)
Invite groups and users to an imanage workspace or a folder
|
PagingItemListJson<BaseJson> |
listFoldersAndDocumentsV30(ListIManageFoldersAndDocumentsJson listIManageFoldersAndDocumentsJson)
Retrieves a list of iManage files and folders for a workspace or a
folder.
|
ListIManageFoldersSingleLevelResultJson |
listFoldersSingleLevelV30(ListIManageFoldersJson listIManageFoldersJson)
Gets the tree of all folders.
|
ItemListJson<LastResolvedIManageDocumentPermissionRequestResultJson> |
listLastResolvedTransientDocumentPermissionRequestsV30(ListLastResolvedTransientDocumentPermissionRequestsJson listLastResolvedTransientDocumentPermissionRequestsJson)
Retrieves a list of resolved document permission requests for all
imanage workspaces.
|
ItemListJson<LastResolvedIManageFolderPermissionRequestResultJson> |
listLastResolvedTransientFolderPermissionRequestsV30(ListLastResolvedTransientFolderPermissionRequestsJson listLastResolvedTransientFolderPermissionRequestsJson)
Retrieves a list of resolved folder permission requests for all iManage
workspaces.
|
PagingItemListJson<BaseJson> |
listMattersV30(ListIManageMattersJson listIManageMattersJson)
Retrieves a list of imanage top level matters and workspaces.
|
OrganizationPolicyJson |
listOrganizationPolicyV30(ListTransientOrganizationPolicyJson listTransientOrganizationPolicyJson)
Returns the organization policy for the given workspace.
|
PermissionDetailsJson |
listPermissionDetailsV30(ListIManagePermissionDetailsJson listIManagePermissionDetailsJson)
List permission details for files and folders for all entities in the
workspace.
|
ItemListJson<IManageDocumentPermissionRequestsResultsJson> |
listTransientDocumentsPermissionRequestsV30(ListTransientDocumentsPermissionRequestsJson listTransientDocumentsPermissionRequestsJson)
Lists existing document permission requests for all imanage workspaces.
|
ItemListJson<IManageWorkspacePermissionRequestsResultsJson> |
listTransientFolderPermissionRequestsV30(ListTransientFolderPermissionRequestsJson listTransientFolderPermissionRequestsJson)
Lists existing folder permission requests for all imanage workspace.
|
BulkOperationResultJson |
markWorkspaceFavoriteV30(MarkIManageWorkspaceStarredJson markIManageWorkspaceStarredJson)
Marks iManage Workspace(s) as starred or unstarred (favorite).
|
IManageDocumentJson |
renameDocumentV30(RenameIManageDocumentJson renameIManageDocumentJson)
Renames a file in an imanage workspace.
|
RenameIManageFolderResultJson |
renameFolderV30(RenameIManageFolderJson renameIManageFolderJson)
Renames an imanage folder.
|
BulkOperationResultJson |
resolveActionForTransientDocumentPermissionRequestV30(ResolveActionForIManageDocumentPermissionRequestJson resolveActionForIManageDocumentPermissionRequestJson)
Applies a decision on a request.
|
BulkOperationResultJson |
resolveActionForTransientFolderPermissionRequestV30(ResolveActionForIManageFolderPermissionRequestJson resolveActionForIManageFolderPermissionRequestJson)
Applies a decision on an imanage workspace permission request.
|
TransientFolderJson |
saveTransientWorkspaceCredentialsV30(SaveTransientWorkspaceCredentialsJson saveTransientWorkspaceCredentialsJson)
Saves the credentials for a given workspace.
|
String |
sendBulkEmailV30(SendEmailsToIManageDocumentsJson sendEmailsToIManageDocumentsJson)
Sends emails to file users.
|
SignInIManageResultJson |
signInIManageWorkspaceV30(CreateiManageWorkspaceCredentialsJson createiManageWorkspaceCredentialsJson)
Sign in to an imanange repository.
|
BulkOperationResultJson |
signOutIManageWorkspaceV30(CheckIManageCredentialJson checkIManageCredentialJson)
Sign out imanange repository.
|
SubmitIfNewIManageDocumentJson |
submitDocumentIfNewV30(String roomId,
SubmitIManageDocumentVdrJson submitIManageDocumentVdrJson)
Submits a new document version.
|
SubmitIManageDocumentResultJson |
submitVersionV30(SubmitIManageVersionVdrJson submitIManageVersionVdrJson)
Submits a new file version.
|
String |
uploadDocumentByPostV30(String documentGuid,
String roomId,
File data,
DeviceType deviceType,
String documentName,
String fileName,
Long start)
Uploads new file data.
|
String |
uploadDocumentByPostV30(String documentGuid,
String roomId,
InputStream data,
DeviceType deviceType,
String documentName,
String fileName,
Long start)
Uploads new file data.
|
BulkOperationResultJson |
validateDocumentsToDownloadV30(ValidateDownloadIManageDocumentsJson validateDownloadIManageDocumentsJson)
Validates files for download.
|
public IManageWorkspaces(NetworkConnectionManager connection, APISession apiSession)
public BulkOperationResultJson addEntitiesV30(AddEntitiesIManageJson addEntitiesIManageJson)
AddEntitiesIManageJson
- information used when adding permitted
entities to workspace or documentspublic BulkOperationResultJson addNotificationV30(CreateIManageActivityLogRecordJson createIManageActivityLogRecordJson)
createIManangeActivityLogRecordJson
- public BulkOperationResultJson addTransientDocumentPermissionRequestV30(AddIManageDocumentPermissionRequestJson addIManageDocumentPermissionRequestJson)
addImanageDocumentPermissionRequestJson
- data about the request
for adding a file permissionpublic BulkOperationResultJson addTransientFolderPermissionRequestV30(AddIManageFolderPermissionRequestJson addIManageFolderPermissionRequestJson)
addImanageFolderPermissionRequestJson
- data about the request
for adding a workspace permissionpublic BulkOperationResultJson changeDefaultPermissionsBulkV30(ChangeEntitiesIManageJson changeEntitiesIManageJson)
changeEntitiesTransientJson
- details of entities (user, group,
domain) and new default permissions to be assigned to them since
expiration date is now not a part of the inheritance model, the user may
send 'leave unchanged' so that the expiration date will not change when
changing permissions. The user can do so by passing expiration date =
null, expiration days = null and neverExpires = true.public CheckIManageCredentialResultJson checkForCredentialV30(CheckIManageCredentialJson checkIManageCredentialJson)
checkIManageCredentialJson
- the imanage repository to be checkedpublic IManageDocumentsTransactionResultJson copyDocumentsFromRoomsToExchangeAsyncV30(CopyIManageDocumentToExchangeAsyncJson copyIManageDocumentToExchangeAsyncJson)
copyIManageDocumentToExchangeAsyncJson
- A list of users to
receive notification and link to the files and permissions to assign the
file when copying imanage files to Exchangepublic IManageFolderJson createFolderV30(CreateIManageFolderJson createIManageFolderJson)
createIManageFolderJson
- a imaange folder to createpublic SubmitIfNewIManageDocumentJson createIManageDocumentV30(CreateNewIManageDocumentJson createNewIManageDocumentJson)
createNewIManageDocumentJson
- json new document upload and
submitpublic BulkOperationResultJson deleteDocumentsAndFoldersV30(DeleteIManageDocumentsAndFoldersJson deleteIManageDocumentsAndFoldersJson)
deleteIManageDocumentsAndFoldersJson
- imanage folders and files
to deletepublic BulkOperationResultJson deleteRoomV30(DeleteIManageWorkspaceJson deleteIManageWorkspaceJson)
deleteIManageWorkspaceJson
- a iManage workspace to deletepublic BulkOperationResultJson documentUploadCompleteV30(String documentGuid, String roomId)
documentGuid
- document guidroomId
- room idpublic InputStream downloadDocumentsFormV30(Set<String> documentItemIds, String downloadType, Set<String> folderItemIds, String wdUniqueDownloadKey, String workspaceUuid)
public InputStream downloadOriginalV30(String workspaceGuid, String downloadType, String forceWatermarks, String itemId)
downloadType
- download typeforceWatermarks
- force water marksitemId
- imanage item id for the documentworkspaceGuid
- workspace guidpublic InputStream downloadSingleDocumentForWebV30(DownloadSingleIManageDocumentJson downloadSingleIManageDocumentJson)
downloadSingleIManageDocumentForWebJson
- public InputStream downloadSingleDocumentForWebV30(String downloadType, boolean forceWatermarks, String itemId, String wdUniqueDownloadKey, String workspaceUuid)
public InputStream downloadSingleDocumentV30(DownloadSingleIManageDocumentJson downloadSingleIManageDocumentJson)
downloadSingleDocumentJson
- public BulkOperationResultJson editFoldersAndDocumentsSettingsBulkV30(IManageEditFoldersAndDocumentsSettingsBulkJson iManageEditFoldersAndDocumentsSettingsBulkJson)
imanageEditFoldersAndDocumentsSettingsBulkJson
- used when bulk
editing file settingspublic InputStream exportActivityHistoryForRoomsV30(ExportActivityHistoryForTransientRoomsJson exportActivityHistoryForTransientRoomsJson)
exportActivityHistoryForTransientRoomsJson
- the rooms infopublic InputStream exportActivityLogV30(GetIManageDocumentActivityLogRequestJson getIManageDocumentActivityLogRequestJson)
getImanageDocumentActivityLogRequestJson
- document info for
activity logpublic GuidJson generateGuidV30()
public GuidJson generateGuidV30(GenerateTransientDocumentGuidJson generateTransientDocumentGuidJson)
generateTransientDocumentGuidJson
- a workspace to get a guid forpublic PagingItemListJson<ActivityLogRecordJson> getActivityLogV30(GetIManageDocumentActivityLogRequestJson getIManageDocumentActivityLogRequestJson)
getImanageDocumentActivityLogRequestJson
- used to get an
activity logpublic InputStream getActivityLogV30(String documentItemId, String fromDate, boolean lastActionPerUser, Integer pageNumber, Integer pageSize, String toDate, String workspaceUuid)
public IManageDocumentJson getDocumentInfoV30(IManageDocumentInfoJson iManageDocumentInfoJson)
IManageDocumentInfoJson
- used for getting file informationpublic IManageFolderInfoResultJson getFolderInfoV30(GetIManageFolderInfoJson getIManageFolderInfoJson)
GetIManageFolderInfoJson
- workspace and folder infopublic TransientPathInfoJson getIManagePathInfoV30(GetIManagePathInfoJson getIManagePathInfoJson)
GetIManagePathInfoJson
- public ItemListJson<EntityPermissionJson> getPermissionsForIOSV30(GetIManageDocumentPermissionsForIosJson getIManageDocumentPermissionsForIosJson)
getIManageDocumentPermissionsForIosJson
- public PagingItemListJson<IManageDocumentJson> getValidIManagePathInfoListV30(GetValidIManagePathInfoListJson getValidIManagePathInfoListJson)
GetValidIManagePathInfoListJson
- public IManageWorkspaceInfoJson getWorkspaceInfoV30(GetIManageWorkspaceInfoJson getIManageWorkspaceInfoJson)
getIManageWorkspaceInfoJson
- public TransientInitiateConversionResultJson initiateConversionV30(IManageInitiateConversionJson iManageInitiateConversionJson)
transientInitiateConversionJson
- used to initiate a conversion
to PDFpublic BulkOperationResultJson inviteV30(IManageDocumentInviteJson iManageDocumentInviteJson)
imanageDocumentInviteJson
- invite datapublic BulkOperationResultJson inviteV30(IManageInviteJson iManageInviteJson)
transientInviteJson
- invite datapublic PagingItemListJson<BaseJson> listFoldersAndDocumentsV30(ListIManageFoldersAndDocumentsJson listIManageFoldersAndDocumentsJson)
listIManageFoldersAndDocumentsJson
- used when retrieving a list
of iManage files and folderspublic ListIManageFoldersSingleLevelResultJson listFoldersSingleLevelV30(ListIManageFoldersJson listIManageFoldersJson)
listIManageFoldersJson
- used to get the tree of all folderspublic ItemListJson<LastResolvedIManageDocumentPermissionRequestResultJson> listLastResolvedTransientDocumentPermissionRequestsV30(ListLastResolvedTransientDocumentPermissionRequestsJson listLastResolvedTransientDocumentPermissionRequestsJson)
LastResolvedIManageDocumentPermissionRequestResultJson
- json
data about the document permission requestpublic ItemListJson<LastResolvedIManageFolderPermissionRequestResultJson> listLastResolvedTransientFolderPermissionRequestsV30(ListLastResolvedTransientFolderPermissionRequestsJson listLastResolvedTransientFolderPermissionRequestsJson)
LastResolvedIManageFolderPermissionRequestResultJson
- json data
about the folder permission requestpublic PagingItemListJson<BaseJson> listMattersV30(ListIManageMattersJson listIManageMattersJson)
listIManageMattersJson
- public OrganizationPolicyJson listOrganizationPolicyV30(ListTransientOrganizationPolicyJson listTransientOrganizationPolicyJson)
listTransientOrganizationPolicyJson
- used to get the
organizational policypublic PermissionDetailsJson listPermissionDetailsV30(ListIManagePermissionDetailsJson listIManagePermissionDetailsJson)
listIManagePermissionDetailsJson
- request for listing permission
details for files and folders for all entities in the workspacepublic ItemListJson<IManageDocumentPermissionRequestsResultsJson> listTransientDocumentsPermissionRequestsV30(ListTransientDocumentsPermissionRequestsJson listTransientDocumentsPermissionRequestsJson)
listTransientDocumentsPermissionRequestsJson
- Details about the
document permission requestpublic ItemListJson<IManageWorkspacePermissionRequestsResultsJson> listTransientFolderPermissionRequestsV30(ListTransientFolderPermissionRequestsJson listTransientFolderPermissionRequestsJson)
listTransientFolderPermissionRequestsJson
- Details about the
document to get info onpublic BulkOperationResultJson markWorkspaceFavoriteV30(MarkIManageWorkspaceStarredJson markIManageWorkspaceStarredJson)
markIManageWorkspaceStarredJson
- a list of items and a mark for
them.public IManageDocumentJson renameDocumentV30(RenameIManageDocumentJson renameIManageDocumentJson)
RenameIManageDocumentJson
- a file to renamepublic RenameIManageFolderResultJson renameFolderV30(RenameIManageFolderJson renameIManageFolderJson)
RenameIManageFolderResultJson
- a folder to renamepublic BulkOperationResultJson resolveActionForTransientDocumentPermissionRequestV30(ResolveActionForIManageDocumentPermissionRequestJson resolveActionForIManageDocumentPermissionRequestJson)
resolveActionForIManageDocumentPermissionRequestJson
- document
and requesters informtaionpublic BulkOperationResultJson resolveActionForTransientFolderPermissionRequestV30(ResolveActionForIManageFolderPermissionRequestJson resolveActionForIManageFolderPermissionRequestJson)
resolveActionForIManageFolderPermissionRequestJson
- document and
requesters informtaionpublic TransientFolderJson saveTransientWorkspaceCredentialsV30(SaveTransientWorkspaceCredentialsJson saveTransientWorkspaceCredentialsJson)
saveTransientWorkspaceCredentialsJson
- saves credentials for a
transient workspacepublic String sendBulkEmailV30(SendEmailsToIManageDocumentsJson sendEmailsToIManageDocumentsJson)
sendEmailsToIManageDocumentsJson
- used when sending emailspublic SignInIManageResultJson signInIManageWorkspaceV30(CreateiManageWorkspaceCredentialsJson createiManageWorkspaceCredentialsJson)
createiManageWorkspaceCredentialsJson
- create credentials for a
iManage workspace if credential not exists, otherwise, it updates
existing credential.public BulkOperationResultJson signOutIManageWorkspaceV30(CheckIManageCredentialJson checkIManageCredentialJson)
checkIManageCredentialJson
- public SubmitIfNewIManageDocumentJson submitDocumentIfNewV30(String roomId, SubmitIManageDocumentVdrJson submitIManageDocumentVdrJson)
submitIManageDocumentVdrJson
- public SubmitIManageDocumentResultJson submitVersionV30(SubmitIManageVersionVdrJson submitIManageVersionVdrJson)
SubmitIManageVersionVdrJson
- public String uploadDocumentByPostV30(String documentGuid, String roomId, File data, DeviceType deviceType, String documentName, String fileName, Long start)
data
- file datadeviceType
- device typedocumentGuid
- document guiddocumentName
- document namefileName
- file nameroomId
- room idstart
- startpublic String uploadDocumentByPostV30(String documentGuid, String roomId, InputStream data, DeviceType deviceType, String documentName, String fileName, Long start)
data
- file datadeviceType
- device typedocumentGuid
- document guiddocumentName
- document namefileName
- file nameroomId
- room idstart
- startpublic BulkOperationResultJson validateDocumentsToDownloadV30(ValidateDownloadIManageDocumentsJson validateDownloadIManageDocumentsJson)
validateDownloadIManageDocumentsJson
- used for validating files
for downloadCopyright © 2019. All rights reserved.