REST API for Oracle WebCenter Portal

Retrieve Portal Templates

get

/v1/portal/portaltemplates

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

Request

Query Parameters

limit

Type: integer (int32)

the maximum number of returned items

Default Value

offset

Type: integer (int32)

the position of the first item in result set

Default Value

orderBy

Type: string

the attribute by which to order the returned objects

q

Type: string

search criteria, example: NameNamespaceQuery;name:;namespace:portaltemplate

Response

Supported Media Types

application/json

200 Response

success

Body

Root Schema : /paths/~1v1~1portal~1portaltemplates/get/responses/200/schema

Type: array

Items

Type: object portalTemplates

Nested Schema : portalTemplates

Properties

items: Type: array items
itemsPerPage: Type: integer (int32)
link: Type: array link
linkStates: Type: array linkStates
portalTemplate: Type: array portalTemplate
resourceType: Type: string
startIndex: Type: integer (int32)
totalResults: Type: integer (int32)

Nested Schema : items

Type: array

Items

Type: string

Nested Schema : link

Type: array

Items

Type: object link

Nested Schema : linkStates

Type: array

Items

Type: object LinkElementState

Nested Schema : portalTemplate

Type: array

Items

Type: object portal

Nested Schema : link

Properties

capabilities: Type: string
contentType: Type: string
href: Type: string
rel: Type: string
resourceType: Type: string
template: Type: string
title: Type: string
type: Type: string

Nested Schema : LinkElementState

Properties

href: Type: boolean
path: Type: string
pathLinkValues: Type: array pathLinkValues
pathLinkWildcards: Type: array pathLinkWildcards
resourceMethod: Type: object reflect.Method
resourceType: Type: string
root: Type: boolean
supportedMethods: Type: array supportedMethods
supportedQueryParams: Type: array supportedQueryParams
template: Type: boolean

Nested Schema : pathLinkValues

Type: array

Items

Type: string

Nested Schema : pathLinkWildcards

Type: array

Items

Type: string

Nested Schema : reflect.Method

Properties

accessible: Type: boolean
annotatedExceptionTypes: Type: array annotatedExceptionTypes
annotatedParameterTypes: Type: array annotatedParameterTypes
annotatedReceiverType: Type: object reflect.AnnotatedType
annotatedReturnType: Type: object reflect.AnnotatedType
bridge: Type: boolean
default: Type: boolean
defaultValue: Type: integer
genericExceptionTypes: Type: array genericExceptionTypes
genericParameterTypes: Type: array genericParameterTypes
genericReturnType: Type: object reflect.Type
modifiers: Type: integer (int32)
name: Type: string
parameterCount: Type: integer (int32)
parameters: Type: array parameters
synthetic: Type: boolean
typeParameters: Type: array typeParameters
varArgs: Type: boolean

Nested Schema : supportedMethods

Type: array

Items

Type: string

Nested Schema : supportedQueryParams

Type: array

Items

Type: object QueryParam

Nested Schema : annotatedExceptionTypes

Type: array

Items

Type: object reflect.AnnotatedType

Nested Schema : annotatedParameterTypes

Type: array

Items

Type: object reflect.AnnotatedType

Nested Schema : reflect.AnnotatedType

Properties

type: Type: object reflect.Type

Nested Schema : genericExceptionTypes

Type: array

Items

Type: object reflect.Type

Nested Schema : genericParameterTypes

Type: array

Items

Type: object reflect.Type

Nested Schema : reflect.Type

Properties

typeName: Type: string

Nested Schema : parameters

Type: array

Items

Type: object reflect.Parameter

Nested Schema : typeParameters

Type: array

Items

Type: object reflect.TypeVariable

Nested Schema : reflect.Parameter

Properties

annotatedType: Type: object reflect.AnnotatedType
declaringExecutable: Type: object reflect.Executable
implicit: Type: boolean
modifiers: Type: integer (int32)
name: Type: string
namePresent: Type: boolean
parameterizedType: Type: object reflect.Type
synthetic: Type: boolean
varArgs: Type: boolean

Nested Schema : reflect.Executable

Properties

accessible: Type: boolean
annotatedExceptionTypes: Type: array annotatedExceptionTypes
annotatedParameterTypes: Type: array annotatedParameterTypes
annotatedReceiverType: Type: object reflect.AnnotatedType
annotatedReturnType: Type: object reflect.AnnotatedType
genericExceptionTypes: Type: array genericExceptionTypes
genericParameterTypes: Type: array genericParameterTypes
modifiers: Type: integer (int32)
name: Type: string
parameterCount: Type: integer (int32)
parameters: Type: array parameters
synthetic: Type: boolean
typeParameters: Type: array typeParameters
varArgs: Type: boolean

Nested Schema : annotatedExceptionTypes

Type: array

Items

Type: object reflect.AnnotatedType

Nested Schema : annotatedParameterTypes

Type: array

Items

Type: object reflect.AnnotatedType

Nested Schema : genericExceptionTypes

Type: array

Items

Type: object reflect.Type

Nested Schema : genericParameterTypes

Type: array

Items

Type: object reflect.Type

Nested Schema : parameters

Type: array

Items

Type: object reflect.Parameter

Nested Schema : typeParameters

Type: array

Items

Type: object reflect.TypeVariable

Nested Schema : reflect.TypeVariable

Properties

annotatedBounds: Type: array annotatedBounds
bounds: Type: array bounds
name: Type: string

Nested Schema : annotatedBounds

Type: array

Items

Type: object reflect.AnnotatedType

Nested Schema : bounds

Type: array

Items

Type: object reflect.Type

Nested Schema : QueryParam

Properties

value: Type: string

Nested Schema : portal

Properties

acronym: Type: string
adminMailingList: Type: string
allMailingList: Type: string
ancestorPath: Type: string
applicationID: Type: string
copyrightMessage: Type: string
created: Type: string (date-time)
creationStatus: Type: string
creator: Type: string
currentVersionId: Type: string
defaultLanguage: Type: string
description: Type: string
displayName: Type: string
documentRef: Type: string
enabledTools: Type: string
helpPage: Type: string
icon: Type: string
iconScaled: Type: string
id: Type: string
includedServices: Type: array includedServices
includeMembers: Type: boolean
includeRoles: Type: boolean
inviteWebCenterUsersEnabled: Type: string
isBlockAllAccess: Type: boolean
isClosed: Type: boolean
isDiscoverable: Type: boolean
isFooterHidden: Type: boolean
isOnline: Type: boolean
isPageCreationSettingInstantCreate: Type: boolean
isPublic: Type: boolean
isPublishRSS: Type: boolean
isSeeded: Type: boolean
isSelfRegistration: Type: boolean
isWorkflowApprovalSubscriptionApprovalRequired: Type: boolean
isWorkflowApprovalSubscriptionEnableAllRoles: Type: boolean
isWorkflowApprovalUnsubscriptionApprovalRequired: Type: boolean
isWorkflowApprovalUnsubscriptionEnableAllRoles: Type: boolean
javaFormatId: Type: string
keywords: Type: string
link: Type: array link
linkStates: Type: array linkStates
locale: Type: object Locale
loginFailedPage: Type: object Linked
loginPage: Type: object Linked
logo: Type: string
logoScaled: Type: string
memberCount: Type: integer (int32)
modified: Type: string (date-time)
modifier: Type: string
name: Type: string
namespace: Type: string
navigationRootNode: Type: object Linked
newVersionId: Type: string
offlinePage: Type: object Linked
pageCreationSettingScheme: Type: string
pageCreationStyle: Type: object Linked
portalColor: Type: string
portalLifecycleStateLastChangedBy: Type: string
portalLifecycleStateLastChangedDate: Type: string (date-time)
portalLifecycleStateMode: Type: string
preview: Type: string
previewScaled: Type: string
privacyPolicyURL: Type: string
reference: Type: object reference
reorderDeviceGroups: Type: boolean
resourceCatalogForGroupSpaceSiteTemplates: Type: object Linked
resourceType: Type: string
securityId: Type: string
securitySeededRoles: Type: string
securitySeededUsers: Type: string
securitySubscriptionMessagesAddMember: Type: string
securitySubscriptionMessagesInviteMember: Type: string
securitySubscriptionMessagesInviteNonMember: Type: string
selfRegistrationDefaultRole: Type: string
selfRegistrationPage: Type: string
serviceDataCopied: Type: string
shortId: Type: string
skin: Type: object Linked
subGSCount: Type: integer (int32)
supportedLanguages: Type: string
templateName: Type: string
workflowApprovalSubscriptionRoleWorkflows: Type: string
workflowApprovalUnsubscriptionRoleWorkflows: Type: string

Nested Schema : includedServices

Type: array

Items

Type: string

Nested Schema : link

Type: array

Items

Type: object link

Nested Schema : linkStates

Type: array

Items

Type: object LinkElementState

Nested Schema : Locale

Properties

country: Type: string
displayCountry: Type: string
displayLanguage: Type: string
displayName: Type: string
displayScript: Type: string
displayVariant: Type: string
extensionKeys: Type: array extensionKeys
iSO3Country: Type: string
iSO3Language: Type: string
language: Type: string
script: Type: string
unicodeLocaleAttributes: Type: array unicodeLocaleAttributes
unicodeLocaleKeys: Type: array unicodeLocaleKeys
variant: Type: string

Nested Schema : Linked

Properties

link: Type: array link
linkStates: Type: array linkStates
resourceType: Type: string

Nested Schema : reference

Properties

link: Type: array link
linkStates: Type: array linkStates
name: Type: string
namespace: Type: string
portalName: Type: string
resourceType: Type: string

Nested Schema : extensionKeys

Type: array

Items

Type: string

Nested Schema : unicodeLocaleAttributes

Type: array

Items

Type: string

Nested Schema : unicodeLocaleKeys

Type: array

Items

Type: string

Nested Schema : link

Type: array

Items

Type: object link

Nested Schema : linkStates

Type: array

Items

Type: object LinkElementState

Nested Schema : link

Type: array

Items

Type: object link

Nested Schema : linkStates

Type: array

Items

Type: object LinkElementState

400 Response

Bad request: invalid search or orderBy parameter supplied

403 Response

Invalid utoken supplied