Update Portal by Short ID
put
/v1/portal/portals/{id}
Update the portal based on the specified short ID and returns the information about the updated portal
Request
Path Parameters
- id
-
Type:
stringRequired:truethe short id of the portal to be updated
Body Parameter
content of the portal to be updated
Root Schema : portal
- 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:
arrayincludedServices - 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:
arraylink - linkStates
-
Type:
arraylinkStates - locale
-
Type:
objectLocale - loginFailedPage
-
Type:
objectLinked - loginPage
-
Type:
objectLinked - 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:
objectLinked - newVersionId
-
Type:
string - offlinePage
-
Type:
objectLinked - pageCreationSettingScheme
-
Type:
string - pageCreationStyle
-
Type:
objectLinked - 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:
objectreference - reorderDeviceGroups
-
Type:
boolean - resourceCatalogForGroupSpaceSiteTemplates
-
Type:
objectLinked - 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:
objectLinked - subGSCount
-
Type:
integer(int32) - supportedLanguages
-
Type:
string - templateName
-
Type:
string - workflowApprovalSubscriptionRoleWorkflows
-
Type:
string - workflowApprovalUnsubscriptionRoleWorkflows
-
Type:
string
Nested Schema : includedServices
Type:
array-
Type:
string
Nested Schema : linkStates
Type:
array-
Type:
objectLinkElementState
Nested Schema : Locale
- country
-
Type:
string - displayCountry
-
Type:
string - displayLanguage
-
Type:
string - displayName
-
Type:
string - displayScript
-
Type:
string - displayVariant
-
Type:
string - extensionKeys
-
Type:
arrayextensionKeys - iSO3Country
-
Type:
string - iSO3Language
-
Type:
string - language
-
Type:
string - script
-
Type:
string - unicodeLocaleAttributes
-
Type:
arrayunicodeLocaleAttributes - unicodeLocaleKeys
-
Type:
arrayunicodeLocaleKeys - variant
-
Type:
string
Nested Schema : Linked
- link
-
Type:
arraylink - linkStates
-
Type:
arraylinkStates - resourceType
-
Type:
string
Nested Schema : reference
- link
-
Type:
arraylink - linkStates
-
Type:
arraylinkStates - name
-
Type:
string - namespace
-
Type:
string - portalName
-
Type:
string - resourceType
-
Type:
string
Nested Schema : link
- 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
- href
-
Type:
boolean - path
-
Type:
string - pathLinkValues
-
Type:
arraypathLinkValues - pathLinkWildcards
-
Type:
arraypathLinkWildcards - resourceMethod
-
Type:
objectreflect.Method - resourceType
-
Type:
string - root
-
Type:
boolean - supportedMethods
-
Type:
arraysupportedMethods - supportedQueryParams
-
Type:
arraysupportedQueryParams - template
-
Type:
boolean
Nested Schema : pathLinkValues
Type:
array-
Type:
string
Nested Schema : pathLinkWildcards
Type:
array-
Type:
string
Nested Schema : reflect.Method
- accessible
-
Type:
boolean - annotatedExceptionTypes
-
Type:
arrayannotatedExceptionTypes - annotatedParameterTypes
-
Type:
arrayannotatedParameterTypes - annotatedReceiverType
-
Type:
objectreflect.AnnotatedType - annotatedReturnType
-
Type:
objectreflect.AnnotatedType - bridge
-
Type:
boolean - default
-
Type:
boolean - defaultValue
-
Type:
integer - genericExceptionTypes
-
Type:
arraygenericExceptionTypes - genericParameterTypes
-
Type:
arraygenericParameterTypes - genericReturnType
-
Type:
objectreflect.Type - modifiers
-
Type:
integer(int32) - name
-
Type:
string - parameterCount
-
Type:
integer(int32) - parameters
-
Type:
arrayparameters - synthetic
-
Type:
boolean - typeParameters
-
Type:
arraytypeParameters - varArgs
-
Type:
boolean
Nested Schema : supportedMethods
Type:
array-
Type:
string
Nested Schema : supportedQueryParams
Type:
array-
Type:
objectQueryParam
Nested Schema : annotatedExceptionTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : annotatedParameterTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : reflect.AnnotatedType
- type
-
Type:
objectreflect.Type
Nested Schema : genericExceptionTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : genericParameterTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : reflect.Type
- typeName
-
Type:
string
Nested Schema : parameters
Type:
array-
Type:
objectreflect.Parameter
Nested Schema : typeParameters
Type:
array-
Type:
objectreflect.TypeVariable
Nested Schema : reflect.Parameter
- annotatedType
-
Type:
objectreflect.AnnotatedType - declaringExecutable
-
Type:
objectreflect.Executable - implicit
-
Type:
boolean - modifiers
-
Type:
integer(int32) - name
-
Type:
string - namePresent
-
Type:
boolean - parameterizedType
-
Type:
objectreflect.Type - synthetic
-
Type:
boolean - varArgs
-
Type:
boolean
Nested Schema : reflect.Executable
- accessible
-
Type:
boolean - annotatedExceptionTypes
-
Type:
arrayannotatedExceptionTypes - annotatedParameterTypes
-
Type:
arrayannotatedParameterTypes - annotatedReceiverType
-
Type:
objectreflect.AnnotatedType - annotatedReturnType
-
Type:
objectreflect.AnnotatedType - genericExceptionTypes
-
Type:
arraygenericExceptionTypes - genericParameterTypes
-
Type:
arraygenericParameterTypes - modifiers
-
Type:
integer(int32) - name
-
Type:
string - parameterCount
-
Type:
integer(int32) - parameters
-
Type:
arrayparameters - synthetic
-
Type:
boolean - typeParameters
-
Type:
arraytypeParameters - varArgs
-
Type:
boolean
Nested Schema : annotatedExceptionTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : annotatedParameterTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : genericExceptionTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : genericParameterTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : parameters
Type:
array-
Type:
objectreflect.Parameter
Nested Schema : typeParameters
Type:
array-
Type:
objectreflect.TypeVariable
Nested Schema : reflect.TypeVariable
- annotatedBounds
-
Type:
arrayannotatedBounds - bounds
-
Type:
arraybounds - name
-
Type:
string
Nested Schema : annotatedBounds
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : bounds
Type:
array-
Type:
objectreflect.Type
Nested Schema : QueryParam
- value
-
Type:
string
Nested Schema : extensionKeys
Type:
array-
Type:
string
Nested Schema : unicodeLocaleAttributes
Type:
array-
Type:
string
Nested Schema : unicodeLocaleKeys
Type:
array-
Type:
string
Nested Schema : linkStates
Type:
array-
Type:
objectLinkElementState
Nested Schema : linkStates
Type:
array-
Type:
objectLinkElementState
Response
Supported Media Types
- application/json
403 Response
Invalid utoken supplied
405 Response
Method not allowed: request does not contain matching currentVersionId