Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
WorkspaceInfo
Workspace information
Parameters
Name Type Description

accessLevel

RoomAccessLevel

The user's role in the workspace.

Possible values: [CONTRIBUTOR, VIEWER, ADMIN].

actualAdmins

Set(String)

Not null
Default value: new HashSet<>()

containsFolders

Boolean

creationDate

Date

Creation date

creator

PersonalRoom

Creator

defaultWorkspaceOrder

ApiDocumentOrderVDR

Default value: null

Default workspace order

Possible values: [SCORE, SENDER, LAST_UPDATED, SIZE, SENDER_ADDRESS, FILE_NAME, TYPE, LAST_VIEWED, NAME, TAG_NAME].

deleteDate

Date

Delete date

deletedItemsCount

Integer

Deleted items count

deletingUserAddress

String

Deleting user address

description

String

Workspace description.

enabledWorkspaceNotifications

Boolean

explicit

boolean

Is the user member of this workspace explicitly. If the user is permitted through domain and not workspace groups, this flag will be set to false if the user never visited this workspace before.

explicitRoom

boolean

Same as explicit as explicit is a keyword in some programming languages

externalRepositoryCloudStatus

ExternalRepositoryCloudStatus

Possible values: [DISCONNECTED, SYNCING, INITIAL_SYNC_ERROR, AUTHENTICATION_ERROR, OK].

externalSiteDataJson

ExternalSiteData

forcePin

Boolean

hyperlink

String

Direct link to the workspace in watchdox's website.

id

String

Workspace's Id

lastFileModifiedDate

Date

Last file modified date

logAccessActionsToFiles

Boolean

name

String

Workspace name.

organizationPolicyJson

OrganizationPolicy

Organization policy

origianlForcePinState

Boolean

personalRestrictedWorkspaceFlag

boolean

Personal restricted workspace flag

personalWorkspaceFlag

boolean

product

String

Obsolete

protectorEnabled

Boolean

Default value: FALSE

readConfirmationRequired

Boolean

is read confirmation required for files in this room ( according to root folder )

roomCapabilities

List(WorkspaceCapabilityType)

Default value: null

List of workspace capabilities

rootFolderUuid

String

shared

Boolean

Default value: false

True if shared, False if not

sharepoint

SharepointRoom

Sharepoint workspace

size

float

Deprecated

starred

Boolean

Default value: false

starredDate

Date

syncPolicy

OrganizationSyncPolicy

Sync policy

totalFilesCount

Integer

Total files count

totalFilesSize

Long

Total files size

totalFoldersCount

Integer

Total folders count

updateDate

Date

update date

uuid

String

workspaceType

String

workspacesPolicy

OrganizationWorkspacesPolicy

Json Format
{
id: String,
name: String,
description: String,
product: 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,
deletingUserAddress: String,
creator:
{
name: String,
address: String
},
sharepoint:
{
roomId: Integer,
externalId: String,
path: String,
sharepointSelectedPath: String
},
syncPolicy:
{
blacklistExpressions: Set(String),
whitelistExpressions: Set(String),
maxSize: Long
}),
totalFilesCount: Integer,
totalFoldersCount: Integer,
totalFilesSize: Long,
lastFileModifiedDate: Date,
deletedItemsCount: Integer,
actualAdmins: Set(String),
size: float,
externalRepositoryData:
{
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
roomExternalData:
{
id: Integer,
items: Set(
{
key: String,
value: String
})
})
}),
externalIdentifier:
{
externalRepository: ExternalRepositoryShowValue,
externalId: String,
externalRepositoryUuid: String,
externalRepositoryName: String
},
personalWorkspaceFlag: Boolean,
personalRestrictedWorkspaceFlag: Boolean,
uuid: String,
logAccessActionsToFiles: Boolean,
externalRepositoryCloudStatus: ExternalRepositoryCloudStatus,
protectorEnabled: Boolean,
workspacesPolicy:
{
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
}),
workspaceType: String,
externalSiteDataJson:
{
name: String,
siteUrl: String,
userName: String,
transientWorkspaceCredentialsUuid: String
},
readConfirmationRequired: Boolean,
rootFolderUuid: String,
forcePin: Boolean,
origianlForcePinState: Boolean,
starred: Boolean,
starredDate: Date,
updateDate: Date,
enabledWorkspaceNotifications: Boolean,
containsFolders: Boolean
}