Overview

Resource WorkspaceUpdater is used to specify the fields to be updated when updating a Workspace.

Members

Show inherited members

Name Type Description

activePreferenceProfile

beeId<preferenceProfile>

Active PreferenceProfile of this scope.

defaultDocumentsFolder

beeId<heterogeneousFolder>

The Folder that serves as the default Documents/Library Folder for this Workspace. The HeterogeneousFolder specified as the default Documents Folder must be a direct child of this Workspace.

defaultSensitivity

beeId<sensitivity>

The default Sensitivity. By default, the default Sensitivity is specified in the template, and can be changed by a Workspace administrator.

defaultWikiFolder

beeId<heterogeneousFolder>

The Folder that contains the default Wiki for this Workspace. The HeterogeneousFolder specified as the default Wiki Folder must be a direct child of this Workspace.

defaultWikiPage

beeId<wikiPage>

Default wiki page for this workspace. Client can use this API to switch to a different wiki page.

description

string

Description of the scope

logoURI

string

The URI of the Workspace logo. If the Workspace 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 logo is stored externally to the Beehive system, the URI is expected to be a regular URL referring to an image (e.g. http://myserver.com/mypages/mylogo.jpg).
Only Workspace coordinators are able to change the logo URI.

Updates to the logo URI do not imply any ACL changes for the logo Artifact if it is stored within the Workspace.

name

string

Get the Name of the Entity

primaryContact

beeId<accessor>

The user who serves as the primary contact for the Workspace.

propertiesUpdater

collabPropertiesUpdater

CollabPropertiesUpdater which can be used to add or remove CollabProperties for this Scope.

publicSummaryURI

string

The URI of the Workspace public 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).
Only Workspace coordinators are able to change the summary public URI.

Updates to the summary public URI do not imply any ACL changes for the public summary Artifact if it is stored within the Workspace.

quotaConfiguration

workspaceQuotaConfiguration

The QuotaConfiguration for this Workspace, including the settings for soft and hard quota.

summaryURI

string

The URI of 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).
Only Workspace coordinators are able to change the Workspace summary URI.

workspaceOwner

beeId<accessor>

The owner of this Workspace. Changing the Workspace owner means: - the new owner will be added as a WorkspaceParticipants if he is not already a WorkspaceParticipant. - the new owner will be granted the Workspace coordinator role he does not already have it.

Hierarchy

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

Inherits From

Referenced By Representaions

Not Referenced Directly by Representations