Oracle® Beehive RESTful Web Services API Reference Release 2 (2.0.1.7) E16658-04 |
The Workspaces and Folders category enables you to control Oracle Beehive's Workspace Service. This service is responsible for consolidating and exposing, in a single location, the collaborative functionality provided by the other Oracle Beehive services.
Refer to the module "Oracle Beehive Workspace Concepts" in Oracle Beehive Concepts in Oracle Beehive Documentation Library for more information.
Oracle Beehive has two kinds of workspaces: team workspaces and personal workspaces. A personal workspace contains a user's own resources such as his or her calendar and inbox. A personal workspace exists for each user. Unlike a team workspace, it cannot be created or deleted outside user creation or deletion.
The following topics are covered:
Because team workspaces are usually the key starting point for Oracle Beehive RESTful Web Services operations, it is generally useful to implement a way to list them in your Oracle Beehive RESTful Web Services client.
Use the POST method /wstm/list
to obtain a list of team workspaces for the current logged in user. You have the several options when retrieving a user's team workspaces:
Retrieve a full projection: Calling the GET method /wstm/{id}?projection=FULL
retrieves all the information stored in the workspace identified by {id}
so that you have direct access to the EIDs of all the folders contained in the workspace. The drawback to this option is that a lot of information is retrieved at once; it may be time consuming if you need to retrieve many workspaces and most of the information retrieved may not be used.
Retrieve a directory projection: Calling the GET method /wstm/{id}?projection=DIRECTORY
retrieves less information than the full projection but enough information to identify the workspace identified by {id}
. When a user selects this workspace, that user can retrieve a fuller projection of the same workspace. Call the GET method /wstm/{id}?projection=FULL
.
The workspace object contains the URI of the workspace's logo, logoURI
, which you may set through Oracle Beehive RESTful Web Services and other Oracle Beehive user interfaces. If the logo is stored as a workspace artifact, the URI is a URN with the identifier of the logo artifact (for example, urn:120E:486C:adoc:2BA76E50A4FC4974E040578CBC010F900000000000EF
). The URN is a reference to an artifact of type Document. To retrieve this document, call the adoc
resource with this identifier without the urn
prefix. This document is stored in the public folder of the team workspace. This enables other team workspaces whose directorylisted
flag set to y
to display the logo to non-participants.
If the logo is stored outside the Oracle Beehive system, the URI is a regular URL that refers to an image (for example, http://myserver.com/mypages/mylogo.jpg
).
To add participants to a team workspace, including during creation of a team workspace, specify the participants in the participants
member (of type workspaceParticipantListUpdater
) in teamWorkspaceUpdater
.
The following steps outline how to program a simple workspace Oracle Beehive RESTful Web Services client that can create a team workspace:
/my/workspace
./my/user
./ttws/list/?parent=
<EID of parent of the user object>
.TeamWorkspaceCreator
(either in JSON or XML format):
name
property.Specify the team workspace template you want to use in the templateInstantiator
property.
Note: If you do not specify a template, a team workspace is created with the default template.
TeamWorkspaceUpdater
and attach it to your TeamWorkspaceCreator
. Optionally set the Description
property in the TeamWorkspaceUpdater
.TeamWorkspaceCreator
JSON or XML to /wstm
.
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices