Jump to

• Request
• Response

Publish Updates to a Site

post

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

EXTENDED OPERATION

Publish the latest updates made by a site developer to the site. If the site is online then the updates will be publicly accessible after the publish operation completes. If the site is offline then the updates are published so that when the site is activated and brought online those updates will be publicly accessible.

Introduced in release 19.4.1.

Authorization

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

• Owner
• Manager

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/publish

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 - Publish Only Used Content

Publish only assets that are being used by the site. The default is for all assets targeted to the site's publishing channel to be published.

Request

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

Request Body

{
  "onlyUsedContent": true
}

202Accepted - Publish Static Files Without Compilation

Publish only static files without compilation.

Request

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

Request Body

{
  "onlyStaticFiles": true,
  "skipCompile": true
}

202Accepted - Force a Full Publish

Do a full publish of all the site files. The default is for the publish to be an incremental publish, only publishing changed files.

Request

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

Request Body

{
  "type": "full"
}

202Accepted - Compile and Publish Static Files

Compile and publish static files only.

Request

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

Request Body

{
  "onlyStaticFiles": true,
  "skipCompile": false
}

202Accepted - Compile and Publish Static Files With Authentication

Compile and publish static files only with authentication.

Request

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

Request Headers

X-COMPILATION-AUTH-TOKEN=AYjcyMzY3ZDhiNmJkNTY

Request Body

{
  "onlyStaticFiles": true,
  "skipCompile": false
}

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 - Missing Site Translations

There are missing translations for one or more of the required languages of the site's localization policy..

Error Code

OCE-SITEMGMT-009077

Resolution - Translate Site

Import translations for the site for all required languages.

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
missing	Invalid default language.

For detailed information about this exception detail type, consult the MissingSiteTranslationsExceptionDetail 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": "Missing Site Translations",
  "status": "400",
  "detail": "There are missing translations for one or more of the required languages of the site's localization policy.",
  "o:errorCode": "OCE-SITEMGMT-009077",
  "missing": [
      "en-US"
  ]
}

Introduced in release 19.4.1.

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 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
site	Site 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 - Storage Limit Reached

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

Error Code

OCE-SITEMGMT-009098

Resolution - Increase Storage Limit

Get a system administrator to increase the storage limit.

Where This Error Can be Returned

• This error can be returned in the response body.
• This error will not be returned in the asynchronous job status.

Exception Detail Fields

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

Field 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 - Outbound Data Limit Reached

Outbound data limit has been reached. Limits have been set by the system administrator on the amount of outbound data.

Error Code

OCE-SITEMGMT-009100

Resolution - Increase Outbound Data Limit

Get a system administrator to increase the outbound data limit.

Where This Error Can be Returned

• This error can be returned in the response body.
• This error will not be returned in the asynchronous job status.

Exception Detail Fields

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

Field Name	Description
used	Outbound data used, in GB.
limit	Outbound data limit, in GB.

For detailed information about this exception detail type, consult the OutboundDataLimitReachedExceptionDetail 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": "Outbound Data Limit Reached",
  "status": "403",
  "detail": "Outbound data limit has been reached.",
  "o:errorCode": "OCE-SITEMGMT-009100",
  "used": 1.23456789,
  "limit": 1.23456789
}

Introduced in release 20.3.1.

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 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
site	Site 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"
  }
}

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 Name	Description
site	Site 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 - Theme Import In Progress

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

Error Code

OCE-SITEMGMT-009106

Resolution - Wait for Theme Import to Complete

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

Where This Error Can be Returned

• This error can be returned in the response body.
• This error 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
importedBy	Full name of the user that created the import job that is in progress.
name	Theme name.

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

Example Response Body

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

Introduced in release 20.4.2.

409Conflict - Component Import In Progress

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

Error Code

OCE-SITEMGMT-009107

Resolution - Wait for Component Import to Complete

Wait for the component import to complete and try 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
importedBy	Full name of the user that created the import job that is in progress.
name	Component name.

For detailed information about this exception detail type, consult the ComponentImportInProgressExceptionDetail 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": "Component Import In Progress",
  "status": "409",
  "detail": "Unable to access component as it is in the progress of being re-imported.",
  "o:errorCode": "OCE-SITEMGMT-009107",
  "importedBy": "value",
  "name": "ContentNavMenu"
}

Introduced in release 20.4.2.

409Conflict - Site not Published

The operation cannot be performed on a site that is not published.

Error Code

OCE-SITEMGMT-009141

Resolution - Publish Site

Publish the site to perform this operation.

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

For detailed information about this exception detail type, consult the SiteNotPublishedExceptionDetail 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 Published",
  "status": "409",
  "detail": "Operation cannot be performed on a site that is not a public site.",
  "o:errorCode": "OCE-SITEMGMT-009141",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

Introduced in release 22.6.1.

409Conflict - Site Republish Required

Unable to publish the site, a republish is required.

Error Code

OCE-SITEMGMT-009150

Resolution - Republish Site

Republish the 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.

Example Response Body

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Republish Required",
  "status": "409",
  "detail": "Unable to publish the site, a republish is required.",
  "o:errorCode": "OCE-SITEMGMT-009150"
}

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 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
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"
}

409Conflict - Site Activation Already In Progress

Can not request site publish/activation while it is currently being activated.

Error Code

OCE-SITEMGMT-009165

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 Activation Already In Progress",
  "status": "409",
  "detail": "Unable to request site publish/activation while it is currently being activated.",
  "o:errorCode": "OCE-SITEMGMT-009165"
}

409Conflict - Site Content Localization Required

The site contains content which has not been localized into languages required by the site's localization policy.

Error Code

OCE-SITEMGMT-009160

Resolution - Check Translations

Ensure all asset translations are up to date.

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
localizationPolicy	Localization policy enforcing the validation.

For detailed information about this exception detail type, consult the SiteContentLocalizationRequiredExceptionDetail 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 Localization Required",
  "status": "409",
  "detail": "The site contains content which has not been localized into languages required by the site's localization policy.",
  "o:errorCode": "OCE-SITEMGMT-009160",
  "localizationPolicy": "Oracle Content and Experience"
}

409Conflict - Compilation Server Failure

Unable to perform site operation as it contains a file with a blocked extension.

Error Code

OCE-SITEMGMT-009167

Resolution - Setup Compilation Server

Setup the compilation server

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": "Compilation Server Failure",
  "status": "409",
  "detail": "Unable to perform site operation as the compilation server failed.",
  "o:errorCode": "OCE-SITEMGMT-009167"
}

409Conflict - Compilation Server Invalid URL

Unable to perform site operation as it contains a file with a blocked extension.

Error Code

OCE-SITEMGMT-009168

Resolution - Setup Compilation Server

Setup the compilation server

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": "Compilation Server Invalid URL",
  "status": "409",
  "detail": "Unable to perform site operation as the compilation server URL is invalid.",
  "o:errorCode": "OCE-SITEMGMT-009168"
}

409Conflict - Unable to Connect to Compilation Server Timeout

Unable to perform site operation as it contains a file with a blocked extension.

Error Code

OCE-SITEMGMT-009169

Resolution - Setup Compilation Server

Setup the compilation server

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": "Unable to Connect to Compilation Server Timeout",
  "status": "409",
  "detail": "Unable to perform site operation as the compilation server timed out.",
  "o:errorCode": "OCE-SITEMGMT-009169"
}

409Conflict - Unable to Connect to Compilation Server

Unable to perform site operation as it contains a file with a blocked extension.

Error Code

OCE-SITEMGMT-009170

Resolution - Setup Compilation Server

Setup the compilation server

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": "Unable to Connect to Compilation Server",
  "status": "409",
  "detail": "Unable to perform site operation as cannot connect to compilation server.",
  "o:errorCode": "OCE-SITEMGMT-009170"
}

409Conflict - Compilation Server Invalid Version

Unable to perform site operation as it contains a file with a blocked extension.

Error Code

OCE-SITEMGMT-009171

Resolution - Setup Compilation Server

Setup the compilation server

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": "Compilation Server Invalid Version",
  "status": "409",
  "detail": "Unable to perform site operation as is using an invalid compilation server version.",
  "o:errorCode": "OCE-SITEMGMT-009171"
}

409Conflict - Compilation Server Endpoint Not Set

Unable to perform site operation as it contains a file with a blocked extension.

Error Code

OCE-SITEMGMT-009172

Resolution - Setup Compilation Server

Setup the compilation server

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": "Compilation Server Endpoint Not Set",
  "status": "409",
  "detail": "Unable to perform site operation as compilation server endpoint is not set.",
  "o:errorCode": "OCE-SITEMGMT-009172"
}

409Conflict - No Route to Compilation Server Host

Unable to perform site operation as no route to compilation server host.

Error Code

OCE-SITEMGMT-009173

Resolution - Setup Compilation Server

Setup the compilation server

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": "No Route to Compilation Server Host",
  "status": "409",
  "detail": "Unable to perform site operation as no route to compilation server host.",
  "o:errorCode": "OCE-SITEMGMT-009173"
}

409Conflict - Site Update In Progress

Can not request site publish/activation while it is currently being updated.

Error Code

OCE-SITEMGMT-009174

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
site	Site that has operation in progress.

For detailed information about this exception detail type, consult the SiteUpdateInProgressExceptionDetail 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 Update In Progress",
  "status": "409",
  "detail": "Unable to request site publish/activation while it is currently being updated.",
  "o:errorCode": "OCE-SITEMGMT-009174",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

409Conflict - Site Static Publish In Progress

Can not request site publish/activation while it is currently being static published.

Error Code

OCE-SITEMGMT-009175

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
site	Site that has operation in progress.

For detailed information about this exception detail type, consult the SiteStaticPublishInProgressExceptionDetail 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 Static Publish In Progress",
  "status": "409",
  "detail": "Unable to request site publish/activation while it has a static publish in progress.",
  "o:errorCode": "OCE-SITEMGMT-009175",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

Request

Supported Media Types

• application/json

Path Parameters

• id: string

  Immutable identifier for the site.

Query Parameters

• includeDeleted(optional): boolean

  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

• Prefer(optional): string

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

• X-Compilation-Auth-Token(optional): string

  This header provides an authorization token for the compilation server when publishing sites. This is required when site compilation is performed and the token cannot be obtained from the authenticated session of the publishing request.

Body ()

Site publish options, such as whether to publish all assets or only those targeted to the site's publishing channel.

Introduced in release 21.1.2.

Root Schema : schema

Type: object

Show Source

• 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.

• onlyStaticFiles(optional): boolean

  Publish only static files. If set to true then only site static files are published. By default static files are not compiled. To include compilation of site static files use skipCompile with a value of false. If set to false everything in the site is published. If not specified, the default is false.

  Introduced in release 21.1.2.
• onlyUsedContent(optional): boolean

  Publish only used content. If set to true then only assets that have been added to the site's pages will be published. If set to false, all assets targeted to the site's publishing channel will be published. If not specified, the default is false.

  Introduced in release 21.1.2.
• selectiveStaticPublish(optional): boolean

  Defaults to false and only used with the doStaticFilePublishOnly option. If true, static items already published will not get removed, it will only replace files in the current static folder.

  Introduced in release 23.6.2.
• skipCompile(optional): boolean

  If true, the site compilation will be skipped and the site will just be published. If not specified, skip compile defaults to false unless only publishing static files is set to true and then the default will be true.

  Introduced in release 21.1.2.
• type(optional): string

  Publication type. An incremental publish will only publish updated site files. A full publish will force a publish of all site files, even if they have not changed. If not specified, the default is incremental.

  Valid values are:

  • incremental - Incremental publish of site pages, publishing only those that have changed
  • full - Full publish of all site pages, even if there have been no changes since last publish

  Introduced in release 21.1.2.

{
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>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.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "type":{
            "description":"<p>Publication type. An incremental publish will only publish updated site files. A full publish will force a publish of all site files, even if they have not changed. If not specified, the default is <code>incremental</code>.</p><p>Valid values are:\n<ul><li> <code>incremental</code> - Incremental publish of site pages, publishing only those that have changed</li><li> <code>full</code> - Full publish of all site pages, even if there have been no changes since last publish</li></p><small>Introduced in release 21.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "onlyStaticFiles":{
            "description":"<p>Publish only static files. If set to <code>true</code> then only site static files are published. By default static files are not compiled. To include compilation of site static files use <code>skipCompile</code> with a value of <code>false</code>. If set to <code>false</code> everything in the site is published. If not specified, the default is <code>false</code>.</p><small>Introduced in release 21.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "onlyUsedContent":{
            "description":"<p>Publish only used content. If set to <code>true</code> then only assets that have been added to the site's pages will be published. If set to <code>false</code>, all assets targeted to the site's publishing channel will be published. If not specified, the default is <code>false</code>.</p><small>Introduced in release 21.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "skipCompile":{
            "description":"<p>If <code>true</code>, the site compilation will be skipped and the site will just be published. If not specified, skip compile defaults to <code>false</code> unless only publishing static files is set to <code>true</code> and then the default will be <code>true</code>.</p><small>Introduced in release 21.1.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "selectiveStaticPublish":{
            "description":"<p>Defaults to <code>false</code> and only used with the doStaticFilePublishOnly option. If <code>true</code>, static items already published will not get removed, it will only replace files in the current static folder.</p><small>Introduced in release 23.6.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        }
    },
    "example":{
        "onlyUsedContent":true
    }
}

Example:

{
    "onlyUsedContent":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

• Array of: items

{
    "description":"<p>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.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• object Link

  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.

{
    "allOf":[
        {
            "$ref":"#/definitions/Link"
        }
    ]
}

Nested Schema : Link

Type: 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.

Show Source

• 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 to true.

• 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 be false if the property is not present.

{
    "description":"<p>REST HATEOAS link and related metadata. If responses provide links (for example, a <code>self</code> link to the resource itself) the links provided will include one or more of the properties defined on this link structure.</p>",
    "properties":{
        "rel":{
            "description":"<p>Name of the link relation that, in addition to the type property, can be used to retrieve link details.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "href":{
            "description":"<p>The target resource URI. URI <em>RFC3986</em> or URI Template <em>RFC6570</em>. If the value is set to URI Template, then the <code>templated</code> property must be set to <code>true</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "templated":{
            "description":"<p>Boolean flag that specifies the <code>href</code> property is a URI or URI Template. The property can be assumed to be <code>false</code> if the property is not present.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"boolean"
        },
        "mediaType":{
            "description":"<p>Media type, as defined by RFC 2046, describing the link target.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "method":{
            "description":"<p>HTTP method for requesting the target of the link.</p><p>Valid values are:\n<ul><li> <code>OPTIONS</code> - HTTP OPTIONS</li><li> <code>HEAD</code> - HTTP HEAD</li><li> <code>GET</code> - HTTP GET</li><li> <code>POST</code> - HTTP POST</li><li> <code>PUT</code> - HTTP PUT</li><li> <code>PATCH</code> - HTTP PATCH</li><li> <code>DELETE</code> - HTTP DELETE</li></p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "profile":{
            "description":"<p>Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        }
    }
}

Back to Top

Response

202 Response

Accepted

Headers

• Location: string

  Location of the resource.

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• allOf MissingSiteTranslationsExceptionDetail
  Introduced in release 19.4.1.

{
    "allOf":[
        {
            "$ref":"#/definitions/MissingSiteTranslationsExceptionDetail"
        }
    ]
}

Nested Schema : MissingSiteTranslationsExceptionDetail

Introduced in release 19.4.1.

Match All

Show Source

• 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 MissingSiteTranslationsExceptionDetail-allOf[1]

{
    "description":"<small>Introduced in release 19.4.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "missing":{
                    "description":"<p>Invalid default language.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    ]
}

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

• 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 or detail.

• 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.

{
    "description":"<p>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.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>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 <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>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 <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : MissingSiteTranslationsExceptionDetail-allOf[1]

Type: object

Show Source

• missing(optional): array missing

  Invalid default language.

  Introduced in release 19.4.1.

{
    "properties":{
        "missing":{
            "description":"<p>Invalid default language.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• 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.

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

Nested Schema : missing

Type: array

Invalid default language.

Introduced in release 19.4.1.

Show Source

• Array of: string

{
    "description":"<p>Invalid default language.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (Missing Site Translations)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Missing Site Translations",
    "status":"400",
    "detail":"There are missing translations for one or more of the required languages of the site's localization policy.",
    "o:errorCode":"OCE-SITEMGMT-009077",
    "missing":[
        "en-US"
    ]
}

401 Response

Unauthorized

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• allOf SiteOperationForbiddenExceptionDetail
  Introduced in release 19.1.5.

{
    "allOf":[
        {
            "$ref":"#/definitions/SiteOperationForbiddenExceptionDetail"
        }
    ]
}

Nested Schema : SiteOperationForbiddenExceptionDetail

Introduced in release 19.1.5.

Match All

Show Source

• 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 SiteOperationForbiddenExceptionDetail-allOf[1]

{
    "description":"<small>Introduced in release 19.1.5.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "site":{
                    "description":"<p>Site on which the operation is being performed.</p><small>Introduced in release 19.1.5.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

• 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 or detail.

• 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.

{
    "description":"<p>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.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>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 <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>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 <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : SiteOperationForbiddenExceptionDetail-allOf[1]

Type: object

Show Source

• site(optional): string

  Site on which the operation is being performed.

  Introduced in release 19.1.5.

{
    "properties":{
        "site":{
            "description":"<p>Site on which the operation is being performed.</p><small>Introduced in release 19.1.5.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• 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.

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

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 (Storage Limit Reached)

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

Example Response (Outbound Data Limit Reached)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Outbound Data Limit Reached",
    "status":"403",
    "detail":"Outbound data limit has been reached.",
    "o:errorCode":"OCE-SITEMGMT-009100",
    "used":1.23456789,
    "limit":1.23456789
}

404 Response

Not Found

Headers

• Cache-Control: string

  Directives for caching mechanisms.

• Content-Length: string

  Size of the response body.

• Content-Type: string

  Content type of the response.

Body ()

Root Schema : schema

Match All

Show Source

• allOf SiteNotFoundExceptionDetail

{
    "allOf":[
        {
            "$ref":"#/definitions/SiteNotFoundExceptionDetail"
        }
    ]
}

Nested Schema : SiteNotFoundExceptionDetail

Match All

Show Source

• 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 SiteNotFoundExceptionDetail-allOf[1]

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "site":{
                    "description":"<p>Site that does not exist or is not visible to the authenticated user.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

• 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 or detail.

• 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.

{
    "description":"<p>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.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>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 <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>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 <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : SiteNotFoundExceptionDetail-allOf[1]

Type: object

Show Source

• site(optional): string

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

{
    "properties":{
        "site":{
            "description":"<p>Site that does not exist or is not visible to the authenticated user.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• 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.

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

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

• allOf SiteDeletedExceptionDetail
  Introduced in release 19.4.1.

{
    "allOf":[
        {
            "$ref":"#/definitions/SiteDeletedExceptionDetail"
        }
    ]
}

Nested Schema : SiteDeletedExceptionDetail

Introduced in release 19.4.1.

Match All

Show Source

• 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 SiteDeletedExceptionDetail-allOf[1]

{
    "description":"<small>Introduced in release 19.4.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "site":{
                    "description":"<p>Site that is soft deleted, if the site identifier has been provided.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

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

• 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 or detail.

• 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.

{
    "description":"<p>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.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>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 <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>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 <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : SiteDeletedExceptionDetail-allOf[1]

Type: object

Show Source

• site(optional): string

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

  Introduced in release 19.4.1.

{
    "properties":{
        "site":{
            "description":"<p>Site that is soft deleted, if the site identifier has been provided.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    }
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: items

{
    "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ExceptionDetail"
            }
        ]
    }
}

Nested Schema : items

Match All

Show Source

• 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.

{
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        }
    ]
}

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 (Theme Import In Progress)

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

Example Response (Component Import In Progress)

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

Example Response (Site not Published)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site not Published",
    "status":"409",
    "detail":"Operation cannot be performed on a site that is not a public site.",
    "o:errorCode":"OCE-SITEMGMT-009141",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

Example Response (Site Republish Required)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Republish Required",
    "status":"409",
    "detail":"Unable to publish the site, a republish is required.",
    "o:errorCode":"OCE-SITEMGMT-009150"
}

Example Response (Blocked File Extension)

{
    "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"
}

Example Response (Site Activation Already In Progress)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Activation Already In Progress",
    "status":"409",
    "detail":"Unable to request site publish/activation while it is currently being activated.",
    "o:errorCode":"OCE-SITEMGMT-009165"
}

Example Response (Site Update In Progress)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Update In Progress",
    "status":"409",
    "detail":"Unable to request site publish/activation while it is currently being updated.",
    "o:errorCode":"OCE-SITEMGMT-009174",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

Example Response (Site Static Publish In Progress)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Static Publish In Progress",
    "status":"409",
    "detail":"Unable to request site publish/activation while it has a static publish in progress.",
    "o:errorCode":"OCE-SITEMGMT-009175",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

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