Overview

Resource Workspace is the environment in which most collaboration happens. It defines a logical scope of work, such as a particular project. There are two types of Workspaces, PersonalWorkspaces and TeamWorkspaces. Workspaces contain Folders with special semantics, such as the Inbox and the Trash. The Inbox is used for storing the Workspace's incoming Messages and the Trash is used to store deleted Workspace items before they are purged. These special Folders cannot be deleted.

Members

Show inherited members

Projections
Name Type Required Description

activePreferenceProfile

preferenceProfile
Active preference profile of the scope.

attachedMarkers

marker[]
Set of marker elements associated with the entity.

attachedReminders

reminder[]
List of reminders attached to the entity

attachedSubscriptions

subscription[]
List of subscriptions attached to the entity

availableMarkers

marker[]
Available marker Elements for the Scope

availablePreferenceProfiles

preferenceProfile[]
Available preference profiles of the scope.

bonds

bond[]
Bonds associated with the scope.

collabId

beeId
CollabId of the snapshot

createdOn

dateTime
Entity's creation date

creator

actor
The actor that created this entity

defaultAddressBook

addressBook
The default AddressBook of this Workspace, where the Workspace's Addresses are kept.

defaultCalendar

calendar
The default Calendar of this Workspace, where the Workspace's Events are stored.

defaultConference

conference
The default Conference of this Workspace.

defaultDocumentsFolder

heterogeneousFolder
The Documents Folder, the default location for Documents within this Workspace.

defaultSensitivity

sensitivity
The default Sensitivity of this Workspace.

defaultTaskList

taskList
The default TaskList of this Workspace, where the Tasks in this Workspace are kept.

defaultWikiFolder

heterogeneousFolder
The Wiki Folder, the default location for the Wiki in this Workspace.

defaultWikiPage

wikiPage
The default WikiPage of this Workspace, which serves as the home page of this Workspace's Wiki.

deleted

boolean
Deletion flag. If this property is set to true the entity is deleted.

description

string
Description of the scope.

elements

listResult
A List of the Folders contained under this Workspace.

inbox

heterogeneousFolder
The Inbox of this Workspace, a special Folder that stores the Workspace's incoming Messages.

lastModifiedByName

string
The name of the user who last modified this Workspace.

locks

lock[]
A list of the Locks held on this Workspace.

logoURI

string
The URI for the workspace logo. If the logo is stored as a Workspace Artifact, the URI will be a URN with the CollabId of the logo artifact (e.g. urn:120E:486C:adoc:2BA76E50A4FC4974E040578CBC010F900000000000EF). If the public summary is stored externally to the Beehive system, the URI is expected to be a regular URL that refers to an image (e.g. http://myserver.com/mypages/mylogo.jpg)
It is expected that the URN of an internally stored logo will reference an Artifact of type Document. Consumers of the logo can load the corresponding Document to get its path if they need to build a full URL for their clients. If a Document currently used as a logo is deleted from the system, the Workspace service will still return its CollabId in the summary URI. In other words, the Workspace service will not track the life-cycle of the logo object.

modifiedBy

actor
The actor that last modified the entity

modifiedOn

dateTime
The date when entity was last modified

name

string
Name of the entity.

parent

entity
The parent for this entity.

path

string
The path to where this Workspace is located.

policies

policy[]
Policies of the scope.

primaryContact

accessor
The user that serves as the primary contact for this Workspace.

properties

collabProperties
Properties of the scope.

publicSummaryURI

string
The URI for the public Workspace summary. If the public summary is stored as a Workspace Artifact, the URI will be a URN with the CollabId of the summary Artifact (e.g. urn:120E:486C:adoc:2BA76E50A4FC4974E040578CBC010F900000000000EF). If the public summary is stored externally to the Beehive system, the URI will be a regular URL (e.g. http://myserver.com/mypages/summary.jsp).
The urn of an internally stored public summary will reference an Artifact of type Document. Consumers of the summary can load the corresponding Document to get its path if they need to build a full URL for their clients. If a Document currently used as a public summary is deleted from the system, the Workspace service will still return its CollabId in the summary URI. In other words, the Workspace service will not track the life-cycle of the summary object.
If a public summary Artifact is provided in the Template used to instantiate a Workspace, the Workspace public summary URI will be initialized to a URN with the CollabId of the created public summary Artifact. By default, the summary Artifact is created under a "Summary" Folder in the Workspace and named "public_summary.html". The ACLs on the public summary Artifact are initialized based on whether the Workspace is listed in the public directory. If so, the public summary will be readable by all; if not, it will be initialized as a regular summary. After the instantiation, Workspace coordinators are responsible for managing the summary ACLs appropriately. Changes to the whether the Workspace is listed in the directory will not automatically result into ACL changes on the public summary Artifact.

In both the internal as well as the external Workspace summary case, the Workspace service will never parse, execute, or, in general, process the bytes addressed by this URI.

quotaConfiguration

quotaConfiguration
QuotaConfiguration of the scope.

quotaStatus

quotaStatus
The QuotaStatus of the workspace. It can be one of the following: normal, quota threshold reached, soft quota reached, hard quota reached.

shortWorkspaceId

int
The short ID of this Workspace. It is used to determine rack affinity.

snapshotId

string
Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.

summaryURI

string
The URI for the Workspace Summary. If the Workspace summary is stored as a Workspace Artifact, the URI will be a URN with the CollabId of the summary Artifact (e.g. urn:120E:486C:adoc:2BA76E50A4FC4974E040578CBC010F900000000000EF). If the summary is stored externally to the Beehive system, the URI will be a regular URL (e.g. http://myserver.com/mypages/summary.jsp).
The URN of an internally stored summary will reference an Artifact of type Document. Consumers of the summary can load the corresponding Document to get its path if they need to build a full URL for their clients. If a Document currently used as a Workspace summary is deleted from the system, the Workspace service will still return its CollabId in the summary URI. In other words, the Workspace service will not track the life-cycle of the summary object.
If a summary Artifact is provided in the Template used to instantiate a Workspace, the Workspace summary URI will be initialized to a URN with the CollabId of the created summary Artifact. By default, the summary Artifact is created under a "Summary" folder in the Workspace and named "summary.html". The ACLs on the summary Artifact are initialized to allow Workspace viewers to read it and Workspace coordinators to modify it. After the instantiation, Workspace coordinators are responsible for managing the summary ACLs appropriately. Only Workspace coordinators will be able to update the URI of the Workspace summary.

In both the internal as well as the external Workspace summary case, the Workspace service will never parse, execute, or, in general, process the bytes addressed by this URI.

trash

trash
The Trash Folder of this Workspace, where items in the Workspace are placed after they are deleted but before they are purged.

workspaceOwner

accessor
The user that owns the Workspace.

workspaceTemplate

workspaceTemplate
The template used to create this Workspace.

Hierarchy

workspace is an abstract type. It cannot directly be used. Rather, one of its subtypes must be used

Inherits From

Inherited By

Referenced By Representaions