1. REST API for Sites Management
  2. Tasks
  3. Themes
  4. Updating and Copying

Copy a Theme

post

/sites/management/api/v1/themes/{id}/copy

EXTENDED OPERATION

Copy a theme by providing a new theme name and optional description. Theme names are case sensitive and two themes cannot share the same name. Use only letters, numbers, hyphens, and underscores in theme names. Copying a theme also copies the theme folder, including all the theme artifacts.

Introduced in release 19.4.1.

Authorization

To invoke this operation, the authenticated user or client application must have been shared with the resource and have one of the following sharing roles:

  • Owner
  • Manager
  • Contributor
  • Downloader

To invoke this operation, the authenticated user or client application must have one of the following roles:

  • CECDeveloperUser
  • CECSitesAdministrator
  • CECContentAdministrator

Asynchronous Processing

This operation supports both asynchronous and synchronous processing. The client can specify a preferred interaction mode by adding a Prefer header with a value of respond-async. The server may change an asynchronous request to synchronous so the client should be prepared to handle both cases. An accepted response will include a Location header, which provides the location of a status resource that can be polled to obtain information about the asynchronous processing.

For more information about reading the status see Get the Progress of a Site Related Job.

Path Alternative Identifiers

The default identifier for a Theme resource is the Theme Identifier. The Theme resource supports alternative identifiers.

nameTheme Name

Instead of the theme identifier, the theme name can be used to uniquely identify a theme in the resource path. The default resource path parameter for a theme is the theme identifier, but when working with themes the human-readable theme name is sometimes easier.

http://api.example.com/sites/management/api/v1/themes/name:LearnTheme/copy

Introduced in release 19.4.1.

Successful Response Examples

This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

201Created - Copy a Theme Specifying a Name and Description

Copy a theme specifying a new name and description for the copy.

Request

POST https://api.example.com/sites/management/api/v1/themes/{id}/copy

Request Body

{
  "name": "LearnThemeCopy",
  "description": "A copy of the learn theme."
}

202Accepted - Copy a Theme Specifying a Name and Description Asynchronously

Copy a theme specifying a new name and description for the copy asynchronously.

Request

POST https://api.example.com/sites/management/api/v1/themes/{id}/copy

Request Headers

Prefer=respond-async

Request Body

{
  "name": "LearnThemeCopy",
  "description": "A copy of the learn theme."
}

Client Error Response Examples

This operation responds with the following client error (4xx) responses, with exception details in the response body or reported through the asynchronous job. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

400Bad Request - Invalid Theme Name

The provided theme name cannot be used because it contains characters or words that are not allowed. The reason the theme name is invalid will be reported in the error message.

Error Code

OCE-SITEMGMT-009052

Resolution - Remove Spaces

Change the theme name so that it does not contain spaces.

Resolution - Check Characters

Use only letters, numbers, hyphens, and underscores in theme names.

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error will not be returned in the asynchronous job status.
Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
themeNameInvalid theme name.
reasonReason the theme name is invalid. Valid values are:
  • tooLong - Name is too long
  • invalidCharacters - Name contains invalid characters
  • startWithSpace - Name starts with a space
  • endWithSpace - Name ends with a space
  • internalWord - Name is a restricted internal word
  • empty - Name is empty

For detailed information about this exception detail type, consult the InvalidThemeNameExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Theme Name",
  "status": "400",
  "detail": "Theme name '{themeName}' cannot be used to create a theme.",
  "o:errorCode": "OCE-SITEMGMT-009052",
  "themeName": "CafeSupremoTheme",
  "reason": "tooLong"
}

Introduced in release 19.4.1.

403Forbidden - Storage Limit Reached

Storage transfer limit has been reached. Billing limits have been set on the amount of storage available by the system administrator.

Error Code

OCE-SITEMGMT-009098

Resolution - Increase Storage Limit

Get a system administrator to increase the storage limit.

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error will not be returned in the asynchronous job status.
Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
usedStorage used, in GB.
limitStorage limit, in GB.

For detailed information about this exception detail type, consult the StorageLimitReachedExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Storage Limit Reached",
  "status": "403",
  "detail": "Storage limit has been reached.",
  "o:errorCode": "OCE-SITEMGMT-009098",
  "used": 1.23456789,
  "limit": 1.23456789
}

Introduced in release 20.3.1.

403Forbidden - Sites Administrator Role Required

The Sites Administrator role is required to create resources of this type.

Error Code

OCE-SITEMGMT-009140

Resolution - Change Sites System Settings

Creation of sites, templates, themes and components can be restricted to sites administrators. Update the Sites System settings to allow creation of sites resources of this type by non admin users.

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error can be returned in the asynchronous job status.
Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
resourceTypeResource type that can only be created by Sites Administrators. Valid values are:
  • site - Site resource
  • template - Template resource
  • theme - Theme resource
  • component - Component resource
nameName of resource being created, if available.

For detailed information about this exception detail type, consult the SitesAdminRoleRequiredExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Sites Administrator Role Required",
  "status": "403",
  "detail": "The Sites Administrator role is required to create resources of this type.",
  "o:errorCode": "OCE-SITEMGMT-009140",
  "resourceType": "site",
  "name": "value"
}

Introduced in release 22.5.2.

404Not Found - Theme Not Found

The site theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.

Error Code

OCE-SITEMGMT-009041

Resolution - Check Identifier

Check that the theme identifier is valid.

Resolution - Check Membership

Check that the authenticated user is a member of the theme.

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error will not be returned in the asynchronous job status.
Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
themeTheme that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the ThemeNotFoundExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Theme Not Found",
  "status": "404",
  "detail": "Theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.",
  "o:errorCode": "OCE-SITEMGMT-009041",
  "theme": {
    "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
  }
}

Introduced in release 19.4.1.

409Conflict - Theme Already Exists

A theme with the same name or identity already exists. Theme names and identities must be unique across all themes.

Error Code

OCE-SITEMGMT-009042

Resolution - Change the Theme Name

If clashing on name during a copy or rename, choose a different name.

Resolution - Change the Conflict Resolution Name

If clashing on name during an import, choose a different name for the theme conflict resolution.

Resolution - Change the Conflict Resolution Action

If clashing on identity during an import, change the theme conflict resolution type to overwrite, create, or skip.

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error will not be returned in the asynchronous job status.
Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
themeDuplicate theme.
nameDuplicate name.
itemGuidDuplicate identity Guid.

For detailed information about this exception detail type, consult the ThemeAlreadyExistsExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Theme Already Exists",
  "status": "409",
  "detail": "A theme with the same name or identity already exists.",
  "o:errorCode": "OCE-SITEMGMT-009042",
  "theme": {
    "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
  },
  "name": "CafeSupremoTheme",
  "itemGuid": "value"
}

Introduced in release 19.4.1.

409Conflict - Theme Deleted

The operation cannot be performed on a soft deleted theme. This error can only occur when the includeDeleted query parameter set to true

Error Code

OCE-SITEMGMT-009062

Resolution - Restore Theme

Restore the theme and then try the operation again.

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error will not be returned in the asynchronous job status.
Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
themeTheme that is soft deleted.

For detailed information about this exception detail type, consult the ThemeDeletedExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Theme Deleted",
  "status": "409",
  "detail": "The operation cannot be performed as the theme has been soft deleted.",
  "o:errorCode": "OCE-SITEMGMT-009062",
  "theme": {
    "id": "FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
  }
}

Introduced in release 19.4.1.

409Conflict - Theme Import In Progress

This error will occur when a theme is being copied or published, but at the same time it is being overwritten by a template import.

Error Code

OCE-SITEMGMT-009106

Resolution - Wait for Theme Import to Complete

Wait for the template import that is overwriting theme to complete and try again.

Where This Error Can be Returned
  • This error can be returned in the response body.
  • This error can be returned in the asynchronous job status.
Exception Detail Fields

This error type includes the following fields/values in the response:

Field NameDescription
importedByFull name of the user that created the import job that is in progress.
nameTheme name.

For detailed information about this exception detail type, consult the ThemeImportInProgressExceptionDetail schema in the definitions section of the swagger document.

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Theme Import In Progress",
  "status": "409",
  "detail": "Unable to access theme as it is in the progress of being re-imported.",
  "o:errorCode": "OCE-SITEMGMT-009106",
  "importedBy": "value",
  "name": "CafeSupremoTheme"
}

Introduced in release 20.4.2.

Request

Supported Media Types
Path Parameters
Query Parameters

  • Resources that have been marked for deletion can be read, modified, and support extended operations as long this query parameter is set to true. When the includeDeleted query parameter is not sent then the response to read, modification, and extended operations will be identical to that which would be returned if the resource was permanently deleted.

Header Parameters
Body ()

Details about the copy.

Root Schema : schema
Type: object
Show Source
  • Maximum Length: 1000

    Optional description. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.

    Introduced in release 19.4.1.
  • Maximum Length: 255

    Name of the theme.

    Introduced in release 19.4.1.
Example:
{
    "name":"LearnThemeCopy",
    "description":"A copy of the learn theme."
}
Back to Top

Response

201 Response

Created
Headers

202 Response

Accepted
Headers

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : InvalidThemeNameExceptionDetail
Introduced in release 19.4.1.
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : InvalidThemeNameExceptionDetail-allOf[1]
Type: object
Show Source

  • Reason the theme name is invalid.

    Valid values are:

    • tooLong - Name is too long
    • invalidCharacters - Name contains invalid characters
    • startWithSpace - Name starts with a space
    • endWithSpace - Name ends with a space
    • internalWord - Name is a restricted internal word
    • empty - Name is empty

    Introduced in release 19.4.1.
  • Maximum Length: 255

    Invalid theme name.

    Introduced in release 19.4.1.
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Invalid Theme Name)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Theme Name",
    "status":"400",
    "detail":"Theme name '{themeName}' cannot be used to create a theme.",
    "o:errorCode":"OCE-SITEMGMT-009052",
    "themeName":"CafeSupremoTheme",
    "reason":"tooLong"
}

401 Response

Unauthorized

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : StorageLimitReachedExceptionDetail
Introduced in release 20.3.1.
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : StorageLimitReachedExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Storage Limit Reached)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Storage Limit Reached",
    "status":"403",
    "detail":"Storage limit has been reached.",
    "o:errorCode":"OCE-SITEMGMT-009098",
    "used":1.23456789,
    "limit":1.23456789
}
Example Response (Sites Administrator Role Required)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Sites Administrator Role Required",
    "status":"403",
    "detail":"The Sites Administrator role is required to create resources of this type.",
    "o:errorCode":"OCE-SITEMGMT-009140",
    "resourceType":"site",
    "name":"value"
}

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : ThemeNotFoundExceptionDetail
Introduced in release 19.4.1.
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : ThemeNotFoundExceptionDetail-allOf[1]
Type: object
Show Source

  • Theme that does not exist or is not visible to the authenticated user.

    Introduced in release 19.4.1.
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Theme Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Not Found",
    "status":"404",
    "detail":"Theme does not exist or has been deleted, or the authenticated user or client application does not have access to the theme.",
    "o:errorCode":"OCE-SITEMGMT-009041",
    "theme":{
        "id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
    }
}

409 Response

Conflict
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : ThemeAlreadyExistsExceptionDetail
Introduced in release 19.4.1.
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : ThemeAlreadyExistsExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Theme Already Exists)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Already Exists",
    "status":"409",
    "detail":"A theme with the same name or identity already exists.",
    "o:errorCode":"OCE-SITEMGMT-009042",
    "theme":{
        "id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
    },
    "name":"CafeSupremoTheme",
    "itemGuid":"value"
}
Example Response (Theme Deleted)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Deleted",
    "status":"409",
    "detail":"The operation cannot be performed as the theme has been soft deleted.",
    "o:errorCode":"OCE-SITEMGMT-009062",
    "theme":{
        "id":"FFA7758925559C7F6FC394910D5DDCD9211A3DB216EC"
    }
}
Example Response (Theme Import In Progress)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Theme Import In Progress",
    "status":"409",
    "detail":"Unable to access theme as it is in the progress of being re-imported.",
    "o:errorCode":"OCE-SITEMGMT-009106",
    "importedBy":"value",
    "name":"CafeSupremoTheme"
}

413 Response

Payload Too Large

415 Response

Unsupported Media Type

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout
Back to Top