REST API for Sites Management

Soft Delete a Template

delete

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

SINGULAR

Soft delete the template. The folder that corresponds to the soft-deleted template will be moved to the trash folder of the owner of the template. A template that has been soft deleted can be restored or hard deleted. A soft-deleted template will no longer be available to used to create sites.

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

Restoring a Deleted Template

A soft-deleted template can be restored by the owner or the user that deleted the template.

For more information, see Restore a Soft-Deleted Template.

Permanently Deleting a Template

A soft-deleted template can be permanently deleted using a hard delete.

For more information, see Hard Delete a Template.

Path Alternative Identifiers

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

nameTemplate Name

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

http://api.example.com/sites/management/api/v1/templates/name:CafeSupremo

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.

204No Content - Soft Deleted

When the resource is deleted a 204 status code is returned.

Client Error Response Examples

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

403Forbidden - Template Operation Forbidden

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

Error Code

OCE-SITEMGMT-009053

Resolution - Change the Sharing Role

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

Exception Detail Fields

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

Field Name	Description
`template`	Template on which the operation is being performed.

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

Introduced in release 19.4.1.

404Not Found - Template Not Found

The site template 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-009000

Resolution - Check Identifier

Check that the template identifier is valid.

Resolution - Check Membership

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

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 TemplateNotFoundExceptionDetail 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 Not Found",
  "status": "404",
  "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-009000",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

Request

Path Parameters

id: string

Immutable identifier for the template.

Response

204 Response

No Content

Headers

Location: string

Location of the resource.

400 Response

Bad Request

401 Response

Unauthorized

403 Response

Forbidden

Root Schema : schema

Match All

Show Source

allOf TemplateOperationForbiddenExceptionDetail

Introduced in release 19.4.1.

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

Nested Schema : TemplateOperationForbiddenExceptionDetail

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

{
    "description":"<small>Introduced in release 19.4.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "template":{
                    "description":"<p>Template on which the operation is being performed.</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 : TemplateOperationForbiddenExceptionDetail-allOf[1]

Type: object

Show Source

template(optional): string

Template on which the operation is being performed.
Introduced in release 19.4.1.

{
    "properties":{
        "template":{
            "description":"<p>Template on which the operation is being performed.</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 (Template Operation Forbidden)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Operation Forbidden",
    "status":"403",
    "detail":"You do have a sharing role in this template, but your role does not allow you to use this operation.",
    "o:errorCode":"OCE-SITEMGMT-009053",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}

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.

Root Schema : schema

Match All

Show Source

allOf TemplateNotFoundExceptionDetail

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

Nested Schema : TemplateNotFoundExceptionDetail

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

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "template":{
                    "description":"<p>Template 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

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 : TemplateNotFoundExceptionDetail-allOf[1]

Type: object

Show Source

template(optional): string

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

{
    "properties":{
        "template":{
            "description":"<p>Template 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 (Template Not Found)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Template Not Found",
    "status":"404",
    "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-009000",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}

409 Response

Conflict

413 Response

Payload Too Large

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