Create a Site
/sites/management/api/v1/sites
Create a new site from a site template given site details such as the site name and description. Site names are case-sensitive and two sites cannot share the same name. Use only letters, numbers, hyphens, and underscores in site names. A justification can also be provided with the site details if the site creation needs approval when site governance is enabled.
Authorization
When site governance is disabled sites can be created from a site template for which the authenticated user or client application is a member.
When site governance is enabled sites can be created from a site template if the site template is associated with an active
policy. When site
governance is enabled the request to create a site may require approval before the site is created.
In all cases, to create an enterprise site the user must be an enterprise user.
Enterprise Sites
If the template is an enterprise template, enterprise site-related fields, such as a site prefix, localization policy or repository, can also be specified when creating a site. If a repository is specified then the authenticated user or client application must have at least a contributor role in the repository.
Suppressing Site Governance
When site governance is enabled sites can only be created from a template if the template is associated with an active
policy. If
a site administrator wants to override any policy controls and create a site from any template they can suppress site governance
policies using a header parameter. For more details of the header consult the Request section of this operation.
Email Notifications
When site governance is enabled a request to create a site may cause an email notification to be sent to the users that can approve the site creation. 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 create 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 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 create 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 New Site Request
If site governance is disabled, creation of a new 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 New Site Request with Site Governance
If site governance is enabled, creation of a new site may require approval and the 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 the progress can be monitored using the status resource. When the status changes to succeeded
, the site has been created. The request for the new site can be identified using the request
link of the status resource. Further operations on the request can then be performed, such as adding a review to the request so it is approved or reading the site relationship resource to get the site details.
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.
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 - Create a Standard Site with Site Governance Off
For creating a standard site, the site name and template are required. A description can be specified if required.
Request
POST https://api.example.com/sites/management/api/v1/sites
Request Headers
Prefer=respond-async
Request Body
{ "template": "name:Acme", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch." }
202Accepted - Create a Standard Site with Site Governance On
For creating a standard site, the site name and template are required. A description can be specified if required.
Request
POST https://api.example.com/sites/management/api/v1/sites
Request Headers
Prefer=respond-async
Request Body
{ "template": "name:Acme", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch.", "justification": "I require a marketing site for our new product." }
202Accepted - Create an Enterprise Site with Site Governance Off.
For creating an enterprise site, the site name, template, repository, localization policy and default language are required. The site prefix and description can be specified if required.
Request
POST https://api.example.com/sites/management/api/v1/sites
Request Headers
Prefer=respond-async
Request Body
{ "template": "name:Acme", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch.", "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "defaultLanguage": "en-US" }
202Accepted - Create an Enterprise Site with Site Governance On
For creating an enterprise site, the site name, template and default language are required. Depending on the policy, the repository, localization policy and site prefix may be allowed. A description can be specified if required.
Request
POST https://api.example.com/sites/management/api/v1/sites
Request Headers
Prefer=respond-async
Request Body
{ "template": "name:Acme", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch.", "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "localizationPolicy": "7D77CB6653BC1FF8E0530100007F6630", "defaultLanguage": "en-US", "sitePrefix": "News", "justification": "I require a marketing site for our new product." }
202Accepted - Suppress Site Governance Controls
Allow a site administrator to create a site for any template, by passing site governance policies by specifying the suppress header.
Request
POST https://api.example.com/sites/management/api/v1/sites
Request Headers
Prefer=respond-async X-Suppress-Site-Governance=true
Request Body
{ "template": "name:Acme", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch." }Introduced in release 19.4.1.
202Accepted - Create a Site and Suppress Email Notifications
Create a site suppressing any email notifications that would normally be sent to approvers.
Request
POST https://api.example.com/sites/management/api/v1/sites
Request Headers
X-Suppress-Notifications=true Prefer=respond-async
Request Body
{ "template": "name:Acme", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch." }Introduced in release 20.1.3.
202Accepted - Create a Site and Automatically Approve the Request
Create a site and and automatically approve the request to create a site if the authenticated user or client application is also allowed to approve the request.
Request
POST https://api.example.com/sites/management/api/v1/sites
Request Headers
X-Auto-Approve-Request=true Prefer=respond-async
Request Body
{ "template": "name:Acme", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch." }Introduced in release 20.1.3.
202Accepted - Create a Site for a Named User
Create a site on behalf of another user. Allows a request for a site to be made so that when the site is created it is owned by the named user.
Request
POST https://api.example.com/sites/management/api/v1/sites
Request Headers
Prefer=respond-async
Request Body
{ "template": "name:Acme", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch.", "ownedBy": "username:jsmith" }Introduced in release 20.3.3.
202Accepted - Create a Site for a Named Application
Create a site on behalf of another client application. Allows a request for a site to be made so that when the site is created it is owned by the named client application.
Request
POST https://api.example.com/sites/management/api/v1/sites
Request Headers
Prefer=respond-async
Request Body
{ "template": "name:Acme", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch.", "ownedBy": "application:MyProduct_APPID" }Introduced in release 20.3.3.
202Accepted - Create an SST Site
Create a site using a template which requires granular security. Both the id of the sites security taxonomy and the id of the category within the taxonomy must be specified.
Request
POST https://api.example.com/sites/management/api/v1/sites
Request Headers
Prefer=respond-async
Request Body
{ "template": "name:Acme", "name": "AcmeProductLaunch", "description": "Marketing site for Acme New Product Launch.", "repository": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0", "defaultLanguage": "en-US", "contentSecurity": { "taxonomy": "9CD715E67F21447D83F2708684E936EC", "category": "FFA550A5BCE34073A5BAB279B871DBFE" } }
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
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 Name | Description |
siteName | Invalid site name. |
reason | Reason the site name is invalid. Valid values are:
|
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 Name | Description |
sitePrefix | Invalid 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 Name | Description |
fieldName | Field 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 Name | Description |
user | User or application that does not exist. |
requiredRoles | The user must have at least one of these application roles to be the owner. Valid values are:
|
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 Site Template
The template referenced in the request or associated with the resource does not exist, or has been deleted, or the authenticated user or client application does not have access to the template.
Error Code
OCE-SITEMGMT-009010
Resolution - Check Identifier
Check that the template identifier is valid.
Resolution - Check Authorization
Check that the authenticated user is authorized to access to the template.
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 Name | Description |
template | Template that does not exist or is not visible to the authenticated user. |
For detailed information about this exception detail type, consult the InvalidTemplateExceptionDetail 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 Template", "status": "400", "detail": "Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.", "o:errorCode": "OCE-SITEMGMT-009010", "template": { "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6" } }
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 Name | Description |
repository | Repository 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 Name | Description |
localizationPolicy | Localization 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 Name | Description |
localizationPolicy | Localization policy that does not allow the specified default language. |
defaultLanguage | Invalid 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 - Inactive Template Policy
The template does not have a policy that is marked as active. This error indicates that a site cannot be created from this template because a site administrator has not marked the template as suitable for creating sites from. This error can occur only when site governance is enabled.
Error Code
OCE-SITEMGMT-009015
Resolution - Check Policy is Active
Get a site administrator to check that there is a policy associated with the template and that it is marked as active.
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 Name | Description |
template | Template that does not have a policy, or the policy is inactive. |
For detailed information about this exception detail type, consult the InactiveTemplatePolicyExceptionDetail 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 Template Policy", "status": "400", "detail": "There is no active policy associated with the template.", "o:errorCode": "OCE-SITEMGMT-009015", "template": { "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6" } }
400Bad Request - Restricted Template Policy
This error indicates that the requester cannot use this this template to create a site as a site administrator has restricted site creation to a restricted audience that does not include the requester. This error can only occur when site governance is enabled.
Error Code
OCE-SITEMGMT-009033
Resolution - Add User to the Access List
Get a site administrator to add the user as a member of the policy access list.
Resolution - Change the Policy to Everyone Access
Get a site administrator to change the template policy accessType
to everyone
.
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 Name | Description |
template | Template that has the restricted policy. |
user | User or application that is not a member of the template policy access list. |
For detailed information about this exception detail type, consult the RestrictedTemplatePolicyExceptionDetail 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 Template Policy", "status": "400", "detail": "The policy associated with template has a restricted audience and can't be used by the user that created the request.", "o:errorCode": "OCE-SITEMGMT-009033", "template": { "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6" }, "user": { "id": "1234" } }
Introduced in release 19.3.2.
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 Name | Description |
request | Request 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 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 Name | Description |
reason | Error 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 - Site Id Not Supported
Site id is not supported.
Error Code
OCE-SITEMGMT-009134
Resolution - Suppress Governance
Suppress site governance when creating site using an explicit site id.
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": "Site Id Not Supported", "status": "400", "detail": "Site id is not supported when creating site requests with site governance enabled.", "o:errorCode": "OCE-SITEMGMT-009134" }
Introduced in release 22.1.2.
400Bad Request - Invalid Site Id
The provided site id cannot be used because it has an invalid length, prefix or characters. The reason the site name is invalid will be reported in the error message.
Error Code
OCE-SITEMGMT-009135
Resolution - Check Length
Id must be 44 characters in length.
Resolution - Check Prefix
Id must begin with the letter 'F'.
Resolution - Check Characters
Use only letters and numbers.
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 Name | Description |
reason | Reason the site name is invalid. Valid values are:
|
For detailed information about this exception detail type, consult the InvalidSiteIdExceptionDetail 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 Id", "status": "400", "detail": "Site id cannot be used to create site.", "o:errorCode": "OCE-SITEMGMT-009135", "reason": "invalidCharacters" }
400Bad Request - Invalid Site Content Security
When requesting a new SST site from a template that enforces granular security, a sites security taxonomy and category must be provided. The user or client application must also have the create site permission on the category.
Error Code
OCE-SITEMGMT-009146
Resolution - Provide Content Security
Content security must be provided.
Resolution - Check Content Security Exists
Check that the taxonomy and category exists.
Resolution - Check Content Security Is For Sites Management
Check that the taxonomy provided is for sites management.
Resolution - Check Create Site Permission
Check the user or client application has create site permission on the category.
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 Name | Description |
security | Content security that does not exist, or there is no appropriate permission. |
For detailed information about this exception detail type, consult the InvalidSiteContentSecurityExceptionDetail 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 Content Security", "status": "400", "detail": "Content security must be provided. The taxonomy and category must exist, with the user or client application having the create site permission on the category.", "o:errorCode": "OCE-SITEMGMT-009146", "security": { "taxonomy": { "id": "BC42C4FE109446539C9962DAC0C64CF2" }, "category": { "id": "AF11C4FE109446539C9962DAC0C09KF2" } } }
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
400Bad Request - Localization Policy Required
A localization policy is required to complete the site request. This should be part of the template policy or included in the request.
Error Code
OCE-CAAS-001022
Resolution - Include Localization Policy
Check that a localization policy is provided as part of the template policy or request.
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.
Example Response Body
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Localization Policy Required", "status": "400", "detail": "Localization policy required.", "o:errorCode": "OCE-CAAS-001022" }
Introduced in release 22.11.2.
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 Name | Description |
used | Number of assets. |
limit | Asset 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 Name | Description |
used | Number of advanced videos. |
limit | Advanced 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 Name | Description |
used | Storage used, in GB. |
limit | Storage 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 Name | Description |
resourceType | Resource type that can only be created by Sites Administrators. Valid values are:
|
name | Name 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.
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 Name | Description |
name | Duplicate 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 Name | Description |
sitePrefix | Site 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 Name | Description |
fieldName | Name of the field. |
constraint | Indication that the field is required or prohibited. Valid values are:
|
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 - Template Deleted
The operation cannot be performed on a soft deleted template. This error can only occur when the includeDeleted
query parameter set to true
Error Code
OCE-SITEMGMT-009061
Resolution - Restore Template
Restore the template 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 Name | Description |
template | Template that is soft deleted. |
For detailed information about this exception detail type, consult the TemplateDeletedExceptionDetail 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": "Template Deleted", "status": "409", "detail": "The operation cannot be performed as the template has been soft deleted.", "o:errorCode": "OCE-SITEMGMT-009061", "template": { "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6" } }
Introduced in release 19.4.1.
409Conflict - Template Import In Progress
This error will occur when a template is being copied (e.g. creating a site), but at the same time it is being overwritten by a template import.
Error Code
OCE-SITEMGMT-009105
Resolution - Wait for Template Import to Complete
Wait for the template import to complete and try again.
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 Name | Description |
importedBy | Full name of the user that created the import job that is in progress. |
name | Template name. |
For detailed information about this exception detail type, consult the TemplateImportInProgressExceptionDetail 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": "Template Import In Progress", "status": "409", "detail": "Unable to copy template as it is in the progress of being re-imported.", "o:errorCode": "OCE-SITEMGMT-009105", "importedBy": "value", "name": "CafeSupremo" }
Introduced in release 20.4.2.
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 - Duplicate Site Id
Site already exists with provided id.
Error Code
OCE-SITEMGMT-009136
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 Name | Description |
id | Duplicated site id. |
For detailed information about this exception detail type, consult the DuplicateSiteIdExceptionDetail 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": "Duplicate Site Id", "status": "409", "detail": "A site with the provided id already exists.", "o:errorCode": "OCE-SITEMGMT-009136", "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0" }
Introduced in release 22.1.2.
409Conflict - Site Content Security Not Supported
When requesting a new SST site, the template must have granular security enabled if providing a content security.
Error Code
OCE-SITEMGMT-009147
Resolution - Provide Granular Security Template
Provide a template enabled with granular security.
Resolution - Remove Content Security
Do not provide a content security on creation.
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.
Example Response Body
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", "title": "Site Content Security Not Supported", "status": "409", "detail": "Content security not supported for site creation.", "o:errorCode": "OCE-SITEMGMT-009147" }
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
409Conflict - Site Collection Already Exists
A collection with the same name already exists. Site collection names must be unique across all collections.
Error Code
OCE-SITEMGMT-009154
Resolution - Edit the Site Name
Edit the site name in the request so that it does not clash with an existing collection.
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 Name | Description |
name | Duplicate collection name. |
For detailed information about this exception detail type, consult the SiteCollectionAlreadyExistsExceptionDetail 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 Collection Already Exists", "status": "409", "detail": "A collection with the same name already exists.", "o:errorCode": "OCE-SITEMGMT-009154", "name": "Oracle Content and Experience" }
Introduced in release 22.11.1.
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 Name | Description |
channelName | Channel 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.
409Conflict - Site Content Security Group Already Exists
Cannot perform the site operation because an SST group already exists with name provided. The group name is based on the parent site name.
Error Code
OCE-SITEMGMT-009158
Resolution - Edit the Site Name
Edit the site name in the request so that it does not clash with an existing content security group.
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 Name | Description |
groupName | The existing group name. |
For detailed information about this exception detail type, consult the ContentSecurityGroupAlreadyExistsExceptionDetail 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 Security Group Already Exists", "status": "409", "detail": "Site rename cannot be performed as there is an existing content security group with the same name.", "o:errorCode": "OCE-SITEMGMT-009158", "groupName": "Oracle Content and Experience" }
409Conflict - Blocked File Extension
Unable to perform site operation as it contains a file with a blocked extension.
Error Code
OCE-SITEMGMT-009163
Resolution - Remove Blocked Files
Remove files that use the blocked file extension from the site
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 Name | Description |
fileExtension | Blocked File Extension |
For detailed information about this exception detail type, consult the BlockedFileExtensionExceptionDetail 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": "Blocked File Extension", "status": "409", "detail": "Unable to perform site operation as it contains a file with a blocked extension", "o:errorCode": "OCE-SITEMGMT-009163", "fileExtension": "value" }
Request
- application/json
-
Prefer(optional): string
Request asynchronous processing of the request using a
respond-async
header value. -
X-Auto-Approve-Request(optional): boolean
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
. -
X-Suppress-Notifications(optional): boolean
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. -
X-Suppress-Site-Governance(optional): boolean
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 isinactive
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.
Details of the required site.
object
-
contentSecurity(optional):
contentSecurity
The security category for the site.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
defaultLanguage(optional):
string
The default language of the site. Must be one of the required languages of the localization policy. Required in requests for an enterprise site.
Introduced in release 19.2.3. -
description(optional):
string
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.
-
id(optional):
string
Optionally provided identifier for the site. This id must be unique within the service. If not provided an identifier will be allocated automatically.
No assumptions should be made about the content of the field; the field should be treated as an opaque value.
-
justification(optional):
string
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(optional):
array 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.
-
localizationPolicy(optional):
string
The localization policy that will be associated with the site when it is created. Localization policies can be set only for enterprise sites. A localization policy cannot be associated with a request if the policy associated with the request specifies a localization policy.
Introduced in release 19.2.3. -
name:
string
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.
-
ownedBy(optional):
string
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.
-
repository(optional):
string
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. -
sitePrefix(optional):
string
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. -
template:
string
Get the template associated with the request. When a request for a new site is created, the template from which the site should be created is specified and then associated with the request. If the request is not a new site request a template will not be returned.
{
"template":"name:Acme",
"name":"AcmeProductLaunch",
"description":"Marketing site for Acme New Product Launch."
}
The security category for the site.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
object
SiteContentSecurity
Content security for a site.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
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.
object
Content security for a site.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
category(optional):
string
Associated Taxonomy Category resource.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
-
taxonomy(optional):
string
Associated Taxonomy resource.
Targeted for a Future Release
This operation is targeted for an undecided future release. This operation may be subject to change.
object
REST HATEOAS link and related metadata. If responses provide links (for example, a self
link to the resource itself) the links provided will include one or more of the properties defined on this link structure.
-
href(optional):
string
The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the
templated
property must be set totrue
. -
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
Valid values are:
-
OPTIONS
- HTTP OPTIONS -
HEAD
- HTTP HEAD -
GET
- HTTP GET -
POST
- HTTP POST -
PUT
- HTTP PUT -
PATCH
- HTTP PATCH -
DELETE
- HTTP DELETE
-
-
profile(optional):
string(uri)
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
-
rel(optional):
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details.
-
templated(optional):
boolean
Boolean flag that specifies the
href
property is a URI or URI Template. The property can be assumed to befalse
if the property is not present.
Response
202 Response
400 Response
-
object
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.
-
object
InvalidSiteNameExceptionDetail-allOf[1]
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.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
object
-
reason(optional):
string
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
-
-
siteName(optional):
string
Maximum Length:
242
Invalid site name.
array
Multiple errors can be organized in a hierarchical structure.
-
object
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.
{
"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"
}
{
"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"
}
{
"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"
}
{
"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"
]
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Invalid Site Template",
"status":"400",
"detail":"Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
"o:errorCode":"OCE-SITEMGMT-009010",
"template":{
"id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
}
}
{
"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"
}
}
{
"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"
}
}
{
"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"
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Inactive Template Policy",
"status":"400",
"detail":"There is no active policy associated with the template.",
"o:errorCode":"OCE-SITEMGMT-009015",
"template":{
"id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Restricted Template Policy",
"status":"400",
"detail":"The policy associated with template has a restricted audience and can't be used by the user that created the request.",
"o:errorCode":"OCE-SITEMGMT-009033",
"template":{
"id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
},
"user":{
"id":"1234"
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Id Not Supported",
"status":"400",
"detail":"Site id is not supported when creating site requests with site governance enabled.",
"o:errorCode":"OCE-SITEMGMT-009134"
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Invalid Site Content Security",
"status":"400",
"detail":"Content security must be provided. The taxonomy and category must exist, with the user or client application having the create site permission on the category.",
"o:errorCode":"OCE-SITEMGMT-009146",
"security":{
"taxonomy":{
"id":"BC42C4FE109446539C9962DAC0C64CF2"
},
"category":{
"id":"AF11C4FE109446539C9962DAC0C09KF2"
}
}
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Localization Policy Required",
"status":"400",
"detail":"Localization policy required.",
"o:errorCode":"OCE-CAAS-001022"
}
401 Response
403 Response
-
allOf
SitesAdminRoleRequiredExceptionDetail
Introduced in release 22.5.2.
-
object
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.
-
object
SitesAdminRoleRequiredExceptionDetail-allOf[1]
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.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
object
-
name(optional):
string
Name of resource being created, if available.
Introduced in release 22.5.2. -
resourceType(optional):
string
Resource type that can only be created by Sites Administrators.
Valid values are:
-
site
- Site resource -
template
- Template resource -
theme
- Theme resource -
component
- Component resource
-
array
Multiple errors can be organized in a hierarchical structure.
-
object
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.
{
"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"
}
409 Response
-
object
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.
-
object
SiteAlreadyExistsExceptionDetail-allOf[1]
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.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
object
-
name(optional):
string
Maximum Length:
100
Duplicate name.
array
Multiple errors can be organized in a hierarchical structure.
-
object
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.
{
"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"
}
{
"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"
}
{
"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"
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Template Deleted",
"status":"409",
"detail":"The operation cannot be performed as the template has been soft deleted.",
"o:errorCode":"OCE-SITEMGMT-009061",
"template":{
"id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
}
}
{
"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"
}
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Site Content Security Not Supported",
"status":"409",
"detail":"Content security not supported for site creation.",
"o:errorCode":"OCE-SITEMGMT-009147"
}