Oracle Fusion Middleware REST API Reference for Oracle WebLogic Portal
10g Release 3 (10.3.4)
E14258-03

Get Portlet Category

Retrieves a Category from its ID in the specified webapp.

Namespace

/bea/wlp/api

HTTP Method

GET

URI

/bea/wlp/api/category/details

Parameters

Parameter
Type
Description
Allowed Values
Default Value
webapp (required)
String
The webapp to list portlet categories under.
format
String
The format of the results.
xml
json
xml
locale
String
The locale to use for the title and/or descriptions of the returned Portlet Categories. Must be of the format: lang-country-variant ie. [nn], [nn-nn], or [nn-nn-nnnn].
Preferred locale from request.
categoryId (required)
Integer
The Portlet Category ID.

Input Example

/bea/wlp/api/category/details?webapp=myWebApp&categoryId=12345

Return Example

<rsp>
    <id>12345</id>
    <parentId>10001</parentId>
    <title>My Category 1</title>
    <description>This is My Category 1.</description>
    <webapp>myWebApp</webapp>
    <created_date>2008-07-23T15:05:31-06:00</created_date>
    <modified_date>2008-07-23T15:05:31-06:00</modified_date>
    <portlets>
        <portlet>
            <label>weather_1</label>
            <title>Weather Portlet</title>
            <icon>weather.gif</icon>
            <description>Current weather.</description>
        </portlet>
    </portlets>
    <subcategories>
        <subcategory>
            <id>1111<id>
            <title>Subcategory 1<title>
            <description>This is Subcategory 1<description>
            <webapp>myWebApp<webapp>
        </subcategory>
        <subcategory>
            <id>2222<id>
            <title>Subcategory 2<title>
            <description>This is Subcategory 2<description>
            <webapp>myWebApp<webapp>
        </subcategory>
    </subcategories>
</rsp>
Oracle Fusion Middleware REST API Reference for Oracle WebLogic Portal
10g Release 3 (10.3.4)
E14258-03

Copyright 2011, Oracle. All rights reserved.