Jump to

• Request
• Response

Create Page Template for a Portal

post

/v1/portal/portals/{portalId}/pagetemplates

Creates a page template as a subresource of a portal and returns information about the new page template

Request

Path Parameters

• portalId: string
  The short Id of a portal.

Body ()

Root Schema : pagetemplate

Type: object

Show Source

• category(optional): string
• contentDir(optional): string
• created(optional): string(date-time)
• creator(optional): string
• currentVersionId(optional): string
• description(optional): string
• descriptionKey(optional): string
• displayName(optional): string
• displayNameKey(optional): string
• documentRef(optional): string
• excludedFrom(optional): string
  Allowed Values: [ "EXCLUDED_FROM_HOME_PORTAL", "EXCLUDED_FROM_ALL_PORTALS", "EXCLUDED_FROM_PORTAL_IDS" ]
• excludedPortalIds(optional): string
• iconURI(optional): string
• id(optional): string
• inputFileName(optional): string
• link(optional): array link
• linkStates(optional): array linkStates
• locale(optional): object Locale
• lockedBy(optional): string
• lockedDate(optional): string(date-time)
• logoURL(optional): string
• modified(optional): string(date-time)
• modifier(optional): string
• name(optional): string
• namespace(optional): string
• newVersionId(optional): string
• pageDefinitionPath(optional): string
• pagePath(optional): string
• pageViewType(optional): string
  Allowed Values: [ "JSF", "JSPX" ]
• panelFooterHeight(optional): string
• panelSeparatorWidth(optional): string
• preferredSkin(optional): string
• resourceBundle(optional): string
• resourceType(optional): string
• securityId(optional): string
• seeded(optional): boolean
• shortId(optional): string
• sidePanelWidth(optional): string
• sourcePageDefinitionPath(optional): string
• sourcePath(optional): string
• templateFixedWidth(optional): string
• translatedDescription(optional): string
• usesCustomSecurity(optional): boolean
• visible(optional): boolean
• wcsUsesSpacesNavigationPane(optional): boolean

{
    "properties":{
        "translatedDescription":{
            "type":"string"
        },
        "pageViewType":{
            "type":"string",
            "enum":[
                "JSF",
                "JSPX"
            ]
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "descriptionKey":{
            "type":"string"
        },
        "usesCustomSecurity":{
            "type":"boolean"
        },
        "iconURI":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "shortId":{
            "type":"string"
        },
        "securityId":{
            "type":"string"
        },
        "documentRef":{
            "type":"string"
        },
        "seeded":{
            "type":"boolean"
        },
        "id":{
            "type":"string"
        },
        "excludedFrom":{
            "type":"string",
            "enum":[
                "EXCLUDED_FROM_HOME_PORTAL",
                "EXCLUDED_FROM_ALL_PORTALS",
                "EXCLUDED_FROM_PORTAL_IDS"
            ]
        },
        "panelFooterHeight":{
            "type":"string"
        },
        "templateFixedWidth":{
            "type":"string"
        },
        "wcsUsesSpacesNavigationPane":{
            "type":"boolean"
        },
        "creator":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "locale":{
            "$ref":"#/definitions/Locale"
        },
        "visible":{
            "type":"boolean"
        },
        "excludedPortalIds":{
            "type":"string"
        },
        "lockedBy":{
            "type":"string"
        },
        "modifier":{
            "type":"string"
        },
        "sidePanelWidth":{
            "type":"string"
        },
        "newVersionId":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "pagePath":{
            "type":"string"
        },
        "sourcePath":{
            "type":"string"
        },
        "contentDir":{
            "type":"string"
        },
        "modified":{
            "type":"string",
            "format":"date-time"
        },
        "inputFileName":{
            "type":"string"
        },
        "sourcePageDefinitionPath":{
            "type":"string"
        },
        "pageDefinitionPath":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "linkStates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkElementState"
            }
        },
        "namespace":{
            "type":"string"
        },
        "resourceType":{
            "type":"string"
        },
        "preferredSkin":{
            "type":"string"
        },
        "displayNameKey":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        },
        "logoURL":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "panelSeparatorWidth":{
            "type":"string"
        },
        "resourceBundle":{
            "type":"string"
        },
        "currentVersionId":{
            "type":"string"
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : linkStates

Type: array

Show Source

• Array of: object LinkElementState

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkElementState"
    }
}

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

{
    "properties":{
        "iSO3Country":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "iSO3Language":{
            "type":"string"
        },
        "displayLanguage":{
            "type":"string"
        },
        "unicodeLocaleAttributes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "language":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        }
    }
}

Nested Schema : link

Type: object

Show Source

• capabilities(optional): string
• contentType(optional): string
• href(optional): string
• rel(optional): string
• resourceType(optional): string
• template(optional): string
• title(optional): string
• type(optional): string

{
    "properties":{
        "contentType":{
            "type":"string"
        },
        "resourceType":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "capabilities":{
            "type":"string"
        },
        "template":{
            "type":"string"
        },
        "title":{
            "type":"string"
        }
    }
}

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

{
    "properties":{
        "resourceType":{
            "type":"string"
        },
        "root":{
            "type":"boolean"
        },
        "path":{
            "type":"string"
        },
        "template":{
            "type":"boolean"
        },
        "pathLinkValues":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "pathLinkWildcards":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "href":{
            "type":"boolean"
        },
        "resourceMethod":{
            "$ref":"#/definitions/reflect.Method"
        }
    }
}

Nested Schema : pathLinkValues

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : pathLinkWildcards

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : reflect.Method

Type: object

Show Source

• 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

{
    "properties":{
        "genericExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "genericParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "varArgs":{
            "type":"boolean"
        },
        "annotatedReturnType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "parameterCount":{
            "type":"integer",
            "format":"int32"
        },
        "annotatedReceiverType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "bridge":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "annotatedExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "accessible":{
            "type":"boolean"
        },
        "modifiers":{
            "type":"integer",
            "format":"int32"
        },
        "synthetic":{
            "type":"boolean"
        },
        "genericReturnType":{
            "$ref":"#/definitions/reflect.Type"
        },
        "defaultValue":{
            "type":"integer"
        },
        "annotatedParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Parameter"
            }
        },
        "typeParameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.TypeVariable"
            }
        },
        "default":{
            "type":"boolean"
        }
    }
}

Nested Schema : annotatedExceptionTypes

Type: array

Show Source

• Array of: object reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

Nested Schema : annotatedParameterTypes

Type: array

Show Source

• Array of: object reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

Nested Schema : reflect.AnnotatedType

Type: object

Show Source

• type(optional): object reflect.Type

{
    "properties":{
        "type":{
            "$ref":"#/definitions/reflect.Type"
        }
    }
}

Nested Schema : genericExceptionTypes

Type: array

Show Source

• Array of: object reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

Nested Schema : genericParameterTypes

Type: array

Show Source

• Array of: object reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

Nested Schema : reflect.Type

Type: object

Show Source

• typeName(optional): string

{
    "properties":{
        "typeName":{
            "type":"string"
        }
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object reflect.Parameter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Parameter"
    }
}

Nested Schema : typeParameters

Type: array

Show Source

• Array of: object reflect.TypeVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.TypeVariable"
    }
}

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

{
    "properties":{
        "varArgs":{
            "type":"boolean"
        },
        "implicit":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "namePresent":{
            "type":"boolean"
        },
        "annotatedType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "modifiers":{
            "type":"integer",
            "format":"int32"
        },
        "synthetic":{
            "type":"boolean"
        },
        "declaringExecutable":{
            "$ref":"#/definitions/reflect.Executable"
        },
        "parameterizedType":{
            "$ref":"#/definitions/reflect.Type"
        }
    }
}

Nested Schema : reflect.Executable

Type: object

Show Source

• 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

{
    "properties":{
        "genericExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "genericParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "varArgs":{
            "type":"boolean"
        },
        "annotatedReturnType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "parameterCount":{
            "type":"integer",
            "format":"int32"
        },
        "annotatedReceiverType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "name":{
            "type":"string"
        },
        "annotatedExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "accessible":{
            "type":"boolean"
        },
        "modifiers":{
            "type":"integer",
            "format":"int32"
        },
        "synthetic":{
            "type":"boolean"
        },
        "annotatedParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Parameter"
            }
        },
        "typeParameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.TypeVariable"
            }
        }
    }
}

Nested Schema : annotatedExceptionTypes

Type: array

Show Source

• Array of: object reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

Nested Schema : annotatedParameterTypes

Type: array

Show Source

• Array of: object reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

Nested Schema : genericExceptionTypes

Type: array

Show Source

• Array of: object reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

Nested Schema : genericParameterTypes

Type: array

Show Source

• Array of: object reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object reflect.Parameter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Parameter"
    }
}

Nested Schema : typeParameters

Type: array

Show Source

• Array of: object reflect.TypeVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.TypeVariable"
    }
}

Nested Schema : reflect.TypeVariable

Type: object

Show Source

• annotatedBounds(optional): array annotatedBounds
• bounds(optional): array bounds
• name(optional): string

{
    "properties":{
        "bounds":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "annotatedBounds":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : annotatedBounds

Type: array

Show Source

• Array of: object reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

Nested Schema : bounds

Type: array

Show Source

• Array of: object reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

Nested Schema : unicodeLocaleAttributes

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleKeys

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

403 Response

Invalid utoken supplied

Back to Top