Class Workspaces


  • public class Workspaces
    extends Object
    Functions for secure virtual data workspace handling.
    • Method Detail

      • addEntityToDocumentV30

        public BulkOperationResultJson addEntityToDocumentV30​(AddDocumentEntityJson addDocumentEntityJson)
        Adds permitted entity to workspace with no permissions outside of the given folder.
        Parameters:
        addDocumentEntityJson - json for adding a permitted entity to workspace with no permissions outside of the given folder.
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • addEntityToFolderV30

        public BulkOperationResultJson addEntityToFolderV30​(AddFolderEntityJson addFolderEntityJson)
        Adds permitted entity to workspace with no permissions outside of the given folder.
        Parameters:
        addFolderEntityJson - - json for the entity being added to the folder
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • addEntityV30

        public String addEntityV30​(String roomId,
                                   AddEntityVdrJson addEntityVdrJson)
        This 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.
        Parameters:
        addEntityVdrJson - parameters for the new entity, including type (user, group, domain), permissions and role (administrator, contributor, user, visitor)
        roomId - The room to add the new entity to.
        Returns:
        "success"
      • addFolderPermissionRequestV30

        public BulkOperationResultJson addFolderPermissionRequestV30​(AddFolderPermissionRequestJson addFolderPermissionRequestJson)
        Adds a new permission request for folder.
        Parameters:
        addFolderPermissionRequestJson - a request to add new permissions to a folder
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • addMembersToGroupV30

        public String addMembersToGroupV30​(AddMembersToGroupWithGroupJson addMembersToGroupWithGroupJson)
        Adds members (users) to a group.
        Parameters:
        addMembersToGroupWithGroupJson - list of users to add to group
        Returns:
        "success"
      • addMembersV30

        public String addMembersV30​(String roomId,
                                    AddRoomMembersJson addRoomMembersJson)
        Adds members to a workspace.
        Parameters:
        addRoomMembersJson - list of the members to add
        roomId - the workspace to add members to
        Returns:
        "success"
      • addPermissionsV30

        public BulkOperationResultJson addPermissionsV30​(String roomId,
                                                         VdrAddPermissionsJson vdrAddPermissionsJson)
        Adds permissions for entities (users/groups/domains) to a set of files in a workspace. Permissions can be eg copy, print, edit, download etc.
        Parameters:
        roomId - the room id of the workspace containing the files
        vdrAddPermissionsJson - info about the entities to granted the permissions, the permissions to be added, and the files for which the permissions apply.
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • addTagsV30

        public BulkOperationResultJson addTagsV30​(String roomId,
                                                  AddDocumentsTagValuesJson addDocumentsTagValuesJson)
        Adds tags to a list of files. Tags can be numerical, free text or datestamps.
        Parameters:
        addDocumentsTagValuesJson - details of file list and tags to be added to each file
        roomId - the workspace containing the files
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • changeDefaultPermissionsBulkV30

        public BulkOperationResultJson changeDefaultPermissionsBulkV30​(ChangeEntitiesVdrJson changeEntitiesVdrJson)
        Changes default permissions of a permitted entity in a workspace.
        Parameters:
        changeEntitiesVdrJson - 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.
        Returns:
        BulkOperationResultJson indicates if actions were successful or, if not, the problems.
      • changeDefaultPermissionsV30

        public String changeDefaultPermissionsV30​(String roomId,
                                                  ChangeEntityVdrJson changeEntityVdrJson)
        Changes default permissions of a permitted entity in a workspace.
        Parameters:
        changeEntityVdrJson - details of entity (user, group, domain) and new default permissions to be assigned to it
        roomId - the room id of the workspace to change permissions for.
        Returns:
        "success"
      • copyDocumentsFromRoomsToExchangeAsyncV30

        public ExternalDocumentsTransactionResultJson copyDocumentsFromRoomsToExchangeAsyncV30()
        Submits files in Sent items (asynchronous).
        Returns:
        externalDocumentsTransactionResultJson
      • copyDocumentsFromRoomsToExchangeV30

        public DocumentJson copyDocumentsFromRoomsToExchangeV30​(CopyDocumentFromRoomJson copyDocumentFromRoomJson)
        Submits files in Sent items. This submits room files to recipients within SDS the files will be copied from the room to SDS
        Parameters:
        copyDocumentFromRoomJson - list of users to receive notification and link to the files, permissions to assign the document.
        Returns:
        documentJson - DocumentJson com.confidela.api.json.DocumentJson An indication whether the request succeeded, or indication where it failed.
      • copyMembershipV30

        public BulkOperationResultJson copyMembershipV30​(String roomId,
                                                         CopyMembershipJson copyMembershipJson)
        Copies membership (of several users) to another existing user.
        Parameters:
        copyMembershipJson - list of memberships to copy from and new member to copy to
        roomId - room containing the members (existing and new).
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • createExternalFoldersTreeV30

        public ItemListJson<FolderJson> createExternalFoldersTreeV30​(CreateWorkspaceExternalFoldersJson createWorkspaceExternalFoldersJson)
        Creates a folder in a workspace for each external folder in the tree.
        Parameters:
        createWorkspaceExternalFoldersJson - a collection of external folders to be created in a workspace
        Returns:
        A list of FolderJson objects
      • createFoldersBulkV30

        public TransactionStatusJson createFoldersBulkV30​(CreateFolderAsyncJson createFolderAsyncJson)
        Creates a folder in a workspace with a specified path. the workspace in which the folder is to be created.
        Parameters:
        folderCreateAsyncJson - The path (including folder name) for the folder to be created in the room
        Returns:
        "success"
      • createFoldersInFolderIfNewV30

        public FolderSuggestedNameJson createFoldersInFolderIfNewV30​(CreateFolderJson createFolderJson)
        Creates a folder in a workspace with a specified parent ID and name.
        Parameters:
        createFolderJson - json that represents a folder that will be created in a workspace.
        Returns:
        folderJson - list of folders updated since specified update date; or null if none.
      • createFoldersInFolderV30

        public FolderJson createFoldersInFolderV30​(CreateFolderJson createFolderJson)
        Creates a folder in a workspace with a specified parent ID and name.
        Parameters:
        createFolderJson - json that represents a folder that will be created in a workspace.
        Returns:
        folderJson - list of folders updated since specified update date; or null if none.
      • createFoldersTreeAsyncV30

        public ExternalFoldersTransactionResultJson createFoldersTreeAsyncV30​(CreateWorkspaceFolderTreeJson createWorkspaceFolderTreeJson)
        Creates a folder in a workspace for each folder in the tree asynchronous.
        Parameters:
        createWorkspaceFolderTreeJson - json used to create A workspace folder tree.
        Returns:
        externalFoldersTransactionResultJson
      • createFoldersTreeV30

        public BulkOperationResultJson createFoldersTreeV30​(CreateWorkspaceFolderTreeJson createWorkspaceFolderTreeJson)
        Creates a folder in a workspace for each folder in the tree.
        Parameters:
        createWorkspaceFolderTreeJson - json used to create A workspace folder tree.
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • createFoldersV30

        @Deprecated
        public String createFoldersV30​(String roomId,
                                       PathAndExternalIdJson pathAndExternalIdJson)
        Deprecated.
        Creates a folder in a workspace with a specified path.
        Parameters:
        pathAndExternalIdJson - The path (including folder name) for the folder to be created in the room
        roomId - the workspace in which the folder is to be created.
        Returns:
        "success"
      • createNewDocumentV30

        public SubmitIfNewJson createNewDocumentV30​(CreateNewDocumentJson createNewDocumentJson)
        Create new empty document
        Parameters:
        createNewDocumentJson - json new document upload and submit
        Returns:
        SubmitIfNewJson - return exist or new document
      • createRoomV30

        public RoomJson createRoomV30​(CreateRoomJson createRoomJson)
        Creates a workspace. Assign a name, description and list of administrators for the room.
        Parameters:
        createRoomJson - details of room name, description and administrators
        Returns:
        roomJson - details of new room, including room id
      • deleteDocumentsBulkV30

        public BulkOperationResultJson deleteDocumentsBulkV30​(BulkDeleteWorkspaceDocumentsJson bulkDeleteWorkspaceDocumentsJson)
        Deletes files and/or folders. The files and folders can be in different rooms (workspaces) ??
        Parameters:
        bulkDeleteWorkspaceDocumentsJson - list of files and/or folders to delete. They can be in any workspace. Note : if slash added at the Note : when this API is called on an external repository room - it will behave as if forceAction = true. end of a path, only its content will be deleted
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • deleteDocumentsV30

        public BulkOperationResultJson deleteDocumentsV30​(String roomId,
                                                          DeleteDocumentsSelectionVdrJson deleteDocumentsSelectionVdrJson)
        Deletes files and/or folders from a workspace.
        Parameters:
        deleteDocumentsSelectionVdrJson - list of files and/or folders to delete Note : if slash added at the end of a path, only its content will be deleted Note : when this API is called on an external repository room - it will behave as if forceAction = true.
        roomId - workspace containing the folder to be moved.
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • deleteEntitiesV30

        public String deleteEntitiesV30​(String roomId,
                                        DeleteRoomEntitiesJson deleteRoomEntitiesJson)
        Deletes entities from a workspace. All permissions for the entity in the room will be revoked as well.
        Parameters:
        deleteRoomEntitiesJson - the entities to remove/revoke from the room.
        roomId - the room to remove the entities from.
        Returns:
        "success"
      • deleteFolderV30

        public BulkOperationResultJson deleteFolderV30​(String roomId,
                                                       DeleteFolderJson deleteFolderJson)
        Deletes a folder and all of its subfolders and files from a workspace. The user must have sufficient rights to delete the folders.
        Parameters:
        deleteFolderJson - the folder to be deleted.
        roomId - the room containing the folder to be deleted.
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • deleteRoomV30

        public BulkOperationResultJson deleteRoomV30​(DeleteRoomJson deleteRoomJson)
        Deletes a workspace and all its contents. The deletion can be recoverable (from the recycle bin) or permanent.
        Parameters:
        deleteRoomJson - room to be deleted, and flag indicating whether deletion is permanent.
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • deleteRoomV30

        @Deprecated
        public BulkOperationResultJson deleteRoomV30​(String roomId)
        Deprecated.
        Delete a room.
        Parameters:
        roomId - room id of room to be deleted.
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • documentUploadCompleteV30

        public BulkOperationResultJson documentUploadCompleteV30​(String documentGuid,
                                                                 String roomId)
        Completes the already uploaded by chunks file.
        Parameters:
        documentGuid - the guid for the file
        roomId - the room into which the file will be uploaded.
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • downloadDocumentsWithRecycleBinFormV30

        public InputStream downloadDocumentsWithRecycleBinFormV30​(Set<String> documentsGuids,
                                                                  Boolean forceAction,
                                                                  String roomGuid,
                                                                  Integer roomId,
                                                                  String wdUniqueDownloadKey)
        Downloads files from the Recycle bin (Form) for a given workspace.
        Parameters:
        documentsGuids - List of document Guids.
        forceAction - Flag whether to continue after failure
        roomGuid - Guid of the room to obtain the information about.
        roomId - Id of the room to obtain the information about.
        wdUniqueDownloadKey - Unique download key.
        Returns:
        a binary stream of data
      • downloadDocumentsWithRecycleBinV30

        public InputStream downloadDocumentsWithRecycleBinV30​(DownloadWorkspaceDocumentsWithRecycleBinJson downloadWorkspaceDocumentsWithRecycleBinJson)
        Downloads files from the recycle bin for a given workspace. allowed for workspace admins only
        Parameters:
        downloadWorkspaceDocumentsWithRecycleBinJson - json to download Files from the recycle bin to be a given workspace
        Returns:
        a binary stream of data
      • downloadGenericDocumentsV30

        public InputStream downloadGenericDocumentsV30​(String roomId,
                                                       DownloadDocumentsSelectionVdrJson downloadDocumentsSelectionVdrJson)
        Creates and downloads a ZIP file containing all (original and protected) files in a specified workspace.
        Parameters:
        downloadDocumentsSelectionVdrJson - details of the maximum number of files to download and type of files (original or protected)
        roomId - room id of the workspace containing the files.
        Returns:
        inputStream a binary stream of data
      • downloadOriginalDocumentsV30

        @Deprecated
        public void downloadOriginalDocumentsV30​(String roomId,
                                                 DocumentsSelectionVdrJson documentsSelectionVdrJson)
        Deprecated.
        Use Workspaces#downloadGenericDocumentsV30(String, String, DownloadDocumentsSelectionVdrJson) instead.
        Creates and downloads a ZIP file containing original files.
        Parameters:
        documentsSelectionVdrJson - details for files to download.
        roomId - room id for workspace containing the files
      • downloadProtectedDocumentsV30

        @Deprecated
        public InputStream downloadProtectedDocumentsV30​(String roomId,
                                                         DocumentsSelectionVdrJson documentsSelectionVdrJson)
        Deprecated.
        Use Workspaces#downloadGenericDocumentsV30(String, String, DownloadDocumentsSelectionVdrJson) instead.
        Creates and streams a ZIP file containing protected files.
        Parameters:
        documentsSelectionVdrJson - json to specify various criteria for selecting files
        roomId - room id for workspace containing the files
        Returns:
        inputStream a binary stream of data
      • downloadSingleRecycleBinDocumentV30

        public InputStream downloadSingleRecycleBinDocumentV30​(DownloadSingleRecycleBinWorkspaceDocumentJson downloadSingleRecycleBinWorkspaceDocumentJson)
        Downloads the original version of the file. Allowed only for workspace admins
        Parameters:
        downloadSingleRecycleBinWorkspaceDocumentJson - original version of a file to be downloaded
        Returns:
        inputStream a binary stream of data
      • editFolderSettingsV30

        @Deprecated
        public BulkOperationResultJson editFolderSettingsV30​(EditFolderSettingsJson editFolderSettingsJson)
        Deprecated.
        Edit folder permission settings - whether the folder should inherit permissions from its parent, and whether to force descendants inherit.
        Parameters:
        editFolderSettingsJson - json Used when editing folder permissions.
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.@return bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • editFoldersAndDocumentsSettingsBulkV30

        public BulkOperationResultJson editFoldersAndDocumentsSettingsBulkV30​(EditFoldersAndDocumentsSettingsBulkJson editFoldersAndDocumentsSettingsBulkJson)
        Edit folder permission settings - whether the folder should inherit permissions from its parent, and whether to force descendants inherit.
        Parameters:
        editFoldersAndDocumentsSettingsBulkJson - json Used when editing folder permissions in bulk.
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • editManagersToGroupV30

        public BulkOperationResultJson editManagersToGroupV30​(EditManagersOnGroupJson editManagersOnGroupJson)
        Edit managers on groups ( set or unset manager properties for users).
        Parameters:
        EditManagersOnGroupJson -
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • editPermissionsV30

        public BulkOperationResultJson editPermissionsV30​(String roomId,
                                                          VdrEditPermissionsJson vdrEditPermissionsJson)
        Edit permissions for a list of files for a list of entities (users, groups, etc).
        Parameters:
        roomId - the room id of the workspace containing the files
        vdrEditPermissionsJson - info about the files, entities and permissions to be changed.
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • editRoomV30

        public RoomJson editRoomV30​(String roomId,
                                    EditRoomJson editRoomJson)
        Renames a workspace.
        Parameters:
        editRoomJson - new name for room
        roomId - room id of room to be renamed.
        Returns:
        roomJson
      • entityListV30

        public ItemListJson<RoomEntityJson> entityListV30​(String roomId)
        List the workspace entities (groups/domain/users) that are members of the workspace. This may only be done by users that have CRUD entities privileges.
        Parameters:
        roomId - the requested room.
        Returns:
        A list of RoomEntityJson objects
      • entityPagedListV30

        public PagingItemListJson<CountingRoomEntityJson> entityPagedListV30​(ListRoomEntitiesJson listRoomEntitiesJson)
        List 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
        Parameters:
        listRoomEntitiesJson - json about how to list the workspace entities
        Returns:
        A list of CountingRoomEntityJson objects
      • exportGroupLogToJsonV30

        public PagingItemListJson<GroupLogRecordJson> exportGroupLogToJsonV30​(String roomId,
                                                                              BaseLogJson baseLogJson)
        Exports the workspace groups log to JSON.
        Parameters:
        baseLogJson - json about how to export a log.
        roomId - room id for workspace containing the files
        Returns:
        A list of GroupLogRecordJson objects
      • exportGroupLogV30

        public InputStream exportGroupLogV30​(String roomId,
                                             BaseLogJson baseLogJson)
        Exports the workspace groups log.
        Parameters:
        baseLogJson - json about how to export a log.
        roomId - room id for workspace containing the files
        Returns:
        inputStream a binary stream of data
      • foldersReadConfirmationEditV30

        public BulkOperationResultJson foldersReadConfirmationEditV30​(FolderReadConfirmationEditJson folderReadConfirmationEditJson)
        set the default read confirmation flag for folders
        Parameters:
        FoldersReadConfirmationEditJson - json to set read confirmation flags for folders
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • generateGuidV30

        public GuidJson generateGuidV30​(String roomId)
        Creates a GUID for a new file.
        Parameters:
        roomId - - the GUID for the room to which the file will be added
        Returns:
        guidJson - info including new guid
      • getActivityLogV30

        @Deprecated
        public PagingItemListJson<ActivityLogRecordJson> getActivityLogV30​(String guid,
                                                                           String roomId,
                                                                           boolean lastActionPerUser,
                                                                           Integer pageNumber,
                                                                           Integer pageSize)
        Deprecated.
        Use Files#getActivityLogV30(String, GetDocumentActivityLogRequestJson) instead.
        Gets the activity log for a specific file. The log returns details of all access activities for the file by any user or group.
        Parameters:
        guid - the guid of the file
        lastActionPerUser - a flag indicating whether only the last action for each user should be retrieved. If not set, all activities for all users will be returned.
        pageNumber - the page number, of a multi-page response. ??
        pageSize - the size of a displayed page on the viewing device (in rows??)
        roomId - the room id of the workspace containing the file
        Returns:
        A list of ActivityLogRecordJson objects with details of the activity log for the file. The details include the users who accessed the file, the type of access (view, download etc), date of access, location of access, accessing device, IP address
      • getBulkEmailDataV30

        public EmailBulkDataJson getBulkEmailDataV30​(GetEmailBulkDataJson getEmailBulkDataJson)
        Gets data for bulk email notifications.
        Parameters:
        getEmailBulkDataJson - details about the files (guids).
        Returns:
        emailBulkDataJson - guids to recipients, divided by rooms
      • getDocumentGUIDV30

        public GuidJson getDocumentGUIDV30​(String roomId,
                                           GetGuidByFolderAndNameJson getGuidByFolderAndNameJson)
        Gets a document GUID.
        Parameters:
        getGuidByFolderAndNameJson - json to get a file guid.
        roomId - room id for workspace containing the files
        Returns:
        guidJson
      • getDocumentInfoV30

        public DocumentJson getDocumentInfoV30​(String guid,
                                               String roomId)
        Gets 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.
        Parameters:
        guid - the guid of the file
        roomId - the room id of the workspace containing the file
        Returns:
        documentJson - the information requested about the file.
      • getDocumentLinksV30

        public DocumentLinksJson getDocumentLinksV30​(GuidJson guidJson)
        Gets links for a file in a workspace. The link is a URI for the file.
        Parameters:
        guidJson - file guid for which links are to be obtained
        Returns:
        documentLinksJson - URI link to file
      • getExternalTransactionStatusV30

        public ExternalTransactionStatusJson getExternalTransactionStatusV30​(ExternalTransactionInputJson externalTransactionInputJson)
        Gets external transaction status.
        Parameters:
        externalTransactionInputJson - external transaction input Json
        Returns:
        externalTransactionStatusJson - the status of an external transaction
      • getFolderInfoV30

        public FolderInfoJson getFolderInfoV30​(GetFolderInfoJson getFolderInfoJson)
        Get info for a folder if it has been updated later than a specified date. Info returned is folder name, subfolders, update date.
        Parameters:
        getFolderInfoJson - folder name, update date, room id and user info.
        Returns:
        folderInfoJson - folder info, if folder updated later than update date; null if folder not updated.
      • getFolderLinksV30

        public FolderLinksJson getFolderLinksV30​(String roomId,
                                                 PathOrFolderIdJson pathOrFolderIdJson)
        Gets links for a folder in a workspace. The link is a URI for the folder.
        Parameters:
        pathOrFolderIdJson - path to folder in the workspace
        roomId - Id workspace for which links are to be obtained
        Returns:
        folderLinksJson - URI link to folder
      • getFolderTreeV30

        public FolderJson getFolderTreeV30​(String roomId,
                                           String folderUuid)
        Gets the tree of all folders and subfolders in a specified workspace.
        Parameters:
        roomId - the room for which the tree will be returned
        Returns:
        folderJson - list of folders updated since specified update date; or null if none.
      • getGroupInfoV30

        public RoomEntityJson getGroupInfoV30​(GetGroupInfoJson getGroupInfoJson)
        Gets information about a group in a workspace.
        Parameters:
        getGroupInfoJson - gets info about a group
        Returns:
        roomEntityJson - information about the group, including name, permissions, default expiration date, group users, group distribution lists
      • getGroupsV30

        public ItemListJson<RoomEntityJson> getGroupsV30​(String roomId)
        Gets a list of all groups in a specified workspace.
        Parameters:
        roomId - room id of workspace
        Returns:
        A list of RoomEntityJson objects
      • getInfoForAdminV30

        public WorkspaceInfoJson getInfoForAdminV30​(String roomId,
                                                    boolean addExternalData,
                                                    boolean fetchEvenIfDeleted,
                                                    boolean includeWorkspacePolicyData)
        Gets workspace info. The info includes the name, creation date, deletion date, URL, product, access level, whether workspace is shared, explicit
        Parameters:
        addExternalData - include external data
        fetchEvenIfDeleted - fetch even if deleted
        includeWorkspacePolicyData - include workspace policy data
        roomId - room to obtain information about
        Returns:
        workspaceInfoJson - info about workspace
      • getInfoV30

        public WorkspaceInfoJson getInfoV30​(String roomId,
                                            boolean addExternalData,
                                            boolean adminMode,
                                            boolean fetchEvenIfDeleted,
                                            boolean includeSyncData,
                                            boolean includeWorkspacePolicyData)
        Gets workspace info. The info includes the name, creation date, deletion date, URL, product, access level, whether workspace is shared, explicit
        Parameters:
        addExternalData - include external data
        adminMode - admin mode
        fetchEvenIfDeleted - fetch even if deleted
        includeSyncData - include sync data
        includeWorkspacePolicyData - include workspace policy data
        roomId - room to obtain information about
        Returns:
        workspaceInfoJson - info about workspace
      • getInitialSyncStateForExternalRoomV30

        public InitialSyncStatusJson getInitialSyncStateForExternalRoomV30​(InitialSyncRoomDataJson initialSyncRoomDataJson)
        Applies a decision on a request.
        Parameters:
        initialSyncRoomDataJson - - data about the room for which status is being retrieved
        Returns:
        initialSyncStatusJson - resulting status
      • getInviteTextV30

        public InviteTextJson getInviteTextV30​(String emailSubject,
                                               String guid,
                                               String roomId)
        Gets invite email message for file.
        Parameters:
        emailSubject - subject line of invite email message
        guid - file guid
        roomId - room containing file
        Returns:
        inviteTextJson - subject line and message text of invite email message for specified file.
      • getInviteTextV30

        public InviteTextJson getInviteTextV30​(String emailSubject,
                                               String roomId)
        Gets invite email message for workspace.
        Parameters:
        emailSubject - subject line of invite email message.
        roomId - room
        Returns:
        inviteTextJson - subject line and message text of invite email message for specified room.
      • getPermissionsV30

        public ItemListJson<EntityPermissionJson> getPermissionsV30​(String guid,
                                                                    String roomId)
        Returns all permitted entities permitted to the workspace.
        Parameters:
        guid - The file guid to get the recipients for
        roomId - room to obtain information about
        Returns:
        A list of EntityPermissionJson objects
      • getRoomLinksV30

        public RoomLinksJson getRoomLinksV30​(String roomId)
        Returns the URL link to a workspace.
        Parameters:
        roomId - the workspace
        Returns:
        roomLinksJson - the link to the workspace
      • getRoomsTagValuesV30

        public TagListJson getRoomsTagValuesV30​(RoomListJson roomListJson)
        Gets a list of tags for a list of the user's workspaces.
        Parameters:
        roomListJson - list of rooms
        Returns:
        tagListJson - A list of com.confidela.api.json.tags.TagFieldJson
      • inviteV30

        public BulkOperationResultJson inviteV30​(String roomId,
                                                 InviteJson inviteJson)
        Invite groups to a workspace.
        Parameters:
        inviteJson - list of groups, and email messages to be sent to them
        roomId - room to which groups will be invited
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • inviteV30

        public BulkOperationResultJson inviteV30​(String guid,
                                                 String roomId,
                                                 InviteJson inviteJson)
        Invites groups to a specific file in a workspace.
        Parameters:
        guid - guid for file
        inviteJson - list of groups and email messages to be sent to them
        roomId - room containing the file
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • listDocumentsForAdminV30

        public PagingItemListJson<BaseJson> listDocumentsForAdminV30​(String roomId,
                                                                     ListDocumentsVdrJson listDocumentsVdrJson)
        Lists all files in a specified workspace for admin console requests.
        Parameters:
        listDocumentsVdrJson - filters to be applied to list (eg, All, Read), ordering and page size for the returned list
        roomId - The workspace to get file list from
        Returns:
        A list of Json objects which may contain DocumentJson, PartialDocumentJson and/or FolderJson objects. The list (or partial list) of files in workspace, according to filter, sort and page size.
      • listDocumentsV30

        public PagingItemListJson<BaseJson> listDocumentsV30​(String roomId,
                                                             ListDocumentsVdrJson listDocumentsVdrJson)
        Requests a list of all files in a specified workspace.
        Parameters:
        listDocumentsVdrJson - Filters to be applied to list (eg, All, Read), ordering and page size for the returned list
        roomId - The workspace to get file list from
        Returns:
        A list of Json objects which may contain DocumentJson, PartialDocumentJson and/or FolderJson objects. The list (or partial list) of files in workspace, according to filter, sort and page size.
      • listFolderDefaultPermissionsV30

        public FolderDefaultPermissionsJson listFolderDefaultPermissionsV30​(ListFolderDefaultPermissionsJson listFolderDefaultPermissionsJson)
        Available for workspace admins only. Shows permissions for each of the default entities in given folder
        Parameters:
        listFolderDefaultPermissionsJson - details for listing permissions for each of the default entities in given folder
        Returns:
        folderDefaultPermissionsJson
      • listFolderPermissionRequestsV30

        public ItemListJson<FolderPendingPermissionRequestsJson> listFolderPermissionRequestsV30​(ListFolderPermissionRequestsJson listFolderPermissionRequestsJson)
        Lists existing permissions requests for folder or the entire workspace where the root folder is supplied.
        Parameters:
        listFolderPermissionRequestsJson - listing existing permissions requests for folder
        Returns:
        A list of FolderPendingPermissionRequestsJson objects
      • listFolderPermissionsBulkV30

        public PermissionDetailsJson listFolderPermissionsBulkV30​(ListBulkFolderPermissionsJson listBulkFolderPermissionsJson)
        Available for workspace admins only. Shows aggregation of permissions of folders (not including expiration date)
        Parameters:
        listBulkFolderPermissionsJson - json when getting the aggregation of permissions of folders
        Returns:
        permissionDetailsJson
      • listFoldersAndDocumentsV30

        public FoldersDocumentsJson listFoldersAndDocumentsV30​(String roomId)
        Lists all folders and files in the specified workspace.
        Parameters:
        roomId - Id of the room to obtain the information about.
        Returns:
        foldersDocumentsJson - list of folders and files in the room
      • listPermissionDetailsV30

        public PermissionDetailsJson listPermissionDetailsV30​(ListPermissionDetailsJson listPermissionDetailsJson)
        Lists permission details for files and folders bulkly for all entities in the room.
        Parameters:
        listPermissionDetailsJson - details for listing permission details for files and folders bulky for all entities in the workspace
        Returns:
        permissionDetailsJson
      • listRoomsForAdminV30

        public ItemListJson<WorkspaceInfoJson> listRoomsForAdminV30​(boolean addExternalData,
                                                                    Set<String> workspaceTypes)
        Retrieves a list of all the workspaces for a user with VIEW_ALL_ROOMS capability.
        Parameters:
        addExternalData - add external data
        workspaceTypes - workspace types
        Returns:
        A list of WorkspaceInfoJson objects
      • listRoomsV30

        public ItemListJson<WorkspaceInfoJson> listRoomsV30​(boolean addExternalData,
                                                            boolean adminMode,
                                                            boolean includeSyncData,
                                                            boolean includeWorkspacePolicyData,
                                                            Set<String> workspaceTypes)
        Retrieves a list of all the workspaces of the current user.
        Parameters:
        addExternalData - include external data
        adminMode - for backwards compatibility
        includeSyncData - include sync data
        includeWorkspacePolicyData - include workspace policy data
        workspaceTypes - workspace types
        Returns:
        A list of WorkspaceInfoJson objexts
      • listWorkspacesRecycleBinDocumentsV30

        public PagingItemListJson<RecycleBinDocumentJson> listWorkspacesRecycleBinDocumentsV30​(ListWorkspaceRecycleBinDocumentsJson listWorkspaceRecycleBinDocumentsJson)
        Lists files in the workspace Recycle bin. The recycle bin holds files from workspaces that have been deleted, but not permanently.
        Parameters:
        listWorkspaceRecycleBinDocumentsJson - details as to how to format the response list (page size, ascending or descending order)
        Returns:
        A list of RecycleBinDocumentJson objects
      • listWorkspacesRecycleBinWorkspacesV30

        public PagingItemListJson<WorkspaceInfoJson> listWorkspacesRecycleBinWorkspacesV30​(ListWorkspaceRecycleBinWorkspacesJson listWorkspaceRecycleBinWorkspacesJson)
        Lists workspaces in the workspaces Recycle bin. The recycle bin holds workspaces that have been deleted, but not permanently.
        Parameters:
        listWorkspaceRecycleBinWorkspacesJson - details as to how to format the response (page size, order)
        Returns:
        A list of WorkspaceInfoJson objects
      • loadToCacheV30

        public BulkOperationResultJson loadToCacheV30​(LoadToCacheJson loadToCacheJson)
        Adds a workspace to cache (saved for offline).
        Parameters:
        loadToCacheJson - details of what to load into the cache
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • lockDocumentsV30

        public BulkOperationResultJson lockDocumentsV30​(LockDocumentsRequestJson lockDocumentsRequestJson)
        Locks files.
        Parameters:
        lockDocumentsRequestJson - json for request to lock files
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • markRoomAsExplicitV30

        public String markRoomAsExplicitV30​(String roomId,
                                            RoomExplicitJson roomExplicitJson)
        Marks a workspace as explicit.
        Parameters:
        roomExplicitJson - flag indicating the room to be marked as explicit
        roomId - the room to be marked
        Returns:
        "success"
      • markV30

        public BulkOperationResultJson markV30​(MarkDocumentsSelectionJson markDocumentsSelectionJson)
        Marks a specified list of files with a mark.
        Parameters:
        markDocumentsSelectionJson - a list of files and a mark for them.
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • markV30

        public BulkOperationResultJson markV30​(String roomId,
                                               MarkDocumentsSelectionVdrJson markDocumentsSelectionVdrJson)
        Marks a specified list of files in a workspace.
        Parameters:
        markDocumentsSelectionVdrJson - a list of files and a mark for them.
        roomId - room containing the files
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • modifyGroupV30

        public String modifyGroupV30​(ModifyGroupWithGroupJson modifyGroupWithGroupJson)
        Use 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.
        Parameters:
        modifyGroupWithGroupJson - the group's current identifier or name.
        Returns:
        "success"
      • moveAllV30

        public BulkOperationResultJson moveAllV30​(String roomId,
                                                  MoveAllJson moveAllJson)
        Moves all files from one folder in a workspace to another folder.
        Parameters:
        moveAllJson - the source and target folders
        roomId - the room (workspace) containing both source and target folders
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • moveDocumentV30

        public BulkOperationResultJson moveDocumentV30​(String guid,
                                                       String roomId,
                                                       PathOrFolderIdJson pathOrFolderIdJson)
        Moves a file in a workspace to a new folder.
        Parameters:
        guid - guid of file to be moved
        pathOrFolderIdJson - new pathname for file. File name is unchanged.
        roomId - room id of workspace containing the file
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • moveFolderIntoFolderV30

        public BulkOperationResultJson moveFolderIntoFolderV30​(MoveFolderIntoFolderJson moveFolderIntoFolderJson)
        Moves a folder in a workspace (and its contents) to a new location within the same workspace.
        Parameters:
        moveFolderIntoFolderJson - source folder, to be moved, and destination path within workspace (including the folder name for both). Eg. specifying the source folder path "/ExampleFolder/ExampleSubFolder") and the new full folder path "/ExampleSubFolder" to move the subfolder ExampleSubFolder to be one of the room's direct folders, under the root folder)
        Returns:
        bulkOperationResultJson details about the success of each request, for each entity and file
      • moveFolderV30

        public BulkOperationResultJson moveFolderV30​(String roomId,
                                                     MoveFolderJson moveFolderJson)
        Moves a folder in a workspace (and its contents) to a new location within the same workspace.
        Parameters:
        moveFolderJson - source folder, to be moved, and destination path within workspace (including the folder name for both). Eg. specifying the source folder path "/ExampleFolder/ExampleSubFolder") and the new full folder path "/ExampleSubFolder" to move the subfolder ExampleSubFolder to be one of the room's direct folders, under the root folder)
        roomId - workspace containing the folder to be moved.
        Returns:
        bulkOperationResultJson details about the success of each request, for each entity and file
      • moveV30

        public BulkOperationResultJson moveV30​(String roomId,
                                               MoveJson moveJson)
        Moves files in a workspace folder to a different folder within the same workspace.
        Parameters:
        moveJson - source and target folders for move, within the workspace, and files within the source folder. Note : if slash added at the end of the source path, only its content will be moved and not the folder itself IMPORTANT NOTE: we assume that all folders are "sisters", meaning they have the same parent and they are all moved to the same new parent
        roomId - the the workspace with the files to be moved
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • openForAllRoomV30

        public BulkOperationResultJson openForAllRoomV30​(String roomId,
                                                         OpenForAllRoomEditJson openForAllRoomEditJson)
        Sets a workspace to be open to all entities (users, groups, domains etc).
        Parameters:
        openForAllRoomEditJson - info about the room to be opened
        roomId - the room id for the workspace to be opened
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • removeAllTagsV30

        public String removeAllTagsV30​(String documentGuid,
                                       String roomId,
                                       TagFieldJson tagFieldJson)
        Removes all tags for a specified file.
        Parameters:
        documentGuid - the guid of file
        roomId - the workspace containing the file
        tagFieldJson - json data about the tag name and type
        Returns:
        "success"
      • removeClassificationV30

        @Deprecated
        public String removeClassificationV30​(String roomId,
                                              DocumentsSelectionJson documentsSelectionJson)
        Deprecated.
        Removes classification from the given files. Notice that force action is not supported for this action.
        Parameters:
        documentsSelectionJson - json data(e.g. GUID's) about the documents
        roomId - the room files are in. list of files to remove classifications from.
        Returns:
        "success"
      • removeMembersFromGroupV30

        public BulkOperationResultJson removeMembersFromGroupV30​(RemoveMembersFromGroupJson removeMembersFromGroupJson)
        Removes members (users) from a group.
        Parameters:
        removeMembersFromGroupJson - list of members to be removed from the group
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • removeTagsV30

        public BulkOperationResultJson removeTagsV30​(String roomId,
                                                     RemoveDocumentsTagValuesJson removeDocumentsTagValuesJson)
        Removes specified tags from a list of files.
        Parameters:
        removeDocumentsTagValuesJson - the list of tags and files
        roomId - the workspace containing the files
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • removeUserFromRoomDeprecatedV30

        @Deprecated
        public String removeUserFromRoomDeprecatedV30​(String domain,
                                                      String name,
                                                      String roomId,
                                                      ListRoomEntitiesJson listRoomEntitiesJson)
        Deprecated.
        Use Workspaces#deleteEntitiesV30(String, String, DeleteRoomEntitiesJson) instead.
        Removes a user from all the room groups. This will effectively revoke permissions from the room for this user, unless the user's domain is a member in the room, or the administrator opened the room for everyone.
        Parameters:
        domain - the user's domain
        name - the user's name
        roomId - the requested room to remove the user from.
        Returns:
        "success"
      • renameDocumentV30

        public String renameDocumentV30​(String guid,
                                        String roomId,
                                        UpdateDocumentJson updateDocumentJson)
        Renames a file in a workspace.
        Parameters:
        guid - guid for file to be renamed
        roomId - room id for workspace containing the file
        updateDocumentJson - details of new name for file
        Returns:
        "success"
      • renameFolderV30

        public String renameFolderV30​(String roomId,
                                      RenameFolderJson renameFolderJson)
        Renames a folder within a workspace.
        Parameters:
        renameFolderJson - original and new folder names. The location of the folder within the workspace is not changed, only the folder name.
        roomId - room (workspace) with original folder
        Returns:
        "success"
      • resolveActionForFolderPermissionRequestV30

        public BulkOperationResultJson resolveActionForFolderPermissionRequestV30​(ResolveActionForFolderPermissionRequestJson resolveActionForFolderPermissionRequestJson)
        Applies a decision on a request.
        Parameters:
        resolveActionForFolderPermissionRequestJson - json data(e.g. folder ID, action being taken, etc.) about the request
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • restoreWorkspaceRecycleBinAllDocumentsV30

        public BulkOperationResultJson restoreWorkspaceRecycleBinAllDocumentsV30​(String roomUuid)
        Restores all documentss from Recycle bin for the specified workspace uuid.
        Parameters:
        roomUuid - the workspace (room) uuid of the workspace to have all it's recycle bin docs restored.
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • restoreWorkspacesRecycleBinDocumentsV30

        public BulkOperationResultJson restoreWorkspacesRecycleBinDocumentsV30​(RestoreWorkspacesRecycleBinDocumentJson restoreWorkspacesRecycleBinDocumentJson)
        Restores files from Recycle bin. Files are restored to their original workspaces and removed from the recycle bin.
        Parameters:
        restoreWorkspacesRecycleBinDocumentJson - list of document guids of files in the Recycle Bin to be restored.
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • restoreWorkspacesRecycleBinWorkspacesV30

        public BulkOperationResultJson restoreWorkspacesRecycleBinWorkspacesV30​(RestoreWorkspacesRecycleBinWorkspacesJson restoreWorkspacesRecycleBinWorkspacesJson)
        Restores workspaces from Recycle bin.
        Parameters:
        restoreWorkspacesRecycleBinWorkspacesJson - list of workspace (room) ids of workspace in the Recycle Bin to be restored.
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • revokePermissionsV30

        public BulkOperationResultJson revokePermissionsV30​(String roomId,
                                                            VdrRevokePermissionJson vdrRevokePermissionJson)
        Revokes all permissions for a list of entities (users, groups etc) for a list of files in a workspace.
        Parameters:
        roomId - the room id for the workspace containing the files
        vdrRevokePermissionJson - info about the files and entities (users, groups etc) for which permissions are to be revoked
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and file
      • searchDocumentsForAdminV30

        public PagingItemListJson<DocumentJson> searchDocumentsForAdminV30​(SearchDocumentsVdrJson searchDocumentsVdrJson)
        For 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.
        Parameters:
        searchDocumentsVdrJson - a search string and other qualifications for the search, such as page size and order for the result list
        Returns:
        A list of DocumentJson objexts meeting the search criteria, arranged according to the order and page size.
      • searchDocumentsV30

        public PagingItemListJson<DocumentJson> searchDocumentsV30​(SearchDocumentsVdrJson searchDocumentsVdrJson)
        For 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.
        Parameters:
        searchDocumentsVdrJson - a search string and other qualifications for the search, such as page size and order for the result list
        Returns:
        com.confidela.api.json.DocumentJson list of files meeting the search criteria, arranged according to the order and page size.
      • sendBulkEmailV30

        public String sendBulkEmailV30​(SendEmailBulkJson sendEmailBulkJson)
        Sends bulk email notifications for a list of files to all permitted entities (users, groups etc) for each file. The emails are sent immediately.
        Parameters:
        sendEmailBulkJson - details about the files (guids) and email messages to be sent.
        Returns:
        "success"
      • sendEmailV30

        public String sendEmailV30​(String guid,
                                   String roomId,
                                   SendEmailJson sendEmailJson)
        Sends email to group of recipients with a message regarding a specific file in a workspace.
        Parameters:
        guid - guid of the file
        roomId - room id of the workspace containing the file
        sendEmailJson - details of the email message to be sent and the list of
        Returns:
        "success"
      • setClassificationV30

        @Deprecated
        public String setClassificationV30​(String roomId,
                                           SetClassificationJson setClassificationJson)
        Deprecated.
        Sets files classifications.
        Parameters:
        roomId - the room the files are in
        setClassificationJson - json data with the doucment GUID's and classification
        Returns:
        "success"
      • setModifiedDateV30

        @Deprecated
        public BulkOperationResultJson setModifiedDateV30​(DocumentsModifiedDateSetJson documentsModifiedDateSetJson)
        Deprecated.
        Sets file modified date.
        Parameters:
        documentsModifiedDateSetJson - json for modified date to be set for a file
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • setSharepointProtectorV30

        public BulkOperationResultJson setSharepointProtectorV30​(BulkWorkspaceProtectorSettingsJson bulkWorkspaceProtectorSettingsJson)
        Sets protect anywhere policy for a workspace.
        Parameters:
        bulkWorkspaceProtectorSettingsJson - a collection of workspace protector settings used when setting a Sharepoint protector
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • setUpdateDataV30

        public BulkOperationResultJson setUpdateDataV30​(DocumentsUpdateDataSetJson documentsUpdateDataSetJson)
        Sets files update data.
        Parameters:
        documentsUpdateDataSetJson - a collection of file data updates to be applied to a file
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • submitDocumentIfNewV30

        public SubmitIfNewJson submitDocumentIfNewV30​(String roomId,
                                                      SubmitDocumentVdrJson submitDocumentVdrJson)
        Submits 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).
        Parameters:
        roomGuid - the room id for the room into which the file will be submitted.
        submitDocumentVdrJson - info about the file to be submitted including name, path, user.
        Returns:
        submitIfNewJson - A list of com.confidela.api.json.SubmitIfNewJson info about the submitted file in the room.
      • submitDocumentsV30

        public ItemListJson<SubmitDocumentResultJson> submitDocumentsV30​(String roomId,
                                                                         SubmitDocumentsVdrJson submitDocumentsVdrJson)
        Submits files to a workspace. The submit action is requested after files have been uploaded to a workspace, to notify entities (users, groups etc)
        Parameters:
        roomId - the room id of the room (workspace) into which the files will be submitted.
        submitDocumentsVdrJson - info about the files to be submitted including: the guids for the files, recipients for the files, tags, email notifiction message details
        Returns:
        A list of SubmitDocumentResultJson objects
      • unlockDocumentsV30

        public BulkOperationResultJson unlockDocumentsV30​(UnlockDocumentsRequestJson unlockDocumentsRequestJson)
        Unlock files.
        Parameters:
        unlockDocumentsRequestJson - json for a request to unlock a file
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • updateDocumentV30

        @Deprecated
        public String updateDocumentV30​(String guid,
                                        String roomId,
                                        File data,
                                        DeviceType deviceType,
                                        String documentName,
                                        String mailBody,
                                        String mailSubject,
                                        Boolean sendMail)
        Deprecated.
        Update a file in a workspace. The update action uploads the file to the server and sends an email notification to all entities (users, groups) with permissions for the file.
        Parameters:
        data - information about the file to be uploaded: filename folder
        deviceType - device type
        documentName - the name of the file
        guid - the guid of the file
        mailBody - body of the mail
        mailSubject - subject of the mail
        roomId - the room id of the workspace into which the file will be uploaded.
        sendMail - flag indicating whether an email notification should be sent (to permitted entities)
        Returns:
        "success"
      • uploadBlobV30

        public GuidJson uploadBlobV30​(String roomId,
                                      File data,
                                      DeviceType deviceType,
                                      String documentName,
                                      String fileName)
        Uploads a file to a workspace and generates a new GUID for it.
        Parameters:
        data - information about the file to be uploaded: filename folder
        deviceType - device type
        documentName - document name
        fileName - file name
        roomId - the room into which the file will be uploaded.
        Returns:
        guidJson - info about uploaded file, including the guid created for it.
      • uploadDocumentBase64V30

        public String uploadDocumentBase64V30​(String documentGuid,
                                              String roomId,
                                              File data,
                                              DeviceType deviceType,
                                              String documentName)
        Uploads a file to a workspace in base64.
        Parameters:
        data - information about the file to be uploaded: filename folder
        deviceType - device type
        documentGuid - the guid for the file
        documentName - name for the file
        roomId - the room into which the document will be uploaded.
        Returns:
        "success"
      • uploadDocumentByPostV30

        public String uploadDocumentByPostV30​(String documentGuid,
                                              String roomId,
                                              File data,
                                              DeviceType deviceType,
                                              String documentName,
                                              String fileName,
                                              Long start)
        Uploads a file to a workspace.
        Parameters:
        data - information about the file to be uploaded: filename folder
        deviceType - device type
        documentGuid - the guid for the file
        documentName - name for the file
        fileName - name of the file
        roomId - the room into which the file will be uploaded
        start - the start to the specified uploadedInputStream
        Returns:
        "success"
      • uploadDocumentByPostV30

        public String uploadDocumentByPostV30​(String documentGuid,
                                              String roomId,
                                              InputStream data,
                                              DeviceType deviceType,
                                              String documentName,
                                              String fileName,
                                              Long start)
        Uploads a file to a workspace.
        Parameters:
        data - information about the file to be uploaded: filename folder
        deviceType - device type
        documentGuid - the guid for the file
        documentName - name for the file
        fileName - name of the file
        roomId - the room into which the file will be uploaded
        start - the start to the specified uploadedInputStream
        Returns:
        "success"
      • validateCreateFolderV30

        public BulkOperationResultJson validateCreateFolderV30​(ValidateCreateFolderJson validateCreateFolderJson)
        Validates the parameters are ok for adding folder.
        Parameters:
        validateCreateFolderJson - json used to validate params when creating a folder
        Returns:
        bulkOperationResultJson - details about the success of each request, for each entity and document
      • validateDocumentsToDownloadFromRecycleBinV30

        public BulkOperationResultJson validateDocumentsToDownloadFromRecycleBinV30​(ValidateDownloadWorkspaceDocumentsWithRecycleBinJson validateDownloadWorkspaceDocumentsWithRecycleBinJson)
        Validates files to download from a Recycle bin.
        Parameters:
        validateDownloadWorkspaceDocumentsWithRecycleBinJson - json used when validating files to download from a recycle bin
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • validateDocumentsToDownloadV30

        public BulkOperationResultJson validateDocumentsToDownloadV30​(ValidateDownloadDocumentVersionInVdrsJson validateDownloadDocumentVersionInVdrsJson)
        Validates the file versions for download from a list of files.
        Parameters:
        validateDownloadDocumentVersionInVdrsJson - details of files to validate.
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.
      • validateDocumentsToDownloadV30

        public BulkOperationResultJson validateDocumentsToDownloadV30​(String roomId,
                                                                      ValidateDownloadDocumentsSelectionVdrJson validateDownloadDocumentsSelectionVdrJson)
        Validates a list of files for download from a specific workspace.
        Parameters:
        roomId - room id for workspace containing the files
        validateDownloadDocumentsSelectionVdrJson - details of files to validate
        Returns:
        bulkOperationResultJson - indicates if actions were successful or, if not, the problems.