BlackBerry Workspaces API Reference
Resources
Name Description

Authentication

Functions for handling authentication.

Documents

Functions for sending secure files via BlackBerry Workspaces.

Files

Functions for sending secure files via BlackBerry Workspaces.

Notifications

Functions for managing notifications.

OneDriveManagement

Functions for managing OneDrive repositories.

Organizations

Functions for managing organizations.

Rooms

Functions for secure virtual data workspace handling.

Sessions

Functions for connecting and identifying users with the BlackBerry Workspaces API servers.

SharePoint

Functions for managing SharePoint repositories.

SystemProperties

Functions for accessing basic BlackBerry Workspaces system properties.

TransientWorkspaces

Functions for secure virtual data transient workspace handling.

Users

Functions for managing users.

Workspaces

Functions for secure virtual data workspace handling.

Jsons
Name Description

AccountCreationStatusRequest

AccountCreationStatusResult

ActiveDirectoryGroupInfo

Active Directory group details.

ActiveDirectoryGroupSuggestion

An Active Directory group suggestion used when searching for AD groups

ActiveDirectorySettings

The details of an Active Directory connection when listing the details for an organization

ActivityLogRecord

A single record the represents an activity of a user on a file used in reports

AddActiveDirectoryGroup

Add an Active Directory group.

AddActiveDirectoryGroups

Add multiple Active Directory groups.

AddDocumentEntity

Give user permissions to a particular workspace file only.

AddDocumentPermissionRequest

Request to add permissions to a file.

AddDocumentsTagValues

List tags.

AddEmailProtectorWhitelistEntities

Add users and domains to the Email Protector whitelist.

AddEntitiesTransient

Add users to transient workspaces.

AddEntityVdr

List information when adding a user to a workspace.

AddFolderEntity

List information when adding a user to a workspace.

AddFolderPermissionRequest

Request for access to a folder.

AddMemberToGroup

Add a single user to a group.

AddMembersToGroup

Add multiple users to a group.

AddMembersToGroupWithGroup

Add multiple users to a group and add group information.

AddOrganizationBlacklisting

Add entities to blacklist.

AddOrganizationDistributionList

Add a new distribution list, including members.

AddOrganizationSystemAccountsIdp

Add multiple new system accounts.

AddOrganizationSystemAccountsIdpResponse

Response to adding new system accounts.

AddOrganizationWatermark

Add a new watermark.

AddOrganizationWatermarkContentLine

Add content to a watermark.

AddRoomMember

Add a user to a workspace.

AddRoomMembers

Add multiple users to a workspace.

AddSiteInput

Add a site.

AddSiteOutput

AddTransientDocumentPermissionRequest

A request used when adding a file permission

AddTransientFolderPermissionRequest

A request used when adding a file permission

AggregatedPermissionDetailsResponse

Response to aggregated permission details.

AggregatedPermissionTemplate

Request aggregated permission details.

AnnotationColor

An RGB color value

AnnotationFieldBase

Base for other annotations. Do not use.

AnnotationPoint

A single point

AnnotationRectangle

A rectangle as defined by PDF Spec (PDF32000 2008), which is defined by two points: one indicating the lower left corner, and the other the upper right corner.

ArrowDocumentAnnotation

AuthenticationParameters

Request for authentication details.

AuthenticationPolicy

Set authentication policy.

AvailableUserInfo

Show user details.

BaseLog

Information about how to export a log.

BulkDeleteWorkspaceDocuments

Delete multiple files, includes information about how to delete.

BulkOperationResult

Show result of bulk operation.

BulkWorkspaceProtectorSettings

Set workspace settings with SharePoint Protector.

ChangeActiveDirectorySettingsStatus

Request to enable or disable Active Directory.

ChangeEntitiesTransient

Change multiple workspace member permissions for a transient workspace.

ChangeEntitiesVdr

Change multiple workspace member permissions for a workspace.

ChangeEntityVdr

Change a single workspace member permissions for a workspace.

CircleDocumentAnnotation

Classification

ClientTokenTTLConfig

Information about a client and its associated token.

ConnectorConfiguration

a Connector configuration - contains the info of how to login to the connector

CopyDocumentFromInbox

Copy files from Inbox.

CopyDocumentFromRoom

List users to receive a notification with link and permissions assigned sending a copy.

CopyMembership

List users when copying membership.

CopyMultipleDocumentsToExchangeAsync

List of documents to send to exchange. WS documents and transient workspace documents.

CopyTransientDocumentToExchangeAsync

List users to receive a notification with link and permissions assigned sending a copy from a transient workspace.

CountingRoomEntity

Used when listing the workspace entities (groups/domain/everyone) that are members of the workspace.

CreateAggregatedUserDocActivityReport

Created by egilron on 6/12/2016.

CreateFolder

Add folder.

CreateInternalDomainLicensingReport

CreateLicensingReport

Created by tdagan on 11/16/2016.

CreateNewComment

CreateNewCommentResult

CreateNewDocument

CreateNewTransientComment

CreateNewTransientCommentResult

CreateNewTransientDocument

CreateOrganizationWeeklyStorageReport

Created by egilron on 12/12/2016.

CreateQuickSendStorageReport

Created by egilron on 14/12/2016.

CreateRoom

Add workspace.

CreateSession

Settings for creating a new user session.

CreateTransientActivityLogRecord

Used when adding a notification for a file action in the file's activity log file.

CreateTransientFolder

Add transient workspace.

CreateTransientWorkspace

A new transient workspace to create

CreateWorkspaceExternalFolders

A collection of external folders to be created in a workspace.

CreateWorkspaceFolderTree

A workspace folder tree that will be created.

CreateWorkspaceFolderTreeRecord

A single entry in a new workspace folder tree.

CreateWorkspacesStorageReport

Created by egilron on 14/12/2016.

DefaultNotificationEmail

The default notification email

DeleteActiveDirectoryGroupList

A collection of active directory groups to be deleted.

DeleteActiveDirectorySettings

An active directory setting to be deleted.

DeleteComment

DeleteDocumentsSelectionSds

Files to be deleted from Inbox/Sent items.

DeleteDocumentsSelectionVdr

Files or folders to be deleted from a workspace.

DeleteEmbeddedNotification

Created by tdagan on 3/27/2017.

DeleteFolder

Delete folder and all its contents from a workspace.

DeleteIdpSettings

A list of IDP settings to remove from the organization.

DeleteNotification

Notification for deleting a user.

DeleteOrganizationSystemAccountIdp

Delete system account from organization.

DeleteOrganizationWatermark

Delete watermark from organization.

DeleteOrganizationsDistributionLists

List distribution lists to delete.

DeleteRoom

Delete workspace.

DeleteRoomEntities

Delete multiple items from a workspace.

DeleteTags

List tags to delete.

DeleteTransientComment

DeleteTransientDocumentAnnotations

DeleteTransientDocumentsAndFolders

Delete folder and all its contents from a transient workspace.

DeleteTransientWorkspace

Delete transient workspace.

DeviceInfo

List device information.

DistributionList

Details of a single distribution list

DocuSignPolicy

Document

A file that is used in various operations

DocumentAndRecipients

Used when gathering information about bulk email notifications

DocumentAndVersion

DocumentAnnotation

Annotation details

DocumentAnnotations

A collection of annotations

DocumentAnnotationsForUser

DocumentAnnotationsForUsers

DocumentAnnotationsList

A collection of annotation records

DocumentAnnotationsListRecord

A single annotation list record

DocumentChunk

Information about a chunk of file data's status

DocumentChunks

Information about the status of multiple chunks of file data

DocumentComment

DocumentCommentCount

DocumentConversionStatus

Status information of a file conversion

DocumentCurrentVersion

Current version information about a file. Used in various places.

DocumentExternalData

A file's external data

DocumentExternalRepositoryData

Information about a file's external repository

DocumentIdentifier

DocumentLinkInfoResult

DocumentLinks

Details about a link within a file

DocumentModifiedDateSet

Used when setting a file's modified date

DocumentPageAnnotations

A collection of annotations

DocumentPendingPermissionRequest

A pending request for a file permission

DocumentPermissionRequestsResults

Result from a pending permission request

DocumentPlainAnnotation

A plain annotation

DocumentUpdateDataSet

Information used when updating file data

DocumentVersionAnnotationsList

A set of annotation records used when getting file version information

DocumentVersionAnnotationsListRecord

Information about a single file annotation used when getting file version information

DocumentVersionReadConfirmed

DocumentsModifiedDateSet

Modified date to be set for a file

DocumentsReadConfirmationEdit

DocumentsSelection

Base type of several file selection JSONs

DocumentsSelectionSds

Specifies a filter for selecting files

DocumentsSelectionVdr

Specifies various criteria for selecting files

DocumentsUpdateDataSet

A collection of file data updates to be applied to a file

Domain

A single domain's information

DownloadComments

DownloadDocumentsSelectionSds

Used when choosing which files to download

DownloadDocumentsSelectionVdr

Used when choosing which files to download in a workspace

DownloadSentItemsDocumentsWithRecycleBin

User who's sent items and recycle bin will be downloaded

DownloadSingleDocumentSelection

A single file to be downloaded

DownloadSingleRecycleBinWorkspaceDocument

Original version of a file to be downloaded. Allowed only for workspace admins

DownloadSingleTransientDocument

DownloadSingleTransientDocumentForWeb

DownloadTransientComments

DownloadTransientDocumentAnnotations

DownloadWorkspaceDocumentsWithRecycleBin

Files to be downloaded from a workspace Recycle bin.

EditActiveDirectoryGroup

Used when editing Active Directory groups in the organization

EditActiveDirectorySettings

Used when editing the Active Directory settings for and organization

EditActiveDirectorySettingsResponse

Response from editing an organization's Active Directory settings

EditCollaboration

Edit collaboration settings.

EditExternalTransactionStatusInput

Used when editing the status of an external transaction

EditFolderSettings

Used when editing folder permissions

EditFoldersAndDocumentsSettingsBulk

Used when editing folder permissions in bulk

EditIdpClientSettings

Used when editing IDP settings for an organization

EditIdpSettings

Used when editing IDP settings for an organization

EditIdpTTLSettings

EditManagersOnGroup

Add multiple users to a group and add group information.

EditOrganizationPolicy

Used when editing an organizational policy

EditOrganizationSystemAccountsIdp

Organizational system accounts to be updated

EditOrganizationWatermark

An organizational watermark to be updated

EditOrganizationWatermarkContentLine

An organizational watermark content line to be updated

EditRoom

A workspace to be edited

EditTag

Information about a tag that will be renamed

EditUser

A user to be edited

EmailBulkData

Collection used to store bulk email data

EmbeddedNotification

Created by tdagan on 3/21/2017.

EntityInFolderPermissions

Permissions for an entity that exists in a folder

EntityInRoomResponse

Response when querying about entities in a workspace

EntityPermission

A single permission for an entity

ErrorInfo

Information about an error

ExistingActiveDirectoryGroupSuggestion

Details of a suggested Active Directory group

ExistingDocument

A file that exists, but with a new suggested name

ExistingTransientDocument

ExportActivityHistoryForTransientRooms

Used when exporting the activity history for multiple rooms

ExportSpecificUsersTransientActivityHistoryByMail

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

ExportUsersTransientActivityHistory

Used when exporting activity history for a list of users in current user's organization to a CSV file

ExternalDataItem

Simple key/value pair representing a piece of external data

ExternalDocumentsTransactionResult

Results from an action regarding external files

ExternalFoldersTransactionResult

Results from an action regarding external folders

ExternalRepositoryIdRequest

Request for getting the ID of an external repository

ExternalRepositoryIdResult

Result from getting external repository ID information

ExternalSiteData

External site data

ExternalTransactionInput

Used when getting the status of an external transaction

ExternalTransactionStatus

The status of an external transaction

Folder

Details about a single folder

FolderDefaultPermissions

The default permissions for a folder

FolderExternalData

A collection of items in an external folder

FolderExternalRepositoryData

Details about a folder in an external repository

FolderInfo

Details about a single folder

FolderLinks

Used when getting links for a folder in a workspace

FolderPathToUuid

Created by sbenhayun on 6/7/2017.

FolderPendingPermissionRequest

A request for permissions on an existing folder

FolderPendingPermissionRequests

A collection of requests for folder permissions

FolderReadConfirmationEdit

FoldersDocuments

A collection of folders and files

FreeDrawDocumentAnnotation

FreeDrawnElementDocumentAnnotation

GenerateTransientDocumentGuid

GUID for a file in transient workspace's context

GeometricalObjectDocumentAnnotation

GetDocumentActivityLogRequest

Request for getting information about an activity log

GetDocumentLinkInfoRequest

Request for getting information about a file link

GetDocumentsActivityLogRequest

Request for getting information about an activity log

GetDocumentsConversionStatus

Used when getting the status of a file conversion

GetDocumentsGuidsInfo

Created by ybennatan on 8/29/2016.

GetDocumentsVersionsInfo

Created by ybennatan on 8/31/2016.

GetEmailBulkData

Used when getting bulk data about email

GetFolderInfo

Used when getting information about a folder.

Either the "roomId" or the "roomGuid" must be specified to identify the workspace.

The "path", "folderId", "folderGuid" must be specified to identify the folder.

GetGroupInfo

Used when getting information about a group in a workspace

GetGuidByFolderAndName

GUID of folder and filename

GetInfoUnauthDocumentResult

Result from getting informaton about an unauthorized file

GetOrRefreshAccessTokenResponse

Response from getting information about an access token that needs to be obtained or refreshed

GetPathInfo

A path to get information about

GetTransientDocumentActivityLogRequest

Used to get an activity log

GetTransientDocumentPermissionsForIos

Used to identify a workspace to get permission information from

GetTransientFolderInfo

Workspace to get a single level of folders from

GetTransientWorkspaceInfo

GetValidDocumentsGuidsInfo

GetValidPathInfoList

GetWopiProofKey

GoodTokenErrorResponse

Error response when generating a BlackBerry Workspaces authentication token from a given Good authentication token.

GroupAndMembers

Used when adding entities to a group

GroupLogRecord

A record used when exporting group logs

GroupRequest

Group request when filtering reports

GroupsLogByIds

Used when exporting groups logs

GroupsLogByRooms

Used when exporting groups logs

Guid

A simple GUID

HighlightDocumentAnnotation

HistoryPeriod

Time period used when exporting history logs

InitialSyncRoomData

Used when applying a decision to a request

InitialSyncStatus

Status of an initial sync

InlineTextDocumentAnnotation

Invite

Used to invite groups to a workspace

InviteText

Information about the invite email

IsActiveDirectoryConfiguredResult

Result from determining if Active Directory is enabled

IsActiveDirectorySettingsEnabled

Used when finding out if Active Directory is enabled

IsEmailProtectorEnabled

Result from determining if the email protector is enabled

ItemErrorInfo

A problematic item found during different processes

ItemList

A generic list of items

LastResolvedDocumentPermissionRequestResult

Member of a list of last resolved permission requests on files in rooms and in exchange

LastResolvedFolderPermissionRequestResult

Member of a list of last resolved permission requests on folder

LastResolvedTransientDocumentPermissionRequestResult

LastResolvedTransientFolderPermissionRequestResult

LineDocumentAnnotation

ListActiveDirectoryGroups

Details about how to get a list of Active Directory groups

ListActiveDirectoryGroupsSuggestions

A list of suggestions used when searching for Active Directory groups

ListAllNotifications

Created by tdagan on 3/21/2017.

ListBulkFolderPermissions

Used when getting the aggregation of permissions of folders

ListDistributionListsByName

Used when getting a list of members of a named distribution list

ListDistributionlists

Information about returning a list of all distribution lists for an organization.

ListDocumentComments

ListDocumentsPermissionRequests

Used when listing existing permission requests for a file

ListDocumentsVdr

Details of how to obtain a list of files

ListDomains

Details of how to obtain a list of domains

ListEmailProtectorWhitelistEntitiesResult

Results from listing all user and domain entities within the Email protector whitelist

ListEmailProtectorWhitelistEntityResult

An entity result from listing all user and domain entities within the Email protector whitelist

ListExchangesRecycleBinDocuments

Used when listing hidden files in the Inbox and items in the Sent items Recycle bin.

ListExistingActiveDirectoryGroupsSuggestions

Details about using suggestions when searching for Acive Directory groups

ListExternalConnectors

ListExternalConnectorsResult

Result json for the ListExternalConnectors API

ListFolderDefaultPermissions

Details for listing permissions for each of the default entities in given folder

ListFolderPermissionRequests

Used when listing existing permissions requests for folder or the entire workspace in case the root folder is supplied

ListIdpSettings

Currently not used

ListIdpSettingsResultItem

Single result from listing IDP settings for organization

ListIdpSettingsResultItemMultiMember

Multi result from listing IDP settings for organization

ListInternalDomainsForOrganizationRequest

Used when requesting organization's internal domains

ListInternalDomainsForOrganizationResponse

Response for requesting organization's internal domains

ListLastResolvedFolderPermissionRequests

Details for listing last resolved permission requests on folder

ListLastResolvedTransientDocumentPermissionRequests

ListLastResolvedTransientFolderPermissionRequests

ListLibrariesInput

Libraries to list

ListLibrariesOutput

ListNotifications

Detals about how to list a user's notifications

ListOrganizationBlacklisting

Details for listing an organization's blacklist entries

ListOrganizationBlacklistingResult

Results from listing an organization's blacklist entries

ListOrganizationPolicy

Organization ID for listing policies

ListOrganizationSystemAccountsIdp

Used when listing organization system accounts

ListOrganizationWatermarks

Collection of watermark positions

ListPendingNumberPermissionRequests

Details about how to list the number of pending existing file permission requests and workspace permission requests for an admin

ListPendingNumberPermissionRequestsResult

Result from listing the number of pending existing file permission requests and workspace permission requests for an admin

ListPermissionDetails

Details for listing permission details for files and folders in bulk for all entities in the workspace

ListPermittedUsersToTransientWorkspace

ListRoomEntities

Details about how to list the workspace entities

ListRoomsByType

Result from a permission request for a document in a transient workspace

ListRoomsByTypeResult

Workspace information

ListSitesInput

Input when listing sites

ListSitesOutput

ListStarredTransientDocuments

List of starred files in transient workspace

ListSummaryEmbeddedNotification

ListSystemAccountItem

Details about a single system account

ListTagTree

A tree of tag lists

ListTags

A list of tags

ListTransientDocumentComments

ListTransientDocumentsPermissionRequests

Used when listing existing permission requests for a file

ListTransientFolderPermissionRequests

Used when listing pending permission requests for folder in transient workspaces

ListTransientFolders

Used to get the tree of all folders

ListTransientFoldersAndDocuments

Used when retrieving a list of transient files and folders.

ListTransientFoldersSingleLevelResult

Single level of tree folders

ListTransientOrganizationPolicy

Used to get the organizational policy

ListTransientPermissionDetails

Request for listing permission details for files and folders for all entities in the workspace

ListUserMentionInComments

ListUserMentionInUnreadDocumentComments

ListVersionsReadConfirmation

ListVersionsReadConfirmationRet

ListWorkspaceGroupMembershipsForUserRequest

Used to list the groups a user is a member of

ListWorkspaceRecycleBinDocuments

Used to list files in the workspace recycle bin. The recycle bin holds non-permanently deleted files.

ListWorkspaceRecycleBinWorkspaces

Used to list files in the workspaces recycle bin. The recycle bin holds non-permanently deleted workspaces

LoadToCache

Details of what to load into the cache

LockDocumentsRequest

Request to lock files

MarkDocumentComments

MarkDocumentsSelection

Mark a set of files

MarkDocumentsSelectionSds

Files selected for marking

MarkDocumentsSelectionVdr

Files selected for marking

MarkEmbeddedNotification

Created by tdagan on 3/27/2017.

MarkNotification

Mark details

MarkupDocumentAnnotation

MarkupLocation

Members

A membership list

ModifyGroupWithGroup

Information for modifying a group

Move

Used when moving files

MoveAll

Move all files to another folder

MoveFolder

Used when moving a folder

MoveFolderIntoFolder

Used when moving a folder to another folder

NewSession

Details of a new session that was created

NoReplyEmailRequest

No reply email empty request

NoReplyEmailResponse

No reply email

Notification

Used for listing a user's notifications

OnDemandRequest

Request for various demands

OpenForAllRoomEdit

Used for setting a workspace to be open to all entities

OrgAdminsUserEmails

OrgLicenseExpirationTimeRequest

Created by sbenhayun on 8/3/2017.

OrgLicenseExpirationTimeResponse

Created by sbenhayun on 8/3/2017.

OrganizationConversionPolicy

An orgainzation conversion policy

OrganizationCustomization

Details about organization customization

OrganizationExchangePolicy

Organization file share policy

OrganizationPolicy

An organizational policy

OrganizationProtectAnywherePolicy

An organizational protect anywhere policy

OrganizationRoleLogRecord

A single log record about organization roles

OrganizationStoragePolicy

Used for editing on organizational storage policy

OrganizationStoragePolicyResponse

Response from getting an organizational storage policy

OrganizationSubdomainCustomization

Information about subdomain customization

OrganizationSyncPolicy

Organization sync policy details

OrganizationWatermarkConfig

OrganizationWatermarkContent

OrganizationWorkspacesPolicy

An organization workspace plicy

Pagination

Pagination details

PagingItemList

Details about a page item

PathAndExternalId

A path and external ID

PathOrFolderId

A path or ID for a folder

PermissionDetails

List of permission details

PermissionFromUser

A permission from a user

PermissionRequestUserAndType

User and type infomation for a permission request

PermissionSet

Various permissions

PermissionTemplatePayload

Permission template payload

PermissionsTemplateForFolderRequest

Request for a folder permission template

PermissionsTemplateRequest

Request for a permissions template

PermissionsToUser

Permissions to a user

PermissionsToUserForGetPermissions

Permission to a user for getting permissions

PermittedEntityFromUser

A permitted entity from a user

PermittedEntityToUser

Permitted entity to user

PermittedEntityWithPermissionsFromUser

Permitted entity with permissions from a user

PersonalRoom

Personal workspace ("My workspace")

ProtectorDownloadTypeResult

Result from getting info about a protector download type

PublicKey

Request for authentication details.

RecycleBinDocument

A recycle bin file

RemoveDocumentsTagValues

List of files to remove tags from

RemoveEmailProtectorWhitelistEntities

Used when removing user and domain entities from the email protector whitelist.

RemoveMembersFromGroup

Json representation of a list of members to remove from a group

RemoveOrganizationBlacklisting

List of entities to remove from the organization denied blacklist.

RemoveUsers

Users to remove from an organization

RenameDistributionList

New name for a distribution list

RenameFolder

Used when renaming a folder

RenameTransientDocument

A file to rename

RenameTransientFolder

A folder to rename

RenameTransientFolderResult

Result from renaming transient folder

ReportFilter

A report filter

ResolveActionForDocumentPermissionRequest

Request to resolve an action on a file

ResolveActionForFolderPermissionRequest

Request to resolve and action on a folder

ResolveActionForTransientDocumentPermissionRequest

Request to resolve and action on a file

ResolveActionForTransientFolderPermissionRequest

Request to resolve and action on a file

RestoreExchangesRecycleBinDocuments

Files to restore from the Sent items recycle bin to the original folders.

RestoreWorkspacesRecycleBinDocument

Files to restore from the Sent items recycle bin to the original folders.

RestoreWorkspacesRecycleBinWorkspaces

Workspaces to restore from the recycle bin

Room

A workspace

RoomEmailData

List workspace files

RoomEntity

A workspace

RoomExplicit

Used when marking a workspace explicit

RoomExternalData

Items associated with a workspace

RoomExternalRepositoryData

Information about an external repository

RoomLinks

Used when getting a URL for a workspace

RoomList

List of workspaces

RoomRecipients

List workspace members

RoomsReportRequestByMail

Request for a workspace report

SaveTransientWorkspaceCredentials

Saves credentials for a transient workspace

SdsAddPermissions

Information for adding SDS permissions

SdsAddRecipients

Information for adding recipients to files

SdsEditPermissions

Used when editing file permissions in Sent items

SdsGetRecipients

File to list recipients of

SdsRevokePermissions

Used when revoking all permissions for entities (users, groups, lists) for files in the Sent items.

SearchDocumentsSds

Used when searching a file for a string

SearchDocumentsVdr

Used when searching files for a string

SendEmail

Used when sending an email

SendEmailBulk

Used when sending bulk email notifications for a list of files to all permitted entities (users, groups etc) for each file

SendEmailsToTransientDocuments

Used when sending emails

SendSupportEmail

SetClassification

Used to set the classification on a file

ShareTransientDocumentAnnotation

SharepointRoom

SharePoint workspace

SimpleNaturalInteger

this json allows us to differentiate between the following case when supplying integer values for updating in the DB 1. the field is not being sent in the json ( a null value will occur when using the SimpleIntegerJson as member in another json)- signifies not to touch the current value 2. the field appears as an empty json (just the internal value of SimpleIntegerJson will be null, but the member will not) - signifies reset to null

SquareDocumentAnnotation

StarredTransientDocuments

Starred files in transient workspaces

Status

A command status

StrikeoutDocumentAnnotation

SubmitDocumentResult

Result from submitting a file

SubmitDocumentSds

These parameters are needed when submitting files in SDS mode (not to a workspace).

SubmitDocumentVdr

SubmitDocumentsVdr

Used when submitting files

SubmitIfNew

SubmitIfNewTransientDocument

SubmitTransientDocumentResult

SubmitTransientDocumentVdr

SubmitTransientVersionVdr

SummaryEmbeddedNotification

SystemProperties

Various system properties

TagDateValueAdd

A tag date value

TagDateValueRemove

Used when removing values

TagField

A tag

TagList

A collection of tags

TagListRemove

Used when removing tags

TagNumericValueAdd

A tag numeric value

TagNumericValueRemove

Used when removing values

TagRecord

TagStringValueAdd

A tag text value

TagStringValueRemove

Used when removing values

TagTree

A tag tree

TextCommentDocumentAnnotation

TextMarkupDocumentAnnotation

TextualDocumentAnnotation

TimeEstimation

Estimated seconds left

TransactionInput

Used when getting a file transaction status

TransactionStatus

File transaction status

TransientDocument

Details for a file in a transient workspace

TransientDocumentAndUsers

TransientDocumentCommentCount

TransientDocumentInfo

Used for getting file information

TransientDocumentInvite

TransientDocumentPendingPermissionRequest

A pending request for a file permission in a transient workspace

TransientDocumentPermissionRequestsResults

Result from a permission request for a document in a transient workspace

TransientDocumentsTransactionResult

Result from copying files to Sent items

TransientEditFoldersAndDocumentsSettingsBulk

Used when bulk editing file settings

TransientFolder

Details of a transient folder

TransientFolderInfoResult

Result from getting a single folder level

TransientFolderPendingPermissionRequest

A request for permissions on an existing folder

TransientFolderPermissionRequestsResults

Result from a pending transient workspace permission request

TransientInitiateConversion

Used to initiate a conversion

TransientInitiateConversionResult

Result from initiating a conversion

TransientInvite

Invite

TransientListUserMentionInUnreadDocumentComments

TransientMove

Used for moving folders or files

TransientPathInfo

TransientWorkspace

A transient worksapce

TransientWorkspaceExternalData

Workspace external data

TransientWorkspaceInfo

Transient Workspace Info

UnStarredTransientDocuments

Files in transient workspaces that are not starred.

UnauthDocument

File details

UnauthDocumentInfo

Details used when opening a file

UnderlineDocumentAnnotation

UnlockDocumentsRequest

Request to unlock a file

UnregisterUserForPushNotification

Created by sbenhayun on 3/8/2017.

UpdateComment

UpdateDocument

Used when updating a file

UpdateTransientComment

UploadUserTransientDocumentAnnotations

Url

URL Json contains a URL

User

A user

UserAbilities

Details about a user's abilities

UserAuthenticationLoggingInitialDateResponse

UserData

Details about a user

UserDetails

User details

UserDirectMembershipResolveData

Data used for resolving user direct membership

UserReport

UserRole

A user role

Users

User list

UsersForPasswordReset

Users who need a password reset

UsersReportRequest

ValidPathInfo

ValidateCreateFolder

Used to validate params when creating a folder

ValidateDownloadDocumentVersionInVdrs

Used when validating files for download

ValidateDownloadDocumentsSelectionSds

Used when validating files for download

ValidateDownloadDocumentsSelectionVdr

Used when validating files for download

ValidateDownloadSentItemsDocumentsWithRecycleBin

Used when validating sent items download of a user with it's recycle bin.

ValidateDownloadTransientDocuments

Used for validating a file for download

ValidateDownloadTransientDocumentsAnnotations

ValidateDownloadUserTransientDocumentAnnotationsInDoc

ValidateDownloadWorkspaceDocumentsWithRecycleBin

Used when validating files to download from a recycle bin.

ValidateKCDWorkspaceCredentials

Validates credentials for a kcd transient workspace

ValidateUsersNotAdminsInWorkspacesRequest

Used when validating non-admin users in a workspace

ValidateUsersNotAdminsInWorkspacesResponse

Response to validating non-admin users in a workspace

VdrAddPermissions

Add permissions to an entity

VdrEditPermissions

Used when editing permissions for a list of files for a list of entities

VdrRevokePermission

Used when revoking permissions

VerifyActiveDirectorySettings

An a Active Directory setting to be verified

ViewerWatermark

A viewer watermark

WopiProofKey

WorkspaceGroupMembershipForUserInfo

WorkspaceInfo

Workspace information

WorkspaceProtectorSettings

Used when setting a protector

Enums
Name Description

ADGroupType

This enum exists to minimise client-side options (verify we're requesting AD groups).

AccessLevel

An enum of access level

ActiveDirectoryActionLogType

An enum of Active Directory action log types.

ActiveDirectoryGroupActionType

An enum of Active Directory group action types.

ActiveDirectoryGroupOrder

An enum of the values for ordering Active Directory groups.

ActiveDirectoryGroupType

An enum of Active Directory Group types

ActiveDirectoryUserType

An enums of Active Directory user types

AggregationStatus

An enum of values for the aggreation status

AnnotationFlagsEnum

An enum of values for annotation flags

AnnotationGeometricalObjectType

An enum of the annotation geographical object types

AnnotationType

An enum of the annotation types

ApiDocumentFilter

An enum of API file filters

ApiDocumentOrderSDS

An enum of API file order SDS values

ApiDocumentOrderVDR

An enum of API file order workspace values

ApiFilterScope

An enum of API filter scope values

AuthenticationMethod

An enum of authentication methods

BlockCipherMode

CacheDocumentStatus

An enum of file cache status values

CheckCredentialsResult

An enum of values for the result of credentials check

Color

An enum of color values

CommentMentionType

Created by sbenhayun on 1/23/2017.

ConversionModuleStatus

An enum of values for the conversion module status

DeviceAction

An enum of device actions

DeviceOperationAuthEnum

An enum of device operation auth values

DeviceState

An enum of device state values

DeviceType

An enum of device type values

DeviceTypeByAgent

An enum of device types by agent.

DistributionListsReportOrder

An enum of values for ordering distribution list reports

DistributionlistsOrder

An enum of values for ordering distribution lists

DlpStatus

An enum of DLP status values

DocumentAccessLevel

An enum of values for file access level

DocumentFormat

An enum of file format values

DocumentReportOrder

An enum of values for file report order for API V3 and above

DocumentStatusForApi

An enum of document status for api

DomainsOrder

An enum of values for ordering domains.

DownloadType

An enum of download type

DownloadTypes

An enum of download type values

EntityStatusCode

An enum of values for entity status code

EntityType

An enum of values for entity type

ErrorItemType

An enum of error item types

ExpirationOptions

An enum of expiration values

ExternalDataEntityType

A enum of external data entity types

ExternalIDPType

An enum of extenal IDP types

ExternalRepositoryCloudStatus

An enum of values for external repository cloud status.

ExternalRepositoryInitialSyncStatus

An enum of values for an external repository's initial sync status.

ExternalRepositoryRetrieveNewToken

An enum of values for whether to retrieve a new token for an external repository

ExternalRepositoryShowValue

An enum of values for external repository display

ExternalRepositoryType

An enum of external repository type

FileFormat

An enum of values for file formats

GroupActionType

An enum of values for group actions

GroupType

An enum of group types

GroupTypeRequest

Used to wrap the groupType enum to provide the "all" option without changing the original enum to prevent the GroupType enum from containing values that should not be saved in the database

GroupsReportOrder

An enum of values for ordering group reports

IappUserActionType

An enum of iApp user actions

IappUserLevel

An enum of iApp user levels

LayoutMode

An enum of layout modes

LineContentType

An enum of line content types

LogActionType

An enum of log action values

LogSeverity

An enum of values for log severity

MarkOperationNotification

An enum of values for mark operation notifications

MarkOperationSDS

An enum of mark operation SDS values

MarkOperationVDR

An enum of mark operation workspace values

NotificationPeriod

An enum of values for notification period

OauthAccountState

An enum of OAUTH account states

OnlineViewerEncryptionMethod

An enum of online viewer encryption methods

OrgAttributeType

An enum of organization attribute types

OrgCapabilityType

An enum of organization capability types

OrgLicenseType

An enum of organization license types

OrgRoleType

An enum of organization roles

OrganizationAuditActionTypeEnum

An enum of organization audit actions

OrganizationAuditAreaEnum

An enum of organization audit area values

OrganizationCustomizationActionType

An enum of organization customization actions

OrganizationCustomizationFields

An enum of organization customization fields

OrganizationProduct

Products in the context of plans allocated to users in organization

OrganizationRole

An enum of organization roles

OrganizationRoleActionType

An enum of organization role action types

OrganizationSubdomainCustomizationFields

An enum of organization subdomain customization fields

OrganizationToDeniedPermittedEntitiesLogActionTypeEnum

An enum of types for logging organization to denied permitted entities actions

OrganizationToDeniedPermittedEntitiesOrderEnum

An enum for ordering organization to denied permitted entities

PdfConversionStatus

An enum of status values for PDF conversion

PermissionRequestAction

An enum of actions for handling permission requests

PermissionRequestAdminAction

An enum of admin action for permission requests

PermissionRequestType

An enum of permission request types

PermissionRequestTypeExternalInterface

An enum of external interface types for permission requests

PermissionTemplateNameRequest

This must be synced with the existing templates in the database which are static at the moment

PermissionTemplateType

An enum of permission template types

ProtectAnywhereSettingsActionLogType

An enum of log types for Protect Anywhere settings actions

ProtectAnywhereTemplateName

Used for setting max allowed template for protector rules. This must be synced with the existing templates in the database which are static at the moment.

PushNotificationsType

Created by sbenhayun on 3/13/2017.

ReadyForDownloadOriginal

An enum of values for reflecting ready to download original

RecycleBinExchangeDocumentsOrder

An enum of values for ordering files in the Set items Recycle bin/hidden files in Inbox

RecycleBinWorkspaceDocumentsOrder

An enum of values for ordering files in the Recycle bin

RecycleBinWorkspacesOrder

An enum of values for ordering workspaces in the Recycle bin

ReportPeriod

An enum of report period values

Role

An enum of roles

RoomAccessLevel

An enum of workspace access levels

RoomEntityType

An enum of workspace entity type

RoomRole

An enum of workspace roles

RoomSearchType

An enum of search types for workspace

RoomsReportOrder

An enum of values for ordering workspace reports

SigningAlgorithm

An enum of signing algorithms

SingleListDataEntityType

An enum of single list date entities

SuccessLevel

An enum of success levels

TagsOrder

An enum for values for ordering tags

TemplatePermissionsFilter

An enum of values for template permissions

TransactionStatusEnum

An enum of transaction status values

TransientEntityOrderByDirectionEnum

An enum of values for directional order of transient entities

TransientEntityOrderByEnum

An enum of values for ordering transient entities

TransientInitiateConversionFileFormat

An enum of file formats

TrueFalseEither

An enum of Boolean values including either(null)

UserAuthenticationActivityType

UserNotificationOrder

An enum of values for ordering user notifications

UsersOrder

An enum of values for ordering users

UsersReportOrder

An enum of values for ordering users reports

VdrDocumentFilter

An enum of values for filtering workspace files

VdrDocumentOrder

An enum of values for ordering workspace files. This is is to be used for API V3 and up!

WaterMarkPosition

An enum of values for a watermark's position

WhoCanView

An enum of values specifying who can view a file

WorkspaceCapabilityType

An enum of values for specifying workspace capability

YesNoDefault

An enum of boolean-mirroring values