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

Copy a Site

post

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

EXTENDED OPERATION

Copy a site by providing a new site name and optional details, such as a site description. Site names are case sensitive and two sites cannot share the same name. Use only letters, numbers, hyphens, and underscores in site names. If the site being copied is an enterprise site, enterprise site-related fields, such as a site prefix or repository, can also be specified. For enterprise sites the default language and localization policy will be the same as the site being copied. If an enterprise site is being copied and a repository is specified then the authenticated user or client application must have at least a contributor role in the repository. The owner of the site will be the authenticated user or client application if an explicit owner is not provided. When site governance is enabled, a justification can also be provided with the site details because the site copy may need approval before the site is copied.

Introduced in release 19.1.5.

Authorization

When site governance is enabled copying the site may require approval depending on the copy policy for the site. A user can copy a site that has been shared with them and they 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:

  • CECStandardUser
  • CECEnterpriseUser

Email Notifications

When site governance is enabled a request to copy a site may cause an email notification to be sent to the users that can approve the site copy. Automatic approved requests do not cause an email notification to be send, but a request that requires administrator or named user approval may send notifications. The email notification will be sent to an approver if the preferences of the approver allows the send you email when someone requests that you approve the creation of a site notification. No email notifications will ever be sent if notifications are disabled for all users. Email notifications can be suppressed by providing a suppress notifications request header. Presence of this request header will stop any email notifications being generated regardless of the user preferences.

Automatic Approval

When site governance is enabled a request to copy a site that requires approval can be automatically approved under certain circumstances. The request can be automatically approved if the authenticated user or client application is one of the users that is allowed to approve the request. For example if the authenticated user or client application has the site administrator role, and the site copy requires administrator approval then the request can be immediately approved. Automatic approval can be enabled by including the auto approve request request header. If this header is not used then the request to copy a site will remain pending waiting for a review to be added. If a request is automatically approved no email notifications will be sent.

Getting the Progress of Copy Site Request

If site governance is disabled, copying of a site will start immediately, and the progress can be monitored from the site job status resource.

For more information, see Get the Progress of a Site Related Job.

Getting the Progress of a Copy Site Request with Site Governance

If site governance is enabled, copying of a site may require approval, and the job status resource will report a blocked job progress until the request is approved. If the request is approved, then the site processing will start, and progress can be monitored using the status resource. When the status changes to succeeded, the site has been created. The request can be identified using the request link of the status resource returned in the Location header. Further operations on the request can then be performed, such as adding a review to the request so it is approved.

For more information, see Check the Progress of a Request.

Asynchronous Processing

This operation only supports asynchronous processing. A Prefer header with the value of respond-async must be included in the request. 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 Site resource is the Site Identifier. The Site resource supports alternative identifiers.

nameSite Name

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

http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/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.

202Accepted - Copy a Standard Site

For copying a standard site, the site name is required. The copy can include updates from the copied site if required. A description for the copied site can also be provided if required.

Request

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

Request Headers

Prefer=respond-async

Request Body

{
  "name": "AcmeProductLaunch2020",
  "description": "Marketing site for Acme New Product Launch 2020.",
  "includeUpdates": true
}

202Accepted - Copy an Enterprise Site

For copying an enterprise site, the site name is required. The copy can include updates from the copied site if required. A repository can be specified if the repository needs to be different from the repository associated with the site being copied. A site prefix can be specified for the copy. A description for the copied site can also be provided if required.

Request

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

Request Headers

Prefer=respond-async

Request Body

{
  "name": "AcmeProductLaunch2020",
  "description": "Marketing site for Acme New Product Launch 2020.",
  "includeUpdates": false,
  "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0",
  "sitePrefix": "News"
}

202Accepted - Copy a Site and Suppress Email Notifications

Copy a site suppressing any email notifications that would normally be sent to approvers.

Request

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

Request Headers

Prefer=respond-async
X-Suppress-Notifications=true

Request Body

{
  "name": "AcmeProductLaunch2020",
  "description": "Marketing site for Acme New Product Launch 2020.",
  "includeUpdates": true
}
Introduced in release 20.1.3.

202Accepted - Copy a Site and Automatically Approve the Request

Copy a site and and automatically approve the request to copy the site if the authenticated user is also allowed to approve the request.

Request

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

Request Headers

X-Auto-Approve-Request=true
Prefer=respond-async

Request Body

{
  "name": "AcmeProductLaunch2020",
  "description": "Marketing site for Acme New Product Launch 2020.",
  "includeUpdates": true
}
Introduced in release 20.1.3.

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 Site Name

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

Error Code

OCE-SITEMGMT-009012

Resolution - Remove Spaces

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

Resolution - Check Characters

Use only letters, numbers, hyphens, and underscores in site 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
siteNameInvalid site name.
reasonReason the site 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 InvalidSiteNameExceptionDetail 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 Site Name",
  "status": "400",
  "detail": "Site name '{siteName}' cannot be used to create a site.",
  "o:errorCode": "OCE-SITEMGMT-009012",
  "siteName": "MyNewProduct",
  "reason": "tooLong"
}

400Bad Request - Invalid Site Prefix

Site prefix is not a valid prefix.

Error Code

OCE-SITEMGMT-009034

Resolution - Remove Spaces

Change the site prefix so that it does not contain spaces.

Resolution - Check Characters

Use only letters, numbers, hyphens, and underscores in site prefixes.

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
sitePrefixInvalid site prefix value. Site prefixes are limit to 15 characters in length.

For detailed information about this exception detail type, consult the InvalidSitePrefixExceptionDetail 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 Site Prefix",
  "status": "400",
  "detail": "Site prefix '{sitePrefix}' contains invalid characters.",
  "o:errorCode": "OCE-SITEMGMT-009034",
  "sitePrefix": "News Site"
}

400Bad Request - Invalid Site Field

Indicates that a field in the request should not be specified because the associated site (for a copy request) or template (for a new site request) does not require or support the field. For example, a request for a site using a standard template should not specify a localization policy.

Error Code

OCE-SITEMGMT-009017

Resolution - Remove the Default Language Field

Remove the request defaultLanguage field if the template or site is a standard template or standard site.

Resolution - Remove the Localization Policy Field

Remove the request localizationPolicy field if the template or site is a standard template or standard site.

Resolution - Remove the Repository Field

Remove the request repository field if the template or site is a standard template or standard site.

Resolution - Remove the Site Prefix Field

Remove the request sitePrefix field if the template or site is a standard template or standard site.

Resolution - Remove the Default Language Field

Remove the request defaultLanguage field if the template or site is a standard template or standard site.

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
fieldNameField name that is incompatible with the type of site.

For detailed information about this exception detail type, consult the InvalidSiteFieldExceptionDetail 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 Site Field",
  "status": "400",
  "detail": "Field '{fieldName}' should not be provided for this request.",
  "o:errorCode": "OCE-SITEMGMT-009017",
  "fieldName": "defaultLanguage"
}

400Bad Request - Invalid Site Owner

For requesting a new site and specifying the intended owner, the user or client application must exist and have a CEC role, such as standard user, enterprise user or site administrator role.

Error Code

OCE-SITEMGMT-009021

Resolution - Check User Exists

Check that the user identifier is valid.

Resolution - Check Role

Check that the user or application has one of the required roles.

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
userUser or application that does not exist.
requiredRolesThe user must have at least one of these application roles to be the owner. Valid values are:
  • CECServiceAdministrator - Service Administrator
  • Assign user enumerates
  • Change user passwords and challenge questions
  • Configure, monitor, and manage service instances
  • CECSitesAdministrator - Sites Administrator
  • Create sites, templates, themes or components
  • CECRepositoryAdministrator - Repository Administrator
  • CECDeveloperUser - Developer User
  • CECContentAdministrator - Content Administrator
  • Create new content types and publish items
  • CECStandardUser - Standard User
  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • View and interact with content items in sites
  • Manage and view custom properties and edit values
  • CECEnterpriseUser - Enterprise User
  • Manage content (view, upload, and edit documents)
  • Share content and sites with others
  • Use conversations to collaborate (discuss topics, direct message someone, assign flags to someone, add annotations to documents)
  • Follow people
  • Digital Assets
  • Content Items (editorial content management)
  • Create, manage, view, and interact with content items
  • Collections
  • Create, edit, and publish sites
  • Manage and publish site themes
  • Create, register, export, and import custom site components
  • Create, edit, export, and import site templates
  • Manage and view custom properties and edit values
  • CECExternalUser - External User
Reserved for future use.
  • CECIntegrationUser - Integration User
Used to impersonate another user while performing operations through the Social REST endpoints of the REST API for Collaboration.
  • CECSitesVisitor - Sites Visitor
Access sites restricted to visitors.

For detailed information about this exception detail type, consult the InvalidOwnerExceptionDetail 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 Site Owner",
  "status": "400",
  "detail": "User or application does not exist, or does exist but does not have an appropriate role.",
  "o:errorCode": "OCE-SITEMGMT-009021",
  "user": {
    "id": "1234"
  },
  "requiredRoles": [
      "CECServiceAdministrator"
  ]
}

400Bad Request - Invalid Repository

The referenced repository could not be found. Either the repository does not exist or has been deleted, or the authenticated user or client application does not have access to the repository.

Error Code

OCE-CAAS-001006

Resolution - Check Identifier

Check that the repository identifier is valid.

Resolution - Check Membership

Check that the authenticated user is a member of the repository and they have the relevant role to perform the operation relating to the repository.

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
repositoryRepository that does not exist or is not visible to the authenticated user, if the repository identifier has been provided.

For detailed information about this exception detail type, consult the InvalidRepositoryExceptionDetail 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 Repository",
  "status": "400",
  "detail": "Repository does not exist or has been deleted, or the authenticated user or client application does not have access to the repository.",
  "o:errorCode": "OCE-CAAS-001006",
  "repository": {
    "id": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0"
  }
}

Introduced in release 19.2.3.

400Bad Request - Invalid Localization Policy

The referenced localization policy could not be found. Either the localization policy does not exist or has been deleted, or the identifier provided is incorrect.

Error Code

OCE-CAAS-001004

Resolution - Check Identifier

Check that the localization policy identifier is valid.

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
localizationPolicyLocalization policy that does not exist.

For detailed information about this exception detail type, consult the InvalidLocalizationPolicyExceptionDetail 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 Localization Policy",
  "status": "400",
  "detail": "Localization policy does not exist.",
  "o:errorCode": "OCE-CAAS-001004",
  "localizationPolicy": {
    "id": "7D77CB6653BC1FF8E0530100007F6630"
  }
}

Introduced in release 19.2.3.

400Bad Request - Invalid Default Language

The default language is either missing or not one of the required languages supported by the associated localization policy.

Error Code

OCE-CAAS-001003

Resolution - Default Language Missing

If the default language has not been provided, then ensure a default language listed in the error message is provided.

Resolution - Language Not Supported

If a default language has been provided, then ensure that the provided language matches one of the languages listed in the error message.

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
localizationPolicyLocalization policy that does not allow the specified default language.
defaultLanguageInvalid default language.

For detailed information about this exception detail type, consult the InvalidDefaultLanguageExceptionDetail 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 Default Language",
  "status": "400",
  "detail": "Default Language '{defaultLanguage}' is not valid. The default language must be one of the localization policy's required languages.",
  "o:errorCode": "OCE-CAAS-001003",
  "defaultLanguage": "en-US"
}

Introduced in release 19.2.3.

400Bad Request - Site Request Timeout

When a request is approved, it should be processed within a reasonable amount of time. If the request has been approved but has not been completed, the processing may have become lost or stuck. When this happens, the request will have a timeout error associated with the request.

Error Code

OCE-SITEMGMT-009014

Resolution - Retry the Request

Retry the request to restart request processing.

Where This Error Can be Returned
  • This error will never 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
requestRequest whose processing has timed out.

For detailed information about this exception detail type, consult the RequestTimeOutExceptionDetail 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": "Site Request Timeout",
  "status": "400",
  "detail": "Request processing has timed out.",
  "o:errorCode": "OCE-SITEMGMT-009014",
  "request": {
    "id": "e77229e8-1f44-4c27-bacb-9a99b7c77af7"
  }
}

400Bad Request - Unable to Copy Hybrid Link

Unable to copy hybrid link.

Error Code

OCE-SITEMGMT-009104

Resolution - Fix Broken Links

Check links within the site pages and correct any broken ones.

Where This Error Can be Returned
  • This error will never 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
linkIdId of the hybrid link that cannot be copied.
folderIdId of the folder that contains the hybrid link.

For detailed information about this exception detail type, consult the CopyHybridLinkExceptionDetail 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": "Unable to Copy Hybrid Link",
  "status": "400",
  "detail": "Unable to copy hybrid link.",
  "o:errorCode": "OCE-SITEMGMT-009104",
  "linkId": "value",
  "folderId": "value"
}

400Bad Request - Unable to Import Site Content

Unable to create site as the site's content cannot be imported. The details field contains the reason the content failed to import.

Error Code

OCE-SITEMGMT-009111

Where This Error Can be Returned
  • This error will never 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
reasonError string.

For detailed information about this exception detail type, consult the SiteContentImportErrorExceptionDetail 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": "Unable to Import Site Content",
  "status": "400",
  "detail": "{reason}",
  "o:errorCode": "OCE-SITEMGMT-009111"
}

400Bad Request - Unpublished Site Items

Some content used by the site has not been published to the site's channel.

Error Code

OCE-SITEMGMT-009137

Resolution - Publish Content

Ensure all content has been targeted and published to the site's channel.

Where This Error Can be Returned
  • This error will never be returned in the response body.
  • This error can be returned in the asynchronous job status.
Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Unpublished Site Items",
  "status": "400",
  "detail": "Some content used by the site has not been published to the site's channel.",
  "o:errorCode": "OCE-SITEMGMT-009137"
}

400Bad Request - Unable to Export Site Content

The site's content assets cannot be exported.

Error Code

OCE-SITEMGMT-009138

Where This Error Can be Returned
  • This error will never 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
siteNameSite name.

For detailed information about this exception detail type, consult the SiteContentExportErrorExceptionDetail 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": "Unable to Export Site Content",
  "status": "400",
  "detail": "The site's content assets cannot be exported.",
  "o:errorCode": "OCE-SITEMGMT-009138"
}

403Forbidden - Inactive Policy

Indicates that an operation is not allowed as the policy for the operation is inactive.

Error Code

OCE-SITEMGMT-009071

Resolution - Check Policy is Active

Get a site administrator to check that the policy associated with operation is marked as active.

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
policyPolicy that is governing this operation.

For detailed information about this exception detail type, consult the InactivePolicyExceptionDetail 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": "Inactive Policy",
  "status": "403",
  "detail": "The policy for this operation is inactive.",
  "o:errorCode": "OCE-SITEMGMT-009071",
  "policy": {
    "id": "721af08b-32db-4eee-b6af-0c38d3ba4681"
  }
}

403Forbidden - Restricted Policy

Indicates that an operation is not allowed as the policy for the operation is restricted.

Error Code

OCE-SITEMGMT-009072

Resolution - Add User to the Access List

Get a site administrator to add the user or client application as a member of the policy access list.

Resolution - Change the Policy to Everyone Access

Get a site administrator to change the policy accessType to everyone.

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
policyPolicy that is governing this operation.
userUser or application that is not a member of the policy access list.

For detailed information about this exception detail type, consult the RestrictedPolicyExceptionDetail 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": "Restricted Policy",
  "status": "403",
  "detail": "The policy for the operation has a restricted audience and can't be used by the user or client application.",
  "o:errorCode": "OCE-SITEMGMT-009072",
  "policy": {
    "id": "721af08b-32db-4eee-b6af-0c38d3ba4681"
  },
  "user": {
    "id": "1234"
  }
}

403Forbidden - Site Operation Forbidden

Your sharing role within the site does not allow you to perform the operation.

Error Code

OCE-SITEMGMT-009026

Resolution - Change the Sharing Role

Change the sharing role given to the authenticated user to the required role or higher.

Resolution - Change the Application Role

Ensure the user has a Standard User or Enterprise User Application Role.

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
siteSite on which the operation is being performed.

For detailed information about this exception detail type, consult the SiteOperationForbiddenExceptionDetail 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": "Site Operation Forbidden",
  "status": "403",
  "detail": "You do have a sharing role in this site, but your role does not allow you to use this operation.",
  "o:errorCode": "OCE-SITEMGMT-009026",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

Introduced in release 19.1.5.

403Forbidden - Asset Limit Reached

Asset limit has been reached. Asset limits have been set by the system administrator on the amount of assets that can be created.

Error Code

OCE-SITEMGMT-009097

Resolution - Increase Asset Limit

Get a system administrator to increase the asset limit.

Where This Error Can be Returned
  • This error will never 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
usedNumber of assets.
limitAsset limit.

For detailed information about this exception detail type, consult the AssetLimitReachedExceptionDetail 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": "Asset Limit Reached",
  "status": "403",
  "detail": "Asset limit has been reached.",
  "o:errorCode": "OCE-SITEMGMT-009097",
  "used": 1234567890,
  "limit": 1234567890
}

Introduced in release 20.3.1.

403Forbidden - Advanced Video Limit Reached

Advanced video limit has been reached. Advanced video limits have been set by the system administrator on the amount of advanced videos that can be created.

Error Code

OCE-SITEMGMT-009099

Resolution - Increase Advanced Video Limit

Get a system administrator to increase the advanced video limit.

Where This Error Can be Returned
  • This error will never 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
usedNumber of advanced videos.
limitAdvanced video limit.

For detailed information about this exception detail type, consult the AdvancedVideoLimitReachedExceptionDetail 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": "Advanced Video Limit Reached",
  "status": "403",
  "detail": "Advanced video limit has been reached.",
  "o:errorCode": "OCE-SITEMGMT-009099",
  "used": 1234567890,
  "limit": 1234567890
}

Introduced in release 20.3.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 will never 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
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.

403Forbidden - Granular Security Operation Forbidden

Granular security restrictions prevent this operation from being performed on the site or template e.g copying SST sites.

Error Code

OCE-SITEMGMT-009148

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
siteSite on which the operation is being performed.
templateTemplate on which the operation is being performed.

For detailed information about this exception detail type, consult the GranularSecurityOperationForbiddenExceptionDetail 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": "Granular Security Operation Forbidden",
  "status": "403",
  "detail": "Granular security operation forbidden for the site or template.",
  "o:errorCode": "OCE-SITEMGMT-009148",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  },
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

Targeted for a Future Release

This operation is targeted for an undecided future release. This operation may be subject to change.

404Not Found - Site Not Found

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

Error Code

OCE-SITEMGMT-009003

Resolution - Check Identifier

Check that the site identifier is valid.

Resolution - Check Membership

Check that the authenticated user is a member of the site or a site administrator.

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
siteSite that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the SiteNotFoundExceptionDetail 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": "Site Not Found",
  "status": "404",
  "detail": "Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
  "o:errorCode": "OCE-SITEMGMT-009003",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

404Not Found - User Not Found

The user does not exist.

Error Code

OCE-IDS-001001

Where This Error Can be Returned
  • This error will never 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
userUser that does not exist.

For detailed information about this exception detail type, consult the UserNotFoundExceptionDetail 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": "User Not Found",
  "status": "404",
  "detail": "User does not exist.",
  "o:errorCode": "OCE-IDS-001001",
  "user": {
    "id": "1234"
  }
}

409Conflict - Site Deleted

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

Error Code

OCE-SITEMGMT-009059

Resolution - Restore Site

Restore the site 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
siteSite that is soft deleted, if the site identifier has been provided.

For detailed information about this exception detail type, consult the SiteDeletedExceptionDetail 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": "Site Deleted",
  "status": "409",
  "detail": "The operation cannot be performed as the site has been soft deleted.",
  "o:errorCode": "OCE-SITEMGMT-009059",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

Introduced in release 19.4.1.

409Conflict - Site Already Exists

A site with the same name already exists. Site names must be unique across all sites.

Error Code

OCE-SITEMGMT-009004

Resolution - Edit the Site Name

Edit the site name in the request so that it does not clash with an existing site.

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
nameDuplicate name.

For detailed information about this exception detail type, consult the SiteAlreadyExistsExceptionDetail 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": "Site Already Exists",
  "status": "409",
  "detail": "A site with the same name already exists.",
  "o:errorCode": "OCE-SITEMGMT-009004",
  "name": "Oracle Content and Experience"
}

409Conflict - Site Prefix Already Exists

A site with the same site prefix already exists. Site prefixes must be unique across all sites.

Error Code

OCE-SITEMGMT-009029

Resolution - Edit the Site Prefix

Edit the site prefix in the request so that it does not clash with an existing site.

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
sitePrefixSite prefix value that has clashed with an existing site. Site prefixes are limit to 15 characters in length.

For detailed information about this exception detail type, consult the SitePrefixAlreadyExistsExceptionDetail 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": "Site Prefix Already Exists",
  "status": "409",
  "detail": "Site with prefix '{sitePrefix}' already exists.",
  "o:errorCode": "OCE-SITEMGMT-009029",
  "sitePrefix": "News"
}

Introduced in release 19.2.3.

409Conflict - Site Policy Violation

A template or site policy requires that a field value (that is missing) be present or prohibits the use of a field value (that is present). The error message will specify the field name and whether the field is prohibited or required. This error can occur only when site governance is enabled.

Error Code

OCE-SITEMGMT-009035

Resolution - Check Localization Policy is Allowed

If specifying a localization policy, check that the policy allows a localization policy to be specified in the request.

Resolution - Check Site Prefix is Allowed

If specifying a site prefix, check that the policy allows a site prefix to be specified in the request.

Resolution - Do Not Specify a Repository

If specifying a repository, check that the policy does not already specify a repository.

Resolution - Specify a Repository

If the policy does not specify a repository, then the request must specify a repository.

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
fieldNameName of the field.
constraintIndication that the field is required or prohibited. Valid values are:
  • required - Field is required
  • prohibited - Field is not allowed

For detailed information about this exception detail type, consult the PolicyConstraintViolationExceptionDetail 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": "Site Policy Violation",
  "status": "409",
  "detail": "Field '{fieldName}' is {constraint} by the policy associated with this request.",
  "o:errorCode": "OCE-SITEMGMT-009035",
  "fieldName": "repository",
  "constraint": "required"
}

Introduced in release 19.2.3.

409Conflict - Site Governance Disabled

Site governance is enabled or disabled using a tenant-wide setting controlled by site administrators. When site governance is disabled, certain methods will be prevented on the site management REST API, such as creating a request for a site or activating a site.

Error Code

OCE-SITEMGMT-009002

Resolution - Enable Site Governance

Enable governance for sites using the Sites and Assets administrator settings and retry the failed request.

Where This Error Can be Returned
  • This error will never be returned in the response body.
  • This error can be returned in the asynchronous job status.
Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Governance Disabled",
  "status": "409",
  "detail": "A request to create or copy a site cannot be processed when site governance is disabled.",
  "o:errorCode": "OCE-SITEMGMT-009002"
}

409Conflict - Starter Edition Limit Reached

Starter edition will only allow you to create one site.

Error Code

OCE-SITEMGMT-009117

Resolution - Upgrade to Premium

Upgrade to Premium to access unlimited sites.

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.
Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Starter Edition Limit Reached",
  "status": "409",
  "detail": "Starter edition will only allow you to create one site.",
  "o:errorCode": "OCE-SITEMGMT-009117"
}

Introduced in release 21.6.1.

409Conflict - Site Content Not Ready

The site contains content assets in a "not ready" state.

Error Code

OCE-SITEMGMT-009144

Where This Error Can be Returned
  • This error will never 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
siteSite on which the operation is being performed.

For detailed information about this exception detail type, consult the SiteContentNotReadyErrorExceptionDetail 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": "Site Content Not Ready",
  "status": "409",
  "detail": "The site contains content assets in a \"not ready\" state.",
  "o:errorCode": "OCE-SITEMGMT-009144",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

409Conflict - Site Channel Already Exists

A channel with the same name already exists. Channel names must be unique across all sites.

Error Code

OCE-SITEMGMT-009155

Resolution - Edit the Site Name

Edit the site name in the request so that it does not clash with an existing channel.

Where This Error Can be Returned
  • This error will never 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
channelNameChannel name.

For detailed information about this exception detail type, consult the SiteChannelAlreadyExistsExceptionDetail 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": "Site Channel Already Exists",
  "status": "409",
  "detail": "A channel with the same name already exists.",
  "o:errorCode": "OCE-SITEMGMT-009155",
  "channelName": "Oracle Content and Experience"
}

Introduced in release 22.12.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

  • Request asynchronous processing of the request using a respond-async header value.

  • When a request to create or copy a site is made when site governance is enabled the request can be auto approved. The request can be automatically approved if the authenticated user is one of the users that is allowed to approve the request. For example if the authenticated user has the site administrator role, and the site requires administrator approval then the request can be automatically approved. If the user is not allowed to approve the request then the header is included. To enable automatic approval, when valid, include this header in the request with a value of true.

  • If a client wants to prevent notifications being sent on a per request basis this header can be set to the value true. Even if the notification would normally be sent, this header will suppress notification delivery for the request.

  • If a site administrator wants to by pass the policy on a site related operation then the suppress site governance header can be set to the value true in the request. Even if a policy is inactive then operation can be performed by a site administrator if this header is set. Other policy controls such as the type of approval or restrictions of the operation such as specifying a site prefix are also suppressed.

Body ()

The details required to copy a site. At a minimum the new site name must be provided.

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

    The site description is used to help people understand the purpose and usage of the site. 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.1.5.

  • Include unpublished updates in the copy.

    Introduced in release 19.2.2.
  • Maximum Length: 1000

    The justification is to help human approvers review this request. There is no restriction on the contents of the description; it can be a single line or multiple lines with any characters.

  • links

    HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

  • Maximum Length: 242

    This name is used during the site creation process and is used to identify the new site. Names must be unique; the name provided cannot be the same as the name of any existing site.

    Introduced in release 19.1.5.

  • Get the user or client application that will own the site. The user or client application that owns the site may be different than the user or client application that created the request if the request was created on behalf of another user.

    Introduced in release 19.1.5.

  • The asset repository that will be associated with the site when it is created. Repositories can be set only for enterprise sites. A repository cannot be associated with a request if the policy associated with the request specifies a repository.

    Introduced in release 19.2.3.
  • Maximum Length: 15

    The site prefix that will be set on a site when it is created. Will be set only on requests for an enterprise site. Can only be set only if the policy associated with the request allows; otherwise, the site prefix will be automatically generated. Site prefixes are limit to 15 characters in length.

    Introduced in release 19.2.3.
Example:
{
    "name":"AcmeProductLaunch2020",
    "description":"Marketing site for Acme New Product Launch 2020.",
    "includeUpdates":true
}
Nested Schema : links
Type: array

HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source
Nested Schema : items
Match All
Show Source
  • Link
Back to Top

Response

202 Response

Accepted
Headers

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : InvalidSiteNameExceptionDetail
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 : InvalidSiteNameExceptionDetail-allOf[1]
Type: object
Show Source

  • Reason the site 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

  • Maximum Length: 242

    Invalid site name.

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 Site Name)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Name",
    "status":"400",
    "detail":"Site name '{siteName}' cannot be used to create a site.",
    "o:errorCode":"OCE-SITEMGMT-009012",
    "siteName":"MyNewProduct",
    "reason":"tooLong"
}
Example Response (Invalid Site Prefix)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Prefix",
    "status":"400",
    "detail":"Site prefix '{sitePrefix}' contains invalid characters.",
    "o:errorCode":"OCE-SITEMGMT-009034",
    "sitePrefix":"News Site"
}
Example Response (Invalid Site Field)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Field",
    "status":"400",
    "detail":"Field '{fieldName}' should not be provided for this request.",
    "o:errorCode":"OCE-SITEMGMT-009017",
    "fieldName":"defaultLanguage"
}
Example Response (Invalid Site Owner)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Owner",
    "status":"400",
    "detail":"User or application does not exist, or does exist but does not have an appropriate role.",
    "o:errorCode":"OCE-SITEMGMT-009021",
    "user":{
        "id":"1234"
    },
    "requiredRoles":[
        "CECServiceAdministrator"
    ]
}
Example Response (Invalid Repository)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Repository",
    "status":"400",
    "detail":"Repository does not exist or has been deleted, or the authenticated user or client application does not have access to the repository.",
    "o:errorCode":"OCE-CAAS-001006",
    "repository":{
        "id":"F81629473A3DB8B2A28669F19E68209BBAD3340745B0"
    }
}
Example Response (Invalid Localization Policy)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Localization Policy",
    "status":"400",
    "detail":"Localization policy does not exist.",
    "o:errorCode":"OCE-CAAS-001004",
    "localizationPolicy":{
        "id":"7D77CB6653BC1FF8E0530100007F6630"
    }
}
Example Response (Invalid Default Language)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Default Language",
    "status":"400",
    "detail":"Default Language '{defaultLanguage}' is not valid. The default language must be one of the localization policy's required languages.",
    "o:errorCode":"OCE-CAAS-001003",
    "defaultLanguage":"en-US"
}

401 Response

Unauthorized

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : InactivePolicyExceptionDetail
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 : InactivePolicyExceptionDetail-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 (Inactive Policy)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Inactive Policy",
    "status":"403",
    "detail":"The policy for this operation is inactive.",
    "o:errorCode":"OCE-SITEMGMT-009071",
    "policy":{
        "id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
    }
}
Example Response (Restricted Policy)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Restricted Policy",
    "status":"403",
    "detail":"The policy for the operation has a restricted audience and can't be used by the user or client application.",
    "o:errorCode":"OCE-SITEMGMT-009072",
    "policy":{
        "id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
    },
    "user":{
        "id":"1234"
    }
}
Example Response (Site Operation Forbidden)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Operation Forbidden",
    "status":"403",
    "detail":"You do have a sharing role in this site, but your role does not allow you to use this operation.",
    "o:errorCode":"OCE-SITEMGMT-009026",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}
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"
}
Example Response (Granular Security Operation Forbidden)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Granular Security Operation Forbidden",
    "status":"403",
    "detail":"Granular security operation forbidden for the site or template.",
    "o:errorCode":"OCE-SITEMGMT-009148",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    },
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SiteNotFoundExceptionDetail
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 : SiteNotFoundExceptionDetail-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 (Site Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Not Found",
    "status":"404",
    "detail":"Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
    "o:errorCode":"OCE-SITEMGMT-009003",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

409 Response

Conflict
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SiteDeletedExceptionDetail
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 : SiteDeletedExceptionDetail-allOf[1]
Type: object
Show Source

  • Site that is soft deleted, if the site identifier has been provided.

    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 (Site Deleted)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Deleted",
    "status":"409",
    "detail":"The operation cannot be performed as the site has been soft deleted.",
    "o:errorCode":"OCE-SITEMGMT-009059",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}
Example Response (Site Already Exists)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Already Exists",
    "status":"409",
    "detail":"A site with the same name already exists.",
    "o:errorCode":"OCE-SITEMGMT-009004",
    "name":"Oracle Content and Experience"
}
Example Response (Site Prefix Already Exists)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Prefix Already Exists",
    "status":"409",
    "detail":"Site with prefix '{sitePrefix}' already exists.",
    "o:errorCode":"OCE-SITEMGMT-009029",
    "sitePrefix":"News"
}
Example Response (Site Policy Violation)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Policy Violation",
    "status":"409",
    "detail":"Field '{fieldName}' is {constraint} by the policy associated with this request.",
    "o:errorCode":"OCE-SITEMGMT-009035",
    "fieldName":"repository",
    "constraint":"required"
}
Example Response (Starter Edition Limit Reached)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Starter Edition Limit Reached",
    "status":"409",
    "detail":"Starter edition will only allow you to create one site.",
    "o:errorCode":"OCE-SITEMGMT-009117"
}

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