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
Back to Top

Response

Supported Media Types
  • application/json

200 Response

success
Body (
  1. schema
)
Root Schema : schema
Type: array
Show Source
Nested Schema : portalTemplates
Type: object
Show Source
  • items(optional): array items
  • itemsPerPage(optional): integer(int32)
  • link(optional): array link
  • linkStates(optional): array linkStates
  • portalTemplate(optional): array portalTemplate
  • resourceType(optional): string
  • startIndex(optional): integer(int32)
  • totalResults(optional): integer(int32)
Nested Schema : items
Type: array
Show Source
  • Array of: string
Nested Schema : linkStates
Type: array
Show Source
Nested Schema : portalTemplate
Type: array
Show Source
Nested Schema : LinkElementState
Type: object
Show Source
  • href(optional): boolean
  • path(optional): string
  • pathLinkValues(optional): array pathLinkValues
  • pathLinkWildcards(optional): array pathLinkWildcards
  • resourceMethod(optional): object reflect.Method
  • resourceType(optional): string
  • root(optional): boolean
  • template(optional): boolean
Nested Schema : pathLinkValues
Type: array
Show Source
  • Array of: string
Nested Schema : pathLinkWildcards
Type: array
Show Source
  • Array of: string
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
  • typeName(optional): string
Nested Schema : parameters
Type: array
Show Source
Nested Schema : typeParameters
Type: array
Show Source
Nested Schema : reflect.Parameter
Type: object
Show Source
  • 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
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
  • 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
  • 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 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
Nested Schema : includedServices
Type: array
Show Source
  • Array of: string
Nested Schema : linkStates
Type: array
Show Source
Nested Schema : Locale
Type: object
Show Source
  • 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
Nested Schema : Linked
Type: object
Show Source
  • link(optional): array link
  • linkStates(optional): array linkStates
  • resourceType(optional): string
Nested Schema : reference
Type: object
Show Source
  • link(optional): array link
  • linkStates(optional): array linkStates
  • Name of the Portal
  • namespace(optional): string
  • portalName(optional): string
  • resourceType(optional): string
Nested Schema : unicodeLocaleAttributes
Type: array
Show Source
  • Array of: string
Nested Schema : unicodeLocaleKeys
Type: array
Show Source
  • Array of: string
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