Retrieve Portals
/v1/portal/portals
Request
-
limit(optional): integer(int32)
the maximum number of returned itemsDefault Value:
10 -
offset(optional): integer(int32)
the position of the first item in result setDefault Value:
0 -
orderBy(optional): string
the attribute by which to order the returned objects
-
q(optional): string
search criteria, example: NameNamespaceQuery;name:
;namespace:portal
Response
- application/json
200 Response
object-
accessible(optional):
boolean
-
annotatedExceptionTypes(optional):
array annotatedExceptionTypes
-
annotatedParameterTypes(optional):
array annotatedParameterTypes
-
annotatedReceiverType(optional):
object reflect.AnnotatedType
-
annotatedReturnType(optional):
object reflect.AnnotatedType
-
bridge(optional):
boolean
-
default(optional):
boolean
-
defaultValue(optional):
integer
-
genericExceptionTypes(optional):
array genericExceptionTypes
-
genericParameterTypes(optional):
array genericParameterTypes
-
genericReturnType(optional):
object reflect.Type
-
modifiers(optional):
integer(int32)
-
name(optional):
string
-
parameterCount(optional):
integer(int32)
-
parameters(optional):
array parameters
-
synthetic(optional):
boolean
-
typeParameters(optional):
array typeParameters
-
varArgs(optional):
boolean
object-
annotatedType(optional):
object reflect.AnnotatedType
-
declaringExecutable(optional):
object reflect.Executable
-
implicit(optional):
boolean
-
modifiers(optional):
integer(int32)
-
name(optional):
string
-
namePresent(optional):
boolean
-
parameterizedType(optional):
object reflect.Type
-
synthetic(optional):
boolean
-
varArgs(optional):
boolean
object-
accessible(optional):
boolean
-
annotatedExceptionTypes(optional):
array annotatedExceptionTypes
-
annotatedParameterTypes(optional):
array annotatedParameterTypes
-
annotatedReceiverType(optional):
object reflect.AnnotatedType
-
annotatedReturnType(optional):
object reflect.AnnotatedType
-
genericExceptionTypes(optional):
array genericExceptionTypes
-
genericParameterTypes(optional):
array genericParameterTypes
-
modifiers(optional):
integer(int32)
-
name(optional):
string
-
parameterCount(optional):
integer(int32)
-
parameters(optional):
array parameters
-
synthetic(optional):
boolean
-
typeParameters(optional):
array typeParameters
-
varArgs(optional):
boolean
object-
acronym(optional):
string
-
adminMailingList(optional):
string
-
allMailingList(optional):
string
-
ancestorPath(optional):
string
-
applicationID(optional):
string
-
copyrightMessage(optional):
string
-
created(optional):
string(date-time)
-
creationStatus(optional):
string
-
creator(optional):
string
-
currentVersionId(optional):
string
-
defaultLanguage(optional):
string
-
description(optional):
string
-
displayName:
string
Name of the portal as displayed to users.
-
documentRef(optional):
string
-
enabledTools(optional):
string
-
helpPage(optional):
string
-
icon(optional):
string
-
iconScaled(optional):
string
-
id(optional):
string
-
includedServices(optional):
array includedServices
-
includeMembers(optional):
boolean
-
includeRoles(optional):
boolean
-
inviteWebCenterUsersEnabled(optional):
string
-
isBlockAllAccess(optional):
boolean
-
isClosed(optional):
boolean
-
isDiscoverable(optional):
boolean
- isFooterHidden(optional): boolean
-
isOnline(optional):
boolean
-
isPageCreationSettingInstantCreate(optional):
boolean
-
isPublic(optional):
boolean
-
isPublishRSS(optional):
boolean
-
isSeeded(optional):
boolean
-
isSelfRegistration(optional):
boolean
-
isWorkflowApprovalSubscriptionApprovalRequired(optional):
boolean
-
isWorkflowApprovalSubscriptionEnableAllRoles(optional):
boolean
-
isWorkflowApprovalUnsubscriptionApprovalRequired(optional):
boolean
-
isWorkflowApprovalUnsubscriptionEnableAllRoles(optional):
boolean
-
javaFormatId(optional):
string
-
keywords(optional):
string
-
link(optional):
array link
-
linkStates(optional):
array linkStates
-
locale(optional):
object Locale
-
loginFailedPage(optional):
object Linked
-
loginPage(optional):
object Linked
-
logo(optional):
string
-
logoScaled(optional):
string
-
memberCount(optional):
integer(int32)
-
modified(optional):
string(date-time)
-
modifier(optional):
string
-
name:
string
Name of the portal. Note the name of the portal is without space. For example, HRportal.
-
namespace(optional):
string
- navigationRootNode(optional): object Linked
-
newVersionId(optional):
string
-
offlinePage(optional):
object Linked
-
pageCreationSettingScheme(optional):
string
-
pageCreationStyle(optional):
object Linked
-
portalColor(optional):
string
-
portalLifecycleStateLastChangedBy(optional):
string
-
portalLifecycleStateLastChangedDate(optional):
string(date-time)
-
portalLifecycleStateMode(optional):
string
-
preview(optional):
string
-
previewScaled(optional):
string
-
privacyPolicyURL(optional):
string
-
reference(optional):
object reference
-
reorderDeviceGroups(optional):
boolean
-
resourceCatalogForGroupSpaceSiteTemplates(optional):
object Linked
-
resourceType(optional):
string
-
securityId(optional):
string
-
securitySeededRoles(optional):
string
-
securitySeededUsers(optional):
string
-
securitySubscriptionMessagesAddMember(optional):
string
-
securitySubscriptionMessagesInviteMember(optional):
string
-
securitySubscriptionMessagesInviteNonMember(optional):
string
-
selfRegistrationDefaultRole(optional):
string
-
selfRegistrationPage(optional):
string
-
serviceDataCopied(optional):
string
-
shortId(optional):
string
-
skin(optional):
object Linked
-
subGSCount(optional):
integer(int32)
-
supportedLanguages(optional):
string
-
workflowApprovalSubscriptionRoleWorkflows(optional):
string
-
workflowApprovalUnsubscriptionRoleWorkflows(optional):
string
object-
country(optional):
string
-
displayCountry(optional):
string
-
displayLanguage(optional):
string
-
displayName(optional):
string
-
displayScript(optional):
string
-
displayVariant(optional):
string
-
iSO3Country(optional):
string
-
iSO3Language(optional):
string
-
language(optional):
string
-
script(optional):
string
-
unicodeLocaleAttributes(optional):
array unicodeLocaleAttributes
-
unicodeLocaleKeys(optional):
array unicodeLocaleKeys
-
variant(optional):
string
400 Response
403 Response
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:portis the name of the host and the IP port where Oracle WebCenter Portal is running. For example,example.com:8888. -
utokenis 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"
}
]
}