54 Integrating with Oracle WebCenter Spaces

54.2.4.1 Verifying That WebCenter Spaces Is Up and Running

If you want to use the WebCenter SpacesAPIs, the WebCenter Spaces application must be up and running.

To verify that WebCenter Spaces is up and running:

1. Start WebCenter Spaces. The URL is:

   http://host:port/webcenter
   

   You do not need to log in.

2. Verify that the WebCenter Spaces Web service is up and running. The URL is:

   http://host:port/webcenter/SpacesWebService?WSDL
   

   You should see a page similar to the one shown in Figure 54-6. If you do not see this page, contact your Fusion Middleware administrator.

   Figure 54-6 SpacesWebService WSDL

   
   Description of "Figure 54-6 SpacesWebService WSDL"
   
   

For more information about setting up WebCenter Spaces, see the "Getting WebCenter Spaces Up and Running" chapter in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

54.2.4.2 Setting Up the WebCenter Portal Application to Use WebCenter Spaces APIs

Before you can call the WebCenter Spaces APIs in your WebCenter Portal application, you must ensure that your application contains the correct libraries and that there is a connection to the WebCenter Spaces Web service.

To set up your application to use the WebCenter Spaces APIs:

1. Start JDeveloper.

2. In the Application Navigator, expand the application for which you want to provide Space functionality.

   The application should be based on the WebCenter Application template.

3. Right-click the view-controller project and choose Project Properties.

4. Select Libraries and Classpath.

5. Check that the following libraries are available in your project, adding any as necessary:

   • ADF DVT Faces Runtime

   • ADF Model Generic Runtime

   • ADF Model Runtime

   • JAX-RPC Client

   • JAX-WS Client

   • JAXB

   • Oracle JEWT

   • WebCenter Spaces Client

   • JDEV_HOME/jdeveloper/oracle_common/modules/oracle.adf.model_11.1.1/adfm.jar

   • JDEV_HOME/jdeveloper/oracle_common/modules/oracle.xdk_11.1.1/xml.jar

6. Click OK.

7. In the Application Resources panel of the Application Navigator, right-click Connections and choose New Connection > URL.

8. In the Name field, enter SpacesWebServiceEndpoint.

9. In the URL Endpoint field, enter the WebCenter Spaces Web service URL:

   http://host:port/webcenter/SpacesWebService
   

10. Click OK.

    The connection information is added to the connections.xml file in the application's META-INF directory, for example:

    C:\JDeveloper\mywork\mySpacesApplication\.adf\META-INF
    

    If the connections.xml file does not exist, it is created.

11. Open the connections.xml file and verify that the code shown in Example 54-1 appears:

    Example 54-1 WebCenter Spaces Web Service Endpoint URL Connection

    <Reference name="SpacesWebServiceEndpoint"
    className="oracle.adf.model.connection.url.HttpURLConnection">
    <Factory className="oracle.adf.model.connection.url.URLConnectionFactory"/>
    <RefAddresses>
      <XmlRefAddr addrType="SpacesWebServiceEndpoint">
        <Contents>
          <urlconnection name="SpacesWebServiceEndpoint"
          url="http://host:port/webcenter/SpacesWebService"/>
        </Contents>
      </XmlRefAddr>
    </RefAddresses>
    </Reference>
    

    If you need to set the WebCenter Spaces Web service endpoint at runtime, you can use the setGroupSpaceWebServiceEndpoint API (Example 54-2). You can write a wrapper API that takes the endpoint as a parameter and then calls setGroupSpaceWebServiceEndpoint, passing the parameter. An exception is reported as INFO in the log file if the endpoint is not set in connections.xml.

    Example 54-2 Setting the WebCenter Spaces Web Service Endpoint at Runtime

    client.setGroupSpacesWebServiceEndpoint("http://myserver.example.com/webcenter/SpacesWebService");
    

54.2.4.3 Securing the Connection Between the Application and WebCenter Spaces

Before using the WebCenter Spaces APIs in your WebCenter Portal application, you must ensure that the communication between the application (the consumer) and WebCenter Spaces (the producer) is secure. This is so that the identity of the user invoking the APIs is propagated to WebCenter Spaces in a secure manner where the integrity and confidentiality of the communication is maintained.

To do this, the WebCenter Spaces APIs use a policy of SAML based token passing with message protection. Your administrator must create a Java keystore and update the credential store so that WebCenter Spaces can verify the authenticity of the security tokens received from your application. You must then register this keystore and update the credential store using JDeveloper.

For information about the steps that the administrator must perform, see "Securing WebCenter Spaces for Applications Consuming Spaces Client APIs with WS-Security" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

54.2.4.4 Setting Up the WebCenter Spaces Client Context

Before calling any of the WebCenter Spaces APIs in your application code, a few setup steps are required.

To set up the WebCenter Spaces client context

1. Domain-wide configuration settings are used when you call WebCenter Spaces APIs from an application deployed on WebLogic Server (WLS), unless you specifically choose to override them. To override or set security configuration parameters, use the APIs provided by the GroupSpaceWSContext class.

   In particular, you must set the SAML issuer name and the public key alias for WebCenter Spaces, which are required for data encryption. If the WebCenter Spaces Web service endpoint is not set in the connections.xml file, you can set this too.

   For example:

   GroupSpaceWSContext context = new GroupSpaceWSContext();
   
   context.setEndPoint("endPointUrl");
   context.setSamlIssuerName("samlIssuer");
   context.setRecipientKeyAlias("producer");
   
   groupSpaceWSClient = new GroupSpaceWSClient(context);
   

   Where:

   • endPointUrl is the WebCenter Spaces Web service endpoint, for example, http://server.example.com:8912/webcenter/SpacesWebService.

   • samlIssuer is the issuer URI of the SAML Authority issuing assertions for this SAML Asserting Party, for example, http://www.oracle.com. Out-of-the-box, http://www.oracle.com is the only trusted SAML issuer.

   • producer is the public key alias for WebCenter Spaces, for example, orakey if you are using a simple topology.

     For information about the steps that the administrator must perform, see "Securing WebCenter Spaces for Applications Consuming Spaces Client APIs with WS-Security" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

   For a full list of the APIs provided by the GroupSpaceWSContext class, see the Oracle Fusion Middleware Java API Reference for Oracle WebCenter.

2. Initialize the WebCenter Spaces client by passing the context. For example:

   GroupSpaceWSClient client = new GroupSpaceWSClient(context);
   

3. Once you have initialized the client, check everything is set up correctly by calling:

   getWebCenterSpacesURL();
   

   If the correct URL is returned, everything is set up correctly and you can start using the WebCenter Spaces APIs.

54.2.5.1 Managing Spaces and Space Template

Use the following WebCenter Spaces APIs to manage your Spaces and Space templates:

• createGroupSpace

• setCustomAttribute

• createGroupSpaceTemplate

• deleteGroupSpace

Before you begin

Before using any of these APIs, you must complete all the steps listed in Section 54.2.4, "How to Set Up Your WebCenter Portal Application to Use the WebCenter Spaces APIs."

This section includes the following subsections

• Creating a Space

• Creating a Custom Attribute

• Creating a Space Template

• Deleting a Space

//create the Space
GroupSpaceWSMetadata gsMetadata = 
client.createGroupSpace("Databases", "Databases" "A community for people interested in databases", "databases, oracle", "CommunityofInterest");
//print the Space GUID to provide confirmation of creation
System.out.println("GUID: " + gsMetadata.getGuid());

//create the Space
client.createGroupSpace("Databases", "Databases", "A community for people interested in databases", null, "CommunityofInterest");
//create the custom attribute
client.setCustomAttribute("Databases", "Vendors", "List of vendors", "java.lang.String", "Oracle, IBM");

GroupSpaceWSMetadata templMetadata =
client.createGroupSpaceTemplate("DatabasesTemplate", "Databases Template", 
"A template based on the Databases Space", "Databases");
//print the template GUID to provide confirmation of creation
System.out.println("GUID: " + templMetadata.getGuid());

//delete the Space
Boolean success = client.deleteGroupSpace("Databases");
//print a message depending on the result of the deletion
if(success)
{
  System.out.println("Operation Succeeded");
}
else
{
  System.out.println(Operation Failed");
}

54.2.5.2 Managing Space Membership

Use the following WebCenter Spaces APIs to manage Space membership:

• addMember

• inviteMember

• removeMember

• getRoles

Before you begin

Before using any of these APIs, you must complete all the steps listed in Section 54.2.4, "How to Set Up Your WebCenter Portal Application to Use the WebCenter Spaces APIs."

This section includes the following subsections:

• Adding Members to a Space

• Inviting Users to Join a Space

• Removing Members from a Space

• Retrieving Role Information

//create the list of users
List addMem = new ArrayList();
//create the GroupSpaceWSMembers objects
GroupSpaceWSMembers mem1 = new GroupSpaceWSMembers("pat", "Viewer");
GroupSpaceWSMembers mem2 = new GroupSpaceWSMembers("vicki", "Participant");
GroupSpaceWSMembers grp1 = new GroupSpaceWSMembers("Sales", "Viewer");
grp1.setGroup(true);
GroupSpaceWSMembers grp2 = new GroupSpaceWSMembers("Marketing", Viewer");
grp2.setGroup(true);
//add the GroupSpaceWSMembers objects to the list of users
addMem.add(mem1);
addMem.add(mem2);
addMem.add(grp1);
addMem.add(grp2);
//add the users to the Space
client.addMember("Databases", addMem);
//print a list of members to confirm the new members were added
GroupSpaceWSMetadata memMetData = client.getGroupSpaceMetadata("Databases");
for (GroupSpaceWSMembers mems: memMetData.getMembers())
{
  System.out.println(mems.getMember());
  System.out.println(mems.getRole());
}

//create the list of users
List inviteMem = new ArrayList();
//create the GroupSpaceWSMembers objects
GroupSpaceWSMembers mem1 = new GroupSpaceWSMembers("pat", "Viewer");
GroupSpaceWSMembers mem2 = new GroupSpaceWSMembers("vicki", "Participant");
//add the GroupSpaceWSMembers objects to the list of users
inviteMem.add(mem1);
inviteMem.add(mem2);
//invite the list of users to join the Space
client.inviteMember("Databases", inviteMem);

//create the list of users
List remMem = new ArrayList();
//create the GroupSpaceWSMembers objects
GroupSpaceWSMembers mem1 = new GroupSpaceWSMembers("pat");
GroupSpaceWSMembers mem2 = new GroupSpaceWSMembers("vicki");
2 lines
//add the GroupSpaceWSMembers objects to the list of users
remMem.add(mem1);
remMem.add(mem2);

//remove the users from the Space
client.removeMember("Databases", remMem);
//print a list of members to confirm the members were removed
GroupSpaceWSMetadata memMetData = client.getGroupSpaceMetadata("Databases");
for (GroupSpaceWSMembers mems: memMetData.getMembers())
{
  System.out.println(mems.getMember());
  System.out.println(mems.getRole());
}

//retrieve the list of roles
List<String> roles = client.getRoles("Databases");
//print the list of roles
for (String role: roles)
{
  System.out.println(role);
}

54.2.5.3 Retrieving Information for Spaces and Space Templates

Use the following WebCenter Spaces APIs to retrieve Space information:

• getGroupSpaces

• getPublicGroupSpaces

• getDiscoverableGroupSpaces

• getGroupSpaceMetadata

• getGroupSpaceMetadataByGuid

• getGroupSpaceTemplates

• getGroupSpaceTemplateMetadata

• getGroupSpaceTemplateMetadataByGuid

• getWebCenterSpacesURL

• getGroupSpaceURL

Before you begin

Before using any of these APIs, you must complete all the steps listed in Section 54.2.4, "How to Set Up Your WebCenter Portal Application to Use the WebCenter Spaces APIs."

This section includes the following subsections

• Retrieving a List of Spaces

• Retrieving a List of Public Spaces

• Retrieving a List of Discoverable Spaces

• Retrieving Space Metadata

• Retrieving a List of Space Templates

• Retrieving Space Template Metadata

• Retrieving the WebCenter Spaces URL

• Retrieving a Space URL

• Retrieving RSS Feed URLs for Space Services

List<String> allGroupSpaces = client.getGroupSpaces("Database");

List<String> allGroupSpaces = client.getGroupSpaces(null)

List<String> allPublicGroupSpaces = client.getPublicGroupSpaces("Database");

List<String> allPublicGroupSpaces = client.getPublicGroupSpaces(null)

List<String> allDiscoverableGroupSpaces = client.getDiscoverableGroupSpaces("Database");

List<String> allDiscoverableGroupSpaces = client.getDiscoverableGroupSpaces(null)

getGroupSpaceMetadata("spaceName").getGuid();

//get the exact name of the Space
List<String> myGroupSpace = client.getGroupSpaces("Databases");
//check that the API returns a single result
if(myGroupSpace.size() == 1)
{
  //retrieve the metadata
  GroupSpaceWSMetadata metadata = client.getGroupSpaceMetadata(myGroupSpace);
  //get Space description
  System.out.println("Description: " + metadata.getDescription());
  //get Space keywords
  System.out.println("Keywords: " + metadata.getKeywords());
  //get the date the Space was last updated
  System.out.println("Last Updated Date: "+ metadata.getLastUpdated().toString());
}

GroupSpaceWSMetadata metadata = client.getGroupSpaceMetadataByGuid("Guid");
//get Space display name
System.out.println("Display Name: " + metadata.getDisplayName());
//get the name of the user who created the Space
System.out.println("Created By: " + metadata.getCreatedBy());
//get the date the Space was last updated
System.out.println("Last Updated Date: " + metadata.getLastUpdated().toString());

//get the exact name of the Space
List<String> myGroupSpace = client.getGroupSpaces("Databases");
//check that the API returns a single result
if(myGroupSpace.size() == 1)
{
  //retrieve the metadata
  GroupSpaceWSMetadata metadata = client.getGroupSpaceMetadata(myGroupSpace);
  //get list of custom attributes
  List<GSCustomMetadata.Attribute> attributes = metadata.getCustomAttributes();
  //get name, description, type, and value for each custom attribute
  for(GSCustomMetadata.Attribute attribute: attributes)
  {
    System.out.println("Name :" + attribute.getName());
    System.out.println("Description :" + attribute.getDescription());
    System.out.println("Type :" + attribute.getType());
    System.out.println("value.toString() :" + attribute.getValue().toString());
  }
}

//get the exact name of the Space
List<String> myGroupSpace = client.getGroupSpaces("Databases");
//check that the API returns a single result
if(myGroupSpace.size() == 1)
{
  //retrieve the metadata
  GroupSpaceWSMetadata metadata = client.getGroupSpaceMetadata(myGroupSpace);
  //get the list of members
  for(String member: metadata.getMembers())
  {
    System.out.println("Member UID: " + member);
  }
}

List<String> allGroupSpaceTemplates = client.getGroupSpaceTemplates("Interest");

List<String> allGroupSpaceTemplates = client.getGroupSpaceTemplates(null);

GroupSpaceWSMetadata metadata = client.getGroupSpaceTemplateMetadata(myGroupSpaceTemplate);
//get the exact name of the Space template
List<String> myGroupSpaceTemplate = client.getGroupSpaceTemplates("CommunityofInterest");
//check that the API returns a single result
if(myGroupSpaceTemplate.size() == 1)
{
  //retrieve the metadata -- get GUID
  System.out.println("GUID: " + metadata.getGuid());
  //get template description
  System.out.println("Description: " + metadata.getDescription());
  //get name of user who created the template
  System.out.println("Keywords: " + metadata.getCreatedBy());
}

GroupSpaceWSMetadata templGuidMetadata = client.getGroupSpaceTemplateMetadataByGuid("Guid");
System.out.println("Template Name: " + templGuidMetadata.getName());

String myWebCenterSpacesURL = client.getWebCenterSpacesURL();

String myGroupSpaceURL = client.getGroupSpaceURL("Databases");

//get the list of Spaces
List<String> spaces = client.getGroupSpaces("");
//print the list of Spaces as hyperlinks
for (String spaceName : spaces)
{
  print("<a href =""" + client.getGroupSpaceURL(spaceName) + "">" + spaceName + "</a><br>");
}

String service_URL = client.getServiceRSSFeedURL("groupspace_name",service_ID);

String recentActivityURL = client.getServiceRSSFeedURL("Finance_Project", GroupSpaceWSClient.RECENT_ACTIVITY_SERVICE_ID);

String service_URL = client.getServiceRSSFeedURLbyGuid("groupspace_GUID",service_ID);

String recentActivityURL = client.getServiceRSSFeedURLbyGuid("s2201fa44_b441_4bdd_950e_47307f6f9800", GroupSpaceWSClient.RECENT_ACTIVITY_SERVICE_ID);

54.2.6.1 Providing Localized Error Messages

Sometimes you may find that the default error messages provided by the APIs are not specific enough for your particular application. In these cases you can provide your own error messages.

Use the getLocalizedMessage API to compose application-specific error messages.

Example 54-30 shows a servlet that includes code to create a Space. If any exceptions are raised during the creation process, a localized message is printed.

servlet1.java

doGet()
{
...
  print("<b>Output</b>");
  try
    {
      GroupSpaceWSClient client = new GroupSpaceWSClient(context);
      client.createGroupSpace("Databases", "Databases, "A community for people interested in databases", "databases, oracle", "CommunityofInterest");
      print("Successfully created Space");
    }
  catch(GroupSpaceWSException ex)
    {
      if(ex instanceof GroupSpaceNameNullException)
        print(ex.getLocalizedMessage());
      else if (ex instanceof GroupSpaceDescNullException)
        print(ex.getLocalizedMessage());
    }
...
}

54.2.6.2 Listing the Error Stack

For debugging purposes, it is often useful to see which errors ultimately led to the failure of a particular operation to discover the underlying cause of the problem. Use the printStackTrace API to list all the errors that caused a particular exception.

Example 54-31 prints the exception and all the errors leading up to it.

servlet1.java

doGet()
{
...
  print("<b>Output</b>");
  try
    {
      GroupSpaceWSClient client = new GroupSpaceWSClient(context);
      client.createGroupSpace("Databases", "Databases", "A community for people interested in databases", "databases, oracle", "CommunityofInterest");
      print("Successfully created Space");
    }
  catch(GroupSpaceWSException ex)
    {
      ex.printStackTrace();
    }
...
}

54.3.4.1 urn:oracle:webcenter:spaces

Use this resource type to identify the URI to use to view a list of Spaces (GET) and to create a new Space (POST). The response from a GET operation includes each Space, and each Space includes links to operate on that Space.

Navigation Paths to spaces

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces

Supported Methods for spaces

The following methods are supported by this resource:

• GET – Returns information on all Spaces.

  • request - body: None

  • query parameters:

    • startIndex

    • itemsPerPage

    • projection - Allowed values are summary and details. The default is summary.

    • visibility - Determines which Spaces are included in the list: all Spaces, public Spaces only, joined Spaces, or discoverable Spaces.

      Allowed values are all, public, joined and discoverable. The default is joined.

  • response - body: collection of Spaces

• POST – Creates a new Space.

  • request - body: space

    <space>
       <name>aName</name>
       <description>aDescription</description>
       <templateName>aTemplate</templateName>
    </space>
    

    Note:

    The templateName parameter must be a valid template name returned from urn:oracle:webcenter:spaces:resource:templates. For example, the default template names are:

    Basic
    CommunityOfInterest
    ProjectSpace
    

Resource Types Linked to from spaces

Table 54-6 lists the resource types that the client can link to from this resource.

54.3.4.2 urn:oracle:webcenter:spaces:resource:templates

Use this resource type to identify the URI to use to retrieve a list of Space templates (GET). The response from a GET operation includes a list of template names. The main purpose of retrieving template names is to provide a value for the templateName parameter for the create Space command.

Navigation Paths to templates

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      resource
         templates

Supported Methods for templates

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters:

    • startIndex

    • projection - Allowed values are summary and details. The default is summary.

    • q - Performs searches.

    • itemsPerPage

  • response - body: list of template names

For more information about query parameters, see Section 55.6.2.5, "Templates."

Resource Types Linked to from templates

Table 54-7 lists the resource types that the client can link to from this resource.

54.3.4.3 urn:oracle:webcenter:space

Use this resource type to identify the URI to use to view details for a single Space (GET), create a nested Space (POST), or delete a Space (DELETE). The response from a GET operation includes the specific Space identified by the URI, including its creator, description, members, and custom attributes.

Navigation Paths to space

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      space

Supported Methods for space

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters:

    • projection - Allowed values are summary, and details. The default is details. Choose summary to exclude member and custom attribute details.

  • response - body: Space

• POST – Creates a new Space that is a child of the named Space. This feature supports creating hierarchical or nested Spaces.

  • request - body: Space

    <space>
       <name>FooSpace</name>
       <description>foobar</description>
       <templateName>CommunityOfInterest</templateName>
    </space>
    

    Note:

    The templateName parameter must be a valid template name returned from urn:oracle:webcenter:spaces:resource:templates. For example, the default template names are:

    Basic
    CommunityOfInterest
    ProjectSpace
    

• DELETE – Deletes the named Space.

  • request - body: None

    On delete, a 204 status code is returned whether or not the Space existed.

For more information about query parameters, see Section 55.6.2.5, "Templates."

Writable Elements for space

Table 54-8 lists the writable elements for this resource.

Basic
CommunityOfInterest
ProjectSpace

Read-only Elements for space

Table 54-9 lists the read-only elements for this resource.

Resource Types Linked to from space

Table 54-10 lists the resource types that the client can link to from this resource.

54.3.4.4 urn:oracle:webcenter:space:resourceindex

Use this resource type to identify the URI to use to view the WebCenter Spaces resource index.

Navigation Paths to resourceindex

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      space

Supported Methods for resourceindex

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters: None

  • response - body: resource index

Resource Types Linked to From resourceindex

Table 54-11 lists the resource types that the client can link to from this resource.

54.3.4.5 urn:oracle:webcenter:space:roles

Use this resource type to get a list of roles for the named Space (GET). The results returned from this call can be used to add a new member to a Space with urn:oracle:webcenter:space:members.

Navigation Paths to space:roles

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      space
         roles

Supported Methods for roles

The following methods are supported by this resource:

• GET – Returns the list of roles assigned to the named Space.

Resource Types Linked to from roles

Table 54-12 lists the resource types that the client can link to from this resource.

54.3.4.6 urn:oracle:webcenter:space:role

Use this resource type to get a named role (GET).

Use this resource type to get a list of roles for the named Space (GET). The results returned from this call can be used to add a new member to a Space with urn:oracle:webcenter:space:members.

Navigation Paths to space:role

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      space
         role

Supported Methods for role

The following methods are supported by this resource:

• GET – Returns the named role.

Resource Types Linked to from role

Table 54-12 lists the resource types that the client can link to from this resource.

54.3.4.7 urn:oracle:webcenter:space:icon

Use this resource type to get the icon used for the named Space (GET).

Navigation Paths to space:icon

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      space
         icon

Supported Methods for icon

The following methods are supported by this resource:

• GET – Returns the icon used for the named Space.

Resource Types Linked to from icon

Table 54-12 lists the resource types that the client can link to from this resource.

54.3.4.8 urn:oracle:webcenter:space:attributes

Use this resource type to identify the URI to use to view a list of custom attributes defined for a Space (GET). The response from a GET operation includes each custom attribute for the Space, and each attribute includes links to operate on that attribute. Also use this resource type to add custom attributes to a Space (POST).

Navigation Paths to attributes

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      space
         attributes

Supported Methods for attributes

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters: None

  • response - body: collection of attributes

• POST – Adds a custom attribute to the named space.

  • request - body:

    <attribute>
       <name>anAttribute</name> 
       <value>aValue</value>
    </attribute>
    

Writeable Elements for attributes

Table 54-15 lists the writeable elements for this resource.

Resource Types Linked to From attributes

Table 54-16 lists the resource types that the client can link to from this resource.

54.3.4.9 urn:oracle:webcenter:space:attribute bill

Use this resource type to identify the URI to use to view the name and value of single Space attribute (GET). The response from a GET operation includes the specific attribute identified by the URI.

Navigation Paths to attribute

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      space
         attributes

Supported Methods for attribute

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters: None

  • response - body: attribute

Read-only Elements for attribute

Table 54-17 lists the read-only elements for this resource.

Resource Types Linked to From attribute

Table 54-18 lists the resource types that the client can link to from this resource.

54.3.4.10 urn:oracle:webcenter:space:members

Use this resource type to identify the URI to use to view a list of members for the Space (GET). The response from a GET operation includes each member of the Space, each member includes links to operate on that member.

Navigation Paths to members

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      space

Supported Methods for members

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters: None

  • response - body: collection of members

• POST – Adds a member to the Space.

  • request - body: member

  <member>
      <name>vicki</name>
      <role>Participant</role>
  </member>
  

• DELETE – Removes the named member from the Space. You can obtain the member guid with urn:oracle:webcenter:space:member.

  • request - body: None

  DELETE
  http://hostname:portnum/rest/api/spaces/spacename/members/member_guid
  

Writeable Elements of spaces:space:members

Resource Types Linked to From members

Table 54-20 lists the resource types that the client can link to from this resource.

54.3.4.11 urn:oracle:webcenter:space:member

Use this resource type to identify the URI to use to view details for a Space member and their current role assignments (GET). The response from a GET operation includes the specific member identified by the URI, including a hyperlink to the member's profile.

Navigation Paths to member

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      space
         members

Supported Methods for member

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters: None

  • response - body: member

Read-only Elements for member

Table 54-21 lists the read-only elements for this resource.

Resource Types Linked to From member

Table 54-22 lists the resource types that the client can link to from this resource.

54.3.4.12 urn:oracle:webcenter:space:lists

Use this resource type to identify the URI to use to view (GET) and add (POST) lists for the Space. The response from a GET operation includes each list in the Space, and each list includes links used to operate on that list. The response from a POST operation includes the list that was created in this collection of lists and a link to operate on that list.

Navigation Paths to lists

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      resourceindex
      space
         lists

Supported Methods for lists

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters:

    • startIndex

    • itemsPerPage

    • q

      You can search on name, title, description, creator, created, modifier, and modified.

      For string type elements (that is, name, title, description, creator, and modifier), you can use the following supported operands: equals, not.equals, and contains. For example:

      q=name:contains:issues
      q=creator:equals:monty
      

      For date type elements (that is, created and modified), you can use the following supported operands: equals, not.equals, greater.than, greater.than.or.equals, less.than, less.than.or.equals. For example:

      q=created:greater.than:10-SEP-2009
      

    • projection - Allowed values are summary and details. The default is summary.

  • response - body: collection of lists

• POST

  • request - body: list

  • response - body: list

For more information about query parameters, see Section 55.6.2.5, "Templates."

Resource Types Linked to From lists

Table 54-23 lists the resource types that the client can link to from this resource.

54.3.4.13 urn:oracle:webcenter:space:list

Use this resource type to identify the URI to use to view (GET), update (PUT), and delete (DELETE) a list belonging to a Space. The response from a GET operation includes the specific list identified by the URI. The response from a PUT operation includes the modified version of the list identified by the URI. The response to a DELETE operation is a 204 status code.

Navigation Paths to list

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      resourceindex
         lists
             list

Supported Methods for list

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters: None

  • response - body: list

• PUT

  • request - body: list

  • response - body: list

• DELETE

  • request - body: None

  • response - body: None

Writable Elements for list

Table 54-24 lists the writable elements for this resource.

Read-only Elements for list

Table 54-25 lists the read-only elements for this resource.

Resource Types Linked to From list

Table 54-26 lists the resource types that the client can link to from this resource.

54.3.4.14 urn:oracle:webcenter:space:list:rows

Use this resource type to identify the URI to use to view (GET) and create (POST) list rows (list items). The response from a GET operation includes each row in this list, each row includes links to operate on that row. The response from a POST operation includes the row that was created in this list and a link to operate on that row.

Navigation Paths to rows

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      resourceindex
        lists
           list
              rows 

Supported Methods for rows

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters:

    • startIndex

    • itemsPerPage

    • q

      You can search on name, title, description, creator, created, modifier, and modified.

      For string type elements (that is, name, title, description, creator, and modifier), you can use the following supported operands: equals, not.equals, contains, and starts.with. For example:

      q=name:contains:issues
      q=creator:equals:monty
      

      For date type elements (that is, created and modified), you can use the following supported operands: equals, not.equals, greater.than, greater.than.or.equals, less.than, less.than.or.equals. For example:

      q=created:greater.than:10-SEP-2009
      

  • response - body: collection of rows

• POST

  • request - body: row

  • response - body: row

For more information about query parameters, see Section 55.6.2.5, "Templates."

Resource Types Linked to From rows

Table 54-27 lists the resource types that the client can link to from this resource.

54.3.4.15 urn:oracle:webcenter:space:list:row

Use this resource type to identify the URI to use to view (GET), update (PUT), and delete (DELETE) a list row (list item). The response to a GET operation includes the specific row identified by the URI. The response to a PUT operation includes the modified version of the row identified by the URI. The response to a DELETE operation is a 204 status code.

Navigation Paths to row

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      resourceindex
         lists
            list 
              rows
                 row

Supported Methods for row

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters: None

  • response - body: row

• PUT

  • request - body: row

  • response - body: row

• DELETE

  • request - body: None

  • response - body: None

For more information about query parameters, see Section 55.6.2.5, "Templates."

Writable Elements for row

Table 54-28 lists the writable elements for this resource.

Read-only Elements for row

Table 54-29 lists the read-only elements for this resource.

Resource Types Linked to From row

Table 54-30 lists the resource types that the client can link to from this resource.

54.3.4.16 urn:oracle:webcenter:space:list:columns

Use this resource type to identify the URI to use to view (GET) and create (POST) list columns (list item detail). The response from a GET operation includes each column in this list, each column includes link to operate on that column. The response from a POST operation includes the column created in this list and a link to operate on that column.

Navigation Paths to columns

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      resourceindex
        lists
           list
              columns

Supported Methods for columns

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters:

    • startIndex

    • itemsPerPage

    • q - Search parameters STARTS.WITH and END.WITH are not supported.

  • response - body: collection of columns

• POST

  • request - body: column

  • response - body: column

For more information about query parameters, see Section 55.6.2.5, "Templates."

Resource Types Linked to From columns

Table 54-31 lists the resource types that the client can link to from this resource.

54.3.4.17 urn:oracle:webcenter:space:list:column

Use this resource type to identify the URI to use to view (GET), update (PUT), and delete (DELETE) a list column (list item detail). The response from a GET operation includes the specific column identified by the URI. The response from a PUT operation includes the modified version of the column identified by the URI. The response from a DELETE operation is a 204 status code.

Navigation Paths to column

This section shows how the client can navigate through the hypermedia to access this resource:

resourceindex
   spaces
      resourceindex
         lists
            list
               columns
                 column

Supported Methods for column

The following methods are supported by this resource:

• GET

  • request - body: None

  • query parameters: None

  • response - body: column

• PUT

  • request - body: column

  • response - body: column

• DELETE

  • request - body: None

  • response - body: None

Writable Elements for column

Table 54-32 lists the writable elements for this resource.

Read-only Elements for column

Table 54-33 lists the read-only elements for this resource.

Resource Types Linked to From column

Table 54-26 lists the resource types that the client can link to from this resource.