Retrieve Portals

get

/v1/portal/portals

Returns information about the portal based on the specified query. Note: when search criteria is omitted, returns all the available portal

Request

Query Parameters
Back to Top

Response

Supported Media Types

200 Response

success
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : portals
Type: object
Show Source
Nested Schema : linkStates
Type: array
Show Source
Nested Schema : portal
Type: array
Show Source
Nested Schema : LinkElementState
Type: object
Show Source
Nested Schema : pathLinkValues
Type: array
Show Source
Nested Schema : pathLinkWildcards
Type: array
Show Source
Nested Schema : reflect.Method
Type: object
Show Source
Nested Schema : annotatedExceptionTypes
Type: array
Show Source
Nested Schema : annotatedParameterTypes
Type: array
Show Source
Nested Schema : reflect.AnnotatedType
Type: object
Show Source
Nested Schema : genericExceptionTypes
Type: array
Show Source
Nested Schema : genericParameterTypes
Type: array
Show Source
Nested Schema : reflect.Type
Type: object
Show Source
Nested Schema : parameters
Type: array
Show Source
Nested Schema : typeParameters
Type: array
Show Source
Nested Schema : reflect.Parameter
Type: object
Show Source
Nested Schema : reflect.Executable
Type: object
Show Source
Nested Schema : annotatedExceptionTypes
Type: array
Show Source
Nested Schema : annotatedParameterTypes
Type: array
Show Source
Nested Schema : genericExceptionTypes
Type: array
Show Source
Nested Schema : genericParameterTypes
Type: array
Show Source
Nested Schema : parameters
Type: array
Show Source
Nested Schema : typeParameters
Type: array
Show Source
Nested Schema : reflect.TypeVariable
Type: object
Show Source
Nested Schema : annotatedBounds
Type: array
Show Source
Nested Schema : bounds
Type: array
Show Source
Nested Schema : portal
Type: object
Show Source
Nested Schema : includedServices
Type: array
Show Source
Nested Schema : linkStates
Type: array
Show Source
Nested Schema : Locale
Type: object
Show Source
Nested Schema : Linked
Type: object
Show Source
Nested Schema : reference
Type: object
Show Source
Nested Schema : unicodeLocaleAttributes
Type: array
Show Source
Nested Schema : unicodeLocaleKeys
Type: array
Show Source
Nested Schema : linkStates
Type: array
Show Source
Nested Schema : linkStates
Type: array
Show Source

400 Response

Bad request: invalid search or orderBy parameter supplied

403 Response

Invalid utoken supplied
Back to Top

Examples

Use the endpoint to retrieve a collection of portals available in Oracle WebCenter Portal that you are authorized to view. In the response, you can view information related to each portal, including shortId, which is used to retrieve additional information about a portal. For example, retrieve information about resource catalog or skins of a portal. You can use the query parameters to filter your results.

To retrieve information about the available portals in Oracle WebCenter Portal submit a GET request on the REST resource. Use the following format to submit a GET request using cURL:

curl -i -X GET 
http://hostname:port/rest/api/v1/portal/portals?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.

HTTP Status Code

HTTP_STATUS = 200

Example of Response Body

In this example, you can view the contents of the response body in JSON format, including the shortId for the portal, In this example, shortId: Aiki s highlighted.

{
    "resourceType": "urn:oracle:webcenter:portal:portals",
    "startIndex": 0,
    "itemsPerPage": 10,
    "items": [
        {       
        .                                                                               ,
            "resourceType": "urn:oracle:webcenter:portal:portal",
            "displayName": "Default Group Space Metadata",
            "icon": "/oracle/webcenter/space/metadata/spaces/images/project_logo.gif",
            "logo": "/oracle/webcenter/space/metadata/spaces/images/project_logo.gif",
            "supportedLanguages": "English-US, English-UK",
            "allMailingList": "all@example.com",
            "adminMailingList": "admin@example.com",
            "securitySeededUsers": "admin",
            "securitySeededRoles": "Moderator",
            "pageCreationSettingScheme": "WCSchemeNone",
            "portalLifecycleStateMode": "active",
            "portalLifecycleStateLastChangedBy": "admin",
            "subGSCount": 0,
            "reorderDeviceGroups": false,
            "isPublic": true,
            "memberCount": 0,
            "isSeeded": true,
            "isFooterHidden": false,
            "isOnline": true,
            "isDiscoverable": true,
            "isPublishRSS": false,
            "isSelfRegistration": false,
            "isWorkflowApprovalSubscriptionApprovalRequired": true,
            "isWorkflowApprovalSubscriptionEnableAllRoles": true,
            "isWorkflowApprovalUnsubscriptionApprovalRequired": true,
            "isWorkflowApprovalUnsubscriptionEnableAllRoles": true,
            "isPageCreationSettingInstantCreate": false,
            "isClosed": false,
            "isBlockAllAccess": false,
            "javaFormatId": "s8bba_beee_296c916a23ed",
            "created": "2018-07-09T01:46:12.943Z",
            "securityId": "portal/s8bbyrrf_296abcdd",
            "shortId": "Aik",
            "creator": "system",
            "modifier": "system",
            "modified": "2018-07-09T01:46:12.943Z",
            "description": "This is the default group space metadata",
            "namespace": "portal",
            "currentVersionId": "7bd-99aa-ab34aec08163",
            "locale": "en_US",
            "id": "8bba98ff-296c916a23ed",
            "name": "DefaultGroupSpace"
        }
    ]
}
Back to Top