Oracle® Beehive SOAP Web Services API Reference
Release 2 (2.0.1.7)
Show inherited members
ProjectionsName | Type | Required | Description |
---|---|---|---|
defaultAddressBook |
The default AddressBook of this Workspace, where the Workspace's Addresses are kept. | ||
defaultCalendar |
The default Calendar of this Workspace, where the Workspace's Events are stored. | ||
defaultConference |
The default Conference of this Workspace. | ||
defaultDocumentsFolder |
The Documents Folder, the default location for Documents within this Workspace. | ||
defaultSensitivity |
The default Sensitivity of this Workspace. | ||
defaultTaskList |
The default TaskList of this Workspace, where the Tasks in this Workspace are kept. | ||
defaultWikiFolder |
The Wiki Folder, the default location for the Wiki in this Workspace. | ||
defaultWikiPage |
The default WikiPage of this Workspace, which serves as the home page of this Workspace's Wiki. | ||
elements |
A List of the Folders contained under this Workspace. | ||
inbox |
The Inbox of this Workspace, a special Folder that stores the Workspace's incoming Messages. | ||
lastModifiedByName |
The name of the user who last modified this Workspace. | ||
locks |
lock[] |
A list of the Locks held on this Workspace. | |
logoURI |
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. |
||
path |
The path to where this Workspace is located. | ||
primaryContact |
The user that serves as the primary contact for this Workspace. | ||
publicSummaryURI |
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. |
||
quotaStatus |
The QuotaStatus of the workspace. It can be one of the following: normal, quota threshold reached, soft quota reached, hard quota reached. | ||
shortWorkspaceId |
The short ID of this Workspace. It is used to determine rack affinity. | ||
summaryURI |
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 |
The Trash Folder of this Workspace, where items in the Workspace are placed after they are deleted but before they are purged. | ||
workspaceOwner |
The user that owns the Workspace. | ||
workspaceTemplate |
The template used to create this Workspace. |
Inherits From
Inherited By