Index BlackBerry Workspaces SDK
BlackBerry Workspaces JSON
IManageDocument
Details for a file in a IManage workspace
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 file, and the last update date of their annotation

cacheStatus

CacheDocumentStatus

Cache status

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

classification

String

Classification, if exists.

contentType

String

Content type

convertedName

String

Converted name for file

creationDate

Date

Date of creation.

dlpStatus

String

return the DLP status of an uploading document

documentCurrentVersion

DocumentCurrentVersion

A json which represents the current version of the file

editorUrl

String

URL to edit the document using Wopi

fileHash

String

File hash

filename

String

File name.

folderId

Integer

Folder id

folderUuid

String

Folder uuid

inheritsPerms

Boolean

Inherits permissions

itemId

String

lastUpdated

Date

Date of creation or last update of the file.

licenseHoursValid

Integer

Max hours that the license is valid

modifiedBy

String

Modified by

modifiedDate

Date

Date of modified.

name

String

File name

numOfVersions

Integer

Indicates how many versions this file has

onlineEditorUrl

String

URL to edit the file online

openToAnyone

Boolean

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

originalSize

Long

Original size of file (bytes)

parentItemId

String

The IManage item id of the parent folder

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.

readyForDownloadOriginal

ReadyForDownloadOriginal

Read only when file is cached and download vlp validation is over (if necessary)

Possible values: [READY, NOT_READY, ERROR].

rmsEnabled

Boolean

Default value: true

RMS enabled

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

Secure transfer file

sender

String

Sender's email address

starred

Boolean

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

starredDate

Date

Mark 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.

transientDocumentCommentCountJson

TransientDocumentCommentCount

Comments count

url

String

URL of a (protected) file.

viewerUrl

String

URL of a (protected) file for viewing .

workspaceUuid

String

Workspace uuid

Json Format
{
name: String,
convertedName: String,
sender: String,
filename: String,
url: String,
viewerUrl: String,
editorUrl: String,
contentType: String,
room: String,
folderId: Integer,
folderUuid: String,
lastUpdated: Date,
creationDate: 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
})
}),
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,
parentItemId: String,
itemId: String
}