BlackBerry.Workspaces.Json Namespace |
Class | Description | |
---|---|---|
AccountCreationStatusRequestJson | ||
AccountCreationStatusResultJson | ||
ActiveDirectoryGroupInfoJson |
Active Directory group details.
| |
ActiveDirectoryGroupSuggestionJson |
An Active Directory group suggestion used when searching for AD groups
| |
ActiveDirectorySettingsJson |
The details of an Active Directory connection when listing the details
for an organization
| |
ActivityLogRecordJson |
A single record the represents an activity of a user on a file used in
reports
| |
AddActiveDirectoryGroupJson |
Add an Active Directory group.
| |
AddActiveDirectoryGroupsJson |
Add multiple Active Directory groups.
| |
AddDocumentEntityJson |
Give user permissions to a particular workspace file only.
| |
AddDocumentPermissionRequestJson |
Request to add permissions to a file.
| |
AddDocumentsTagValuesJson |
List tags.
| |
AddEmailProtectorWhitelistEntitiesJson |
Add users and domains to the Email Protector whitelist.
| |
AddEntitiesIManageJson |
Add users to IManage workspaces.
| |
AddEntitiesTransientJson |
Add users to transient workspaces.
| |
AddEntityVdrJson |
List information when adding a user to a workspace.
| |
AddFolderEntityJson |
List information when adding a user to a workspace.
| |
AddFolderPermissionRequestJson |
Request for access to a folder.
| |
AddIManageDocumentPermissionRequestJson |
A request used when adding a file permission
| |
AddIManageFolderPermissionRequestJson |
A request used when adding an imanage workspace permission
| |
AddMembersToGroupJson |
Add multiple users to a group.
| |
AddMembersToGroupWithGroupJson |
Add multiple users to a group and add group information.
| |
AddMemberToGroupJson |
Add a single user to a group.
| |
AddOrganizationBlacklistingJson |
Add entities to blacklist.
| |
AddOrganizationDistributionListJson |
Add a new distribution list, including members.
| |
AddOrganizationSystemAccountsIdpJson |
Add multiple new system accounts.
| |
AddOrganizationSystemAccountsIdpResponseJson |
Response to adding new system accounts.
| |
AddOrganizationWatermarkContentLineJson |
Add content to a watermark.
| |
AddOrganizationWatermarkJson |
Add a new watermark.
| |
AddRoomMemberJson |
Add a user to a workspace.
| |
AddRoomMembersJson |
Add multiple users to a workspace.
| |
AddSiteInputJson |
Add a site.
| |
AddSiteOutputJson | ||
AddTransientDocumentPermissionRequestJson |
A request used when adding a file permission
| |
AddTransientFolderPermissionRequestJson |
A request used when adding a file permission
| |
AggregatedPermissionDetailsResponseJson |
Response to aggregated permission details.
| |
AggregatedPermissionTemplateJson |
Request aggregated permission details.
| |
AnnotationColorJson |
An RGB color value
| |
AnnotationFieldBaseJson |
Base for other annotations. Do not use.
| |
AnnotationPointJson |
A single point
| |
AnnotationRectangleJson |
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.
| |
ArrowDocumentAnnotationJson | ||
AuthenticationParametersJson |
Request for authentication details.
| |
AuthenticationPolicyJson |
Set authentication policy.
| |
AutocompleteRequestJson | ||
AvailableUserInfoJson |
Show user details.
| |
BaseJson |
Base class for BlackBerry Workspaces JSON objects.
| |
BaseLogJson |
Information about how to export a log.
| |
BulkDeleteWorkspaceDocumentsJson |
Delete multiple files, includes information about how to delete.
| |
BulkOperationResultJson |
Show result of bulk operation.
| |
BulkWorkspaceProtectorSettingsJson |
Set workspace settings with SharePoint Protector.
| |
ChangeActiveDirectorySettingsStatusJson |
Request to enable or disable Active Directory.
| |
ChangeEntitiesIManageJson |
Change multiple workspace member permissions for a imanage workspace.
| |
ChangeEntitiesTransientJson |
Change multiple workspace member permissions for a transient workspace.
| |
ChangeEntitiesVdrJson |
Change multiple workspace member permissions for a workspace.
| |
ChangeEntityVdrJson |
Change a single workspace member permissions for a workspace.
| |
CheckIManageCredentialJson |
Check IManage Credential
| |
CheckIManageCredentialResultJson |
Result of checking IManage Credential
| |
CircleDocumentAnnotationJson | ||
ClassificationJson | ||
ClientTokenTTLConfigJson |
Information about a client and its associated token.
| |
ConnectorConfigurationJson |
a Connector configuration - contains the info of how to login to the
connector
| |
CopyDocumentFromInboxJson |
Copy files from Inbox.
| |
CopyDocumentFromRoomJson |
List users to receive a notification with link and permissions assigned
sending a copy.
| |
CopyIManageDocumentToExchangeAsyncJson |
List users to receive a notification with link and permissions assigned
sending a copy from a imanage workspace.
| |
CopyMembershipJson |
List users when copying membership.
| |
CopyMultipleDocumentsToExchangeAsyncJson |
List of documents to send to exchange. WS documents and transient
workspace documents.
| |
CopyTransientDocumentToExchangeAsyncJson |
List users to receive a notification with link and permissions assigned
sending a copy from a transient workspace.
| |
CountingRoomEntityJson |
Used when listing the workspace entities (groups/domain/everyone) that
are members of the workspace.
| |
CreateAggregatedUserDocActivityReportJson |
Created by egilron on 6/12/2016.
| |
CreateFolderAsyncJson | ||
CreateFolderJson |
Add folder.
| |
CreateIManageActivityLogRecordJson |
Used when adding a notification for a file action in the file's
activity log file.
| |
CreateIManageFolderJson |
Add a folder for an Imanage workspace.
| |
CreateiManageWorkspaceCredentialsJson |
Credentials for an iManage workspace
| |
CreateInternalDomainLicensingReportJson | ||
CreateLicensingReportJson |
Created by tdagan on 11/16/2016.
| |
CreateMultipleRoomsJson | ||
CreateMultipleRoomsResponseJson | ||
CreateNewCommentJson | ||
CreateNewCommentResultJson | ||
CreateNewDocumentJson | ||
CreateNewIManageDocumentJson |
Information for creating imanage document
| |
CreateNewTransientCommentJson | ||
CreateNewTransientCommentResultJson | ||
CreateNewTransientDocumentJson | ||
CreateOrganizationWeeklyStorageReportJson |
Created by egilron on 12/12/2016.
| |
CreateQuickSendStorageReportJson |
Created by egilron on 14/12/2016.
| |
CreateRoomEntityJson | ||
CreateRoomJson |
Add workspace.
| |
CreateSessionJson |
Settings for creating a new user session.
| |
CreateTransientActivityLogRecordJson |
Used when adding a notification for a file action in the file's
activity log file.
| |
CreateTransientFolderJson |
Add transient workspace.
| |
CreateTransientWorkspaceJson |
A new transient workspace to create
| |
CreateWorkspaceExternalFoldersJson |
A collection of external folders to be created in a workspace.
| |
CreateWorkspaceFolderTreeJson |
A workspace folder tree that will be created.
| |
CreateWorkspaceFolderTreeRecordJson |
A single entry in a new workspace folder tree.
| |
CreateWorkspacesStorageReportJson |
Created by egilron on 14/12/2016.
| |
DefaultNotificationEmailJson |
The default notification email
| |
DefaultWorkspacePermissionsJson | ||
DeleteActiveDirectoryGroupListJson |
A collection of active directory groups to be deleted.
| |
DeleteActiveDirectorySettingsJson |
An active directory setting to be deleted.
| |
DeleteCommentJson | ||
DeleteDocumentsSelectionSdsJson |
Files to be deleted from Inbox/Sent items.
| |
DeleteDocumentsSelectionVdrJson |
Files or folders to be deleted from a workspace.
| |
DeleteEmbeddedNotificationJson |
Created by tdagan on 3/27/2017.
| |
DeleteFolderJson |
Delete folder and all its contents from a workspace.
| |
DeleteIdpSettingsJson |
A list of IDP settings to remove from the organization.
| |
DeleteIManageDocumentsAndFoldersJson |
Delete folder and all its contents from a imanage workspace.
| |
DeleteIManageWorkspaceJson |
Delete iManage workspace.
| |
DeleteNotificationJson |
Notification for deleting a user.
| |
DeleteOrganizationsDistributionListsJson |
List distribution lists to delete.
| |
DeleteOrganizationSystemAccountIdpJson |
Delete system account from organization.
| |
DeleteOrganizationWatermarkJson |
Delete watermark from organization.
| |
DeleteRoomEntitiesJson |
Delete multiple items from a workspace.
| |
DeleteRoomJson |
Delete workspace.
| |
DeleteTagsJson |
List tags to delete.
| |
DeleteTransientCommentJson | ||
DeleteTransientDocumentAnnotationsJson | ||
DeleteTransientDocumentsAndFoldersJson |
Delete folder and all its contents from a transient workspace.
| |
DeleteTransientWorkspaceJson |
Delete transient workspace.
| |
DeviceInfoJson |
List device information.
| |
DeviceTypeJson | ||
DistributionListJson |
Details of a single distribution list
| |
DocumentAndRecipientsJson |
Used when gathering information about bulk email notifications
| |
DocumentAndVersionJson | ||
DocumentAnnotationJson |
Annotation details
| |
DocumentAnnotationsForUserJson | ||
DocumentAnnotationsForUsersJson | ||
DocumentAnnotationsJson |
A collection of annotations
| |
DocumentAnnotationsListJson |
A collection of annotation records
| |
DocumentAnnotationsListRecordJson |
A single annotation list record
| |
DocumentChunkJson |
Information about a chunk of file data's status
| |
DocumentChunksJson |
Information about the status of multiple chunks of file data
| |
DocumentCommentCountJson | ||
DocumentCommentJson | ||
DocumentConversionStatusJson |
Status information of a file conversion
| |
DocumentCurrentVersionJson |
Current version information about a file. Used in various places.
| |
DocumentExternalDataJson |
A file's external data
| |
DocumentExternalRepositoryDataJson |
Information about a file's external repository
| |
DocumentIdentifierJson | ||
DocumentJson |
A file that is used in various operations
| |
DocumentLinkInfoResultJson | ||
DocumentLinksJson |
Details about a link within a file
| |
DocumentModifiedDateSetJson |
Used when setting a file's modified date
| |
DocumentPageAnnotationsJson |
A collection of annotations
| |
DocumentPendingPermissionRequestJson |
A pending request for a file permission
| |
DocumentPermissionRequestsResultsJson |
Result from a pending permission request
| |
DocumentPlainAnnotationJson |
A plain annotation
| |
DocumentsModifiedDateSetJson |
Modified date to be set for a file
| |
DocumentsReadConfirmationEditJson | ||
DocumentsSelectionJson |
Base type of several file selection JSONs
| |
DocumentsSelectionSdsJson |
Specifies a filter for selecting files
| |
DocumentsSelectionVdrJson |
Specifies various criteria for selecting files
| |
DocumentsUpdateDataSetJson |
A collection of file data updates to be applied to a file
| |
DocumentUpdateDataSetJson |
Information used when updating file data
| |
DocumentVersionAnnotationsListJson |
A set of annotation records used when getting file version information
| |
DocumentVersionAnnotationsListRecordJson |
Information about a single file annotation used when getting file
version information
| |
DocumentVersionReadConfirmedJson | ||
DocuSignPolicyJson | ||
DomainJson |
A single domain's information
| |
DownloadCommentsJson | ||
DownloadDocumentsSelectionSdsJson |
Used when choosing which files to download
| |
DownloadDocumentsSelectionVdrJson |
Used when choosing which files to download in a workspace
| |
DownloadPrepareDocumentStatusInputJson | ||
DownloadPrepareDocumentStatusOutputJson | ||
DownloadSentItemsDocumentsWithRecycleBinJson |
User who's sent items and recycle bin will be downloaded
| |
DownloadSingleDocumentSelectionJson |
A single file to be downloaded
| |
DownloadSingleIManageDocumentJson |
Request for a document to be downloaded
| |
DownloadSingleRecycleBinWorkspaceDocumentJson |
Original version of a file to be downloaded. Allowed only for workspace
admins
| |
DownloadSingleTransientDocumentForWebJson | ||
DownloadSingleTransientDocumentJson | ||
DownloadTransientCommentsJson | ||
DownloadTransientDocumentAnnotationsJson | ||
DownloadWorkspaceDocumentsWithRecycleBinJson |
Files to be downloaded from a workspace Recycle bin.
| |
EditActiveDirectoryGroupJson |
Used when editing Active Directory groups in the organization
| |
EditActiveDirectorySettingsJson |
Used when editing the Active Directory settings for and organization
| |
EditActiveDirectorySettingsResponseJson |
Response from editing an organization's Active Directory settings
| |
EditCollaborationJson |
Edit collaboration settings.
| |
EditExternalTransactionStatusInputJson |
Used when editing the status of an external transaction
| |
EditFoldersAndDocumentsSettingsBulkJson |
Used when editing folder permissions in bulk
| |
EditFolderSettingsJson |
Used when editing folder permissions
| |
EditIdpClientSettingsJson |
Used when editing IDP settings for an organization
| |
EditIdpSettingsJson |
Used when editing IDP settings for an organization
| |
EditIdpTTLSettingsJson | ||
EditManagersOnGroupJson |
Add multiple users to a group and add group information.
| |
EditOrganizationPolicyJson |
Used when editing an organizational policy
| |
EditOrganizationSystemAccountsIdpJson |
Organizational system accounts to be updated
| |
EditOrganizationWatermarkContentLineJson |
An organizational watermark content line to be updated
| |
EditOrganizationWatermarkJson |
An organizational watermark to be updated
| |
EditRoomJson |
A workspace to be edited
| |
EditTagJson |
Information about a tag that will be renamed
| |
EditUserJson |
A user to be edited
| |
EmailBulkDataJson |
Collection used to store bulk email data
| |
EmbeddedNotificationJson |
Created by tdagan on 3/21/2017.
| |
EmbeddedNotificationsCommentInfoJson | ||
EntityInFolderPermissionsJson |
Permissions for an entity that exists in a folder
| |
EntityInRoomResponseJson |
Response when querying about entities in a workspace
| |
EntityPermissionJson |
A single permission for an entity
| |
ErrorInfoJson |
Information about an error
| |
ExistingActiveDirectoryGroupSuggestionJson |
Details of a suggested Active Directory group
| |
ExistingDocumentJson |
A file that exists, but with a new suggested name
| |
ExistingTransientDocumentJson | ||
ExportActivityHistoryForTransientRoomsJson |
Used when exporting the activity history for multiple rooms
| |
ExportSpecificUsersTransientActivityHistoryByMailJson |
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
| |
ExportUsersTransientActivityHistoryJson |
Used when exporting activity history for a list of users in current
user's organization to a CSV file
| |
ExternalDataItemJson |
Simple key/value pair representing a piece of external data
| |
ExternalDocumentsTransactionResultJson |
Results from an action regarding external files
| |
ExternalFoldersTransactionResultJson |
Results from an action regarding external folders
| |
ExternalRepositoryIdRequestJson |
Request for getting the ID of an external repository
| |
ExternalRepositoryIdResultJson |
Result from getting external repository ID information
| |
ExternalSiteDataJson |
External site data
| |
ExternalTransactionInputJson |
Used when getting the status of an external transaction
| |
ExternalTransactionStatusJson |
The status of an external transaction
| |
FolderDefaultPermissionsJson |
The default permissions for a folder
| |
FolderExternalDataJson |
A collection of items in an external folder
| |
FolderExternalRepositoryDataJson |
Details about a folder in an external repository
| |
FolderInfoJson |
Details about a single folder
| |
FolderJson |
Details about a single folder
| |
FolderLinksJson |
Used when getting links for a folder in a workspace
| |
FolderPathToUuidJson |
Created by sbenhayun on 6/7/2017.
| |
FolderPendingPermissionRequestJson |
A request for permissions on an existing folder
| |
FolderPendingPermissionRequestsJson |
A collection of requests for folder permissions
| |
FolderReadConfirmationEditJson | ||
FoldersDocumentsJson |
A collection of folders and files
| |
FolderSuggestedNameJson | ||
FreeDrawDocumentAnnotationJson | ||
FreeDrawnElementDocumentAnnotationJson | ||
GenerateTransientDocumentGuidJson |
GUID for a file in transient workspace's context
| |
GeometricalObjectDocumentAnnotationJson | ||
GetDocumentActivityLogRequestJson |
Request for getting information about an activity log
| |
GetDocumentLinkInfoRequestJson |
Request for getting information about a file link
| |
GetDocumentsActivityLogRequestJson |
Request for getting information about an activity log
| |
GetDocumentsConversionStatusJson |
Used when getting the status of a file conversion
| |
GetDocumentsGuidsInfoJson |
Created by ybennatan on 8/29/2016.
| |
GetDocumentsVersionsInfoJson |
Created by ybennatan on 8/31/2016.
| |
GetEmailBulkDataJson |
Used when getting bulk data about email
| |
GetFolderInfoJson |
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.
| |
GetGroupInfoJson |
Used when getting information about a group in a workspace
| |
GetGuidByFolderAndNameJson |
GUID of folder and filename
| |
GetIManageDocumentActivityLogRequestJson |
Used to get imanage document activity log
| |
GetIManageDocumentPermissionsForIosJson |
Used to identify a workspace to get permission information from
| |
GetIManageFolderInfoJson |
Information for getting the workspace or folder single level folders.
| |
GetIManagePathInfoJson |
A path to get information about
| |
GetIManageWorkspaceInfoJson | ||
GetInfoUnauthDocumentResultJson |
Result from getting informaton about an unauthorized file
| |
GetOrRefreshAccessTokenResponseJson |
Response from getting information about an access token that needs to
be obtained or refreshed
| |
GetPathInfoJson |
A path to get information about
| |
GetSamlIdpIdJson | ||
GetSAMLIdPMetadataJson | ||
GetTransientDocumentActivityLogRequestJson |
Used to get an activity log
| |
GetTransientDocumentPermissionsForIosJson |
Used to identify a workspace to get permission information from
| |
GetTransientFolderInfoJson |
Workspace to get a single level of folders from
| |
GetTransientWorkspaceInfoJson | ||
GetValidDocumentsGuidsInfoJson | ||
GetValidIManagePathInfoListJson | ||
GetValidPathInfoListJson | ||
GetWopiProofKeyJson | ||
GoodTokenErrorResponseJson |
Error response when generating a BlackBerry Workspaces authentication
token from a given Good authentication token.
| |
GroupAndMembersJson |
Used when adding entities to a group
| |
GroupLogRecordJson |
A record used when exporting group logs
| |
GroupRequestJson |
Group request when filtering reports
| |
GroupsLogByIdsJson |
Used when exporting groups logs
| |
GroupsLogByRoomsJson |
Used when exporting groups logs
| |
GuidJson |
A simple GUID
| |
HideNotificationJson | ||
HighlightDocumentAnnotationJson | ||
HistoryPeriodJson |
Time period used when exporting history logs
| |
IManageDocumentInfoJson |
Used for getting file information
| |
IManageDocumentInviteJson |
Invite data for a document
| |
IManageDocumentJson |
Details for a file in a IManage workspace
| |
IManageDocumentPermissionRequestsResultsJson |
Result from a permission request for a document in a imanage workspace
| |
IManageDocumentsTransactionResultJson |
Result from copying files to Sent items
| |
IManageFolderInfoResultJson |
Result from getting a single folder level
| |
IManageFolderJson |
IManage folder info
| |
IManageInitiateConversionJson |
Used to initiate a conversion to PDF for a document
| |
IManageInviteJson |
Invite to imanage workspace or folder
| |
IManageMatterInfoJson |
The imanage matter info for creating imanage workspace locally
| |
IManageMatterJson |
Details of iManage matter/folder
| |
IManageMoveJson |
Used for moving folders or files
| |
IManageWorkspaceInfoJson |
IManage Workspace Info
| |
IManageWorkspacePermissionRequestsResultsJson |
Result from a pending transient workspace permission request
| |
InitialSyncRoomDataJson |
Used when applying a decision to a request
| |
InitialSyncStatusJson |
Status of an initial sync
| |
InlineTextDocumentAnnotationJson | ||
InviteJson |
Used to invite groups to a workspace
| |
InviteTextJson |
Information about the invite email
| |
IsActiveDirectoryConfiguredResultJson |
Result from determining if Active Directory is enabled
| |
IsActiveDirectorySettingsEnabledJson |
Used when finding out if Active Directory is enabled
| |
IsEmailProtectorEnabledJson |
Result from determining if the email protector is enabled
| |
ItemErrorInfoJson |
A problematic item found during different processes
| |
ItemListJsonT |
A generic list of JSON items.
| |
ItemWithErrorJson | ||
KMSRegionJson | ||
LastDocsWithActivityJson | ||
LastDocWithActivityJson | ||
LastResolvedDocumentPermissionRequestResultJson |
Member of a list of last resolved permission requests on files in rooms
and in exchange
| |
LastResolvedFolderPermissionRequestResultJson |
Member of a list of last resolved permission requests on folder
| |
LastResolvedIManageDocumentPermissionRequestResultJson | ||
LastResolvedIManageFolderPermissionRequestResultJson | ||
LastResolvedTransientDocumentPermissionRequestResultJson | ||
LastResolvedTransientFolderPermissionRequestResultJson | ||
LineDocumentAnnotationJson | ||
ListActiveDirectoryGroupsJson |
Details about how to get a list of Active Directory groups
| |
ListActiveDirectoryGroupsSuggestionsJson |
A list of suggestions used when searching for Active Directory groups
| |
ListAllFavoriteItemsJson | ||
ListAllNotificationsJson |
Created by tdagan on 3/21/2017.
| |
ListBulkFolderPermissionsJson |
Used when getting the aggregation of permissions of folders
| |
ListDistributionListsByNameJson |
Used when getting a list of members of a named distribution list
| |
ListDistributionlistsJson |
Information about returning a list of all distribution lists for an
organization.
| |
ListDocumentCommentsJson | ||
ListDocumentsPermissionRequestsJson |
Used when listing existing permission requests for a file
| |
ListDocumentsVdrJson |
Details of how to obtain a list of files
| |
ListDomainsJson |
Details of how to obtain a list of domains
| |
ListEmailProtectorWhitelistEntitiesResultJson |
Results from listing all user and domain entities within the Email
protector whitelist
| |
ListEmailProtectorWhitelistEntityResultJson |
An entity result from listing all user and domain entities within the
Email protector whitelist
| |
ListExchangesRecycleBinDocumentsJson |
Used when listing hidden files in the Inbox and items in the Sent items
Recycle bin.
| |
ListExistingActiveDirectoryGroupsSuggestionsJson |
Details about using suggestions when searching for Acive Directory
groups
| |
ListExternalConnectorsJson | ||
ListExternalConnectorsResultJson |
Result json for the ListExternalConnectors API
| |
ListFavoriteItemsJson | ||
ListFolderDefaultPermissionsJson |
Details for listing permissions for each of the default entities in
given folder
| |
ListFolderPermissionRequestsJson |
Used when listing existing permissions requests for folder or the
entire workspace in case the root folder is supplied
| |
ListIdpSettingsJson |
Currently not used
| |
ListIdpSettingsResultItemJson |
Single result from listing IDP settings for organization
| |
ListIdpSettingsResultItemMultiMemberJson |
Multi result from listing IDP settings for organization
| |
ListIManageFoldersAndDocumentsJson |
Information for retrieving a list of iManage files and folders for a
workspace or a folder.
| |
ListIManageFoldersJson |
Used to get the tree of all folders
| |
ListIManageFoldersSingleLevelResultJson |
Single level of tree folders
| |
ListIManageMattersJson |
Used when retrieving a list of imanage matters
| |
ListIManagePermissionDetailsJson |
Request for listing permission details for files and folders for all
entities in the workspace
| |
ListInternalDomainsForOrganizationRequestJson |
Used when requesting organization's internal domains
| |
ListInternalDomainsForOrganizationResponseJson |
Response for requesting organization's internal domains
| |
ListLastResolvedFolderPermissionRequestsJson |
Details for listing last resolved permission requests on folder
| |
ListLastResolvedTransientDocumentPermissionRequestsJson | ||
ListLastResolvedTransientFolderPermissionRequestsJson | ||
ListLibrariesInputJson |
Libraries to list
| |
ListLibrariesOutputJson | ||
ListNotificationsJson |
Detals about how to list a user's notifications
| |
ListOrganizationBlacklistingJson |
Details for listing an organization's blacklist entries
| |
ListOrganizationBlacklistingResultJson |
Results from listing an organization's blacklist entries
| |
ListOrganizationPolicyJson |
Organization ID for listing policies
| |
ListOrganizationSystemAccountsIdpJson |
Used when listing organization system accounts
| |
ListOrganizationWatermarksJson |
Collection of watermark positions
| |
ListPendingNumberPermissionRequestsJson |
Details about how to list the number of pending existing file
permission requests and workspace permission requests for an admin
| |
ListPendingNumberPermissionRequestsResultJson |
Result from listing the number of pending existing file permission
requests and workspace permission requests for an admin
| |
ListPermissionDetailsJson |
Details for listing permission details for files and folders in bulk
for all entities in the workspace
| |
ListPermittedUsersToTransientWorkspaceJson | ||
ListRoomEntitiesJson |
Details about how to list the workspace entities
| |
ListRoomsByTypeJson |
Result from a permission request for a document in a transient
workspace
| |
ListRoomsByTypeResultJson |
Workspace information
| |
ListSitesInputJson |
Input when listing sites
| |
ListSitesOutputJson | ||
ListStarredTransientDocumentsJson |
List of starred files in transient workspace
| |
ListSummaryEmbeddedNotificationJson | ||
ListSystemAccountItemJson |
Details about a single system account
| |
ListTagsJson |
A list of tags
| |
ListTagTreeJson |
A tree of tag lists
| |
ListTransientDocumentCommentsJson | ||
ListTransientDocumentsPermissionRequestsJson |
Used when listing existing permission requests for a file
| |
ListTransientFolderPermissionRequestsJson |
Used when listing pending permission requests for folder in transient
workspaces
| |
ListTransientFoldersAndDocumentsJson |
Used when retrieving a list of transient files and folders.
| |
ListTransientFoldersJson |
Used to get the tree of all folders
| |
ListTransientFoldersSingleLevelResultJson |
Single level of tree folders
| |
ListTransientOrganizationPolicyJson |
Used to get the organizational policy
| |
ListTransientPermissionDetailsJson |
Request for listing permission details for files and folders for all
entities in the workspace
| |
ListUserMentionInCommentsJson | ||
ListUserMentionInUnreadDocumentCommentsJson | ||
ListUserWorkspaceNotificationsSettingsJson | ||
ListVersionsReadConfirmationJson | ||
ListVersionsReadConfirmationRetJson | ||
ListWorkspaceGroupMembershipsForUserRequestJson |
Used to list the groups a user is a member of
| |
ListWorkspaceRecycleBinDocumentsJson |
Used to list files in the workspace recycle bin. The recycle bin holds
non-permanently deleted files.
| |
ListWorkspaceRecycleBinWorkspacesJson |
Used to list files in the workspaces recycle bin. The recycle bin holds
non-permanently deleted workspaces
| |
LoadToCacheJson |
Details of what to load into the cache
| |
LockDocumentsRequestJson |
Request to lock files
| |
MarkDocumentCommentsJson | ||
MarkDocumentsSelectionJson |
Mark a set of files
| |
MarkDocumentsSelectionSdsJson |
Files selected for marking
| |
MarkDocumentsSelectionVdrJson |
Files selected for marking
| |
MarkEmbeddedNotificationJson |
Created by tdagan on 3/27/2017.
| |
MarkIManageWorkspaceStarredJson |
Set of workspaces to be marked as starred or unstarred(favorite)
| |
MarkItemsStarredJson |
Mark a set of items
| |
MarkNotificationJson |
Mark details
| |
MarkupDocumentAnnotationJson | ||
MarkupLocationJson | ||
MembersJson |
A membership list
| |
ModifyGroupWithGroupJson |
Information for modifying a group
| |
MoveAllJson |
Move all files to another folder
| |
MoveFolderIntoFolderJson |
Used when moving a folder to another folder
| |
MoveFolderJson |
Used when moving a folder
| |
MoveJson |
Used when moving files
| |
NewSessionJson |
Details of a new session that was created
| |
NoReplyEmailRequestJson |
No reply email empty request
| |
NoReplyEmailResponseJson |
No reply email
| |
NotificationJson |
Used for listing a user's notifications
| |
OidcPublicKeyResultJson | ||
OnDemandRequestJson |
Request for various demands
| |
OpenForAllRoomEditJson |
Used for setting a workspace to be open to all entities
| |
OrgAdminsUserEmailsJson | ||
OrganizationActiveBYOKJson | ||
OrganizationConversionPolicyJson |
An orgainzation conversion policy
| |
OrganizationCustomizationJson |
Details about organization customization
| |
OrganizationExchangePolicyJson |
Organization file share policy
| |
OrganizationPolicyJson |
An organizational policy
| |
OrganizationProtectAnywherePolicyJson |
An organizational protect anywhere policy
| |
OrganizationRoleLogRecordJson |
A single log record about organization roles
| |
OrganizationStoragePolicyJson |
Used for editing on organizational storage policy
| |
OrganizationStoragePolicyResponseJson |
Response from getting an organizational storage policy
| |
OrganizationSubdomainCustomizationJson |
Information about subdomain customization
| |
OrganizationSyncPolicyJson |
Organization sync policy details
| |
OrganizationWatermarkConfigJson | ||
OrganizationWatermarkContentJson | ||
OrganizationWorkspacesPolicyJson |
An organization workspace plicy
| |
OrgLicenseExpirationTimeRequestJson |
Created by sbenhayun on 8/3/2017.
| |
OrgLicenseExpirationTimeResponseJson |
Created by sbenhayun on 8/3/2017.
| |
PaginationJson |
Pagination details
| |
PagingItemListJsonT |
A PagingItemListJson object represents a page or subset of a larger
set of Json objects. The object contains the offset that the wrapped
ItemListJson object represents within the larger set.
| |
PathAndExternalIdJson |
A path and external ID
| |
PathOrFolderIdJson |
A path or ID for a folder
| |
PermissionDetailsJson |
List of permission details
| |
PermissionFromUserJson |
A permission from a user
| |
PermissionRequestUserAndTypeJson |
User and type infomation for a permission request
| |
PermissionSetJson |
Various permissions
| |
PermissionsTemplateForFolderRequestJson |
Request for a folder permission template
| |
PermissionsTemplateRequestJson |
Request for a permissions template
| |
PermissionsToUserForGetPermissionsJson |
Permission to a user for getting permissions
| |
PermissionsToUserJson |
Permissions to a user
| |
PermissionTemplatePayloadJson |
Permission template payload
| |
PermittedEntityFromUserJson |
A permitted entity from a user
| |
PermittedEntityToUserJson |
Permitted entity to user
| |
PermittedEntityWithPermissionsFromUserJson |
Permitted entity with permissions from a user
| |
PersonalRoomJson |
Personal workspace ("My workspace")
| |
ProtectorDownloadTypeResultJson |
Result from getting info about a protector download type
| |
PublicKeyJson |
Request for authentication details.
| |
RecentSharedWithMeJson | ||
RecycleBinDocumentJson |
A recycle bin file
| |
RemoveDocumentsTagValuesJson |
List of files to remove tags from
| |
RemoveEmailProtectorWhitelistEntitiesJson |
Used when removing user and domain entities from the email protector
whitelist.
| |
RemoveMembersFromGroupJson |
Json representation of a list of members to remove from a group
| |
RemoveOrganizationBlacklistingJson |
List of entities to remove from the organization denied blacklist.
| |
RemoveUsersJson |
Users to remove from an organization
| |
RenameDistributionListJson |
New name for a distribution list
| |
RenameFolderJson |
Used when renaming a folder
| |
RenameIManageDocumentJson |
Information about the file to rename
| |
RenameIManageFolderJson |
Information about the folder to rename
| |
RenameIManageFolderResultJson |
Result from renaming transient folder
| |
RenameTransientDocumentJson |
A file to rename
| |
RenameTransientFolderJson |
A folder to rename
| |
RenameTransientFolderResultJson |
Result from renaming transient folder
| |
ReportFilterJson |
A report filter
| |
ResolveActionForDocumentPermissionRequestJson |
Request to resolve an action on a file
| |
ResolveActionForFolderPermissionRequestJson |
Request to resolve and action on a folder
| |
ResolveActionForIManageDocumentPermissionRequestJson |
Request to resolve and action on a file
| |
ResolveActionForIManageFolderPermissionRequestJson |
Request to resolve and action on an imanage workspace
| |
ResolveActionForTransientDocumentPermissionRequestJson |
Request to resolve and action on a file
| |
ResolveActionForTransientFolderPermissionRequestJson |
Request to resolve and action on a file
| |
RestoreExchangesRecycleBinDocumentsJson |
Files to restore from the Sent items recycle bin to the original
folders.
| |
RestoreWorkspacesRecycleBinDocumentJson |
Files to restore from the Sent items recycle bin to the original
folders.
| |
RestoreWorkspacesRecycleBinWorkspacesJson |
Workspaces to restore from the recycle bin
| |
RollbackToSnapshotJson | ||
RollbackToSnapshotRetJson | ||
RoomEmailDataJson |
List workspace files
| |
RoomEntityJson |
A workspace
| |
RoomExplicitJson |
Used when marking a workspace explicit
| |
RoomExternalDataJson |
Items associated with a workspace
| |
RoomExternalRepositoryDataJson |
Information about an external repository
| |
RoomJson |
A workspace
| |
RoomLinksJson |
Used when getting a URL for a workspace
| |
RoomListJson |
List of workspaces
| |
RoomRecipientsJson |
List workspace members
| |
RoomsReportRequestByMailJson |
Request for a workspace report
| |
SaveTransientWorkspaceCredentialsJson |
Saves credentials for a transient workspace
| |
SdsAddPermissionsJson |
Information for adding SDS permissions
| |
SdsAddRecipientsJson |
Information for adding recipients to files
| |
SdsEditPermissionsJson |
Used when editing file permissions in Sent items
| |
SdsGetRecipientsJson |
File to list recipients of
| |
SdsRevokePermissionsJson |
Used when revoking all permissions for entities (users, groups, lists)
for files in the Sent items.
| |
SearchDocumentsSdsJson |
Used when searching a file for a string
| |
SearchDocumentsVdrJson |
Used when searching files for a string
| |
SearchFilterJson | ||
SearchRequestJson | ||
SendEmailBulkJson |
Used when sending bulk email notifications for a list of files to all
permitted entities (users, groups etc) for each file
| |
SendEmailJson |
Used when sending an email
| |
SendEmailsToIManageDocumentsJson |
Used when sending emails
| |
SendEmailsToTransientDocumentsJson |
Used when sending emails
| |
SendNotificationsJson | ||
SendSupportEmailJson | ||
SetClassificationJson |
Used to set the classification on a file
| |
SharedWithMeJson | ||
SharedWithMeResponseJson | ||
SharepointRoomJson |
SharePoint workspace
| |
ShareTransientDocumentAnnotationJson | ||
SignInIManageResultJson |
SignIn IManage
| |
SimpleNaturalIntegerJson |
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
| |
SquareDocumentAnnotationJson | ||
StarredTransientDocumentsJson |
Starred files in transient workspaces
| |
StatusJson |
A command status
| |
StrikeoutDocumentAnnotationJson | ||
SubmitDocumentResultJson |
Result from submitting a file
| |
SubmitDocumentSdsJson |
These parameters are needed when submitting files in SDS mode (not to a
workspace).
| |
SubmitDocumentsVdrJson |
Used when submitting files
| |
SubmitDocumentVdrJson | ||
SubmitIfNewIManageDocumentJson | ||
SubmitIfNewJson | ||
SubmitIfNewTransientDocumentJson | ||
SubmitIManageDocumentResultJson | ||
SubmitIManageDocumentVdrJson | ||
SubmitIManageVersionVdrJson | ||
SubmitTransientDocumentResultJson | ||
SubmitTransientDocumentVdrJson | ||
SubmitTransientVersionVdrJson | ||
SummaryEmbeddedNotificationJson | ||
SystemPropertiesJson |
Various system properties
| |
TagDateValueAddJson |
A tag date value
| |
TagDateValueRemoveJson |
Used when removing values
| |
TagFieldJson |
A tag
| |
TagListJson |
A collection of tags
| |
TagListRemoveJson |
Used when removing tags
| |
TagNumericValueAddJson |
A tag numeric value
| |
TagNumericValueRemoveJson |
Used when removing values
| |
TagRecordJson | ||
TagStringValueAddJson |
A tag text value
| |
TagStringValueRemoveJson |
Used when removing values
| |
TagTreeJson |
A tag tree
| |
TextCommentDocumentAnnotationJson | ||
TextMarkupDocumentAnnotationJson | ||
TextualDocumentAnnotationJson | ||
TimeEstimationJson |
Estimated seconds left
| |
TotalEmbeddedNotificationsRequestJson | ||
TotalEmbeddedNotificationsResponseJson | ||
TransactionInputJson |
Used when getting a file transaction status
| |
TransactionStatusJson |
File transaction status
| |
TransientDocumentAndUsersJson | ||
TransientDocumentCommentCountJson | ||
TransientDocumentInfoJson |
Used for getting file information
| |
TransientDocumentInviteJson | ||
TransientDocumentJson |
Details for a file in a transient workspace
| |
TransientDocumentPendingPermissionRequestJson |
A pending request for a file permission in a transient workspace
| |
TransientDocumentPermissionRequestsResultsJson |
Result from a permission request for a document in a transient
workspace
| |
TransientDocumentsTransactionResultJson |
Result from copying files to Sent items
| |
TransientEditFoldersAndDocumentsSettingsBulkJson |
Used when bulk editing file settings
| |
TransientFolderInfoResultJson |
Result from getting a single folder level
| |
TransientFolderJson |
Details of a transient folder
| |
TransientFolderPendingPermissionRequestJson |
A request for permissions on an existing folder
| |
TransientFolderPermissionRequestsResultsJson |
Result from a pending transient workspace permission request
| |
TransientInitiateConversionJson |
Used to initiate a conversion
| |
TransientInitiateConversionResultJson |
Result from initiating a conversion
| |
TransientInviteJson |
Invite
| |
TransientListUserMentionInUnreadDocumentCommentsJson | ||
TransientMoveJson |
Used for moving folders or files
| |
TransientPathInfoJson | ||
TransientWorkspaceExternalDataJson |
Workspace external data
| |
TransientWorkspaceInfoJson |
Transient Workspace Info
| |
TransientWorkspaceJson |
A transient worksapce
| |
UnauthDocumentInfoJson |
Details used when opening a file
| |
UnauthDocumentJson |
File details
| |
UnderlineDocumentAnnotationJson | ||
UnlockDocumentsRequestJson |
Request to unlock a file
| |
UnregisterUserForPushNotificationJson |
Created by sbenhayun on 3/8/2017.
| |
UnStarredTransientDocumentsJson |
Files in transient workspaces that are not starred.
| |
UpdateCommentJson | ||
UpdateDocumentJson |
Used when updating a file
| |
UpdateTransientCommentJson | ||
UploadUserTransientDocumentAnnotationsJson | ||
UrlJson |
URL Json contains a URL
| |
UserAbilitiesJson |
Details about a user's abilities
| |
UserAuthenticationLoggingInitialDateResponseJson | ||
UserDataJson |
Details about a user
| |
UserDetailsJson |
User details
| |
UserDeviceNotificationTypeSettingsJson | ||
UserDirectMembershipResolveDataJson |
Data used for resolving user direct membership
| |
UserJson |
A user
| |
UserReportJson | ||
UserRoleJson |
A user role
| |
UsersForPasswordResetJson |
Users who need a password reset
| |
UsersJson |
User list
| |
UsersReportRequestJson | ||
UserWorkspaceNotificationsSettingsJson | ||
ValidateCreateFolderJson |
Used to validate params when creating a folder
| |
ValidateDownloadDocumentsSelectionSdsJson |
Used when validating files for download
| |
ValidateDownloadDocumentsSelectionVdrJson |
Used when validating files for download
| |
ValidateDownloadDocumentVersionInVdrsJson |
Used when validating files for download
| |
ValidateDownloadIManageDocumentsJson |
Used for validating a file for download
| |
ValidateDownloadSentItemsDocumentsWithRecycleBinJson |
Used when validating sent items download of a user with it's recycle
bin.
| |
ValidateDownloadTransientDocumentsAnnotationsJson | ||
ValidateDownloadTransientDocumentsJson |
Used for validating a file for download
| |
ValidateDownloadUserTransientDocumentAnnotationsInDocJson | ||
ValidateDownloadWorkspaceDocumentsWithRecycleBinJson |
Used when validating files to download from a recycle bin.
| |
ValidateKCDWorkspaceCredentialsJson |
Validates credentials for a kcd transient workspace
| |
ValidateSAMLIdPMetadataJson | ||
ValidateUsersNotAdminsInWorkspacesRequestJson |
Used when validating non-admin users in a workspace
| |
ValidateUsersNotAdminsInWorkspacesResponseJson |
Response to validating non-admin users in a workspace
| |
ValidIManagePathInfoJson |
Request for getting documents info
| |
ValidPathInfoJson | ||
VdrAddPermissionsJson |
Add permissions to an entity
| |
VdrEditPermissionsJson |
Used when editing permissions for a list of files for a list of
entities
| |
VdrRevokePermissionJson |
Used when revoking permissions
| |
VerifyActiveDirectorySettingsJson |
An a Active Directory setting to be verified
| |
ViewerWatermarkJson |
A viewer watermark
| |
WopiProofKeyJson | ||
WorkspaceGroupMembershipForUserInfoJson | ||
WorkspaceInfoJson |
Workspace information
| |
WorkspaceProtectorSettingsJson |
Used when setting a protector
|