Index BlackBerry Workspaces SDK
BlackBerry Workspaces Resource
TransientWorkspaces
Functions for secure virtual data transient workspace handling.
Function Summary
Name Path Version Description

DownloadCommentsV30

/3.0/transient/workspace/comment/download

3.0

addEntitiesV30

/3.0/transient/workspace/entities/add

3.0

Adds permitted entities to workspace with no permissions outside of the given folder.

addNotificationV30

/3.0/transient/workspace/logAction

3.0

Adds a notification for a file action in the file's activity log file.

addTransientDocumentPermissionRequestV30

/3.0/transient/workspace/documents/permissions/requests/add

3.0

addTransientFolderPermissionRequestV30

/3.0/transient/workspace/folder/permissions/requests/add

3.0

cancelUploadDocumentByPostV30

/3.0/transient/workspace/{roomId}/documents/{documentGuid}/cancelupload

3.0

changeDefaultPermissionsBulkV30

/3.0/transient/workspace/entities/permissions/change

3.0

Changes default permissions of a permitted entity in a transient workspace.

checkForBoxAccessTokenV30

/3.0/transient/workspace/hasBoxAccessToken

3.0

Check if the logged in user has a Box access token stored.

checkForCredentialV30

/3.0/transient/workspace/hasDropboxAccessToken

3.0

Check if the logged in user has a valid Dropbox access token stored.

copyDocumentsFromRoomsToExchangeAsyncV30

/3.0/transient/workspace/copy/exchange/async

3.0

Copies a transient file to Microsoft Exchange.

createDropboxWorkspaceV30

/3.0/transient/workspace/createDropboxWorkspace

3.0

Creates a new transient workspace for Dropbox.

createFolderV30

/3.0/transient/workspace/folder/create

3.0

Creates a new transient folder.

createNewCommentV30

/3.0/transient/workspace/comment/create

3.0

createNewTransientDocumentV30

/3.0/transient/workspace/document/new/create

3.0

createRoomV30

/3.0/transient/workspace/create

3.0

Creates a new transient workspace.

deleteCommentV30

/3.0/transient/workspace/comment/delete

3.0

deleteDocumentsAndFoldersV30

/3.0/transient/workspace/documents/delete

3.0

Deletes transient folders and files.

deleteRoomV30

/3.0/transient/workspace/delete

3.0

Delete transient workspace.

deleteUserDocumentAnnotationV30

/3.0/transient/workspace/document/annotations/delete

3.0

Delete annotations from transient file.

documentUploadCompleteV30

/3.0/transient/workspace/{roomId}/documents/{documentGuid}/upload/completed

3.0

Complete uploaded file.

downloadDocumentAnnotationsOriginalV30

/3.0/transient/workspace/document/annotations/original

3.0

Returns the annotations for a given file.

downloadDocumentsFormV30

/3.0/transient/workspace/download/documents.zip

3.0

Downloads a set of specified files or all files in a set of specified folders and files in a transient workspace.

downloadOriginalV30

/3.0/transient/workspace/{workspaceGuid}/download

3.0

Returns a single file.

downloadSingleDocumentForWebV30

/3.0/transient/workspace/documents/downloadForWeb

3.0

Downloads a single file (for web).

downloadSingleDocumentForWebV30

/3.0/transient/workspace/documents/downloadForWeb

3.0

Downloads a single file for web (additional info is returned).

downloadSingleDocumentV30

/3.0/transient/workspace/documents/download

3.0

Downloads a single file.

downloadUserDocumentAnnotationsInDocFormForWebV30

/3.0/transient/workspace/annotations/downloadInDocForWeb

3.0

Returns the annotations for a user file in PDF format.

downloadUserDocumentAnnotationsInDocFromV30

/3.0/transient/workspace/annotations/downloadInDocZip

3.0

Downloads document annotations in zip format.

downloadUserDocumentAnnotationsInDocMultipleFromV30

/3.0/transient/workspace/annotations/downloadInDocMultiple

3.0

Downloads annotations for file in a user's workspace.

downloadUserDocumentAnnotationsV30

/3.0/transient/workspace/document/annotations/download

3.0

Downloads user file annotations.

editFoldersAndDocumentsSettingsBulkV30

/3.0/transient/workspace/folders/documents/settings/edit

3.0

Edit folder and file permissions in bulk.

exportActivityHistoryForRoomsV30

/3.0/transient/workspace/activityHistory/csv/create

3.0

Returns a CSV file of workspace activity history for the given set of rooms.

exportActivityLogV30

/3.0/transient/workspace/activityLog/csv/create

3.0

Gets activity log CSV for a file in WD.

exportSpecificUsersActivityHistoryByMailV30

/3.0/transient/workspace/users/activityHistory/allProducts/csv/exportByMail

3.0

Exports a selected Activity history for a list of users in current user's organization to a CSV file as an attachment to an email.

exportUsersActivityHistoryV30

/3.0/transient/workspace/users/activityHistory/allProducts/csv/create

3.0

Exports activity history for a list of users in current user's organization to a CSV file.

generateGuidV30

/3.0/transient/workspace/guid/create

3.0

Creates file GUID for new or updated files.

generateGuidV30

/3.0/transient/workspace/documents/guid/create

3.0

Creates file GUID for new file in a workspace context.

getActivityLogV30

/3.0/transient/workspace/activityLog/csv/export

3.0

Gets activity log for a file in WD in CSV format.

getActivityLogV30

/3.0/transient/workspace/activityLog

3.0

Gets activity log for a file in BlackBerry Workspaces.

getBoxOAuthParametersV30

/3.0/transient/workspace/boxOauthParams

3.0

Return Box OAuth Parameters.

getDocumentInfoV30

/3.0/transient/workspace/document/info

3.0

Retrieves file info.

getDropboxOAuthParametersV30

/3.0/transient/workspace/getDropboxOauthParams

3.0

Return Dropbox OAuth Parameters.

getFolderInfoV30

/3.0/transient/workspace/folders/info/list

3.0

Gets single level of folders.

getPathInfoV30

/3.0/transient/workspace/path/info/list

3.0

Get info for a path.

getPermissionsForIOSV30

/3.0/transient/workspace/documents/permissions/ios

3.0

Returns the iOS-targeted list of permissions for a file.

getValidPathInfoListV30

/3.0/transient/workspace/valid/path/info/list

3.0

Get info for a valid list paths.

getWorkspaceInfoV30

/3.0/transient/workspace/workspace/info

3.0

initiateConversionJsonV30

/3.0/transient/workspace/conversion/initiate

3.0

Initiates conversion.

inviteV30

/3.0/transient/workspace/invite

3.0

Invite groups to a workspace.

inviteV30

/3.0/transient/workspace/documents/invite

3.0

Invites groups to a specific file in a workspace.

listCommentsV30

/3.0/transient/workspace/comment/list

3.0

listFoldersAndDocumentsV30

/3.0/transient/workspace/folders/documents/list

3.0

Retrieves a list of transient files and folders.

listFoldersSingleLevelV30

/3.0/transient/workspace/folders/list

3.0

Gets the tree of all folders.

listLastResolvedTransientDocumentPermissionRequestsV30

/3.0/transient/workspace/documents/permissions/requests/listLastResolve

3.0

listLastResolvedTransientFolderPermissionRequestsV30

/3.0/transient/workspace/folder/permissions/requests/listLastResolve

3.0

listOrganizationPolicyV30

/3.0/transient/workspace/policy/document/list

3.0

Returns the organization policy for the given workspace.

listPermissionDetailsV30

/3.0/transient/workspace/permissionDetails/list

3.0

List permission details for files and folders for all entities in the workspace.

listStarredDocumentsV30

/3.0/transient/workspace/documents/starred/list

3.0

List starred files in transient workspace.

listTransientDocumentsPermissionRequestsV30

/3.0/transient/workspace/documents/permissions/requests/list

3.0

Lists existing permission requests for a document in a transient workspace.

listTransientFolderPermissionRequestsV30

/3.0/transient/workspace/folder/permissions/requests/list

3.0

Lists existing permission requests for a folder in a transient workspace.

listUnreadCommentsUserMentionPerDocumentV30

/3.0/transient/workspace/comment/usermention/unread/list

3.0

mountDropboxSharedFolderV30

/3.0/transient/workspace/mountDropboxSharedFolder

3.0

moveV30

/3.0/transient/workspace/move

3.0

Moves folders and files.

renameDocumentV30

/3.0/transient/workspace/document/rename

3.0

Renames a file in a transient workspace.

renameFolderV30

/3.0/transient/workspace/folder/rename

3.0

Renames a transient folder.

resolveActionForTransientDocumentPermissionRequestV30

/3.0/transient/workspace/documents/permissions/requests/resolve

3.0

Applies a decision on a request.

resolveActionForTransientFolderPermissionRequestV30

/3.0/transient/workspace/folder/permissions/requests/resolve

3.0

Applies a decision on a request.

saveTransientWorkspaceCredentialsV30

/3.0/transient/workspace/credentials/save

3.0

Saves the credentials for a given workspace.

sendBulkEmailV30

/3.0/transient/workspace/documents/emails/send

3.0

Sends emails to file users.

setupBoxAuthTokenV30

/3.0/transient/workspace/setupBoxAuthToken

3.0

shareUserDocumentAnnotationV30

/3.0/transient/workspace/annotations/share

3.0

Shares file annotations with the provided users and/or groups.

signOutBoxWorkspaceV30

/3.0/transient/workspace/signOutBox

3.0

Sign out Box repository.

signOutDropboxWorkspaceV30

/3.0/transient/workspace/signOutDropbox

3.0

Sign out Dropbox repository.

starDocumentsV30

/3.0/transient/workspace/documents/star

3.0

Marks a file with a star.

submitDocumentIfNewV30

/3.0/transient/workspace/{roomId}/documents/submitIfNew

3.0

Submits a new document version.

submitVersionV30

/3.0/transient/workspace/documents/submitVersion

3.0

Submits a new file version.

unstarDocumentsV30

/3.0/transient/workspace/documents/unstar

3.0

updateCommentV30

/3.0/transient/workspace/comment/update

3.0

uploadDocumentByPostV30

/3.0/transient/workspace/{roomId}/documents/{documentGuid}/upload

3.0

Uploads new file data.

uploadUserDocumentAnnotationV30

/3.0/transient/workspace/annotations/uploadWithDevice

3.0

Uploads annotations for a user file.

validateDocumentsToDownloadV30

/3.0/transient/workspace/documents/validateDownload

3.0

Validates files for download.

validateDownloadUserDocumentAnnotationsInDocV30

/3.0/transient/workspace/annotations/validateDownloadInDoc

3.0

Validates user file annotations for download.

validateKCDCredentialsV30

/3.0/transient/workspace/kcd/credentials/validate

3.0

validate the credentials for a kcd user on a given workspace.

validateZipDownloadUserDocumentAnnotationsInDocV30

/3.0/transient/workspace/annotations/download/validateDownloadInDocZip

3.0

Validates user document annotations for download.

Function Details

DownloadCommentsV30

Download a pdf contains all the comments of the given document

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/comment/download
Request Body: DownloadTransientComments
Response Headers: N/A
Response Body: N/A

Request format:

POST /3.0/transient/workspace/comment/download

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
path: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

addEntitiesV30

Adds permitted entities to workspace with no permissions outside of the given folder.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/entities/add
Request Body: AddEntitiesTransient
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/entities/add

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceUuid: String,
folderPath: String,
documentPaths: Set(String),
roomEntities: Set(
{
address: String,
entityType: EntityType
}),
roomGroups: List(
{
groupName: String,
description: String,
membersList: List(
{
entity:
{
address: String,
entityType: EntityType
}
}),
managersList: List(
{
entity:
{
address: String,
entityType: EntityType
}
})
}),
newPermissions:
{
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
comment: Boolean
},
role: String,
access: Boolean,
includeAllSubItems: Boolean,
emailSubject: String,
emailMessage: String,
isSendMail: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

addNotificationV30

Adds a notification for a file action in the file's activity log file.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/logAction
Request Body: CreateTransientActivityLogRecord
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/logAction

Authorization: Bearer <ssid>
Content-type: application/json

{
documentPath: String,
roomGuid: String,
date: Date,
clientDate: Date,
type: LogActionType,
printerName: String,
application: String,
annotatingUsers: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

addTransientDocumentPermissionRequestV30

Add a permission request for a document in a transient workspace

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/permissions/requests/add
Request Body: AddTransientDocumentPermissionRequest
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/documents/permissions/requests/add

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceUuid: String,
path: String,
message: String,
timeExtensionDate: Date,
requestType: PermissionRequestType,
subject: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

addTransientFolderPermissionRequestV30

Add a permission request for a folder in a transient workspace

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/folder/permissions/requests/add
Request Body: AddTransientFolderPermissionRequest
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/folder/permissions/requests/add

Authorization: Bearer <ssid>
Content-type: application/json

{
path: String,
message: String,
roomGuid: String,
subject: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

cancelUploadDocumentByPostV30

Cancels an upload

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/{roomId}/documents/{documentGuid}/cancelupload
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:

documentName: String - document name.
fileName: String - file name.

Request format:

POST /3.0/transient/workspace/{roomId}/documents/{documentGuid}/cancelupload

Authorization: Bearer <ssid>
Content-type: multipart/form-data

Response format:

HTTP/1.1 200 OK

String

changeDefaultPermissionsBulkV30

Changes default permissions of a permitted entity in a transient workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/entities/permissions/change
Request Body: ChangeEntitiesTransient
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/entities/permissions/change

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceUuid: String,
permittedEntitiesWithPermissions: Set(
{
permittedEntity:
{
address: String,
entityType: EntityType
},
permissions:
{
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
comment: Boolean
},
isDefault: Boolean,
revokePermissions: Boolean,
role: String
}),
folderPaths: Set(String),
documentPaths: Set(String),
forceAction: Boolean,
forceInheritanceOnDescendants: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

checkForBoxAccessTokenV30

Check if the logged in user has a Box access token stored.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/hasBoxAccessToken
Request Body: ExternalRepositoryGuid
Response Headers: N/A
Response Body: CheckBoxAccessTokenResult

Request format:

POST /3.0/transient/workspace/hasBoxAccessToken

Authorization: Bearer <ssid>
Content-type: application/json

{
externalRepositoryGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
hasAccessToken: Boolean,
tokenExpired: Boolean
}

checkForCredentialV30

Check if the logged in user has a valid Dropbox access token stored.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/hasDropboxAccessToken
Request Body: GetDropboxWorkspace
Response Headers: N/A
Response Body: CheckDropboxAccessTokenResult

Request format:

POST /3.0/transient/workspace/hasDropboxAccessToken

Authorization: Bearer <ssid>
Content-type: application/json

{
externalRepositoryGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
hasValidAccessToken: Boolean
}

copyDocumentsFromRoomsToExchangeAsyncV30

Copies a transient file to Microsoft Exchange.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/copy/exchange/async
Request Body: CopyTransientDocumentToExchangeAsync
Response Headers: N/A
Response Body: TransientDocumentsTransactionResult

Request format:

POST /3.0/transient/workspace/copy/exchange/async

Authorization: Bearer <ssid>
Content-type: application/json

{
userRecipients: Set(String),
listRecipients: Set(String),
activeDirectoryGroupsRecipients: Set(String),
permission:
{
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
comment: Boolean
},
whoCanView: WhoCanView,
isSendEmail: Boolean,
mailSubject: String,
mailMessage: String,
workspaceUuid: String,
documentPath: String,
deviceType: DeviceType,
isCopyAnnotations: Boolean,
readConfirmation: Boolean,
isOpenToAnyone: Boolean,
isCollaboration: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
transactionUUID: String,
documentPaths: Set(String),
workspaceUuid: String
}

createDropboxWorkspaceV30

Creates a new transient workspace for Dropbox.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/createDropboxWorkspace
Request Body: CreateDropboxWorkspace
Response Headers: N/A
Response Body: TransientWorkspace

Request format:

POST /3.0/transient/workspace/createDropboxWorkspace

Authorization: Bearer <ssid>
Content-type: application/json

{
externalRepositoryGuid: String,
oauthCode: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
id: String,
uuid: String,
name: String,
description: String,
accessLevel: RoomAccessLevel,
hyperlink: String,
explicit: Boolean,
explicitRoom: Boolean,
creationDate: Date,
defaultWorkspaceOrder: ApiDocumentOrderVDR,
roomCapabilities: Set(WorkspaceCapabilityType ),
shared: Boolean,
organizationPolicyJson:
{
isAllowedToShareAnnotationsWithWorkspaceAdmins: Boolean,
isAllowedToShareAnnotationsWithAllWorkspaceGroups: Boolean,
isAllowedToShareAnnotationsWithSelectedGroups: Boolean,
isAllowedToShareAnnotationsWithUsersManually: Boolean,
allowDownloadOriginal: Boolean,
allowDownloadProtected: Boolean,
isAllowedToShareDocumentsWithWorkspaceAdmins: Boolean,
isAllowedToShareDocumentsWithAllWorkspaceGroups: Boolean,
isAllowedToShareDocumentsWithSelectedGroups: Boolean,
isAllowedToShareDocumentsWithUsersManually: Boolean,
allowMobileIos: Boolean,
allowMobileAndroid: Boolean,
allowMobileBlackberry: Boolean,
allowMobileWindowsMobile: Boolean,
deleteFromDisk: Boolean,
licenseHoursValid: Integer,
defaultChangeGroupsToAllDocs: Boolean,
defaultAddGroupsAsDefaultEntity: Boolean,
allowOpenOriginalsInOtherApps: Boolean,
allowOpenUnsupportedInOtherApps: Boolean,
enableRmsSealing: Boolean,
uploadBandwidthLimit: Integer,
downloadBandwidthLimit: Integer,
enableBandwidthLimit: Boolean,
globalDownloadControlled: Boolean,
enableCloudStorageWorkspaces: Boolean,
allowTrackingFromMicrosoftOfficeDocuments: Boolean,
blockNonProvisionedUsers: Boolean,
enableSalesForce: Boolean,
enableWivi: Boolean,
enableOnlineViewerForUnsupportedBrowsers: Boolean,
enableWopi: Boolean,
allowLockingDocuments: Boolean,
useAutoComplete: Boolean,
autoCompleteAllowToAll: Boolean,
autoCompleteDisplayAll: Boolean,
wopiDiscoveryUrl: String,
enableSharingWithoutEmailNotification: Boolean,
shareFilesWithNotificationByDefault: Boolean,
isDisableOnBehalfOfForAllOutgoingEmails: Boolean,
enableComments: Boolean,
commentsDefaultValue: Boolean,
sendWeeklyLicensingReport: Boolean,
sendWeeklyInternalDomainLicensingReport: Boolean,
enablePushNotifications: Boolean,
sendMissingSetupNotificationEmails: Boolean,
sendDailyActivityEmail: Boolean,
enableFetchMembers: Boolean,
forcePinWorkspaces: Boolean,
displayCommentContent: Boolean,
allowAdvancedPrinting: Boolean,
customizedNotificationsEmails: Boolean,
disallowChangeToPermissionTemplates: Boolean
},
deleteDate: Date,
syncPolicy:
{
blacklistExpressions: Set(String),
whitelistExpressions: Set(String),
maxSize: Long
}),
logAccessActionsToFiles: Boolean,
workspacePolicyJson:
{
allowPrintingToPdf: Boolean,
disableCurtain: Boolean,
disablePasscodeLock: Boolean,
allowNonControllableFileTypes: Boolean,
protectImagesInWorkspaces: Boolean,
useAutoComplete: Boolean,
supportedTypes: Set(String),
allowEditDescription: Boolean,
logAccessActionsToFiles: Boolean,
enableReadConfirmation: Boolean,
readConfirmByDefault: Boolean,
fileUploadNotifyWorkspaceMembersDefault: Boolean
}),
transientWorkspaceExternalDataJson:
{
path: String,
userName: String,
password: String
}
}

createFolderV30

Creates a new transient folder.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/folder/create
Request Body: CreateTransientFolder
Response Headers: N/A
Response Body: TransientFolder

Request format:

POST /3.0/transient/workspace/folder/create

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
parentObjectUrl: String,
newFolderName: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isPermsInherited: Boolean,
name: String,
updateDate: Date,
hasSubfolders: Boolean,
roomUUID: String,
room: String,
parentFullPath: String,
fullPath: String,
fullPathDisplay: String,
sharedFolderId: String,
email: String,
timeInvited: Date,
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
folderCapabilities: Set(WorkspaceCapabilityType ),
modifiedBy: String,
subFolders: List(TransientFolder )
}

createNewCommentV30

Add new comment to transient document

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/comment/create
Request Body: CreateNewTransientComment
Response Headers: N/A
Response Body: CreateNewTransientCommentResult

Request format:

POST /3.0/transient/workspace/comment/create

Authorization: Bearer <ssid>
Content-type: application/json

{
path: String,
workspaceGuid: String,
parentCommentUuid: String,
data: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
commentUuid: String,
parentCommentUuid: String
}

createNewTransientDocumentV30

Create new empty document

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/document/new/create
Request Body: CreateNewTransientDocument
Response Headers: N/A
Response Body: SubmitIfNewTransientDocument

Request format:

POST /3.0/transient/workspace/document/new/create

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
documentName: String,
isSendMail: Boolean,
mailSubject: String,
mailMessage: String,
folder: String,
openForAllRoom: Boolean,
modifiedDate: Date,
deviceType: DeviceType,
suggestNewNameWhenAlreadyExists: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
existingDocument:
{
documentGuid: String,
versionGuid: String,
permitted: Boolean,
suggestedName: String
},
document:
{
path: String,
name: String,
convertedName: String,
sender: String,
filename: String,
url: String,
viewerUrl: String,
editorUrl: String,
contentType: String,
room: String,
folder: String,
folderDisplay: String,
folderId: Integer,
folderUuid: String,
lastUpdated: Date,
creationDate: Date,
expires: Date,
accessLevel: DocumentAccessLevel,
secureTransferFile: Boolean,
pendingRequests: Integer,
previewUrl: String,
originalSize: Long,
status:
{
documentState: DocumentStatusForApi,
statusCode: Integer,
errorText: String
},
dlpStatus: String,
percentCompleted: Integer,
classification: String,
read: Boolean,
starred: Boolean,
permissionsJson:
{
accessLevel: Consts$AccessLevel,
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
comment: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
pinRequired: Boolean,
minExpirationDate: Date,
latestChangeDate: Date,
originalComments: Boolean
},
tagList:
{
freeTextValues: List(
{
tagName: String,
tagValue: String
}),
dateValues: List(
{
tagName: String,
tagValue: Date
}),
numericValues: List(
{
tagName: String,
tagValue: Number
})
}),
downloadSize: Long,
downloadPdfSize: Long,
type: String,
documentName: String,
lastUpdateDate: Date,
score: Float,
pdfConversionStatus: PdfConversionStatus,
annotationsList:
{
annotationRecordJsons: Collection(
{
annotatingUserAddress: String,
annotationUpdateDate: Date
})
}),
externalRepositoryData:
{
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
documentExternalData:
{
id: String,
items: Set(
{
key: String,
value: String
})
})
}),
documentCurrentVersion:
{
currentVersionUuid: String,
currentDocVersionUpdateDate: Date
},
modifiedDate: Date,
openToAnyone: Boolean,
licenseHoursValid: Integer,
supportedFileType: Boolean,
numOfVersions: Integer,
rmsEnabled: Boolean,
fileHash: String,
cacheStatus: CacheDocumentStatus,
inheritsPerms: Boolean,
readyForDownloadOriginal: ReadyForDownloadOriginal,
modifiedBy: String,
onlineEditorUrl: String,
starredDate: Date,
transientDocumentCommentCountJson:
{
commentCount: Integer,
commentMentionCount: Integer
},
workspaceUuid: String
})
}

createRoomV30

Creates a new transient workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/create
Request Body: CreateTransientWorkspace
Response Headers: N/A
Response Body: TransientWorkspace

Request format:

POST /3.0/transient/workspace/create

Authorization: Bearer <ssid>
Content-type: application/json

{
name: String,
description: String,
path: String,
userName: String,
password: String,
externalRepositoryGuid: String,
transientWorkspaceCredentialsUuid: String,
domain: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
id: String,
uuid: String,
name: String,
description: String,
accessLevel: RoomAccessLevel,
hyperlink: String,
explicit: Boolean,
explicitRoom: Boolean,
creationDate: Date,
defaultWorkspaceOrder: ApiDocumentOrderVDR,
roomCapabilities: Set(WorkspaceCapabilityType ),
shared: Boolean,
organizationPolicyJson:
{
isAllowedToShareAnnotationsWithWorkspaceAdmins: Boolean,
isAllowedToShareAnnotationsWithAllWorkspaceGroups: Boolean,
isAllowedToShareAnnotationsWithSelectedGroups: Boolean,
isAllowedToShareAnnotationsWithUsersManually: Boolean,
allowDownloadOriginal: Boolean,
allowDownloadProtected: Boolean,
isAllowedToShareDocumentsWithWorkspaceAdmins: Boolean,
isAllowedToShareDocumentsWithAllWorkspaceGroups: Boolean,
isAllowedToShareDocumentsWithSelectedGroups: Boolean,
isAllowedToShareDocumentsWithUsersManually: Boolean,
allowMobileIos: Boolean,
allowMobileAndroid: Boolean,
allowMobileBlackberry: Boolean,
allowMobileWindowsMobile: Boolean,
deleteFromDisk: Boolean,
licenseHoursValid: Integer,
defaultChangeGroupsToAllDocs: Boolean,
defaultAddGroupsAsDefaultEntity: Boolean,
allowOpenOriginalsInOtherApps: Boolean,
allowOpenUnsupportedInOtherApps: Boolean,
enableRmsSealing: Boolean,
uploadBandwidthLimit: Integer,
downloadBandwidthLimit: Integer,
enableBandwidthLimit: Boolean,
globalDownloadControlled: Boolean,
enableCloudStorageWorkspaces: Boolean,
allowTrackingFromMicrosoftOfficeDocuments: Boolean,
blockNonProvisionedUsers: Boolean,
enableSalesForce: Boolean,
enableWivi: Boolean,
enableOnlineViewerForUnsupportedBrowsers: Boolean,
enableWopi: Boolean,
allowLockingDocuments: Boolean,
useAutoComplete: Boolean,
autoCompleteAllowToAll: Boolean,
autoCompleteDisplayAll: Boolean,
wopiDiscoveryUrl: String,
enableSharingWithoutEmailNotification: Boolean,
shareFilesWithNotificationByDefault: Boolean,
isDisableOnBehalfOfForAllOutgoingEmails: Boolean,
enableComments: Boolean,
commentsDefaultValue: Boolean,
sendWeeklyLicensingReport: Boolean,
sendWeeklyInternalDomainLicensingReport: Boolean,
enablePushNotifications: Boolean,
sendMissingSetupNotificationEmails: Boolean,
sendDailyActivityEmail: Boolean,
enableFetchMembers: Boolean,
forcePinWorkspaces: Boolean,
displayCommentContent: Boolean,
allowAdvancedPrinting: Boolean,
customizedNotificationsEmails: Boolean,
disallowChangeToPermissionTemplates: Boolean
},
deleteDate: Date,
syncPolicy:
{
blacklistExpressions: Set(String),
whitelistExpressions: Set(String),
maxSize: Long
}),
logAccessActionsToFiles: Boolean,
workspacePolicyJson:
{
allowPrintingToPdf: Boolean,
disableCurtain: Boolean,
disablePasscodeLock: Boolean,
allowNonControllableFileTypes: Boolean,
protectImagesInWorkspaces: Boolean,
useAutoComplete: Boolean,
supportedTypes: Set(String),
allowEditDescription: Boolean,
logAccessActionsToFiles: Boolean,
enableReadConfirmation: Boolean,
readConfirmByDefault: Boolean,
fileUploadNotifyWorkspaceMembersDefault: Boolean
}),
transientWorkspaceExternalDataJson:
{
path: String,
userName: String,
password: String
}
}

deleteCommentV30

Update comment

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/comment/delete
Request Body: DeleteTransientComment
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/comment/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
commentUuid: String,
path: String,
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteDocumentsAndFoldersV30

Deletes transient folders and files.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/delete
Request Body: DeleteTransientDocumentsAndFolders
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/documents/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
documentPaths: Set(String),
folderPaths: Set(String),
deviceType: DeviceType
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteRoomV30

Delete transient workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/delete
Request Body: DeleteTransientWorkspace
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

deleteUserDocumentAnnotationV30

Delete annotations from transient file.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/document/annotations/delete
Request Body: DeleteTransientDocumentAnnotations
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/document/annotations/delete

Authorization: Bearer <ssid>
Content-type: application/json

{
path: String,
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

documentUploadCompleteV30

Complete uploaded file.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/{roomId}/documents/{documentGuid}/upload/completed
Request Body: N/A
Response Headers: N/A
Response Body: BulkOperationResult

Path parameters:

documentGuid: String - document guid.
roomId: String - room id.

Request format:

POST /3.0/transient/workspace/{roomId}/documents/{documentGuid}/upload/completed

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

downloadDocumentAnnotationsOriginalV30

Returns the annotations for a given file.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/document/annotations/original
Request Body: N/A
Response Headers: N/A
Response Body: N/A

Data form parameters:

path: String.
user: String.
workspaceGuid: String.

Request format:

POST /3.0/transient/workspace/document/annotations/original

Authorization: Bearer <ssid>
Content-type: application/x-www-form-urlencoded

Response format:

HTTP/1.1 200 OK

InputStream

downloadDocumentsFormV30

Downloads a set of specified files or all files in a set of specified folders and files in a transient workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/download/documents.zip
Request Body: N/A
Response Headers: N/A
Response Body: N/A

Data form parameters:

documentPaths: Set.
downloadType: String.
folderPaths: Set.
wdUniqueDownloadKey: String.
workspaceUuid: String.

Request format:

POST /3.0/transient/workspace/download/documents.zip

Authorization: Bearer <ssid>
Content-type: application/x-www-form-urlencoded

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

downloadOriginalV30

Returns a single file.

Version: 3.0
Synopsis: GET
Path: /3.0/transient/workspace/{workspaceGuid}/download
Request Body: N/A
Response Headers: N/A
Response Body: N/A

Path parameters:

workspaceGuid: String - workspace guid.

Query parameters:

documentPath: String - document path.
downloadType: String - download type. (optional, default: "ORIGINAL").
forceWatermarks: String - force water marks. (optional, default: "false").

Request format:

GET /3.0/transient/workspace/{workspaceGuid}/download

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

downloadSingleDocumentForWebV30

Downloads a single file (for web).

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/downloadForWeb
Request Body: N/A
Response Headers: N/A
Response Body: N/A

Data form parameters:

documentPath: String.
downloadType: String.
forceWatermarks: boolean.
wdUniqueDownloadKey: String.
workspaceUuid: String.

Request format:

POST /3.0/transient/workspace/documents/downloadForWeb

Authorization: Bearer <ssid>
Content-type: application/x-www-form-urlencoded

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

downloadSingleDocumentForWebV30

Downloads a single file for web (additional info is returned).

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/downloadForWeb
Request Body: DownloadSingleTransientDocumentForWeb
Response Headers: N/A
Response Body: N/A

Request format:

POST /3.0/transient/workspace/documents/downloadForWeb

Authorization: Bearer <ssid>
Content-type: application/json

{
documentPath: String,
workspaceUuid: String,
downloadType: DownloadTypes,
forceWatermarks: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

downloadSingleDocumentV30

Downloads a single file.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/download
Request Body: DownloadSingleTransientDocument
Response Headers: N/A
Response Body: N/A

Request format:

POST /3.0/transient/workspace/documents/download

Authorization: Bearer <ssid>
Content-type: application/json

{
documentPath: String,
workspaceUuid: String,
downloadType: DownloadTypes,
forceWatermarks: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

downloadUserDocumentAnnotationsInDocFormForWebV30

Returns the annotations for a user file in PDF format.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/annotations/downloadInDocForWeb
Request Body: N/A
Response Headers: N/A
Response Body: N/A

Data form parameters:

path: String.
userAddress: String.
wdUniqueDownloadKey: String.
workspaceGuid: String.

Request format:

POST /3.0/transient/workspace/annotations/downloadInDocForWeb

Authorization: Bearer <ssid>
Content-type: application/x-www-form-urlencoded

Response format:

HTTP/1.1 200 OK

InputStream

downloadUserDocumentAnnotationsInDocFromV30

Downloads document annotations in zip format.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/annotations/downloadInDocZip
Request Body: N/A
Response Headers: N/A
Response Body: N/A

Data form parameters:

path: String.
userAddresses: Set.
wdUniqueDownloadKey: String.
workspaceGuid: String.

Request format:

POST /3.0/transient/workspace/annotations/downloadInDocZip

Authorization: Bearer <ssid>
Content-type: application/x-www-form-urlencoded

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

downloadUserDocumentAnnotationsInDocMultipleFromV30

Downloads annotations for file in a user's workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/annotations/downloadInDocMultiple
Request Body: N/A
Response Headers: N/A
Response Body: N/A

Data form parameters:

path: String.
userAddresses: Set.
wdUniqueDownloadKey: String.
workspaceGuid: String.

Request format:

POST /3.0/transient/workspace/annotations/downloadInDocMultiple

Authorization: Bearer <ssid>
Content-type: application/x-www-form-urlencoded

Response format:

HTTP/1.1 200 OK

InputStream

downloadUserDocumentAnnotationsV30

Downloads user file annotations.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/document/annotations/download
Request Body: DownloadTransientDocumentAnnotations
Response Headers: N/A
Response Body: DocumentAnnotationsForUsers

Request format:

POST /3.0/transient/workspace/document/annotations/download

Authorization: Bearer <ssid>
Content-type: application/json

{
path: String,
workspaceGuid: String,
userAddressesAnnotationsToDownload: Set(String),
shouldDownloadHiddenAnnotations: Boolean,
deviceType: DeviceType,
reportProblematicAnnotations: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
userAnnotations: Collection(
{
userAddress: String,
updateDate: Date,
userAnnotations:
{
documentPageAnnotations: List(
{
pageAnnotations: List(
{
annotationType: AnnotationType,
annotationRectangle:
{
lowerLeftCorner:
{
x: Float,
y: Float
},
upperRightCorner:
{
x: Float,
y: Float
}
},
annotationColor:
{
red: Float,
green: Float,
blue: Float
},
lastModificationDate: Date,
annotationFlags: Set(AnnotationFlagsEnum )
}),
pagePlainAnnotations: List(
{
annotationPDFText: String
}),
annotationsPageNo: Integer
})
})
}),
documentAnnotations:
{
documentPageAnnotations: List(
{
pageAnnotations: List(
{
annotationType: AnnotationType,
annotationRectangle:
{
lowerLeftCorner:
{
x: Float,
y: Float
},
upperRightCorner:
{
x: Float,
y: Float
}
},
annotationColor:
{
red: Float,
green: Float,
blue: Float
},
lastModificationDate: Date,
annotationFlags: Set(AnnotationFlagsEnum )
}),
pagePlainAnnotations: List(
{
annotationPDFText: String
}),
annotationsPageNo: Integer
})
})
}

editFoldersAndDocumentsSettingsBulkV30

Edit folder and file permissions in bulk.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/folders/documents/settings/edit
Request Body: TransientEditFoldersAndDocumentsSettingsBulk
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/folders/documents/settings/edit

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceUuid: String,
folderPaths: Set(String),
documentPaths: Set(String),
makeDescendantsInherit: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

exportActivityHistoryForRoomsV30

Returns a CSV file of workspace activity history for the given set of rooms.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/activityHistory/csv/create
Request Body: ExportActivityHistoryForTransientRooms
Response Headers: N/A
Response Body: N/A

Request format:

POST /3.0/transient/workspace/activityHistory/csv/create

Authorization: Bearer <ssid>
Content-type: application/json

{
from: Date,
to: Date,
roomIds: Set(Integer),
roomGuids: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

exportActivityLogV30

Gets activity log CSV for a file in WD.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/activityLog/csv/create
Request Body: GetTransientDocumentActivityLogRequest
Response Headers: N/A
Response Body: N/A

Request format:

POST /3.0/transient/workspace/activityLog/csv/create

Authorization: Bearer <ssid>
Content-type: application/json

{
roomGuid: String,
documentPath: String,
pageSize: Integer,
pageNumber: Integer,
lastActionPerUser: Boolean,
fromDate: Date,
toDate: Date
}

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

exportSpecificUsersActivityHistoryByMailV30

Exports a selected Activity history for a list of users in current user's organization to a CSV file as an attachment to an email.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/users/activityHistory/allProducts/csv/exportByMail
Request Body: ExportSpecificUsersTransientActivityHistoryByMail
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/users/activityHistory/allProducts/csv/exportByMail

Authorization: Bearer <ssid>
Content-type: application/json

{
userEmails: Set(String),
from: Date,
to: Date
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

exportUsersActivityHistoryV30

Exports activity history for a list of users in current user's organization to a CSV file.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/users/activityHistory/allProducts/csv/create
Request Body: ExportUsersTransientActivityHistory
Response Headers: N/A
Response Body: N/A

Request format:

POST /3.0/transient/workspace/users/activityHistory/allProducts/csv/create

Authorization: Bearer <ssid>
Content-type: application/json

{
userAddresses: Set(String),
datesFilter:
{
from: Date,
to: Date
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

generateGuidV30

Creates file GUID for new or updated files.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/guid/create
Request Body: N/A
Response Headers: N/A
Response Body: Guid

Request format:

POST /3.0/transient/workspace/guid/create

Authorization: Bearer <ssid>

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
guid: String
}

generateGuidV30

Creates file GUID for new file in a workspace context.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/guid/create
Request Body: GenerateTransientDocumentGuid
Response Headers: N/A
Response Body: Guid

Request format:

POST /3.0/transient/workspace/documents/guid/create

Authorization: Bearer <ssid>

{
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
guid: String
}

getActivityLogV30

Gets activity log for a file in WD in CSV format.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/activityLog/csv/export
Request Body: N/A
Response Headers: N/A
Response Body: N/A

Data form parameters:

documentPath: String.
fromDate: String.
lastActionPerUser: boolean.
pageNumber: Integer.
pageSize: Integer.
toDate: String.
workspaceUuid: String.

Request format:

POST /3.0/transient/workspace/activityLog/csv/export

Authorization: Bearer <ssid>
Content-type: application/x-www-form-urlencoded

Response format:

HTTP/1.1 200 OK

Content-type: application/octet-stream

InputStream

getActivityLogV30

Gets activity log for a file in BlackBerry Workspaces.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/activityLog
Request Body: GetTransientDocumentActivityLogRequest
Response Headers: N/A
Response Body: PagingItemListJson of type ActivityLogRecord

Request format:

POST /3.0/transient/workspace/activityLog

Authorization: Bearer <ssid>
Content-type: application/json

{
roomGuid: String,
documentPath: String,
pageSize: Integer,
pageNumber: Integer,
lastActionPerUser: Boolean,
fromDate: Date,
toDate: Date
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(ActivityLogRecord )
}

getBoxOAuthParametersV30

Return Box OAuth Parameters.

Version: 3.0
Synopsis: GET
Path: /3.0/transient/workspace/boxOauthParams
Request Body: N/A
Response Headers: N/A
Response Body: BoxOAuthParams

Request format:

GET /3.0/transient/workspace/boxOauthParams

Authorization: Bearer <ssid>
Content-type: application/json

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
baseUrl: String,
clientId: String,
redirectUri: String
}

getDocumentInfoV30

Retrieves file info.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/document/info
Request Body: TransientDocumentInfo
Response Headers: N/A
Response Body: TransientDocument

Request format:

POST /3.0/transient/workspace/document/info

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
objectUrl: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
path: String,
name: String,
convertedName: String,
sender: String,
filename: String,
url: String,
viewerUrl: String,
editorUrl: String,
contentType: String,
room: String,
folder: String,
folderDisplay: String,
folderId: Integer,
folderUuid: String,
lastUpdated: Date,
creationDate: Date,
expires: Date,
accessLevel: DocumentAccessLevel,
secureTransferFile: Boolean,
pendingRequests: Integer,
previewUrl: String,
originalSize: Long,
status:
{
documentState: DocumentStatusForApi,
statusCode: Integer,
errorText: String
},
dlpStatus: String,
percentCompleted: Integer,
classification: String,
read: Boolean,
starred: Boolean,
permissionsJson:
{
accessLevel: Consts$AccessLevel,
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
comment: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
pinRequired: Boolean,
minExpirationDate: Date,
latestChangeDate: Date,
originalComments: Boolean
},
tagList:
{
freeTextValues: List(
{
tagName: String,
tagValue: String
}),
dateValues: List(
{
tagName: String,
tagValue: Date
}),
numericValues: List(
{
tagName: String,
tagValue: Number
})
}),
downloadSize: Long,
downloadPdfSize: Long,
type: String,
documentName: String,
lastUpdateDate: Date,
score: Float,
pdfConversionStatus: PdfConversionStatus,
annotationsList:
{
annotationRecordJsons: Collection(
{
annotatingUserAddress: String,
annotationUpdateDate: Date
})
}),
externalRepositoryData:
{
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
documentExternalData:
{
id: String,
items: Set(
{
key: String,
value: String
})
})
}),
documentCurrentVersion:
{
currentVersionUuid: String,
currentDocVersionUpdateDate: Date
},
modifiedDate: Date,
openToAnyone: Boolean,
licenseHoursValid: Integer,
supportedFileType: Boolean,
numOfVersions: Integer,
rmsEnabled: Boolean,
fileHash: String,
cacheStatus: CacheDocumentStatus,
inheritsPerms: Boolean,
readyForDownloadOriginal: ReadyForDownloadOriginal,
modifiedBy: String,
onlineEditorUrl: String,
starredDate: Date,
transientDocumentCommentCountJson:
{
commentCount: Integer,
commentMentionCount: Integer
},
workspaceUuid: String
}

getDropboxOAuthParametersV30

Return Dropbox OAuth Parameters.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/getDropboxOauthParams
Request Body: GetDropboxWorkspace
Response Headers: N/A
Response Body: DropboxOAuthParams

Request format:

POST /3.0/transient/workspace/getDropboxOauthParams

Authorization: Bearer <ssid>
Content-type: application/json

{
externalRepositoryGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
baseUrl: String,
clientId: String,
redirectUri: String
}

getFolderInfoV30

Gets single level of folders. workspace to get a single level of folders from

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/folders/info/list
Request Body: GetTransientFolderInfo
Response Headers: N/A
Response Body: TransientFolderInfoResult

Request format:

POST /3.0/transient/workspace/folders/info/list

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
folderPath: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
id: Integer,
uuid: String,
name: String,
updateDate: Date,
hasSubfolders: Boolean,
room: String,
folder: String,
parentId: Integer,
subFolders: List(
{
id: Integer,
isPermsInherited: Boolean,
uuid: String,
name: String,
updateDate: Date,
hasSubfolders: Boolean,
room: String,
roomUUID: String,
folder: String,
parentId: Integer,
parentGuid: String,
subFolders: List(Folder ),
fullPath: String,
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
folderCapabilities: Set(WorkspaceCapabilityType ),
folderRole: String,
readConfirmationRequired: Boolean,
readConfirmationIncludeSubfolder: Boolean,
originalReadAckState: Boolean,
starred: Boolean,
starredDate: Date
}),
fullPath: String,
fullPathDisplay: String,
externalRepositoryData:
{
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
folderExternalData:
{
id: Integer,
items: Set(
{
key: String,
value: String
})
})
}),
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
totalFilesSize: Long,
totalCount: Integer,
lastFileModifiedDate: Date,
isPermissionsInherited: Boolean,
folderCapabilities: Set(WorkspaceCapabilityType ),
folderRole: String
}

getPathInfoV30

Get info for a path.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/path/info/list
Request Body: GetPathInfo
Response Headers: N/A
Response Body: TransientPathInfo

Request format:

POST /3.0/transient/workspace/path/info/list

Authorization: Bearer <ssid>
Content-type: application/json

{
path: String,
workspaceUuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isPermissionsInherited: Boolean,
permissions:
{
downloadOriginal: YesNoDefault,
downloadControlled: YesNoDefault,
copy: YesNoDefault,
print: YesNoDefault,
edit: YesNoDefault,
spotlight: YesNoDefault,
watermark: YesNoDefault,
expiration: ExpirationOptions,
expirationDate: Date,
programmaticAccess: YesNoDefault,
comment: YesNoDefault
},
pathCapabilities: Set(WorkspaceCapabilityType )
}

getPermissionsForIOSV30

Returns the iOS-targeted list of permissions for a file.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/permissions/ios
Request Body: GetTransientDocumentPermissionsForIos
Response Headers: N/A
Response Body: ItemListJson of type EntityPermission

Request format:

POST /3.0/transient/workspace/documents/permissions/ios

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
documentPath: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(EntityPermission )
}

getValidPathInfoListV30

Get info for a valid list paths.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/valid/path/info/list
Request Body: GetValidPathInfoList
Response Headers: N/A
Response Body: PagingItemListJson

Request format:

POST /3.0/transient/workspace/valid/path/info/list

Authorization: Bearer <ssid>
Content-type: application/json

{
validPathInfoListJson: List(
{
workspaceUuid: String,
paths: List(String)
})
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(TransientDocument )
}

getWorkspaceInfoV30

Return info on the workspace

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/workspace/info
Request Body: GetTransientWorkspaceInfo
Response Headers: N/A
Response Body: TransientWorkspaceInfo

Request format:

POST /3.0/transient/workspace/workspace/info

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
name: String
}

initiateConversionJsonV30

Initiates conversion.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/conversion/initiate
Request Body: TransientInitiateConversion
Response Headers: N/A
Response Body: TransientInitiateConversionResult

Request format:

POST /3.0/transient/workspace/conversion/initiate

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
objectUrl: String,
format: TransientInitiateConversionFileFormat
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
status: ConversionModuleStatus,
estimatedTimeForConversion: Integer,
guid: String
}

inviteV30

Invite groups to a workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/invite
Request Body: TransientInvite
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/invite

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
folderPath: String,
emailSubject: String,
emailMessage: String,
groupNames: Set(String),
additionalEmails: Set(String),
activeDirectoryGroupsGuids: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

inviteV30

Invites groups to a specific file in a workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/invite
Request Body: TransientDocumentInvite
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/documents/invite

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
documentPath: String,
emailSubject: String,
emailMessage: String,
groupNames: Set(String),
additionalEmails: Set(String),
activeDirectoryGroupsGuids: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

listCommentsV30

List document comments hierarchy

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/comment/list
Request Body: ListTransientDocumentComments
Response Headers: N/A
Response Body: ItemListJson

Request format:

POST /3.0/transient/workspace/comment/list

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
path: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(DocumentComment )
}

listFoldersAndDocumentsV30

Retrieves a list of transient files and folders.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/folders/documents/list
Request Body: ListTransientFoldersAndDocuments
Response Headers: N/A
Response Body: PagingItemListJson of type TransientDocument

Request format:

POST /3.0/transient/workspace/folders/documents/list

Authorization: Bearer <ssid>

{
folderPath: String,
workspaceGuid: String,
pageSize: Integer,
pageNumber: Integer,
apiDocumentOrderVDR: ApiDocumentOrderVDR,
orderAscending: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(Json )
}

listFoldersSingleLevelV30

Gets the tree of all folders.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/folders/list
Request Body: ListTransientFolders
Response Headers: N/A
Response Body: ListTransientFoldersSingleLevelResult

Request format:

POST /3.0/transient/workspace/folders/list

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
folderPath: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isPermsInherited: Boolean,
name: String,
updateDate: Date,
hasSubfolders: Boolean,
roomUUID: String,
room: String,
parentFullPath: String,
fullPath: String,
fullPathDisplay: String,
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
folderCapabilities: Set(WorkspaceCapabilityType ),
modifiedBy: String,
subFolders: List(ListTransientFoldersSingleLevelResult )
}

listLastResolvedTransientDocumentPermissionRequestsV30

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/permissions/requests/listLastResolve
Request Body: ListLastResolvedTransientDocumentPermissionRequests
Response Headers: N/A
Response Body: ItemListJson of type LastResolvedTransientDocumentPermissionRequestResult

Request format:

POST /3.0/transient/workspace/documents/permissions/requests/listLastResolve

Authorization: Bearer <ssid>
Content-type: application/json

{
numberOfLastDaysToShowRequestsFrom: Integer
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{ }

listLastResolvedTransientFolderPermissionRequestsV30

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/folder/permissions/requests/listLastResolve
Request Body: ListLastResolvedTransientFolderPermissionRequests
Response Headers: N/A
Response Body: ItemListJson of type LastResolvedTransientDocumentPermissionRequestResult

Request format:

POST /3.0/transient/workspace/folder/permissions/requests/listLastResolve

Authorization: Bearer <ssid>
Content-type: application/json

{
numberOfLastDaysToShowRequestsFrom: Integer
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{ }

listOrganizationPolicyV30

Returns the organization policy for the given workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/policy/document/list
Request Body: ListTransientOrganizationPolicy
Response Headers: N/A
Response Body: OrganizationPolicy

Request format:

POST /3.0/transient/workspace/policy/document/list

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isAllowedToShareAnnotationsWithWorkspaceAdmins: Boolean,
isAllowedToShareAnnotationsWithAllWorkspaceGroups: Boolean,
isAllowedToShareAnnotationsWithSelectedGroups: Boolean,
isAllowedToShareAnnotationsWithUsersManually: Boolean,
allowDownloadOriginal: Boolean,
allowDownloadProtected: Boolean,
isAllowedToShareDocumentsWithWorkspaceAdmins: Boolean,
isAllowedToShareDocumentsWithAllWorkspaceGroups: Boolean,
isAllowedToShareDocumentsWithSelectedGroups: Boolean,
isAllowedToShareDocumentsWithUsersManually: Boolean,
allowMobileIos: Boolean,
allowMobileAndroid: Boolean,
allowMobileBlackberry: Boolean,
allowMobileWindowsMobile: Boolean,
deleteFromDisk: Boolean,
licenseHoursValid: Integer,
defaultChangeGroupsToAllDocs: Boolean,
defaultAddGroupsAsDefaultEntity: Boolean,
allowOpenOriginalsInOtherApps: Boolean,
allowOpenUnsupportedInOtherApps: Boolean,
enableRmsSealing: Boolean,
uploadBandwidthLimit: Integer,
downloadBandwidthLimit: Integer,
enableBandwidthLimit: Boolean,
globalDownloadControlled: Boolean,
enableCloudStorageWorkspaces: Boolean,
allowTrackingFromMicrosoftOfficeDocuments: Boolean,
blockNonProvisionedUsers: Boolean,
enableSalesForce: Boolean,
enableWivi: Boolean,
enableOnlineViewerForUnsupportedBrowsers: Boolean,
enableWopi: Boolean,
allowLockingDocuments: Boolean,
useAutoComplete: Boolean,
autoCompleteAllowToAll: Boolean,
autoCompleteDisplayAll: Boolean,
wopiDiscoveryUrl: String,
enableSharingWithoutEmailNotification: Boolean,
shareFilesWithNotificationByDefault: Boolean,
isDisableOnBehalfOfForAllOutgoingEmails: Boolean,
enableComments: Boolean,
commentsDefaultValue: Boolean,
sendWeeklyLicensingReport: Boolean,
sendWeeklyInternalDomainLicensingReport: Boolean,
enablePushNotifications: Boolean,
sendMissingSetupNotificationEmails: Boolean,
sendDailyActivityEmail: Boolean,
enableFetchMembers: Boolean,
forcePinWorkspaces: Boolean,
displayCommentContent: Boolean,
allowAdvancedPrinting: Boolean,
customizedNotificationsEmails: Boolean,
disallowChangeToPermissionTemplates: Boolean
}

listPermissionDetailsV30

List permission details for files and folders for all entities in the workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/permissionDetails/list
Request Body: ListTransientPermissionDetails
Response Headers: N/A
Response Body: PermissionDetails

Request format:

POST /3.0/transient/workspace/permissionDetails/list

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceUuid: String,
folderPaths: Set(String),
documentPaths: Set(String),
permissionTemplateFilter: TemplatePermissionsFilter,
roomRoleFilter: String,
includeExpired: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
aggregatedPermissionDetailsList: List(
{
permittedEntityInRoom:
{
entityType: String,
entityName: String,
entityDisplayedAddress: String,
entityCustomerGivenId: String,
entityUUID: String,
roomRole: String
},
isWaterMark: String,
expirationDate: String,
expirationDays: String,
aggregatedPermissions:
{
templateName: String,
templateDisplayedName: String,
templateType: PermissionTemplateType,
canCopy: String,
canEdit: String,
canPrint: String,
isSpotlight: String,
canDownloadOriginal: String,
canDownloadProtected: String,
isProgrammaticAccess: String,
isComment: String
},
roomRole: String,
isComment: String
})
}

listStarredDocumentsV30

List starred files in transient workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/starred/list
Request Body: ListStarredTransientDocuments
Response Headers: N/A
Response Body: PagingItemListJson of type TransientDocument

Request format:

POST /3.0/transient/workspace/documents/starred/list

Authorization: Bearer <ssid>
Content-type: application/json

{
pagination:
{
pageSize: Integer,
pageNumber: Integer
}
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
offset: Integer,
total: Integer,
items: List(TransientDocument )
}

listTransientDocumentsPermissionRequestsV30

Lists existing permission requests for a document in a transient workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/permissions/requests/list
Request Body: ListTransientDocumentsPermissionRequests
Response Headers: N/A
Response Body: ItemListJson of type TransientDocumentPermissionRequestsResults

Request format:

POST /3.0/transient/workspace/documents/permissions/requests/list

Authorization: Bearer <ssid>
Content-type: application/json

{
adminMode: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(TransientDocumentPermissionRequestsResults )
}

listTransientFolderPermissionRequestsV30

Lists existing permission requests for a folder in a transient workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/folder/permissions/requests/list
Request Body: ListTransientFolderPermissionRequests
Response Headers: N/A
Response Body: ItemListJson of type TransientFolderPermissionRequestsResults

Request format:

POST /3.0/transient/workspace/folder/permissions/requests/list

Authorization: Bearer <ssid>
Content-type: application/json

{
adminMode: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(TransientFolderPermissionRequestsResults )
}

listUnreadCommentsUserMentionPerDocumentV30

List of unread comments of a certain document that user was mention in

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/comment/usermention/unread/list
Request Body: TransientListUserMentionInUnreadDocumentComments
Response Headers: N/A
Response Body: ItemListJson of type DocumentComment

Request format:

POST /3.0/transient/workspace/comment/usermention/unread/list

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
path: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
total: Integer,
items: List(DocumentComment )
}

mountDropboxSharedFolderV30

provide the Dropbox shared folderId to add the folder to the workspace

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/mountDropboxSharedFolder
Request Body: DropboxMountSharedFolder
Response Headers: N/A
Response Body: DropboxMountSharedFolderResult

Request format:

POST /3.0/transient/workspace/mountDropboxSharedFolder

Authorization: Bearer <ssid>
Content-type: application/json

{
sharedFolderId: String,
externalRepositoryGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
shared_folder_id: String,
path_lower: String
}

moveV30

Moves folders and files.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/move
Request Body: TransientMove
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/move

Authorization: Bearer <ssid>
Content-type: application/json

{
folderPaths: Set(String),
deviceType: DeviceType,
documentPaths: Set(String),
targetPath: String,
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

renameDocumentV30

Renames a file in a transient workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/document/rename
Request Body: RenameTransientDocument
Response Headers: N/A
Response Body: TransientDocument

Request format:

POST /3.0/transient/workspace/document/rename

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
objectUrl: String,
newDocumentName: String,
deviceType: DeviceType
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
path: String,
name: String,
convertedName: String,
sender: String,
filename: String,
url: String,
viewerUrl: String,
editorUrl: String,
contentType: String,
room: String,
folder: String,
folderDisplay: String,
folderId: Integer,
folderUuid: String,
lastUpdated: Date,
creationDate: Date,
expires: Date,
accessLevel: DocumentAccessLevel,
secureTransferFile: Boolean,
pendingRequests: Integer,
previewUrl: String,
originalSize: Long,
status:
{
documentState: DocumentStatusForApi,
statusCode: Integer,
errorText: String
},
dlpStatus: String,
percentCompleted: Integer,
classification: String,
read: Boolean,
starred: Boolean,
permissionsJson:
{
accessLevel: Consts$AccessLevel,
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
comment: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
pinRequired: Boolean,
minExpirationDate: Date,
latestChangeDate: Date,
originalComments: Boolean
},
tagList:
{
freeTextValues: List(
{
tagName: String,
tagValue: String
}),
dateValues: List(
{
tagName: String,
tagValue: Date
}),
numericValues: List(
{
tagName: String,
tagValue: Number
})
}),
downloadSize: Long,
downloadPdfSize: Long,
type: String,
documentName: String,
lastUpdateDate: Date,
score: Float,
pdfConversionStatus: PdfConversionStatus,
annotationsList:
{
annotationRecordJsons: Collection(
{
annotatingUserAddress: String,
annotationUpdateDate: Date
})
}),
externalRepositoryData:
{
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
documentExternalData:
{
id: String,
items: Set(
{
key: String,
value: String
})
})
}),
documentCurrentVersion:
{
currentVersionUuid: String,
currentDocVersionUpdateDate: Date
},
modifiedDate: Date,
openToAnyone: Boolean,
licenseHoursValid: Integer,
supportedFileType: Boolean,
numOfVersions: Integer,
rmsEnabled: Boolean,
fileHash: String,
cacheStatus: CacheDocumentStatus,
inheritsPerms: Boolean,
readyForDownloadOriginal: ReadyForDownloadOriginal,
modifiedBy: String,
onlineEditorUrl: String,
starredDate: Date,
transientDocumentCommentCountJson:
{
commentCount: Integer,
commentMentionCount: Integer
},
workspaceUuid: String
}

renameFolderV30

Renames a transient folder.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/folder/rename
Request Body: RenameTransientFolder
Response Headers: N/A
Response Body: RenameTransientFolderResult

Request format:

POST /3.0/transient/workspace/folder/rename

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
objectUrl: String,
newFolderName: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isPermsInherited: Boolean,
name: String,
updateDate: Date,
hasSubfolders: Boolean,
roomUUID: String,
room: String,
parentFullPath: String,
fullPath: String,
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
folderCapabilities: Set(WorkspaceCapabilityType ),
modifiedBy: String,
subFolders: List(
{
isPermsInherited: Boolean,
name: String,
updateDate: Date,
hasSubfolders: Boolean,
roomUUID: String,
room: String,
parentFullPath: String,
fullPath: String,
fullPathDisplay: String,
sharedFolderId: String,
email: String,
timeInvited: Date,
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
folderCapabilities: Set(WorkspaceCapabilityType ),
modifiedBy: String,
subFolders: List(TransientFolder )
})
}

resolveActionForTransientDocumentPermissionRequestV30

Applies a decision on a request.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/permissions/requests/resolve
Request Body: ResolveActionForTransientDocumentPermissionRequest
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/documents/permissions/requests/resolve

Authorization: Bearer <ssid>
Content-type: application/json

{
path: String,
requesters: Set(
{
requesterAddress: String,
requestType: PermissionRequestType
}),
action: PermissionRequestAdminAction,
groupAddressToBeApprovedBy: String,
sendEmail: Boolean,
messageToSend: String,
permissionTemplateToBeApprovedBy:
{
templateName: String,
waterMark: Boolean,
watermark: Boolean,
comment: Boolean,
expirationDate: Date
},
approveByAddingAsDirectUsers: Boolean,
approveBySendCopy: Boolean,
expirationDate: Date,
setNeverExpires: Boolean,
workspaceUuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

resolveActionForTransientFolderPermissionRequestV30

Applies a decision on a request.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/folder/permissions/requests/resolve
Request Body: ResolveActionForTransientFolderPermissionRequest
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/folder/permissions/requests/resolve

Authorization: Bearer <ssid>
Content-type: application/json

{
path: String,
requesters: Set(
{
requesterAddress: String,
requestType: PermissionRequestType
}),
roomGuid: String,
action: PermissionRequestAdminAction,
groupAddressToBeApprovedBy: String,
directUserPermissionsToBeApprovedBy:
{
role: String,
permissionsTemplate:
{
templateName: PermissionTemplateNameRequest,
waterMark: Boolean,
watermark: Boolean,
expirationDate: Date,
expirationDays: Integer,
comment: Boolean
}
},
sendEmail: Boolean,
messageToSend: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

saveTransientWorkspaceCredentialsV30

Saves the credentials for a given workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/credentials/save
Request Body: SaveTransientWorkspaceCredentials
Response Headers: N/A
Response Body: TransientFolder

Request format:

POST /3.0/transient/workspace/credentials/save

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
userName: String,
password: String,
domain: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isPermsInherited: Boolean,
name: String,
updateDate: Date,
hasSubfolders: Boolean,
roomUUID: String,
room: String,
parentFullPath: String,
fullPath: String,
fullPathDisplay: String,
sharedFolderId: String,
email: String,
timeInvited: Date,
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
folderCapabilities: Set(WorkspaceCapabilityType ),
modifiedBy: String,
subFolders: List(TransientFolder )
}

sendBulkEmailV30

Sends emails to file users.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/emails/send
Request Body: SendEmailsToTransientDocuments
Response Headers: N/A
Response Body: N/A

Request format:

POST /3.0/transient/workspace/documents/emails/send

Authorization: Bearer <ssid>
Content-type: application/json

{
subject: String,
note: String,
onBehalfOf: String,
documentPaths: Set(String),
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

String

setupBoxAuthTokenV30

Update existing Box workspace token info(re-authenticate) or create a new Box workspace with the Box token info(sign-in)

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/setupBoxAuthToken
Request Body: SetupBoxToken
Response Headers: N/A
Response Body: TransientWorkspace

Request format:

POST /3.0/transient/workspace/setupBoxAuthToken

Authorization: Bearer <ssid>
Content-type: application/json

{
externalRepositoryGuid: String,
oauthCode: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
id: String,
uuid: String,
name: String,
description: String,
accessLevel: RoomAccessLevel,
hyperlink: String,
explicit: Boolean,
explicitRoom: Boolean,
creationDate: Date,
defaultWorkspaceOrder: ApiDocumentOrderVDR,
roomCapabilities: Set(WorkspaceCapabilityType ),
shared: Boolean,
organizationPolicyJson:
{
isAllowedToShareAnnotationsWithWorkspaceAdmins: Boolean,
isAllowedToShareAnnotationsWithAllWorkspaceGroups: Boolean,
isAllowedToShareAnnotationsWithSelectedGroups: Boolean,
isAllowedToShareAnnotationsWithUsersManually: Boolean,
allowDownloadOriginal: Boolean,
allowDownloadProtected: Boolean,
isAllowedToShareDocumentsWithWorkspaceAdmins: Boolean,
isAllowedToShareDocumentsWithAllWorkspaceGroups: Boolean,
isAllowedToShareDocumentsWithSelectedGroups: Boolean,
isAllowedToShareDocumentsWithUsersManually: Boolean,
allowMobileIos: Boolean,
allowMobileAndroid: Boolean,
allowMobileBlackberry: Boolean,
allowMobileWindowsMobile: Boolean,
deleteFromDisk: Boolean,
licenseHoursValid: Integer,
defaultChangeGroupsToAllDocs: Boolean,
defaultAddGroupsAsDefaultEntity: Boolean,
allowOpenOriginalsInOtherApps: Boolean,
allowOpenUnsupportedInOtherApps: Boolean,
enableRmsSealing: Boolean,
uploadBandwidthLimit: Integer,
downloadBandwidthLimit: Integer,
enableBandwidthLimit: Boolean,
globalDownloadControlled: Boolean,
enableCloudStorageWorkspaces: Boolean,
allowTrackingFromMicrosoftOfficeDocuments: Boolean,
blockNonProvisionedUsers: Boolean,
enableSalesForce: Boolean,
enableWivi: Boolean,
enableOnlineViewerForUnsupportedBrowsers: Boolean,
enableWopi: Boolean,
allowLockingDocuments: Boolean,
useAutoComplete: Boolean,
autoCompleteAllowToAll: Boolean,
autoCompleteDisplayAll: Boolean,
wopiDiscoveryUrl: String,
enableSharingWithoutEmailNotification: Boolean,
shareFilesWithNotificationByDefault: Boolean,
isDisableOnBehalfOfForAllOutgoingEmails: Boolean,
enableComments: Boolean,
commentsDefaultValue: Boolean,
sendWeeklyLicensingReport: Boolean,
sendWeeklyInternalDomainLicensingReport: Boolean,
enablePushNotifications: Boolean,
sendMissingSetupNotificationEmails: Boolean,
sendDailyActivityEmail: Boolean,
enableFetchMembers: Boolean,
forcePinWorkspaces: Boolean,
displayCommentContent: Boolean,
allowAdvancedPrinting: Boolean,
customizedNotificationsEmails: Boolean,
disallowChangeToPermissionTemplates: Boolean
},
deleteDate: Date,
syncPolicy:
{
blacklistExpressions: Set(String),
whitelistExpressions: Set(String),
maxSize: Long
}),
logAccessActionsToFiles: Boolean,
workspacePolicyJson:
{
allowPrintingToPdf: Boolean,
disableCurtain: Boolean,
disablePasscodeLock: Boolean,
allowNonControllableFileTypes: Boolean,
protectImagesInWorkspaces: Boolean,
useAutoComplete: Boolean,
supportedTypes: Set(String),
allowEditDescription: Boolean,
logAccessActionsToFiles: Boolean,
enableReadConfirmation: Boolean,
readConfirmByDefault: Boolean,
fileUploadNotifyWorkspaceMembersDefault: Boolean
}),
transientWorkspaceExternalDataJson:
{
path: String,
userName: String,
password: String
}
}

shareUserDocumentAnnotationV30

Shares file annotations with the provided users and/or groups.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/annotations/share
Request Body: ShareTransientDocumentAnnotation
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/annotations/share

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String,
documentPath: String,
userAddressesToShareWith: Set(String),
groupsToShareWith: Set(String),
shareWithWorkspaceAdmins: Boolean,
shareWithAllWorkspaceGroups: Boolean,
mailBody: String,
activeDirectoryGroupsGuids: Set(String),
shareWithUsersAsDirectMembers: Boolean,
mailSubject: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

signOutBoxWorkspaceV30

Sign out Box repository. It deletes Box workspace owned by the user and deletes the Box token info for the user.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/signOutBox
Request Body: ExternalRepositoryGuid
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/signOutBox

Authorization: Bearer <ssid>
Content-type: application/json

{
externalRepositoryGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

signOutDropboxWorkspaceV30

Sign out Dropbox repository. It deletes Dropbox workspace owned by the user and deletes the credential for the user.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/signOutDropbox
Request Body: GetDropboxWorkspace
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/signOutDropbox

Authorization: Bearer <ssid>
Content-type: application/json

{
externalRepositoryGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

starDocumentsV30

Marks a file with a star.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/star
Request Body: StarredTransientDocuments
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/documents/star

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceUuid: String,
documentPaths: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

submitDocumentIfNewV30

Submits a new document version.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/{roomId}/documents/submitIfNew
Request Body: SubmitTransientDocumentVdr
Response Headers: N/A
Response Body: SubmitIfNewTransientDocument

Path parameters:

roomId: String.

Request format:

POST /3.0/transient/workspace/{roomId}/documents/submitIfNew

Authorization: Bearer <ssid>
Content-type: application/json

{
documentGuid: String,
documentName: String,
isSendMail: Boolean,
mailSubject: String,
mailMessage: String,
folder: String,
openForAllRoom: Boolean,
modifiedDate: Date,
deviceType: DeviceType,
sendToDefaultEntities: Boolean,
recipients:
{
activeDirectoryGroupsGuids: Set(String),
groups: List(String),
domains: List(String),
users: Set(String),
everyone: Boolean
}),
suggestNewNameWhenAlreadyExists: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
existingDocument:
{
documentGuid: String,
versionGuid: String,
permitted: Boolean,
suggestedName: String
},
document:
{
path: String,
name: String,
convertedName: String,
sender: String,
filename: String,
url: String,
viewerUrl: String,
editorUrl: String,
contentType: String,
room: String,
folder: String,
folderDisplay: String,
folderId: Integer,
folderUuid: String,
lastUpdated: Date,
creationDate: Date,
expires: Date,
accessLevel: DocumentAccessLevel,
secureTransferFile: Boolean,
pendingRequests: Integer,
previewUrl: String,
originalSize: Long,
status:
{
documentState: DocumentStatusForApi,
statusCode: Integer,
errorText: String
},
dlpStatus: String,
percentCompleted: Integer,
classification: String,
read: Boolean,
starred: Boolean,
permissionsJson:
{
accessLevel: Consts$AccessLevel,
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
comment: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
pinRequired: Boolean,
minExpirationDate: Date,
latestChangeDate: Date,
originalComments: Boolean
},
tagList:
{
freeTextValues: List(
{
tagName: String,
tagValue: String
}),
dateValues: List(
{
tagName: String,
tagValue: Date
}),
numericValues: List(
{
tagName: String,
tagValue: Number
})
}),
downloadSize: Long,
downloadPdfSize: Long,
type: String,
documentName: String,
lastUpdateDate: Date,
score: Float,
pdfConversionStatus: PdfConversionStatus,
annotationsList:
{
annotationRecordJsons: Collection(
{
annotatingUserAddress: String,
annotationUpdateDate: Date
})
}),
externalRepositoryData:
{
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
documentExternalData:
{
id: String,
items: Set(
{
key: String,
value: String
})
})
}),
documentCurrentVersion:
{
currentVersionUuid: String,
currentDocVersionUpdateDate: Date
},
modifiedDate: Date,
openToAnyone: Boolean,
licenseHoursValid: Integer,
supportedFileType: Boolean,
numOfVersions: Integer,
rmsEnabled: Boolean,
fileHash: String,
cacheStatus: CacheDocumentStatus,
inheritsPerms: Boolean,
readyForDownloadOriginal: ReadyForDownloadOriginal,
modifiedBy: String,
onlineEditorUrl: String,
starredDate: Date,
transientDocumentCommentCountJson:
{
commentCount: Integer,
commentMentionCount: Integer
},
workspaceUuid: String
})
}

submitVersionV30

Submits a new file version.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/submitVersion
Request Body: SubmitTransientVersionVdr
Response Headers: N/A
Response Body: SubmitTransientDocumentResult

Request format:

POST /3.0/transient/workspace/documents/submitVersion

Authorization: Bearer <ssid>
Content-type: application/json

{
roomGuid: String,
contentGuid: String,
docGuid: String,
versionGuid: String,
isSendMail: Boolean,
mailSubject: String,
mailMessage: String,
deviceType: DeviceType,
documentName: String,
modifiedDate: Date,
suggestNewNameWhenAlreadyExists: Boolean,
showInformativeVersionGuidOutOfDateError: Boolean,
folder: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
id: Integer,
guid: String,
name: String,
convertedName: String,
sender: String,
filename: String,
url: String,
viewerUrl: String,
contentType: String,
room: String,
folder: String,
folderId: Integer,
lastUpdated: Date,
creationDate: Date,
expires: Date,
accessLevel: DocumentAccessLevel,
secureTransferFile: Boolean,
recentlyViewed: Date,
pendingRequests: Integer,
previewUrl: String,
originalSize: Long,
status:
{
documentState: DocumentStatusForApi,
statusCode: Integer,
errorText: String
},
percentCompleted: Integer,
classification: String,
read: Boolean,
starred: Boolean,
permissionsJson:
{
accessLevel: Consts$AccessLevel,
downloadOriginal: Boolean,
download: Boolean,
copy: Boolean,
print: Boolean,
edit: Boolean,
spotlight: Boolean,
watermark: Boolean,
comment: Boolean,
expirationDate: Date,
defaultExpirationDays: Integer,
neverExpires: Boolean,
progAccess: Boolean,
pinRequired: Boolean,
minExpirationDate: Date,
latestChangeDate: Date,
originalComments: Boolean
},
tagList:
{
freeTextValues: List(
{
tagName: String,
tagValue: String
}),
dateValues: List(
{
tagName: String,
tagValue: Date
}),
numericValues: List(
{
tagName: String,
tagValue: Number
})
}),
downloadSize: long,
downloadPdfSize: long,
type: String,
documentName: String,
lastUpdateDate: Date,
score: Float,
pdfConversionStatus: PdfConversionStatus,
annotationsList:
{
annotationRecordJsons: Collection(
{
annotatingUserAddress: String,
annotationUpdateDate: Date
})
}),
externalRepositoryData:
{
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
documentExternalData:
{
id: String,
items: Set(
{
key: String,
value: String
})
})
}),
documentCurrentVersion:
{
currentVersionUuid: String,
currentDocVersionUpdateDate: Date
},
modifiedDate: Date,
existingDocument:
{
documentGuid: String,
versionGuid: String,
permitted: Boolean,
suggestedName: String,
lockedForUser: Boolean
},
path: String
}

unstarDocumentsV30

Removes a star for a file

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/unstar
Request Body: UnStarredTransientDocuments
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/documents/unstar

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceUuid: String,
documentPaths: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

updateCommentV30

Update comment

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/comment/update
Request Body: UpdateTransientComment
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/comment/update

Authorization: Bearer <ssid>
Content-type: application/json

{
commentUuid: String,
path: String,
workspaceGuid: String,
data: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

uploadDocumentByPostV30

Uploads new file data.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/{roomId}/documents/{documentGuid}/upload
Request Body: N/A
Response Headers: N/A
Response Body: N/A

Path parameters:

documentGuid: String - document guid.
roomId: String - room id.

Data form parameters:

data: File - file data.
data2: FormDataContentDisposition.
deviceType: DeviceType - device type.
documentName: String - document name.
fileName: String - file name.
start: Long - start.

Request format:

POST /3.0/transient/workspace/{roomId}/documents/{documentGuid}/upload

Authorization: Bearer <ssid>
Content-type: multipart/form-data

Response format:

HTTP/1.1 200 OK

String

uploadUserDocumentAnnotationV30

Uploads annotations for a user file.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/annotations/uploadWithDevice
Request Body: UploadUserTransientDocumentAnnotations
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/annotations/uploadWithDevice

Authorization: Bearer <ssid>
Content-type: application/json

{
annotations:
{
documentPageAnnotations: List(
{
pageAnnotations: List(
{
annotationType: AnnotationType,
annotationRectangle:
{
lowerLeftCorner:
{
x: Float,
y: Float
},
upperRightCorner:
{
x: Float,
y: Float
}
},
annotationColor:
{
red: Float,
green: Float,
blue: Float
},
lastModificationDate: Date,
annotationFlags: Set(AnnotationFlagsEnum )
}),
pagePlainAnnotations: List(
{
annotationPDFText: String
}),
annotationsPageNo: Integer
})
}),
deviceType: DeviceType,
logAction: Boolean,
reportProblematicAnnotations: Boolean,
workspaceGuid: String,
path: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

validateDocumentsToDownloadV30

Validates files for download.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/documents/validateDownload
Request Body: ValidateDownloadTransientDocuments
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/documents/validateDownload

Authorization: Bearer <ssid>
Content-type: application/json

{
forceAction: Boolean,
shouldAggregateMessage: Boolean,
downloadType: DownloadTypes,
workspaceGuid: String,
documentPaths: Set(String),
folderPaths: Set(String)
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

validateDownloadUserDocumentAnnotationsInDocV30

Validates user file annotations for download.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/annotations/validateDownloadInDoc
Request Body: ValidateDownloadUserTransientDocumentAnnotationsInDoc
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/annotations/validateDownloadInDoc

Authorization: Bearer <ssid>
Content-type: application/json

{
userAddress: String,
downloadType: DownloadTypes,
shouldInitiatePdfConversion: Boolean,
objectUrl: String,
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}

validateKCDCredentialsV30

validate the credentials for a kcd user on a given workspace.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/kcd/credentials/validate
Request Body: ValidateKCDWorkspaceCredentials
Response Headers: N/A
Response Body: TransientFolder

Request format:

POST /3.0/transient/workspace/kcd/credentials/validate

Authorization: Bearer <ssid>
Content-type: application/json

{
workspaceGuid: String
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
isPermsInherited: Boolean,
name: String,
updateDate: Date,
hasSubfolders: Boolean,
roomUUID: String,
room: String,
parentFullPath: String,
fullPath: String,
fullPathDisplay: String,
sharedFolderId: String,
email: String,
timeInvited: Date,
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
folderCapabilities: Set(WorkspaceCapabilityType ),
modifiedBy: String,
subFolders: List(TransientFolder )
}

validateZipDownloadUserDocumentAnnotationsInDocV30

Validates user document annotations for download.

Version: 3.0
Synopsis: POST
Path: /3.0/transient/workspace/annotations/download/validateDownloadInDocZip
Request Body: ValidateDownloadTransientDocumentsAnnotations
Response Headers: N/A
Response Body: BulkOperationResult

Request format:

POST /3.0/transient/workspace/annotations/download/validateDownloadInDocZip

Authorization: Bearer <ssid>
Content-type: application/json

{
userDocumentAnnotations: List(
{
objectUrl: String,
userAddresses: Set(String),
workspaceGuid: String
}),
downloadType: DownloadTypes,
shouldInitiatePdfConversion: Boolean
}

Response format:

HTTP/1.1 200 OK

Content-type: application/json

{
problematicItems: List(
{
itemId: String,
errors: List(
{
errorCode: Integer,
isAggregatedMessage: Boolean,
errorArgs: List(String),
errorMessage: String
})
}),
fullSuccess: Boolean,
success: SuccessLevel,
transactionUuid: String
}