REST API for Oracle WebCenter Portal

Retrieve Portal Details by Short ID

get

/v1/portal/portals/{portalId}

Returns information about the portal based on the specified short ID

Request

Path Parameters

id: string

the short id of the portal to be returned

Query Parameters

expand(optional): string

if child nodes should be expanded
fields(optional): string

if a reduced number of fields should be displayed

Response

Supported Media Types

application/json

403 Response

Invalid utoken supplied

404 Response

Invalid short id supplied

Examples

Use this endpoint to retrieve details about the portal based on the specified short ID.

To retrieve information about the portal submit a GET request on the REST resource and you must specify the Portal Id 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}?utoken=utoken
   -H 'Content-Type: application/json'

where

hostname:port is the name of the host and the IP port where the 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 a portal, including the shortIdof the portal. The contents of the response body is in JSON format.

          
    "resourceType": "urn:oracle:webcenter:portal:portal",
    "keywords": "portal intranet",
    "displayName": "Avi Intranet",
    "icon": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranetIcon.png",
    "iconScaled": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranetIcon_ICON16.png",
    "logo": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranet.png",
    "logoScaled": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranet_LOGO75.png",
    "preview": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranetpreview.png",
    "previewScaled": "/oracle/webcenter/space/metadata/spaces/aviintranet/images/AviIntranetpreview_LOGO75.png",
    "creationStatus": "Completed",
    "supportedLanguages": "English-US, English-UK",
    "allMailingList": "yourCommunityName@example.com",
    "adminMailingList": "yourCommunityName-admin@example.com",
    "copyrightMessage": "DeFaUlT-MeSsAgE",
    "privacyPolicyURL": "DeFaUlT-MeSsAgE",
    "securitySeededUsers": "fmwadmin",
    "securitySeededRoles": "Moderator",
    "pageCreationSettingScheme": "WCSchemeNone",
    "portalLifecycleStateMode": "active",
    "portalLifecycleStateLastChangedBy": "fmwadmin",
    "acronym": "AI",
    "portalColor": "#84BBE6",
    "subGSCount": 0,
    "reorderDeviceGroups": false,
    "isPublic": true,
    "memberCount": 4,
    "isSeeded": false,
    "navigationRootNode": {
        "links": [
            {
                "href": "http://example.com:8888/rest/api/v1/portal/portals/Aoc/navigationRootNode?utoken=IKGspIU",
                "rel": "alternate",
                "resourceType": "urn:oracle:webcenter:portal:navigationnode",
                "capabilities": "urn:oracle:webcenter:read urn:oracle:webcenter:delete"
            },
            
        ],
        "resourceType": "urn:oracle:webcenter:portal:navigationnode",
        "namespace": "",
        "portalName": "aviintranet",
        "name": "root"
    },
    "isOnline": false,
    "isDiscoverable": true,
    "isPublishRSS": false,
    "isSelfRegistration": false,
    "isFooterHidden": false,
    "isWorkflowApprovalSubscriptionApprovalRequired": false,
    "isWorkflowApprovalSubscriptionEnableAllRoles": false,
    "isWorkflowApprovalUnsubscriptionApprovalRequired": false,
    "isWorkflowApprovalUnsubscriptionEnableAllRoles": false,
    "isPageCreationSettingInstantCreate": false,
    "isClosed": false,
    "isBlockAllAccess": false,
    "javaFormatId": "dd0a229dc",
    "namespace": "portal",
    "modifier": "admin",
    "modified": "2018-07-26T02:38:43.867Z",
    "creator": "admin",
    "currentVersionId": "39320e67-611a-48fc-bcb2-6d1a733cd5f8",
    "created": "2015-04-03T10:27:52.110Z",
    "securityId": "space/id",
    "shortId": "Aoc",
    "locale": "en_US",
    "id": "753dd0a229dc",
    "name": "aviintranet"
}