Unlink the Policy Associated with a Template
/sites/management/api/v1/templates/{id}/policy
Unlink the policy associated with a template. If there is no default policy associated with a template this operation does nothing. Unlinking the policy indicates that the template is no long suitable for creating sites when site governance is enabled. An alternative to unlinking the policy is to update the policy and make it inactive
.
Authorization
To invoke this operation, the authenticated user or client application must have one of the following roles:
- CECSitesAdministrator
Updating Policies for Templates
Policies that have been associated with a template can be updated using the policy resource.
For more information, see Update the Fields of a Policy.
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/policy
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 - 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.
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" } }
This resource represents the relationship between a Template and Policy resource. If there is no Policy associated with the Template then the response status code will be 204 No Content.
Request
-
id: string
Immutable identifier for the template.
Response
204 Response
400 Response
401 Response
403 Response
404 Response
-
Cache-Control: string
Directives for caching mechanisms.
-
Content-Length: string
Size of the response body.
-
Content-Type: string
Content type of the response.
-
object
ExceptionDetail
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
-
object
TemplateNotFoundExceptionDetail-allOf[1]
object
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
object
-
template(optional):
string
Template that does not exist or is not visible to the authenticated user.
array
Multiple errors can be organized in a hierarchical structure.
-
object
ExceptionDetail
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"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"
}
}