Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
Document
A file that is used in various operations
Parameters
Name Type Description

accessLevel

DocumentAccessLevel

Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.

Possible values: [VIEWER, TRACKING, NONE, FULL].

annotationsList

DocumentAnnotationsList

A json which represents the users who annotated the document, and the last update date of their annotation

cacheStatus

CacheDocumentStatus

Possible values: [UPLOADING, EXISTS, NOT_EXIST, ERROR].

classification

String

Classification, if exists.

collaboration

Boolean

contentType

String

Content type

convertedName

String

Converted name for file

creationDate

Date

Date of creation.

dlpStatus

String

return the DLP status of an uploading file

documentCommentCountJson

DocumentCommentCount

documentCurrentVersion

DocumentCurrentVersion

A json which represents the current version of the document

documentName

String

Deprecated

Use 'name' instead

downloadPdfSize

long

downloadSize

long

Deprecated

editorUrl

String

URL to edit the document using Wopi

expires

Date

Deprecated

Use permissions instead

fileHash

String

filename

String

File name.

folder

String

Default value: ""

File's folder, for example: /office/docs

folderId

Integer

folderUuid

String

foundInContent

Boolean

foundInMetadata

Boolean

guid

String

Signed GUID of a file, created by the server.

inheritsPerms

Boolean

lastUpdateDate

Date

Deprecated

Use 'lastUpdated' instead

lastUpdated

Date

Date of creation or last update of the file.

lastVersionUploaderUserAddress

String

licenseHoursValid

Integer

Max hours that the license is valid

lockingUserAddress

String

modifiedDate

Date

Date of modified.

name

String

File name

numOfVersions

Integer

Indicates how many versions this file has

onlineEditorUrl

String

URL to edit the document online

openToAnyone

boolean

Indicates that the file can be accessed by non-authenticated users

originalReadAckState

Boolean

originalSize

Long

Original size of file (bytes)

pdfConversionStatus

PdfConversionStatus

The status of PDF conversion

Possible values: [NOT_SUPPORTED, COMPLETED, NOT_INITIATED, ERROR, INITIATED].

pendingRequests

Integer

Number of pending requests to access the file

percentCompleted

Integer

Progress status.

permissionsJson

PermissionsToUser

Permissions, in some contexts may be null.

previewUrl

String

URL to preview the file

read

Boolean

Will be true if the last file was read since its last update.

readAcknowledged

Boolean

readConfirmation

Boolean

readyForDownloadOriginal

ReadyForDownloadOriginal

Possible values: [READY, NOT_READY, ERROR].

recentlyViewed

Date

Deprecated

Date file was most recently viewed. not supported any longer - info is meaningless

rmsEnabled

Boolean

Default value: true

room

String

Default value: "0"

Id of the workspace the file has been submitted to.

score

Float

The score of the file in the current search

secureTransferFile

Boolean

sender

String

Sender's email address

starred

Boolean

Will be true if the file was marked as starred (favorite).

starredDate

Date

status

Status

Status, status number and error string in case of error.

supportedFileType

boolean

Indicates that a file can be shown in Watchdox Online Viewer

tagList

TagList

Tags, if exist.

type

String

Deprecated

Use 'contentType' instead

url

String

URL of a (protected) file.

viewerUrl

String

URL of a (protected) file for viewing .

workspaceType

String

workspaceUuid

String

Workspace uuid

Json Format
{
id: Integer,
guid: String,
name: String,
convertedName: String,
sender: String,
filename: String,
url: String,
viewerUrl: String,
contentType: String,
room: String,
folder: String,
folderId: Integer,
folderUuid: String,
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
},
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,
lockingUserAddress: String,
readyForDownloadOriginal: ReadyForDownloadOriginal,
workspaceType: String,
collaboration: Boolean,
editorUrl: String,
onlineEditorUrl: String,
lastVersionUploaderUserAddress: String,
starredDate: Date,
documentCommentCountJson:
{
commentCount: Integer,
commentMentionCount: Integer
},
workspaceUuid: String,
readConfirmation: Boolean,
foundInMetadata: Boolean,
foundInContent: Boolean,
originalReadAckState: Boolean,
readAcknowledged: Boolean
}