Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle WebCenter
11g Release 1 (11.1.1.4.0)

Part Number E10148-12
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

43 Integrating the Lists Service

This chapter provides an overview of the Lists service and describes how to integrate the Lists service with a WebCenter Portal application. It includes the following sections:

43.1 Introduction to the Lists Service

This section provides an overview of the Lists service features and requirements. It includes the following subsections:

43.1.1 Understanding the Lists Service

The Lists service provides a means of creating lists and exposing them for placement on application pages at runtime. At design time, you can make the Lists task flow available in your runtime Resource Catalog. At runtime, users can add the task flow from the Catalog to a page and use the task flow to create lists.

At design time, you can add a code snippet to the Resource Catalog to ensure that populated lists are added to the Catalog at runtime, making them available for placement on your application pages.

By default, only users assigned the seeded role Administrator have manage permission on lists. This means at runtime such users can create, edit, and delete lists and edit list data. The default permission can be changed at deployment in jazn-data.xml or by using Enterprise Manager or the Application Policy Manager. Authorized users can change this permission at runtime at the component level (for more information, see Chapter 23, "Modifying Default Security Behavior of Oracle Composer Components"). Only role-based permission is supported.

43.1.2 What Happens to the Lists Service at Runtime

At runtime, the Lists task flow provides controls for creating lists and adding list data. For information about these controls, see the sections, "Creating and Managing Lists," and "Adding and Managing List Data," in Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.

Tip:

To enable users to work with lists at runtime, they must be explicitly permitted to do so. For more information, see Section 43.2.3, "Enabling Users to Work with Lists at Runtime."

43.2 Basic Configuration for the Lists Service

This section describes the steps required for adding the Lists service to your application. It includes the following subsections:

43.2.1 Setting Up Connections for the Lists Service

The Lists service requires a connection to the database where the WebCenter schema is installed. The Lists service stores all list data in the database. For details about setting up a database connection to the database where the WebCenter schema is installed, see Section 7.2.2, "Setting Up a Database Connection."

Note:

For details about installing the database and the WebCenter schema, see Oracle Fusion Middleware Installation Guide for Oracle WebCenter.

43.2.2 Adding the Lists Service at Design Time

This section explains a basic integration of the Lists service. It includes the following subsections:

43.2.2.1 Lists Service Task Flows

The Lists service includes one task flow: Lists (Figure 43-1).

Figure 43-1 A List Rendered in the Lists Task Flow

A list rendered in the Lists task flow
Description of "Figure 43-1 A List Rendered in the Lists Task Flow"

For information about the Lists task flow, see Section 43.1.2, "What Happens to the Lists Service at Runtime."

43.2.2.2 How to Add the Lists Service to your Application

To add the Lists task flow to your WebCenter Portal application:

  1. Follow the steps described in Section 7.2, "Preparing Your WebCenter Portal Application to Consume Services." to implement security and create a new customizable page in your application.

  2. Create a JSF page on which to add the Lists task flow.

  3. Configure security on the page.

  4. In the Resource Palette, open My Catalogs, then WebCenter Services Catalog, then the Task Flows folder.

  5. Drag and drop the Lists task flow onto your page, and select Region from the context menu.

  6. Save and run your page to the browser.

43.2.3 Enabling Users to Work with Lists at Runtime

Out of the box, only the application administrator can work with lists. For users to see and work with lists at runtime, they must explicitly be granted, minimally, the permission ListPermission:view. At runtime, application administrators can assign this permission through the Role Manager task flow.

For example, to grant view access to lists to all authenticated users, the administrator can create the role AllUsers in the Role Manager task flow, add authenticated-role as a member, and grant view access on Lists.

If you plan to add the Lists service to your application, then you must also add the Role Manager task flow. If your application is based on a Portal Application Template, then the Role Manager task flow is available out of the box on the Security tab in Administration pages. At runtime, you can navigate to this page using the following URL:

http://host:port/appcontxtroot/faces/admin

Note:

Roles and permissions created and granted through the Role Manager at design time are not packaged in the application and are not available after deployment. The provisioning steps described in this section must be taken after deployment.

See Also:

For information about the Role Manager task flow, see Section 63.4, "Using the Role Manager Task Flow."

43.3 Adding Lists to a Resource Catalog

If properly configured, the Resource Catalog makes populated lists available at runtime, enabling authorized users to add them to pages in edit mode. The procedure for adding components to an existing resource catalog or creating a custom catalog are described in Chapter 15, "Creating and Managing Resource Catalogs." This section provides an example of a code snippet to use to add lists to a resource catalog (Example 43-1).

Note:

The values in uppercase are message keys for translated strings.

Example 43-1 Code to Add Lists to a Resource Catalog

<customFolder id="groupLists" visible="#{true}"
      factoryClass="oracle.webcenter.list.view.rc.ListServiceContextFactory">
   <attributes>
    <attribute value="LISTS_CUSTOM_FOLDER.TITLE" attributeId="Title"
      isKey="true"/>
    <attribute value="LISTS_CUSTOM_FOLDER.DESCRIPTION"
      attributeId="Description" isKey="true"/>
    <attribute value="LISTS_CUSTOM_FOLDER.KEYWORDS"
      attributeId="Subject" isKey="true"/>
    <attribute value="oracle.webcenter.list"
      attributeId="WEBCENTER_SERVICE_ID" isKey="false"/>
    <attribute value="/adf/webcenter/folderlists_qualifier.png"
      attributeId="IconURI"/>
   </attributes>
</customFolder>

43.4 Using the Lists Service REST APIs

Oracle WebCenter provides REST APIs to allow access to Lists functionality through interfaces other than the provided task flows. You can use the Lists service REST APIs to perform the following actions:

This section describes the REST APIs associated with the Lists service. It includes the following subsections:

See Also:

For an introduction to the REST APIs, see Chapter 51, "Using Oracle WebCenter REST APIs."

Before you can use REST APIs, you must take the steps outlined in Section 51.2, "Before You Begin: Performing Required Configurations."

43.4.1 Entry Point for Lists

To get to the REST entry point for lists in a WebCenter Spaces Space, you must navigate to a specific Space to see a link to lists in that Space. For all the lists in a Space, find the link elements with a resourceType of:

urn:oracle:webcenter:space:lists

The corresponding href or template element provides the URI entry point, which retrieves the lists in the Space.

See Also:

For more information about the Resource Index, see Section 51.6.1, "The Resource Index."

For more information about resource types, see Section 51.6.2.1, "Resource Type."

43.4.2 Lists Resource Type Taxonomy

When the client has identified the entry point, it can then navigate through the resource type taxonomy to perform the required operations. The resource type taxonomy for lists is:

urn:oracle:webcenter:space:lists
urn:oracle:webcenter:space:list
   urn:oracle:webcenter:space:list:rows
   urn:oracle:webcenter:space:list:row
   urn:oracle:webcenter:space:list:columns
   urn:oracle:webcenter:space:list:column

43.4.3 Lists Security Considerations

You must be logged in to the REST service to access any of the Lists REST APIs. After that, the underlying service handles permission checking.

See Also:

For general security considerations, see Section 51.9, "Security Considerations for WebCenter REST APIs."

43.4.4 Lists Resource Types

This section provides you with all the information you need to know about each resource type. It includes the following subsections:

43.4.4.1 urn:oracle:webcenter:space:lists

The lists response provides a means of retrieving the lists in a given Space (GET) and adding lists to a Space (POST). This section includes the following subsections:

43.4.4.1.1 Navigation Paths to lists

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

urn:oracle:webcenter:resourceindex
   urn:oracle:webcenter:spaces
      urn:oracle:webcenter:space:resourceindex
         urn:oracle:webcenter:space:lists
43.4.4.1.2 Supported Methods for lists

The lists resource type supports the following methods:

Method (lists): GET

This method retrieves the lists in a Space.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists?q=name:equals:ProjectIssues&utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: none

  • Request headers: [Accept = application/xml | application/json]

  • Request parameters - startIndex, itemsPerPage, q, projection

    • q parameter for query, format 'q=attribute:operator:value', for example:

      'q=name:equals:ProjectIssues'
      
      • Supported operators for Strings: equals, not.equals, contains, starts.with

      • Supported operators for Dates: equals, not.equals, greater.than, greater.than.or.equals, less.than, less.than.or.equals

      • May specify several conditions separated by semicolon (;)

  • Searchable attributes (Table 43-1)

    Table 43-1 Searchable Attributes for lists GET Method

    Element Type Description

    name

    string

    Name of list

    description

    string

    Description of list

    creator

    string

    User who created list

    created

    date

    Date the list was created

    modifier

    string

    User who modified list

    modified

    date

    Date the list was last modified


  • Response status: 200 [OK]

  • Response body: <lists>

  • Example:

    <lists resourceType="urn:oracle:webcenter:space:lists">
       <links>
          <link resourceType="urn:oracle:webcenter:list:lists" 
             rel="self" href="opaque"/>
          <link template="opaque?startIndex={startIndex}&
             itemsPerPage={itemsPerPage}&q={searchTerms}&
             projection={projection}
             &stoken=FDgsOu7a2NTTM1cLJvnpkDXfihtHx5Q*"          resourceType="urn:oracle:webcenter:list:lists"/>
       </links>
       <items>
          <list resourceType="urn:oracle:webcenter:space:list">
             <links>
                <link resourceType="urn:oracle:webcenter:list" rel="self" 
                   href="opaque" 
                   capabilities="urn:oracle:webcenter:update 
                   urn:oracle:webcenter:delete"/>
                <link resourceType="urn:oracle:webcenter:list:rows" 
                   href="opaque" 
                   capabilities="urn:oracle:webcenter:create"/>
                <link template="opaque?
                   startIndex={startIndex}&
                   itemsPerPage={itemsPerPage}&q={searchTerms}&
                   stoken=FDgsOu7a2NTTM1cLJvnpkDXfihtHx5Q*" 
                   resourceType="urn:oracle:webcenter:list:rows"/>
                <link resourceType="urn:oracle:webcenter:list:columns" 
                   href="opaque"
                   capabilities="urn:oracle:webcenter:create"/>
             </links>
             <id>/oracle/webcenter/list/scopedMD/
                se0dea180_e2c1_45ac_b08b_
                ba2c0b26aa72/lists/ProjectIssues.xml</id>
             <name>Project Issues</name>
             <description/>
          </list>
       </items>
    </lists>
    

Method (lists): POST

This method creates a list in a Space.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: <list>

  • Writable elements (Table 43-2)

    Table 43-2 Create List Writable Elements

    Element Type Constraints Description

    nameFoot 1 

    string

    Name of list

    description

    string

    Description of list

    columnsFootref 1

    urn:oracle:webcenter:space:list:columns

    1 to 30

    List columns


    Footnote 1 Denotes required element

  • Example:

    <list>
       <name>RestExample</name>
       <description>Created using rest api</description>
       <columns>
          <items>
             <metaColumn>
                <name>No.</name>
                <dataType>number</dataType>
             </metaColumn>
             <metaColumn>
                <name>Description</name>
                <dataType>string</dataType>
             </metaColumn>
          </items>
       </columns>
    </list>
    
  • Request headers: Content-Type = application/xml | application/json, [Accept = application/xml | application/json]

  • Response status: 201 [Created]

  • Response body: <list>

  • Retrieved elements (Table 43-3)

    Table 43-3 Retrieved Elements from lists

    Element Type Description

    id

    string

    List ID

    name

    string

    List name

    description

    string

    List description

    scope.guid

    string

    GUID of Space to which the list belongs

    scope.name

    string

    Name of the Space to which the list belongs

    creator

    string

    Name of the user who created the list

    created

    date

    Date the list was created

    modifier

    string

    Name of the user who last modified the list

    modified

    date

    Date the list was last modified

    columns

    urn:oracle:webcenter:space:list:columns

    List columns


  • Example:

    <list resourceType="urn:oracle:webcenter:space:list">
       <links>
          <link resourceType="urn:oracle:webcenter:space:list" rel="self" 
             href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/
             lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_
             83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
             fb03874979c0.xml)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:update urn:oracle:webcenter:delete"/>
          <link template="http://dadvmh0330.us.oracle.com:8889
             /rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/
             s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_
             417b_a35f_fb03874979c0.xml)/rows?
             utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_
             w**&startIndex={startIndex}&itemsPerPage={itemsPerPage}
             &q={searchTerms}&utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             resourceType="urn:oracle:webcenter:space:list:rows" 
             href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/
             vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_
             83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
             fb03874979c0.xml)/rows?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:create"/>
          <link resourceType="urn:oracle:webcenter:space:list:columns" 
             href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/
             vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_
             83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
             fb03874979c0.xml)/columns?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_
             w**" capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:create"/>
       </links>
       <id>/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_
          f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml</id>
       <name>RestExample</name>
       <description>Created using rest api</description>
       <scope>
          <guid>s355923f0_2f04_4fd0_83ad_f7dac2a7ceed</guid>
          <name>vs1</name>
       </scope>
       <creator>weblogic</creator>
       <author>
          <links>
             <link resourceType="urn:oracle:webcenter:people:person" 
                rel="via" href="http://dadvmh0330.us.oracle.com:8889/
                rest/api/people/E9A35E80F0BC11DFBFBE0FE339E55B21/lists/
                @self?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="image/png" 
                template="http://dadvmh0330.us.oracle.com:8889/
                webcenter/profilephoto/45394133354538304630424
                33131444642464245304645333339453535423231/{size}?
                _xResourceMethod=wsrp" 
                resourceType="urn:oracle:webcenter:people:person" 
                rel="urn:oracle:webcenter:people:icon" 
                href="http://dadvmh0330.us.oracle.com:8889/webcenter/
                profilephoto/4539413335453830463042433131444642464245304645
                333339453535423231/SMALL?_xResourceMethod=wsrp" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="text/html"
                resourceType="urn:oracle:webcenter:spaces:profile" 
                rel="alternate" href="http://dadvmh0330.us.oracle.com:8889/
                webcenter/faces/oracle/webcenter/webcenterapp/view/pages/
                peopleconn/UserProfileGallery.jspx?wc.username=weblogic" 
                capabilities="urn:oracle:webcenter:read"/>
          </links>
          <displayName>weblogic</displayName>
          <guid>E9A35E80F0BC11DFBFBE0FE339E55B21</guid>
          <id>weblogic</id>
       </author>
       <created>2010-11-18T06:10:32.250-08:00</created>
       <modifier>weblogic</modifier>
       <modifiedByUser>
          <displayName>weblogic</displayName>
          <guid>E9A35E80F0BC11DFBFBE0FE339E55B21</guid>
          <id>weblogic</id>
       </modifiedByUser>
       <modified>2010-11-18T06:10:32.250-08:00</modified>
       <columns resourceType="urn:oracle:webcenter:space:list:columns">
          <links>
             <link resourceType="urn:oracle:webcenter:space:list:columns" 
                rel="self" 
                href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces
                /vs1/lists/(/oracle/webcenter/list/scopedMD/
                s355923f0_2f04_4fd0_83ad_
                f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
                fb03874979c0.xml)/columns?utoken=
                FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                capabilities="urn:oracle:webcenter:read 
                urn:oracle:webcenter:create"/>
             <link resourceType="urn:oracle:webcenter:space:list"
                rel="urn:oracle:webcenter:parent" 
                href="http://dadvmh0330.us.oracle.com:8889/
                rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/
                s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/
                ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)?
                utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**"/>
             </links>
             <items>
                <metaColumn resourceType=
                   "urn:oracle:webcenter:space:list:column">
                   <links>
                      <link resourceType="urn:oracle:webcenter:space:
                         list:column" rel="self 
                         "href="http://dadvmh0330.us.oracle.com:8889/
                         rest/api/spaces/vs1/lists/
                         (/oracle/webcenter/list/scopedMD/
                         s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/
                         lists/ls_c9cecbc7_756b_417b_a35f_
                         fb03874979c0.xml)/columns/
                         (lco_9bdd1418_6004_40ba_a052_04e8335b7ee8)?
                         utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                         capabilities="urn:oracle:webcenter:read 
                         urn:oracle:webcenter:update 
                         urn:oracle:webcenter:delete"/>
                   </links>
                   <id>lco_9bdd1418_6004_40ba_a052_04e8335b7ee8</id>
                   <name>No.</name>
                   <dataType>number</dataType>
                   <required>false</required>
                   <displayLength>10</displayLength>
                   <format>number</format>
                   <allowLinks>false</allowLinks>
                </metaColumn>
                <metaColumn resourceType=
                   "urn:oracle:webcenter:space:list:column">
                   <links>
                      <link resourceType=
                         "urn:oracle:webcenter:space:list:column" 
                         rel="self"
                         href="http://dadvmh0330.us.oracle.com:8889/
                         rest/api/spaces/vs1/lists/(/oracle/
                         webcenter/list/scopedMD/
                         s355923f0_2f04_4fd0_83ad_
                         f7dac2a7ceed/lists/ls_c9cecbc7_756b_
                         417b_a35f_fb03874979c0.xml)/columns/
                         (lco_3a31fd20_24f1_4422_99fd_c00d7bed4b24)?
                         utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                         capabilities="urn:oracle:webcenter:read 
                         urn:oracle:webcenter:update
                         urn:oracle:webcenter:delete"/>
                </links>
                <id>lco_3a31fd20_24f1_4422_99fd_c00d7bed4b24</id>
                <name>Description</name>
                <dataType>string</dataType>
                <required>false</required>
                <maxLength>500</maxLength>
                <displayLength>20</displayLength>
                <allowLinks>false</allowLinks>
                <editLines>1</editLines>
             </metaColumn>
          </items>
       </columns>
    </list>
    
43.4.4.1.3 Resource Types Linked to from lists

Table 43-4 lists the resource types that the client can link to from the lists resource.

Table 43-4 Resource Types linked to from lists

rel resourceType

self

urn:oracle:webcenter:space:lists

 

urn:oracle:webcenter:space:list


43.4.4.2 urn:oracle:webcenter:space:list

The list response provides a means of retrieving, updating, and deleting an individual list. This section includes the following subsections:

43.4.4.2.1 Navigation Paths to list

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

urn:oracle:webcenter:resourceindex 
   urn:oracle:webcenter:spaces 
      urn:oracle:webcenter:space:resourceindex 
         urn:oracle:webcenter:space:lists 
            urn:oracle:webcenter:space:list 
43.4.4.2.2 Supported Methods for list

The list resource type supports the following methods:

Method (list): GET

Use this method to retrieve a list.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_bb806754_0652_4d49_9354_5fb62dc3514d.xml)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: none

  • Request headers: [Accept = application/xml | application/json]

  • Response status: 200 [OK]

  • Response body: <list>

  • Retrieved elements (Table 43-5)

    Table 43-5 Retrieved Elements for list

    Element Type Description

    id

    string

    ID of the list

    name

    string

    Name of the list

    description

    string

    Description of the list

    scope.guid

    string

    GUID of the Space to which the list belongs

    scope.name

    string

    Name of the Space to which the list belongs

    creator

    string

    User who created the list

    created

    Date

    Date on which the list was created

    modifier

    string

    User who last modified the list

    modified

    Date

    Date on which the list was last modified

    columns

    urn:oracle:webcenter:space:list:columns

    The columns that make up the list


  • For example:

    <list resourceType="urn:oracle:webcenter:space:list">
       <links>
          <link resourceType="urn:oracle:webcenter:space:list" rel="self" 
             href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/
             lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_
             f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
             fb03874979c0.xml)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:update 
             urn:oracle:webcenter:delete"/>
          <link template="http://dadvmh0330.us.oracle.com:8889
             /rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/
             s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_
             417b_a35f_fb03874979c0.xml)/rows?
             utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**&
             startIndex={startIndex}&itemsPerPage={itemsPerPage}&q=
             {searchTerms}&utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**"
             resourceType="urn:oracle:webcenter:space:list:rows" 
             href="http://dadvmh0330.us.oracle.com:8889/rest/api/
             spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_
             2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
             fb03874979c0.xml)/rows?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:create"/>
          <link resourceType="urn:oracle:webcenter:space:list:columns" 
             href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/
             vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_
             83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
             fb03874979c0.xml)/columns?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_
             w**" capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:create"/>
       </links>
       <id>/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_
          f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml</id>
       <name>RestExample</name>
       <description>Created using rest api</description>
       <scope>
          <guid>s355923f0_2f04_4fd0_83ad_f7dac2a7ceed</guid>
          <name>vs1</name>
       </scope>
       <creator>weblogic</creator>
       <author>
          <links>
             <link resourceType="urn:oracle:webcenter:people:person" 
                rel="via" href="http://dadvmh0330.us.oracle.com:8889/
                rest/api/people/E9A35E80F0BC11DFBFBE0FE339E55B21/lists/
                @self?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**"
                capabilities="urn:oracle:webcenter:read"/>
             <link type="image/png"
                template="http://dadvmh0330.us.oracle.com:8889/
                webcenter/profilephoto/4539413335453830463042433131444
                642464245304645333339453535423231/{size}?
                _xResourceMethod=wsrp" 
                resourceType="urn:oracle:webcenter:people:person" 
                rel="urn:oracle:webcenter:people:icon" 
                href="http://dadvmh0330.us.oracle.com:8889/
                webcenter/profilephoto/4539413335453830463042433131444
                642464245304645333339453535423231/SMALL?
                _xResourceMethod=wsrp" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="text/html" 
                resourceType="urn:oracle:webcenter:spaces:profile" 
                rel="alternate" href="http://dadvmh0330.us.oracle.com:8889/
                webcenter/faces/oracle/webcenter/webcenterapp/view/pages/
                peopleconn/UserProfileGallery.jspx?wc.username=weblogic" 
                capabilities="urn:oracle:webcenter:read"/>
          </links>
          <displayName>weblogic</displayName>
          <guid>E9A35E80F0BC11DFBFBE0FE339E55B21</guid>
          <id>weblogic</id>
       </author>
       <created>2010-11-18T06:10:32.250-08:00</created>
       <modifier>weblogic</modifier>
       <modifiedByUser>
          <displayName>weblogic</displayName>
          <guid>E9A35E80F0BC11DFBFBE0FE339E55B21</guid>
          <id>weblogic</id>
       </modifiedByUser>
       <modified>2010-11-18T06:10:32.250-08:00</modified>
       <columns resourceType="urn:oracle:webcenter:space:list:columns">
          <links>
             <link resourceType="urn:oracle:webcenter:space:list:columns" 
                rel="self" href="http://dadvmh0330.us.oracle.com:8889/
                rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/
                s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_
                756b_417b_a35f_fb03874979c0.xml)/
                columns?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                capabilities="urn:oracle:webcenter:read 
                urn:oracle:webcenter:create"/>
             <link resourceType="urn:oracle:webcenter:space:list" 
                rel="urn:oracle:webcenter:parent" 
                href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/
                vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_
                4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
                fb03874979c0.xml)?utoken=
                FKld8lalI3QRdi8TgQkOCGEzxL5x_w**"/>
          </links>
          <items>
             <metaColumn resourceType=
                "urn:oracle:webcenter:space:list:column">
                <links>
                   <link resourceType=
                      "urn:oracle:webcenter:space:list:column" 
                      rel="self" 
                       href="http://dadvmh0330.us.oracle.com:8889/
                      rest/api/spaces/vs1/lists/(/oracle/webcenter/
                      list/scopedMD/s355923f0_2f04_4fd0_83ad_
                      f7dac2a7ceed/lists/ls_c9cecbc7_
                      756b_417b_a35f_fb03874979c0.xml)/columns/(lco_
                      9bdd1418_6004_40ba_a052_04e8335b7ee8)?
                      utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                      capabilities="urn:oracle:webcenter:read 
                      urn:oracle:webcenter:update 
                      urn:oracle:webcenter:delete"/>
                </links>
                <id>lco_9bdd1418_6004_40ba_a052_04e8335b7ee8</id>
                <name>No.</name>
                <dataType>number</dataType>
                <required>false</required>
                <displayLength>10</displayLength>
                <format>number</format>
                <allowLinks>false</allowLinks>
             </metaColumn>
             <metaColumn resourceType=
                "urn:oracle:webcenter:space:list:column">
                <links>
                   <link resourceType=
                      "urn:oracle:webcenter:space:list:column" 
                      rel="self" 
                      href="http://dadvmh0330.us.oracle.com:8889
                      /rest/api/spaces/vs1/lists/(/oracle/webcenter/
                      list/scopedMD/s355923f0_2f04_4fd0_83ad_
                      f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
                      fb03874979c0.xml)/columns/(lco_3a31fd20_24f1_
                      4422_99fd_c00d7bed4b24)?
                      utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                      capabilities="urn:oracle:webcenter:read
                      urn:oracle:webcenter:update                   urn:oracle:webcenter:delete"/>
                </links>
                <id>lco_3a31fd20_24f1_4422_99fd_c00d7bed4b24</id>
                <name>Description</name>
                <dataType>string</dataType>
                <required>false</required>
                <maxLength>500</maxLength>
                <displayLength>20</displayLength>
                <allowLinks>false</allowLinks>
                <editLines>1</editLines>
             </metaColumn>
          </items>
       </columns>
    </list>
    

Method (list): PUT

Use this method to update a list name or description.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_bb806754_0652_4d49_9354_5fb62dc3514d.xml)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: <list>

  • Writable elements for list (Table 43-6)

    Table 43-6 Writable Elements for list

    Element Type Required Constraints Description

    nameFoot 1 

    string

    Yes

    1 or more characters

    Name of this list

    description

    string

    No

    none

    Description of this list


    Footnote 1 Denotes required element

  • For example:

    <list>
       <name>RestExampleUpdate</name>
       <description>Updated using rest api</description>
    </list>
    
  • Request headers: Content-Type = application/xml | application/json, [Accept = application/xml | application/json]

  • Response status: 200 [OK]

  • Response body: <list>

Method (list): DELETE

Use this method to delete a list.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_bb806754_0652_4d49_9354_5fb62dc3514d.xml)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: none

  • Response status: 204 [No Content]

  • Response body: none

43.4.4.2.3 Resource Types Linked to from list

Table 43-7 lists the resource types that the client can link to from the list resource.

Table 43-7 Resource Types linked to from list

rel resourceType

self

urn:oracle:webcenter:space:list

 

urn:oracle:webcenter:space:list:rows

 

urn:oracle:webcenter:space:list:columns


43.4.4.3 urn:oracle:webcenter:space:list:rows

The rows response provides a means of retrieving and adding rows to a list. This section includes the following subsections:

43.4.4.3.1 Navigation Paths to rows

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

urn:oracle:webcenter:resourceindex
   urn:oracle:webcenter:spaces
      urn:oracle:webcenter:space:resourceindex
         urn:oracle:webcenter:space:lists
            urn:oracle:webcenter:space:list
               urn:oracle:webcenter:space:list:rows
43.4.4.3.2 Supported Methods for rows

The rows resource type supports the following methods:

Method (rows): GET

Use this method to retrieve list rows.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_bb806754_0652_4d49_9354_5fb62dc3514d.xml)/rows?q=lco_9bdd1418_6004_40ba_a052_04e8335b7ee8:equals:2&utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: none

  • Request headers: [Accept = application/xml | application/json]

  • Request parameters - startIndex, itemsPerPage, q, projection

    • q parameter for query, format 'q=columnId:operator:value', for example:

      'q=lco_9bdd1418_6004_40ba_a052_04e8335b7ee8:equals:2'
      
      • Supported operators for Strings: equals, not.equals, contains, starts.with

      • Supported operators for Numbers, Dates: equals, not.equals, greater.than, greater.than.or.equals, less.than, less.than.or.equals

      • May specify several conditions separated by semi-colon (;)

  • Searchable attributes for rows: Rows are searchable by column values.

  • Response status: 200 [OK]

  • Response body: <rows>

  • For example:

    <rows resourceType="urn:oracle:webcenter:space:list:rows">
       <links>
          <link template="http://dadvmh0330.us.oracle.com:8889/
             rest/api/spaces/vs1/lists/(/oracle/webcenter/list/
             scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_
             c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/rows?
             utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**&
             startIndex={startIndex}&itemsPerPage={itemsPerPage}&
             q={searchTerms}&utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             resourceType="urn:oracle:webcenter:space:list:rows" rel="self" 
             href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/
             vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_
             83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
             fb03874979c0.xml)/rows?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:create"/>
          <link resourceType="urn:oracle:webcenter:space:list" 
             rel="urn:oracle:webcenter:parent" 
             href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/
             vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_
             83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
             fb03874979c0.xml)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**"/>
       </links>
       <itemsPerPage>1</itemsPerPage>
       <startIndex>0</startIndex>
       <items>
          <row resourceType="urn:oracle:webcenter:space:list:row">
             <links>
                <link resourceType="urn:oracle:webcenter:space:list:row" 
                   rel="self" href="http://dadvmh0330.us.oracle.com:8889/
                   rest/api/spaces/vs1/lists/(/oracle/webcenter/list/
                   scopedMD/s355923f0_2f04_4fd0_83ad_
                   f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
                   fb03874979c0.xml)/rows/(lr_a14d427f_8515_4c82_956f_
                   a60e6e08668c)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                   capabilities="urn:oracle:webcenter:read 
                   urn:oracle:webcenter:update 
                   urn:oracle:webcenter:delete"/>
             </links>
             <id>lr_a14d427f_8515_4c82_956f_a60e6e08668c</id>
             <listId>/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_
                83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
                fb03874979c0.xml</listId>
             <scope>s355923f0_2f04_4fd0_83ad_f7dac2a7ceed</scope>
             <creator>weblogic</creator>
             <author>
                <links>
                   <link resourceType=
                      "urn:oracle:webcenter:people:person" 
                      rel="via" 
                      href="http://dadvmh0330.us.oracle.com:8889/
                      rest/api/people/E9A35E80F0BC11DFBFBE0FE339E55B21/
                      lists/@self?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_
                      w**" capabilities="urn:oracle:webcenter:read"/>
                   <link type="image/png" 
                      template="http://dadvmh0330.us.oracle.com:8889/
                      webcenter/profilephoto/45394133354538304630424
                      33131444642464245304645333339453535423231/
                      {size}?_xResourceMethod=wsrp" 
                      resourceType="urn:oracle:webcenter:people:person" 
                      rel="urn:oracle:webcenter:people:icon" 
                      href="http://dadvmh0330.us.oracle.com:8889/
                      webcenter/profilephoto/45394133354538304630424
                      33131444642464245304645333339453535423231/SMALL?
                      _xResourceMethod=wsrp" 
                      capabilities="urn:oracle:webcenter:read"/>
                   <link type="text/html" 
                      resourceType="urn:oracle:webcenter:spaces:
                      profile" rel="alternate" 
                      href="http://dadvmh0330.us.oracle.com:8889/
                      webcenter/faces/oracle/webcenter/webcenterapp/
                      view/pages/peopleconn/UserProfileGallery.jspx?
                      wc.username=weblogic" 
                      capabilities="urn:oracle:webcenter:read"/>
                </links>
                <displayName>weblogic</displayName>
                <guid>E9A35E80F0BC11DFBFBE0FE339E55B21</guid>
                <id>weblogic</id>
             </author>
             <created>2010-11-18T07:12:06.599-08:00</created>
             <modifier>weblogic</modifier>
             <modifiedByUser>
                <links>
                   <link resourceType=
                      "urn:oracle:webcenter:people:person" rel="via" 
                      href="http://dadvmh0330.us.oracle.com:8889/rest/
                      api/people/E9A35E80F0BC11DFBFBE0FE339E55B21/lists
                      /@self?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                      capabilities="urn:oracle:webcenter:read"/>
                   <link type="image/png" 
                      template="http://dadvmh0330.us.oracle.com:8889/
                      webcenter/profilephoto/45394133354538304630424
                      33131444642464245304645333339453535423231/
                      {size}?_xResourceMethod=wsrp" 
                      resourceType="urn:oracle:webcenter:people:person" 
                      rel="urn:oracle:webcenter:people:icon" 
                      href="http://dadvmh0330.us.oracle.com:8889/
                      webcenter/profilephoto/45394133354538304630424
                      33131444642464245304645333339453535423231/SMALL?
                      _xResourceMethod=wsrp" 
                      capabilities="urn:oracle:webcenter:read"/>
                   <link type="text/html" 
                      resourceType="urn:oracle:webcenter:spaces:
                      profile" rel="alternate" 
                      href="http://dadvmh0330.us.oracle.com:8889/
                      webcenter/faces/oracle/webcenter/webcenterapp/
                      view/pages/peopleconn/UserProfileGallery.jspx?
                      wc.username=weblogic" 
                      capabilities="urn:oracle:webcenter:read"/>
                </links>
                <displayName>weblogic</displayName>
                <guid>E9A35E80F0BC11DFBFBE0FE339E55B21</guid>
                <id>weblogic</id>
             </modifiedByUser>
             <modified>2010-11-18T07:12:06.599-08:00</modified>
             <columns>
                <column>
                   <id>lco_9bdd1418_6004_40ba_a052_04e8335b7ee8</id>
                   <name>No.</name>
                   <value>1.0</value>
                </column>
                <column>
                   <id>lco_3a31fd20_24f1_4422_99fd_c00d7bed4b24</id>
                   <name>Description</name>
                   <value>test</value>
                </column>
             </columns>
          </row>
       </items>
    </rows>
    

Method (rows): POST

Use this method to create a row in a list.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_bb806754_0652_4d49_9354_5fb62dc3514d.xml)/rows?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: <row>

  • Writable elements (Table 43-8)

    Table 43-8 Writable Elements for rows

    Element Type Constraints Description

    columns.column.idFoot 1 

    string

    Column ID

    columns.column.valueFootref 1

    string

    Valid value for column data type

    Column value


    Footnote 1 Denotes required element

  • For example:

    <row>
       <columns>
          <column>
             <id>lco_9bdd1418_6004_40ba_a052_04e8335b7ee8</id>
             <value>1</value>
          </column>
          <column>
             <id>lco_3a31fd20_24f1_4422_99fd_c00d7bed4b24</id>
             <value>test</value>
          </column>
       </columns>
    </row>
    
  • Request headers: Content-Type = application/xml | application/json, [Accept = application/xml | application/json]

  • Response status: 201 [Created]

  • Response body: <row>

  • Retrieved elements (Table 43-9)

    Table 43-9 Retrieved Elements for rows

    Element Type Description

    id

    string

    Row ID

    list id

    string

    List ID

    scope

    string

    GUID of Space to which list belongs

    creator

    string

    Person who created the list

    created

    date

    Date the list was created

    modifier

    string

    Last user to modify the list

    modified

    date

    Date the list was last modified

    columns

    Column values


  • For example:

    <row resourceType="urn:oracle:webcenter:space:list:row">
       <links>
          <link resourceType="urn:oracle:webcenter:space:list:row" rel="self" 
             href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/
             lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_
             f7dac2a7ceed/lists/ls_bb806754_0652_4d49_9354_
             5fb62dc3514d.xml)/rows/(lr_4cc07327_49cb_4cd5_a270_
             182ddcc8db4a)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:update urn:oracle:webcenter:delete"/>
       </links>
       <id>lr_4cc07327_49cb_4cd5_a270_182ddcc8db4a</id>
       <listId>/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_
          f7dac2a7ceed/lists/ls_bb806754_0652_4d49_9354_
          5fb62dc3514d.xml</listId>
       <scope>s355923f0_2f04_4fd0_83ad_f7dac2a7ceed</scope>
       <creator>weblogic</creator>
       <author>
          <links>
             <link resourceType="urn:oracle:webcenter:people:person" 
                rel="via" href="http://dadvmh0330.us.oracle.com:8889
                /rest/api/people/E9A35E80F0BC11DFBFBE0FE339E55B21/lists/
                @self?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="image/png" 
                template="http://dadvmh0330.us.oracle.com:8889/
                webcenter/profilephoto/4539413335453830463042433131
                444642464245304645333339453535423231/{size}?
                _xResourceMethod=wsrp" 
                resourceType="urn:oracle:webcenter:people:person" 
                rel="urn:oracle:webcenter:people:icon" 
                href="http://dadvmh0330.us.oracle.com:8889/webcenter/
                profilephoto/453941333545383046304243313144464246424530
                4645333339453535423231/SMALL?_xResourceMethod=wsrp" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="text/html" 
                resourceType="urn:oracle:webcenter:spaces:profile" 
                rel="alternate" href="http://dadvmh0330.us.oracle.com:8889/
                webcenter/faces/oracle/webcenter/webcenterapp/view/pages/
                peopleconn/UserProfileGallery.jspx?wc.username=weblogic" 
                capabilities="urn:oracle:webcenter:read"/>
          </links>
          <displayName>weblogic</displayName>
          <guid>E9A35E80F0BC11DFBFBE0FE339E55B21</guid>
          <id>weblogic</id>
       </author>
       <created>2010-11-17T06:34:25.042-08:00</created>
       <modifier>weblogic</modifier>
       <modifiedByUser>
          <links>
             <link resourceType="urn:oracle:webcenter:people:person" 
                rel="via" href="http://dadvmh0330.us.oracle.com:8889/
                rest/api/people/E9A35E80F0BC11DFBFBE0FE339E55B21/lists/
                @self?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="image/png" 
                template="http://dadvmh0330.us.oracle.com:8889/
                webcenter/profilephoto/4539413335453830463042433131
                444642464245304645333339453535423231/{size}?
                _xResourceMethod=wsrp" 
                resourceType="urn:oracle:webcenter:people:person" 
                rel="urn:oracle:webcenter:people:icon" 
                href="http://dadvmh0330.us.oracle.com:8889/webcenter/
                profilephoto/453941333545383046304243313144464246424530
                4645333339453535423231/SMALL?_xResourceMethod=wsrp" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="text/html" 
                resourceType="urn:oracle:webcenter:spaces:profile" 
                rel="alternate" href="http://dadvmh0330.us.oracle.com:8889/
                webcenter/faces/oracle/webcenter/webcenterapp/view/pages/
                peopleconn/UserProfileGallery.jspx?wc.username=weblogic" 
                capabilities="urn:oracle:webcenter:read"/>
          </links>
          <displayName>weblogic</displayName>
          <guid>E9A35E80F0BC11DFBFBE0FE339E55B21</guid>
          <id>weblogic</id>
       </modifiedByUser>
          <modified>2010-11-17T06:34:25.042-08:00</modified>
       <columns>
          <column>
             <id>lco_9bdd1418_6004_40ba_a052_04e8335b7ee8</id>
             <name>No.</name>
             <value>1.0</value>
          </column>
          <column>
             <id>lco_3a31fd20_24f1_4422_99fd_c00d7bed4b24</id>
             <name>Description</name>
             <value>test</value>
          </column>
       </columns>
    </row>
    
43.4.4.3.3 Resource Types Linked to from rows

Table 43-10 lists the resource types that the client can link to from the rows resource.

Table 43-10 Resource Types Linked to from rows

rel resourceType

self

urn:oracle:webcenter:space:list.rows

parent

urn:oracle:webcenter:space:list

 

urn:oracle:webcenter:space:list:row


43.4.4.4 urn:oracle:webcenter:space:list:row

The row response provides a means of retrieving and adding, and deleting an individual list row. This section includes the following subsections:

43.4.4.4.1 Navigation Paths to row

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

urn:oracle:webcenter:resourceindex
   urn:oracle:webcenter:spaces
      urn:oracle:webcenter:space:resourceindex
         urn:oracle:webcenter:space:lists
            urn:oracle:webcenter:space:list
               urn:oracle:webcenter:space:list:rows
                  urn:oracle:webcenter:space:list:row
43.4.4.4.2 Supported Methods for row

The row resource type supports the following methods:

Method (row): GET

Use this method to retrieve data from a list row.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/rows/(lr_a14d427f_8515_4c82_956f_a60e6e08668c)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: none

  • Request headers: [Accept = application/xml | application/json]

  • Response status: 200 [OK]

  • Response body: <row>

  • Retrieved elements (Table 43-11)

    Table 43-11 Retrieved Elements for row

    Element Type Description

    id

    string

    ID of the row

    listId

    string

    ID of the parent list

    scope

    string

    GUID of the Space to which the list belongs

    creator

    string

    User who created the row

    created

    Date

    Date on which the row was created

    modifier

    string

    User who last modified the row

    modified

    Date

    Date on which the row was last modified

    columns

    urn:oracle:webcenter:space:list:columns

    Column values


  • For example:

    <row resourceType="urn:oracle:webcenter:space:list:row">
       <links>
          <link resourceType="urn:oracle:webcenter:space:list:row" 
             rel="self" href="http://dadvmh0330.us.oracle.com:8889/
             rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD
             /s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_bb806754_0652_
             4d49_9354_5fb62dc3514d.xml)/rows/(lr_4cc07327_49cb_4cd5_a270_
             182ddcc8db4a)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:update urn:oracle:webcenter:delete"/>
       </links>
       <id>lr_4cc07327_49cb_4cd5_a270_182ddcc8db4a</id>
       <listId>/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_
          f7dac2a7ceed/lists/ls_bb806754_0652_4d49_9354_
          5fb62dc3514d.xml</listId>
       <scope>s355923f0_2f04_4fd0_83ad_f7dac2a7ceed</scope>
       <creator>weblogic</creator>
       <author>
          <links>
             <link resourceType="urn:oracle:webcenter:people:person" 
                rel="via" href="http://dadvmh0330.us.oracle.com:8889/
                rest/api/people/E9A35E80F0BC11DFBFBE0FE339E55B21/lists/
                @self?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="image/png" 
                template="http://dadvmh0330.us.oracle.com:8889/webcenter/
                profilephoto/453941333545383046304243313144464246424530
                4645333339453535423231/{size}?_xResourceMethod=wsrp" 
                resourceType="urn:oracle:webcenter:people:person" 
                rel="urn:oracle:webcenter:people:icon" 
                href="http://dadvmh0330.us.oracle.com:8889/webcenter/
                profilephoto/453941333545383046304243313144464246424530
                4645333339453535423231/SMALL?_xResourceMethod=wsrp" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="text/html" 
                resourceType="urn:oracle:webcenter:spaces:profile" 
                rel="alternate" href="http://dadvmh0330.us.oracle.com:8889/
                webcenter/faces/oracle/webcenter/webcenterapp/view/pages/
                peopleconn/UserProfileGallery.jspx?wc.username=weblogic" 
                capabilities="urn:oracle:webcenter:read"/>
          </links>
          <displayName>weblogic</displayName>
          <guid>E9A35E80F0BC11DFBFBE0FE339E55B21</guid>
          <id>weblogic</id>
       </author>
       <created>2010-11-17T06:34:25.042-08:00</created>
       <modifier>weblogic</modifier>
       <modifiedByUser>
          <links>
             <link resourceType="urn:oracle:webcenter:people:person" 
                rel="via" href="http://dadvmh0330.us.oracle.com:8889/
                rest/api/people/E9A35E80F0BC11DFBFBE0FE339E55B21/lists/
                @self?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="image/png" 
                template="http://dadvmh0330.us.oracle.com:8889/webcenter/
                profilephoto/453941333545383046304243313144464246424530
                4645333339453535423231/{size}?_xResourceMethod=wsrp" 
                resourceType="urn:oracle:webcenter:people:person" 
                rel="urn:oracle:webcenter:people:icon" 
                href="http://dadvmh0330.us.oracle.com:8889/webcenter/
                profilephoto/453941333545383046304243313144464246424530
                4645333339453535423231/SMALL?_xResourceMethod=wsrp" 
                capabilities="urn:oracle:webcenter:read"/>
             <link type="text/html" 
                resourceType="urn:oracle:webcenter:spaces:profile" 
                rel="alternate" href="http://dadvmh0330.us.oracle.com:8889/
                webcenter/faces/oracle/webcenter/webcenterapp/view/pages/
                peopleconn/UserProfileGallery.jspx?wc.username=weblogic" 
                capabilities="urn:oracle:webcenter:read"/>
          </links>
          <displayName>weblogic</displayName>
          <guid>E9A35E80F0BC11DFBFBE0FE339E55B21</guid>
          <id>weblogic</id>
       </modifiedByUser>
       <modified>2010-11-17T06:34:25.042-08:00</modified>
       <columns>
          <column>
             <id>lco_9bdd1418_6004_40ba_a052_04e8335b7ee8</id>
             <name>No.</name>
             <value>1.0</value>
          </column>
          <column>
             <id>lco_3a31fd20_24f1_4422_99fd_c00d7bed4b24</id>
             <name>Description</name>
             <value>test</value>
          </column>
       </columns>
    </row>
    

Method (row): PUT

Use this method to update row data.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/rows/(lr_a14d427f_8515_4c82_956f_a60e6e08668c)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: <row>

  • Writable elements (Table 43-12)

    Table 43-12 Writable Elements for row

    Element Type Constraints Description

    columns.column.idFoot 1 

    string

    Column ID

    columns.column.valueFootref 1

    string

    valid value for column data type

    Column value


    Footnote 1 Denotes required element

  • For example:

    <row>
       <columns>
          <column>
             <id>lco_9bdd1418_6004_40ba_a052_04e8335b7ee8</id>
             <value>1</value>
          </column>
          <column>
             <id>lco_3a31fd20_24f1_4422_99fd_c00d7bed4b24</id>
             <value>test</value>
          </column>
       </columns>
    </row>
    
  • Request headers: Content-Type = application/xml | application/json, [Accept = application/xml | application/json]

  • Response status: 200 [OK]

  • Response body: <row>

Method (row): DELETE

Use this method to delete a list row.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/rows/(lr_a14d427f_8515_4c82_956f_a60e6e08668c)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: none

  • Response status: 204 [No Content]

  • Response body: none

43.4.4.4.3 Resource Types Linked to from row

Table 43-13 lists the resource types that the client can link to from the row resource.

Table 43-13 Resource Types Linked to from row

rel resourceType

self

urn:oracle:webcenter:space:list:row


43.4.4.5 urn:oracle:webcenter:space:list:columns

The columns response provides a means of retrieving and adding list columns. This section includes the following subsections:

43.4.4.5.1 Navigation Paths to columns

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

urn:oracle:webcenter:resourceindex
   urn:oracle:webcenter:spaces
      urn:oracle:webcenter:space:resourceindex
         urn:oracle:webcenter:space:lists
            urn:oracle:webcenter:space:list
               urn:oracle:webcenter:space:list:columns
43.4.4.5.2 Supported Methods for columns

The columns resource type supports the following methods:

Method (columns): GET

Use this method to retrieve columns in a list.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/columns?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: none

  • Request headers: [Accept = application/xml | application/json]

  • Request parameters: none

  • Response status: 200 [OK]

  • Response body: <metaColumns>

  • For example:

    <metaColumns resourceType="urn:oracle:webcenter:space:list:columns">
       <links>
          <link resourceType="urn:oracle:webcenter:space:list:columns" 
             rel="self" href="http://dadvmh0330.us.oracle.com:8889/
             rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/
             s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_
             417b_a35f_fb03874979c0.xml)/columns?
             utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:create"/>
          <link resourceType="urn:oracle:webcenter:space:list" 
             rel="urn:oracle:webcenter:parent" 
             href="http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/
             lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_
             f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
             fb03874979c0.xml)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**"/>
       </links>
       <items>
          <metaColumn resourceType="urn:oracle:webcenter:space:list:column">
             <links>
                <link resourceType="urn:oracle:webcenter:space:list:column" 
                   rel="self" href="http://dadvmh0330.us.oracle.com:8889/
                   rest/api/spaces/vs1/lists/(/oracle/webcenter/list/
                   scopedMD/s355923f0_2f04_4fd0_83ad_
                   f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
                   fb03874979c0.xml)/columns/(lco_9bdd1418_6004_40ba_
                   a052_04e8335b7ee8)?
                   utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                   capabilities="urn:oracle:webcenter:read 
                   urn:oracle:webcenter:update 
                   urn:oracle:webcenter:delete"/>
             </links>
             <id>lco_9bdd1418_6004_40ba_a052_04e8335b7ee8</id>
             <name>No.</name>
             <dataType>number</dataType>
             <required>false</required>
             <displayLength>10</displayLength>
             <format>number</format>
             <allowLinks>false</allowLinks>
          </metaColumn>
          <metaColumn resourceType="urn:oracle:webcenter:space:list:column">
             <links>
                <link resourceType="urn:oracle:webcenter:space:list:column" 
                   rel="self" href="http://dadvmh0330.us.oracle.com:8889/
                   rest/api/spaces/vs1/lists/(/oracle/webcenter/list/
                   scopedMD/s355923f0_2f04_4fd0_83ad_
                   f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_
                   fb03874979c0.xml)/columns/(lco_3a31fd20_24f1_4422_
                   99fd_c00d7bed4b24)?
                   utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
                   capabilities="urn:oracle:webcenter:read 
                   urn:oracle:webcenter:update 
                   urn:oracle:webcenter:delete"/>
             </links>
             <id>lco_3a31fd20_24f1_4422_99fd_c00d7bed4b24</id>
             <name>Description</name>
             <dataType>string</dataType>
             <required>false</required>
             <maxLength>500</maxLength>
             <displayLength>20</displayLength>
             <allowLinks>false</allowLinks>
             <editLines>1</editLines>
          </metaColumn>
       </items>
    </metaColumns>
    

Method (columns): POST

Use this method to create a column in a list.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/columns?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: <metaColumn>

  • Writable elements (Table 43-14)

    Table 43-14 Writable Elements for columns

    Element Type Constraints Description

    nameFoot 1 

    string

    The name of the column

    dataTypeFootref 1

    string

    • string

    • number

    • datetime

    • boolean

    • person

    • image

    • richtext

    The data type of the column

    required

    boolean

    • true

    • false

    Whether a value is required for the column

    defaultValue

    data type of column

    Object must match data type

    The default value of the column

    maxLength

    int

    Valid only for string data type

    The maximum length for a string value

    rangeLow

    int

    Valid only for number data type

    The low range value for a number data type

    rangeHigh

    int

    Valid only for number data type

    The high range value for a number data type

    format

    string

    For number data type:

    • number

    • currency

    • percent

    For datetime data type:

    • date

    • time

    • both

    The format of the column

    allowLinks

    boolean

    • true

    • false

    Valid only for string data type

    Whether a hyperlink can be specified for a column value

    linkTarget

    string

    • _blank

    • _self

    Valid only if allowLinks=true

    _blank opens link in a new window, _self opens link in the same window

    editLines

    int

    Valid only for string data type

    The number of lines when editing a column value (default=1)

    peopleScope

    string

    • GLOBAL

    • SUB_SCOPE

    Valid only for person data type

    Whether valid users are all users in directory or members of the Space that contains the list

    displayWidth

    int

    Display width of column in pixels

    hint

    string

    Hint displayed to help user when entering column value


    Footnote 1 Denotes required element

  • For example:

    <metaColumn>
       <name>Notes</name>
       <dataType>richtext</dataType>
    </metaColumn
    
  • Request headers: Content-Type = application/xml | application/json, [Accept = application/xml | application/json]

  • Response status: 201 [Created]

  • Response body: <metaColumn>

  • Retrieved elements (Table 43-15)

    Table 43-15 Retrieved Elements from columns

    Element Type Description

    id

    string

    Column ID

    name

    string

    The name of the column

    dataType

    string

    The data type of the column

    required

    boolean

    Whether a value is required for the column

    defaultValue

    data type of column

    The default value of the column

    maxLength

    int

    The maximum length for a string value

    rangeLow

    int

    The low range value for a number data type

    rangeHigh

    int

    The high range value for a number data type

    format

    string

    The format of the column

    allowLinks

    boolean

    Whether a hyperlink can be specified for a column value

    linkTarget

    string

    _blank opens link in a new window, _self opens link in the same window

    editLines

    int

    The number of lines when editing a column value (default=1)

    peopleScope

    string

    Whether valid users are all users in directory or members of the Space that contains the list

    displayWidth

    int

    Display width of column in pixels

    hint

    string

    Hint displayed to help user when entering column value


  • For example:

    <metaColumn resourceType="urn:oracle:webcenter:space:list:column">
       <links>
          <link resourceType="urn:oracle:webcenter:space:list:column" 
             rel="self" href="http://dadvmh0330.us.oracle.com:8889/
             rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/
             s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/
             ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/columns/
             (lco_fe2b9856_32f3_449a_a277_18dc7f6a779e)?
             utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:update urn:oracle:webcenter:delete"/>
       </links>
       <id>lco_fe2b9856_32f3_449a_a277_18dc7f6a779e</id>
       <name>Notes</name>
       <dataType>richtext</dataType>
       <required>false</required>
       <displayLength>20</displayLength>
       <allowLinks>false</allowLinks>
    </metaColumn>
    
43.4.4.5.3 Resource Types Linked to from columns

Table 43-16 lists the resource types that the client can link to from the columns resource.

Table 43-16 Resource Types Linked to from columns

rel resourceType

self

urn:oracle:webcenter:space:list.columns

parent

urn:oracle:webcenter:space:list

 

urn:oracle:webcenter:space:list:column


43.4.4.6 urn:oracle:webcenter:space:list:column

The column response provides a means of retrieving, adding, and deleting an individual list column. This section includes the following subsections:

43.4.4.6.1 Navigation Paths to column

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

urn:oracle:webcenter:resourceindex
   urn:oracle:webcenter:spaces
      urn:oracle:webcenter:space:resourceindex
         urn:oracle:webcenter:space:lists
            urn:oracle:webcenter:space:list
               urn:oracle:webcenter:space:list:columns
                  urn:oracle:webcenter:space:list:column
43.4.4.6.2 Supported Methods for column

The column resource type supports the following methods:

Method (column): GET

Use this method to retrieve a list column.

  • Resource URI. for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/columns/(lco_fe2b9856_32f3_449a_a277_18dc7f6a779e)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: none

  • Request headers: [Accept = application/xml | application/json]

  • Response status: 200 [OK]

  • Response body: <metaColumn>

  • Retrieved elements (Table 43-17)

    Table 43-17 column Retrieved Elements

    Element Type Description

    id

    string

    Column ID

    name

    string

    The name of the column

    dataType

    string

    The data type of the column

    required

    boolean

    Whether a value is required for the column

    defaultValue

    data type of column

    The default value of the column

    maxLength

    int

    The maximum length for a string value

    rangeLow

    int

    The low range value for a number data type

    rangeHigh

    int

    The high range value for a number data type

    format

    string

    The format of the column

    allowLinks

    boolean

    Whether a hyperlink can be specified for a column value

    linkTarget

    string

    _blank opens link in a new window, _self opens link in the same window

    editLines

    int

    The number of lines when editing a column value (default=1)

    peopleScope

    string

    Whether valid users are all users in directory or members of the Space that contains the list

    displayWidth

    int

    Display width of column in pixels

    hint

    string

    Hint displayed to help user when entering column value


  • For example:

    <metaColumn resourceType="urn:oracle:webcenter:space:list:column">
       <links>
          <link resourceType="urn:oracle:webcenter:space:list:column" 
             rel="self" href="http://dadvmh0330.us.oracle.com:8889/
             rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/
             s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/
             ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/
             columns/(lco_fe2b9856_32f3_449a_a277_18dc7f6a779e)?
             utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**" 
             capabilities="urn:oracle:webcenter:read 
             urn:oracle:webcenter:update urn:oracle:webcenter:delete"/>
       </links>
       <id>lco_fe2b9856_32f3_449a_a277_18dc7f6a779e</id>
       <name>Notes</name>
       <dataType>richtext</dataType>
       <required>false</required>
       <displayLength>20</displayLength>
       <allowLinks>false</allowLinks>
    </metaColumn>
    

Method (column): PUT

Use this method to update column data.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/columns/(lco_fe2b9856_32f3_449a_a277_18dc7f6a779e)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: <metacolumn>

  • Writable elements (Table 43-18)

    Table 43-18 column Writable Elements

    Element Type Constraints Description

    nameFoot 1 

    string

    The name of the column

    dataTypeFootref 1

    string

    • string

    • number

    • datetime

    • boolean

    • person

    • image

    • richtext

    The data type of the column

    required

    boolean

    • true

    • false

    Whether a value is required for the column

    defaultValue

    data type of column

    Object must match data type

    The default value of the column

    maxLength

    int

    Valid only for string data type

    The maximum length for a string value

    rangeLow

    int

    Valid only for number data type

    The low range value for a number data type

    rangeHigh

    int

    Valid only for number data type

    The high range value for a number data type

    format

    string

    For number data type:

    • number

    • currency

    • percent

    For datetime data type:

    • date

    • time

    • both

    The format of the column

    allowLinks

    boolean

    • true

    • false

    Valid only for string data type

    Whether a hyperlink can be specified for a column value

    linkTarget

    string

    • _blank

    • _self

    Valid only if allowLinks=true

    _blank opens link in a new window, _self opens link in the same window

    editLines

    int

    Valid only for string data type

    The number of lines when editing a column value (default=1)

    peopleScope

    string

    • GLOBAL

    • SUB_SCOPE

    Valid only for person data type

    Whether valid users are all users in directory or members of the Space that contains the list

    displayWidth

    int

    Display width of column in pixels

    hint

    string

    Hint displayed to help user when entering column value


    Footnote 1 Denotes required element

  • For example:

    <metaColumn>
       <name>Comments</name>
       <dataType>richtext</dataType>
    </metaColumn>
    
  • Request headers: Content-Type = application/xml | application/json, [Accept = application/xml | application/json]

  • Response status: 200 [OK]

  • Response body: <metaColumn>

Method (column): DELETE

Use this method to delete a list column.

  • Resource URI, for example:

    http://dadvmh0330.us.oracle.com:8889/rest/api/spaces/vs1/lists/(/oracle/webcenter/list/scopedMD/s355923f0_2f04_4fd0_83ad_f7dac2a7ceed/lists/ls_c9cecbc7_756b_417b_a35f_fb03874979c0.xml)/columns/(lco_fe2b9856_32f3_449a_a277_18dc7f6a779e)?utoken=FKld8lalI3QRdi8TgQkOCGEzxL5x_w**
    
  • Request body: none

  • Response status: 204 [No Content]

  • Response body: none

43.4.4.6.3 Resource Types Linked to from column

Table 43-19 lists the resource types that the client can link to from the column resource.

Table 43-19 Resource Types Linked to from column

rel resourceType

self

urn:oracle:webcenter:space:list:column


43.5 Troubleshooting the Lists Service

Problem

The List task flow shows an error that the WebCenter Repository is not available.

Solution

The database connection is likely not configured. For more information, see Section 7.2.2, "Setting Up a Database Connection."

Problem

A 401 Unauthorized error appears.

Solution

It is likely that security is not set up for the application. Or it may be that there was insufficient permission to perform the attempted task.