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(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:portaltemplate
Response
Supported Media Types
- application/json
200 Response
success
Nested Schema : portalTemplates
Type:
Show Source
object
-
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 : link
Type:
Show Source
object
-
capabilities(optional):
string
-
contentType(optional):
string
-
href(optional):
string
-
rel(optional):
string
-
resourceType(optional):
string
-
template(optional):
string
-
title(optional):
string
-
type(optional):
string
Nested Schema : LinkElementState
Type:
Show Source
object
-
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 : reflect.Method
Type:
Show Source
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
Nested Schema : annotatedExceptionTypes
Type:
Show Source
array
-
Array of:
object reflect.AnnotatedType
Nested Schema : annotatedParameterTypes
Type:
Show Source
array
-
Array of:
object reflect.AnnotatedType
Nested Schema : reflect.Parameter
Type:
Show Source
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
Nested Schema : reflect.Executable
Type:
Show Source
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
Nested Schema : annotatedExceptionTypes
Type:
Show Source
array
-
Array of:
object reflect.AnnotatedType
Nested Schema : annotatedParameterTypes
Type:
Show Source
array
-
Array of:
object reflect.AnnotatedType
Nested Schema : reflect.TypeVariable
Type:
Show Source
object
-
annotatedBounds(optional):
array annotatedBounds
-
bounds(optional):
array bounds
-
name(optional):
string
Nested Schema : portal
Type:
Show Source
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
Nested Schema : Locale
Type:
Show Source
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
Nested Schema : Linked
Type:
Show Source
object
-
link(optional):
array link
-
linkStates(optional):
array linkStates
-
resourceType(optional):
string
Nested Schema : reference
Type:
Show Source
object
-
link(optional):
array link
-
linkStates(optional):
array linkStates
-
name(optional):
string
Name of the Portal
-
namespace(optional):
string
-
portalName(optional):
string
-
resourceType(optional):
string
400 Response
Bad request: invalid search or orderBy parameter supplied
403 Response
Invalid utoken supplied