Jump to

• Request
• Response
• Examples

Retrieve Resource Catalog

get

/v1/portal/portals/{portalId}/resourcecatalogs

Returns information about the resource catalog of a portal in a list wrapper

Request

Path Parameters

• portalId: string
  The short Id of a portal.

Query Parameters

• limit(optional): integer(int32)
• offset(optional): integer(int32)
• orderBy(optional): string
• q(optional): string

Back to Top

Response

Supported Media Types

• application/json

403 Response

Invalid utoken supplied

Back to Top

Examples

Use this endpoint to retrieve information about the resource catalog of a portal.

To retrieve information about the resource catalog of a portal submit a GET request on the REST resource. In the request, you must specify the {portalid}for which you want to retrieve the details. You can use the query parameters to filter your results. Use the following format to submit a GET request using cURL.

curl -i -X GET 
http://hostname:port/rest/api/v1/portal/portals/{portalId}/resourcecatalogs?utoken=utoken
   -H 'Content-Type: application/json'
  

where

• hostname:port is the name of the host and the IP port where Oracle WebCenter Portal is running. For example, example.com:8888.

• utoken is the API token for accessing the portal APIs. For example, utoken=utoken=abcdIC05zgjZoqCF8ShWL42AhTVvq-fc8uFshnw%2A%2A. For more information, see Authentication.

• {portalId} is the short id of the portal. To retrieve short id of a portal, see Retrieve Portals.

HTTP Status Code

HTTP_STATUS = 200

Example of Response Body

In this example, you can view the details of the resource catalog of a portal. The contents of the response body is in JSON format.

{
    
    "resourceType": "urn:oracle:webcenter:portal:resourcecatalogs",
    "startIndex": 0,
    "itemsPerPage": 10,
    "items": [
        {
            "links": [
                {
                    "rel": "self",
                    "resourceType": "urn:oracle:webcenter:portal:resourcecatalog",
                    "capabilities": "urn:oracle:webcenter:update urn:oracle:webcenter:read",
                    "template": "http://example.com:8888/rest/api/v1/portal/resourcecatalogs/Aoc?expand={expand}={fields}@utoken=rrrrrr77ee_w**"
                },
                
            ],
            "resourceType": "urn:oracle:webcenter:portal:resourcecatalog",
            "translatedDescription": "Used when editing portal-level pages and task flows",
            "visible": true,
            "displayName": "Default Portal Catalog",
            "customAttributes": {},
            "descriptionKey": "DEFAULT_GROUP_SPACE_CATALOG_DESC",
            "displayNameKey": "DEFAULT_GROUP_SPACE_CATALOG",
            "usesCustomSecurity": false,
            "seeded": true,
            "contentDir": "/oracle/webcenter/siteresources/shared",
            "logoURL": "/adf/webcenter/srm_dflt_logo_qualifier.png",
            "excludedPortalIds": "s8bba98ff_4cbb_40b8_beee_296c916a23ed",
            "resourceBundle": "oracle.webcenter.webcenterapp.resource.WebCenterResourceBundle",
            "name": "Default Portal Catalog",
            "namespace": "resourceCatalog",
            "modifier": "system",
            "modified": "2018-07-26T01:46:21.533Z",
            "creator": "system",
            "description": "Used when editing portal-level pages and task flows",
            "currentVersionId": "d648e99b-2e0f-4eb6-aa4a-e09182984730",
            "created": "2018-07-26T01:46:21.533Z",
            "securityId": "oracle_webcenter_siteresource_42a1_84f0_5fa19a127974",
            "documentRef": "/oracle/adf/rc/metadata/scopedMD/defaultScope/DefaultGroupSpaceCatalog.xml",
            "shortId": "AeY",
            "locale": "en_US",
            "id": "ef3e3247-b88f-474"
        },
        
    ]
}

Back to Top