1. REST API for Sites Management
  2. Tasks
  3. Policies
  4. Updating Policies

Update the Fields of a Policy

patch

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

SINGULAR

Update one or more fields of a policy. The policy status can be changed to inactive to prevent the operation associated with the policy from being performed on the related resource. For example, for a policy that is associated with a template, making the policy inactive will prevent the template from being used to create sites. For a policy associated with the copy operation of a site, making the policy inactive will prevent the site from being copied. If the policy status is active the operation is allowed to be performed on the resource associated with the policy.

Other fields can be updated, such as site expiration periods, type of approval required to perform the operation and site security restrictions.

Policies for site operations default to active status, with field values derived from the original request that created the site. These derived site policies can be replaced or updated. If a derived site policy is updated the policy will first be automatically replaced before the update. For copy policies this will mean associated data such as the approval members will be reset to empty as it is no longer linked to the approval members of the request.

Authorization

To invoke this operation, the authenticated user or client application must have one of the following roles:

  • CECSitesAdministrator

Pending Requests Relating to a Policy

If the policy defines that the operation requires approval when the operation associated with the policy is performed a request will be created. This request will be marked as pending, waiting for manual approval. Any pending requests will fail on approval if the associated policy status has been changed to inactive. For example, a template policy may be changed to inactive whilst the template is being modified and then set back to active again once changes to the template are complete. Any pending requests to create sites from that template may fail because the policy was made inactive. However, any failed requests can be retried once the policy is made active again. All other changes to a policy affect only new requests that relate to the policy. Any existing requests use a snapshot of the policy details captured at the time of the request.

Expiration Date

If the policy is a site expiration policy and the expiration period is changed the site expiration date will be updated to match the expiration period if the policy is active. If an expiration period is set, the site expiration date is recalculated and updated. If no expiration period is set then the site expiration date is cleared. This ensures that the site expiration date is kept in line any changes made to the site expiration policy.

Associate a Policy with a Template

Policies are created as relationships with site templates or sites; the policies resource does not provide a way to directly create a policy, only to update a policy that already exists. Once a policy has been associated with a template or site, the policy can be updated directly via the policy resource.

For more information, see Associate a Policy with a Template.

Listing Templates

Policy status and accessType will affect which templates can be listed for site creation. An inactive policy cannot be used to create sites.

For more information, see List or Batch Read Templates.

Read a Site Copy Policy

Policy status will affect which sites can be copied. An inactive policy for the copy operation will be prevent these sites from being copied.

For more information, see Get the Copy Policy for a Site.

Read a Site Expiration Extension Policy

Policy status will affect which sites can have their expiration date extended. An inactive policy for the extend operation will be prevent these sites from being extended.

For more information, see Get the Expiration Policy for a Site.

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.

200OK - Activate a Policy

A policy can be activated by changing the status field to a value of active.

Request

PATCH https://api.example.com/sites/management/api/v1/policies/{id}

Request Body

{
  "status": "active"
}

200OK - Deactivate a Policy

A policy can be deactivated by changing the status field to a value of inactive.

Request

PATCH https://api.example.com/sites/management/api/v1/policies/{id}

Request Body

{
  "status": "inactive"
}

200OK - Change a Policy to Administrator Approval

A policy approval can be by changed by altering the approvalType field.

Request

PATCH https://api.example.com/sites/management/api/v1/policies/{id}

Request Body

{
  "approvalType": "admin"
}

200OK - Change a Policy to Automatic Approval

A policy approval can be by changed by altering the approvalType field.

Request

PATCH https://api.example.com/sites/management/api/v1/policies/{id}

Request Body

{
  "approvalType": "automatic"
}

200OK - Change a Policy to Named Approval

A policy approval can be by changed by altering the approvalType field. Once a policy is changed to named approval, the list of approvers can be read and changed using the approvers list resource. This resource provides the ability to list, add, replace and delete users, applications or groups approvers.

Request

PATCH https://api.example.com/sites/management/api/v1/policies/{id}

Request Body

{
  "approvalType": "named"
}
Introduced in release 19.3.3.

200OK - Change the Site Security Level

A site security policy can be by change by altering the security field. In this example only the security level is being changed.

Request

PATCH https://api.example.com/sites/management/api/v1/policies/{id}

Request Body

{
  "security": {
    "level": "service"
  }
}

200OK - Change the Access Type to Everyone

A policy can be updated so that the associated access list is ignored so that any user can perform the operation associated with a policy, as long as the policy is active.

Request

PATCH https://api.example.com/sites/management/api/v1/policies/{id}

Request Body

{
  "accessType": "everyone"
}

200OK - Change the Access Type to Restricted

A policy can be updated so that the associated access list is used to control which users can perform the operation associated with a policy, as long as the policy is active.

Request

PATCH https://api.example.com/sites/management/api/v1/policies/{id}

Request Body

{
  "accessType": "restricted"
}
Introduced in release 19.3.1.

200OK - Set a Site Expiration Period

If a policy has a site expiration period then when sites are created from a template associated with the policy a site expiration date will be calculated and set on the site. If the policy is associated with a site then the expiration period is used to set expiration dates on copies of the site, or when the site expiration date is extended. The example sets an expiration period of six months.

Request

PATCH https://api.example.com/sites/management/api/v1/policies/{id}

Request Body

{
  "expiration": {
    "amount": 6,
    "unit": "months"
  }
}
Introduced in release 19.4.1.

200OK - Clear the Site Expiration Period

Any site created from a template associated with a policy that does not have an expiration period will not have an expiration date.

Request

PATCH https://api.example.com/sites/management/api/v1/policies/{id}

Request Body

{
  "expiration": null
}
Introduced in release 19.4.1.

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.

400Bad Request - Invalid Security Scope

The site security scope named cannot be used with a security level of everyone. A site security scope of all must be used when using a security level of everyone.

Error Code

OCE-SITEMGMT-009018

Resolution - Edit Site Security Scope

Change the security scope to the suggested required scope value.

Exception Detail Fields

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

Field NameDescription
levelSpecified site security level. Valid values are:
  • service - Only service users
  • cloud - Only cloud users who can sign in to your domain
  • everyone - Anyone without signing in
specifiedScopeSpecified site security scope. Valid values are:
  • named - Only named users within a specified level can access
  • all - All users within a specified level can access
requiredScopeRequired site security scope. Valid values are:
  • named - Only named users within a specified level can access
  • all - All users within a specified level can access

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

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Security Scope",
  "status": "400",
  "detail": "Site security scope '{specifiedScope}' is not valid with a site security level of '{level}'. Use a security scope of '{requiredScope}'.",
  "o:errorCode": "OCE-SITEMGMT-009018",
  "level": "service",
  "specifiedScope": "named",
  "requiredScope": "all"
}

400Bad Request - Invalid Repository

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

Error Code

OCE-CAAS-001006

Resolution - Check Identifier

Check that the repository identifier is valid.

Resolution - Check Membership

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

Exception Detail Fields

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

Field NameDescription
repositoryRepository that does not exist or is not visible to the authenticated user, if the repository identifier has been provided.

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

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Repository",
  "status": "400",
  "detail": "Repository does not exist or has been deleted, or the authenticated user or client application does not have access to the repository.",
  "o:errorCode": "OCE-CAAS-001006",
  "repository": {
    "id": "F81629473A3DB8B2A28669F19E68209BBAD3340745B0"
  }
}

Introduced in release 19.2.3.

400Bad Request - Invalid Site Template

The template referenced in the request or associated with the resource does not exist, or has been deleted, or the authenticated user or client application does not have access to the template.

Error Code

OCE-SITEMGMT-009010

Resolution - Check Identifier

Check that the template identifier is valid.

Resolution - Check Authorization

Check that the authenticated user is authorized to access to the template.

Exception Detail Fields

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

Field NameDescription
templateTemplate that does not exist or is not visible to the authenticated user.

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

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Template",
  "status": "400",
  "detail": "Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
  "o:errorCode": "OCE-SITEMGMT-009010",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

400Bad Request - Unsupported Policy Field

Indicates that a field in the policy should not be provided. For example, a repository should not be specified in a policy for a standard template.

Error Code

OCE-SITEMGMT-009036

Resolution - Remove Localization Policy Allowed

Remove the policy localizationPolicyAllowed field if the associated template is a standard template.

Resolution - Remove Site Prefix Allowed

Remove the policy sitePrefixAllowed field if the associated template is a standard template.

Resolution - Remove Repository

Remove the policy repository field if the associated template is a standard template.

Exception Detail Fields

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

Field NameDescription
fieldField name that is incompatible with the type of site.

For detailed information about this exception detail type, consult the UnsupportedPolicyFieldExceptionDetail 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": "Unsupported Policy Field",
  "status": "400",
  "detail": "Field '{field}' should not be provided for this policy.",
  "o:errorCode": "OCE-SITEMGMT-009036",
  "field": "repository"
}

400Bad Request - Mandatory Policy Field

Indicates that a field in the policy is being cleared, but the field is mandatory in a policy and cannot be set to null.

Error Code

OCE-SITEMGMT-009037

Resolution - Do Not Clear Field

Do not attempt to clear the security field. The field can be changed only to a different value.

Exception Detail Fields

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

Field NameDescription
policyPolicy whose field is mandatory.
fieldNameField name that is being cleared.

For detailed information about this exception detail type, consult the MandatoryPolicyFieldExceptionDetail 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": "Mandatory Policy Field",
  "status": "400",
  "detail": "Field '{fieldName}' should not be set to 'null'.",
  "o:errorCode": "OCE-SITEMGMT-009037",
  "policy": {
    "id": "721af08b-32db-4eee-b6af-0c38d3ba4681"
  },
  "fieldName": "security"
}

400Bad Request - Invalid Site Expiration

The provided site expiration period is either too small or too large.

Error Code

OCE-SITEMGMT-009067

Resolution - Choose a Smaller Site Expiration Period

Specify a smaller site expiration period.

Resolution - Choose a Larger Site Expiration Period

Specify a larger site expiration period.

Exception Detail Fields

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

Field NameDescription
minimumMinimum site expiration amount.
maximumMaximum site expiration amount.

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

Example Response Body
{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Invalid Site Expiration",
  "status": "400",
  "detail": "Site expiration must be set to between '{minimum.amount} {minimum.unit}' and '{maximum.amount} {maximum.unit}'.",
  "o:errorCode": "OCE-SITEMGMT-009067",
  "minimum": {
    "amount": "2",
    "unit": "months"
  },
  "maximum": {
    "amount": "2",
    "unit": "months"
  }
}

Introduced in release 19.4.1.

404Not Found - Policy Not Found

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

Error Code

OCE-SITEMGMT-009022

Resolution - Check Identifier

Check that the policy identifier is valid.

Resolution - Check Role

Check that the authenticated user is a site administrator.

Resolution - Check Access

If the user is not a site administrator then check the policy 'accessType' includes the authenticated user.

Exception Detail Fields

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

Field NameDescription
policyPolicy that does not exist or is not visible to the authenticated user.

For detailed information about this exception detail type, consult the PolicyNotFoundExceptionDetail 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": "Policy Not Found",
  "status": "404",
  "detail": "Policy does not exist or has been deleted, or the authenticated user or client application does not have access to the policy.",
  "o:errorCode": "OCE-SITEMGMT-009022",
  "policy": {
    "id": "721af08b-32db-4eee-b6af-0c38d3ba4681"
  }
}

409Conflict - Policy Read Only

The policy is read only and cannot be modified. Only policies associated with a template or site can be edited. Policies associated with a request are read only.

Error Code

OCE-SITEMGMT-009032

Resolution - Edit Template Policy

If the intention was to change the policy associated with a template, use the policy identifier from the template policy resource.

Resolution - Edit Copy Site Policy

If the intention was to change the policy associated with the copy site operation, use the policy identifier from the copy operation policy resource.

Resolution - Edit Extend Site Expiration Policy

If the intention was to change the policy associated with the copy site operation, use the policy identifier from the extend site expiration operation policy resource.

Exception Detail Fields

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

Field NameDescription
policyPolicy that is read only.

For detailed information about this exception detail type, consult the PolicyReadOnlyExceptionDetail 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": "Policy Read Only",
  "status": "409",
  "detail": "The policy is read-only and cannot be modified.",
  "o:errorCode": "OCE-SITEMGMT-009032",
  "policy": {
    "id": "721af08b-32db-4eee-b6af-0c38d3ba4681"
  }
}

409Conflict - Missing Template Localization Policy

The policy must allow the user to specify a localization policy because the associated enterprise site template does not have a default localization policy.

If the localization policy associated with a template is deleted, then this error can also occur. If a template localization policy is missing it will prevent site requests from completing where the associated policy specifies that the template localization policy should be used.

Error Code

OCE-SITEMGMT-009030

Resolution - Update the Localization Policy

Change the template policy to allow a localization policy to be specified by the requesting user.

Exception Detail Fields

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

Field NameDescription
templateTemplate that has a missing localization policy.

For detailed information about this exception detail type, consult the MissingTemplateLocalizationPolicyExceptionDetail 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 Template Localization Policy",
  "status": "409",
  "detail": "The template does not have a localization policy, or the localization policy associated with the template has been deleted.",
  "o:errorCode": "OCE-SITEMGMT-009030",
  "template": {
    "id": "F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
  }
}

Request

Supported Media Types
Path Parameters
Header Parameters

  • The if match request header is used with a method to make it conditional. A client that has one or more entity tag values previously obtained with the resource can verify that one of those entity tag values is current. If the requested resource does not match any of the provided entity tag values a precondition failed response will be returned without any body.

  • The if none match request header is used with a method to make it conditional. A client that has one or more entity tag values previously obtained with the resource can verify that none of those entity tag values is current.

Body ()

Only properties that are being updated should be provided in the request. To remove a property, include it in the request with a value of null. Properties that cannot be updated are ignored.

Root Schema : schema
Type: object
Show Source

  • Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.

    Valid values are:

    • everyone - Policy, when active, is applicable to everyone
    • restricted - Policy, when active, is applicable to users that are part of the access list

    Introduced in release 19.3.1.

  • When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.

    Valid values are:

    • automatic - A request will automatically be approved without any human approval process involved
    • admin - Any user with the site administrator role can approve the associated request
    • named - Site creation will require approval from one user that is a member of the approvers list associated with the policy

  • expiration

    When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.

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

  • If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.

    Introduced in release 19.2.3.

  • When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.

    Introduced in release 19.2.3.
  • security

    Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.

  • If true, a request for a new site can include an explicit site prefix. If false, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.

    Introduced in release 19.2.3.

  • The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is inactive then the operation cannot be performed. If the policy status is active then the operation can be performed. For example, for a policy associated with a site template, a status of active means that users can create sites from that site template.

    Valid values are:

    • inactive - Policy that is marked as inactive means the associated operation cannot be requested
    • active - Policy that is marked as active means the associated operation can be requested

Example:
{
    "status":"active"
}
Nested Schema : expiration

When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.

Introduced in release 19.4.1.
Match All
Show Source
  • SiteExpirationPeriod

    Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.

    Introduced in release 19.4.1.
Nested Schema : links
Type: array

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

Show Source
Nested Schema : security
Type: object

Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.

Show Source

  • Define which types of users may access a site. Can include all users or be restricted to named users only.

    Valid values are:

    • named - Only named users within a specified level can access
    • all - All users within a specified level can access

  • Maximum open security level that can be set on a site.

    Valid values are:

    • service - Only service users
    • cloud - Only cloud users who can sign in to your domain
    • everyone - Anyone without signing in

Nested Schema : SiteExpirationPeriod
Type: object

Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.

Introduced in release 19.4.1.
Show Source

  • Amount of time used to measure site expiration.

    Introduced in release 19.4.1.

  • Unit of time used to measure site expiration.

    Valid values are:

    • months - Expiration expressed in the number of months
    • years - Expiration expressed in the number of years

    Introduced in release 19.4.1.
Nested Schema : items
Match All
Show Source
  • Link
Back to Top

Response

Supported Media Types

200 Response

OK
Headers
Body ()
Root Schema : schema
Match All
Show Source
  • Policy

    A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.

    A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.

    A policy can be marked as inactive which prevents the operation from being performed or requested.

Nested Schema : Policy

A policy controls how a request to perform a site-related operation is approved and whether there are any particular restrictions or defaults to apply when that operation is performed.

A policy is associated with a resource, for example a site creation policy can be associated with a site template. A site creation policy, for example, could specify that site administrator approval is required to create a site from a particular site template and that site template has a security level of domain users only.

A policy can be marked as inactive which prevents the operation from being performed or requested.

Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • Policy-allOf[1]
Nested Schema : SingularResource
Type: object

All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

Show Source
  • links
Nested Schema : Policy-allOf[1]
Type: object
Show Source
  • access

    List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the accessType of the policy is set to restricted.

    Introduced in release 19.3.1.

  • Determines whether the policy is applicable to everyone, or to just the users that are part of the access list.

    Valid values are:

    • everyone - Policy, when active, is applicable to everyone
    • restricted - Policy, when active, is applicable to users that are part of the access list

    Introduced in release 19.3.1.

  • When a request is made that is associated with this policy, the request will require the type of approval defined by the policy. If the type of approval is automatic then the request will not require manual approval.

    Valid values are:

    • automatic - A request will automatically be approved without any human approval process involved
    • admin - Any user with the site administrator role can approve the associated request
    • named - Site creation will require approval from one user that is a member of the approvers list associated with the policy

  • approvers

    List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.

    Introduced in release 19.3.3.
  • expiration

    When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.

    Introduced in release 19.4.1.

  • Globally unique identifier for a policy.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  • If a localization policy is not allowed, then the requester will not be permitted to specify a localization policy at the time of requesting a site. The localization policy associated with the template will be used. If a localization policy is allowed, then the requester must specify one at the time of requesting a site. This property can be set only when the template associated with the policy is an enterprise templates.

    Introduced in release 19.2.3.
  • repository

    When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.

    Introduced in release 19.2.3.

  • Every time a policy is edited, the revision number is incremented. Revision numbers start at zero. The revision number can be used to see if a policy has changed since it was last requested as the revision is also used as the strong ETag value for this resource.

  • security

    Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.

  • If true, a request for a new site can include an explicit site prefix. If false, then a site prefix must not be provided and will be generated automatically. This property can be set only when the template associated with the policy is an enterprise templates.

    Introduced in release 19.2.3.

  • The policy status specifies whether the policy can be used to perform the operation associated with the policy. If the policy status is inactive then the operation cannot be performed. If the policy status is active then the operation can be performed. For example, for a policy associated with a site template, a status of active means that users can create sites from that site template.

    Valid values are:

    • inactive - Policy that is marked as inactive means the associated operation cannot be requested
    • active - Policy that is marked as active means the associated operation can be requested

Nested Schema : access
Type: object

List of users and groups who have the ability to perform the operation associated with the policy. For example, the list of users and groups who can create a site from a template. If the access list is empty all users can perform the policy operation. The access list is only used if the accessType of the policy is set to restricted.

Introduced in release 19.3.1.
Show Source
Match All
Show Source
  • CollectionResource

    All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Nested Schema : approvers
Type: object

List of users and groups who have the ability to approve any request associated with the policy. For example, the list of users and groups who can approve creating a site from a template. The approval list is only used if the approval type is set to named approvers.

Introduced in release 19.3.3.
Show Source
  • items

    Collection of Policy Approvers Member elements.

    Introduced in release 19.3.3.
Match All
Show Source
  • CollectionResource

    All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Nested Schema : expiration

When a site is created an expiration date can be set on the site if the policy associated with the site template has a site expiration period set. When a site has expired the site cannot be activated unless the expiration period is extended.

Introduced in release 19.4.1.
Match All
Show Source
  • SiteExpirationPeriod

    Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.

    Introduced in release 19.4.1.
Nested Schema : repository

When a policy is created, or edited, the policy can be associated with an asset repository. When a new site is requested, the site will be associated with the policy-defined asset repository. The user cannot specify a repository when creating a new a site if the repository is set on the policy. If there is no asset repository associated with the policy, then an asset repository can be specified when the user creates a new site. An asset repository can be only associated with a policy if the policy is associated with an enterprise template. Standard sites do not get associated with an asset repository.

Introduced in release 19.2.3.
Match All
Show Source
  • Repository

    Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.

    A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.

Nested Schema : security

Security policy for site creation policies. The security policy specifies the minimum level of security a site can have.

Match All
Show Source
  • SecurityPolicy

    The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.

Nested Schema : items
Type: array

Collection of Policy Access Member elements.

Introduced in release 19.3.1.
Show Source
Nested Schema : CollectionResource

All collections returned by REST APIs extend the standard collection definition. The definition provides information about the total number of items, the offset and limit details for the items returned, the number of items and an indicator to whether there are more items available.

Match All
Show Source
Nested Schema : CollectionResource-allOf[1]
Type: object
Show Source

  • Total number of resources in the response.

  • Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements.

  • Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used.

  • Actual response offset used. If the request specifies no offset then the actual offset is provided in the response.

  • Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the totalResults parameter is supported and is set to true by the client.

Nested Schema : items
Type: object
Show Source

  • Display name for the user, client application or group.

    Introduced in release 19.3.1.
  • group

    Group details of the member. Only available if the member has a type of group.

    Introduced in release 19.3.1.

  • If the member is a group, then the type of group is specified. If the member is a user this field is not present.

    Valid values are:

    • oce - Content management group
    • idp - identity provider group

    Introduced in release 20.1.1.

  • Identifier for the user, client application or group member.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

    Introduced in release 19.3.1.

  • Will be set to true if the associated user or client application has only the external user role.

    Introduced in release 21.10.2.

  • Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.

    Introduced in release 19.3.1.

  • Indicates the member is a user, client application or group.

    Valid values are:

    • user - Member is a user or a client application. No distinction is made between a member that is a user or a
    member that is a client application.
    • group - Member is a group

    Introduced in release 19.3.1.
  • user

    User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

    Introduced in release 19.3.1.
Nested Schema : group

Group details of the member. Only available if the member has a type of group.

Introduced in release 19.3.1.
Match All
Show Source
  • Group

    A group is a collection of users and groups. A group has a human readable group name.

    Introduced in release 19.3.1.
Nested Schema : user

User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

Introduced in release 19.3.1.
Match All
Show Source
  • Identity
    Discriminator: type

    Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

    Introduced in release 20.3.1.
Nested Schema : Group

A group is a collection of users and groups. A group has a human readable group name.

Introduced in release 19.3.1.
Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • Group-allOf[1]
Nested Schema : Group-allOf[1]
Type: object
Show Source

  • Human-readable name for the group.

    Introduced in release 19.3.1.

  • Group name that is unique within the service instance.

    Introduced in release 19.3.1.

  • Unique identifer for the group.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

    Introduced in release 19.3.1.
  • roles

    Roles.

    Valid values are:

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

    Introduced in release 21.10.2.

  • Type of the group.

    Valid values are:

    • oce - Content management group
    • idp - identity provider group

    Introduced in release 19.3.1.
Nested Schema : roles
Type: array

Roles.

Valid values are:

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

Introduced in release 21.10.2.
Show Source
Nested Schema : Identity
Discriminator: type

Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

Introduced in release 20.3.1.
Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • Identity-allOf[1]
Nested Schema : Identity-allOf[1]
Type: object
Show Source

  • Human-readable display name.

    Introduced in release 20.3.1.

  • An identifier value allocated by CEC for the user or client application. The identifier is unique within the scope of the service.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

    Introduced in release 20.3.1.

  • Unique name, such as the user name or client application name.

    Introduced in release 20.3.1.
  • roles

    Roles.

    Valid values are:

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

    Introduced in release 21.10.2.

  • Type of Identity. Valid values are: user, service, application, unknown.

    Introduced in release 20.3.1.
Nested Schema : roles
Type: array

Roles.

Valid values are:

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

Introduced in release 21.10.2.
Show Source
Nested Schema : items
Type: array

Collection of Policy Approvers Member elements.

Introduced in release 19.3.3.
Show Source
Nested Schema : items
Type: object
Show Source

  • Display name for the user, client application or group.

    Introduced in release 19.3.3.
  • group

    Group details of the member. Only available if the member has a type of group.

    Introduced in release 19.3.3.

  • If the member is a group, then the type of group is specified. If the member is a user this field is not present.

    Valid values are:

    • oce - Content management group
    • idp - identity provider group

    Introduced in release 20.1.1.

  • Identifier for the user, client application or group member.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

    Introduced in release 19.3.3.

  • Will be set to true if the associated user or client application has only the external user role.

    Introduced in release 21.10.2.

  • Unique name for the user, client application or group. If the member is a user the name is the user name. If the member is a group the name is the group name.

    Introduced in release 19.3.3.

  • Indicates the member is a user, client application or group.

    Valid values are:

    • user - Member is a user or a client application. No distinction is made between a member that is a user or a
    member that is a client application.
    • group - Member is a group

    Introduced in release 19.3.3.
  • user

    User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

    Introduced in release 19.3.3.
Nested Schema : group

Group details of the member. Only available if the member has a type of group.

Introduced in release 19.3.3.
Match All
Show Source
  • Group

    A group is a collection of users and groups. A group has a human readable group name.

    Introduced in release 19.3.1.
Nested Schema : user

User or client application details of the member. Only available if the member has a type of user. A member can be a user, client application or group. The details of both users and client applications can be read.

Introduced in release 19.3.3.
Match All
Show Source
  • Identity
    Discriminator: type

    Identity representing a user or client application. The identity contains the common information such as the identity identifier, unique name and display name.

    Introduced in release 20.3.1.
Nested Schema : SiteExpirationPeriod
Type: object

Site expiration is expressed as a unit of time and and an amount. For example, expire a site two months after the site is created.

Introduced in release 19.4.1.
Show Source

  • Amount of time used to measure site expiration.

    Introduced in release 19.4.1.

  • Unit of time used to measure site expiration.

    Valid values are:

    • months - Expiration expressed in the number of months
    • years - Expiration expressed in the number of years

    Introduced in release 19.4.1.
Nested Schema : Repository

Repositories are a storage location for files, both text and images. Repository administrators can create a repository with channel policies and localization policies designated for the repository. Multiple repositories can be created to handle different marketing needs.

A repository can be used to manage all the assets you need in one place. For example, perhaps your company sells computer equipment. One repository could be set up to handle the files related to desktop computers. Another repository could be used for tablets. Each repository might contain photos, graphics, and content about the different kinds of computers. The assets in each repository are controlled by the policies you allocate to the repository.

Match All
Show Source
  • SingularResource

    All singular resources include the properties of the singular resource definition. A singular resource includes a list of links that provide relationships to other resources, or in the case of the self link the resource itself.

  • Repository-allOf[1]
Nested Schema : Repository-allOf[1]
Type: object
Show Source
Nested Schema : channels
Type: array

Channels associated with the repository.

Show Source
Nested Schema : contentTypes
Type: array

Content types associated with the repository.

Show Source
Nested Schema : createdDate

Date and time the repository was created.

Match All
Show Source
Nested Schema : languageOptions
Type: array

Language options for the repository.

Show Source
Nested Schema : updatedDate

Date and time the repository was last updated.

Match All
Show Source
Nested Schema : items
Match All
Show Source
Nested Schema : ChannelId
Type: object

Channel identifier.

Show Source

  • Unique identifier for the repository.

    No assumptions should be made about the content of the field; the field should be treated as an opaque value.

  • Short unique human-readable name to identify the channel.

Nested Schema : items
Match All
Show Source
Nested Schema : ContentTypeId
Type: object

Content type identifier.

Show Source
Nested Schema : DateTimeZone
Type: object

Date, time and time zone.

Show Source
Nested Schema : SecurityPolicy
Type: object

The security policy specifies the minimum level of security level a site will be allowed to have. The site will be created with this minimum level, and the site manager/owner can then set a more restrictive security level on the site if they wish. The manager/owner cannot select a security level that is less secure than the values specified on the sites security policy.

Show Source

  • Define which types of users may access a site. Can include all users or be restricted to named users only.

    Valid values are:

    • named - Only named users within a specified level can access
    • all - All users within a specified level can access

  • Maximum open security level that can be set on a site.

    Valid values are:

    • service - Only service users
    • cloud - Only cloud users who can sign in to your domain
    • everyone - Anyone without signing in

Example Response ()
{
    "id":"721af08b-32db-4eee-b6af-0c38d3ba4681",
    "status":"inactive",
    "approvalType":"automatic",
    "accessType":"everyone",
    "security":{
        "level":"service",
        "appliesTo":"named"
    },
    "localizationPolicyAllowed":false,
    "sitePrefixAllowed":false,
    "expiration":{
        "amount":"2",
        "unit":"months"
    },
    "revision":"0"
}

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : InvalidSecurityScopeExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : InvalidSecurityScopeExceptionDetail-allOf[1]
Type: object
Show Source

  • Specified site security level.

    Valid values are:

    • service - Only service users
    • cloud - Only cloud users who can sign in to your domain
    • everyone - Anyone without signing in

  • Required site security scope.

    Valid values are:

    • named - Only named users within a specified level can access
    • all - All users within a specified level can access

  • Specified site security scope.

    Valid values are:

    • named - Only named users within a specified level can access
    • all - All users within a specified level can access

Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Invalid Security Scope)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Security Scope",
    "status":"400",
    "detail":"Site security scope '{specifiedScope}' is not valid with a site security level of '{level}'. Use a security scope of '{requiredScope}'.",
    "o:errorCode":"OCE-SITEMGMT-009018",
    "level":"service",
    "specifiedScope":"named",
    "requiredScope":"all"
}
Example Response (Invalid Repository)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Repository",
    "status":"400",
    "detail":"Repository does not exist or has been deleted, or the authenticated user or client application does not have access to the repository.",
    "o:errorCode":"OCE-CAAS-001006",
    "repository":{
        "id":"F81629473A3DB8B2A28669F19E68209BBAD3340745B0"
    }
}
Example Response (Invalid Site Template)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Template",
    "status":"400",
    "detail":"Template does not exist or has been deleted, or the authenticated user or client application does not have access to the template.",
    "o:errorCode":"OCE-SITEMGMT-009010",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}
Example Response (Unsupported Policy Field)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Unsupported Policy Field",
    "status":"400",
    "detail":"Field '{field}' should not be provided for this policy.",
    "o:errorCode":"OCE-SITEMGMT-009036",
    "field":"repository"
}
Example Response (Mandatory Policy Field)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Mandatory Policy Field",
    "status":"400",
    "detail":"Field '{fieldName}' should not be set to 'null'.",
    "o:errorCode":"OCE-SITEMGMT-009037",
    "policy":{
        "id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
    },
    "fieldName":"security"
}
Example Response (Invalid Site Expiration)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Site Expiration",
    "status":"400",
    "detail":"Site expiration must be set to between '{minimum.amount} {minimum.unit}' and '{maximum.amount} {maximum.unit}'.",
    "o:errorCode":"OCE-SITEMGMT-009067",
    "minimum":{
        "amount":"2",
        "unit":"months"
    },
    "maximum":{
        "amount":"2",
        "unit":"months"
    }
}

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found
Headers
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : PolicyNotFoundExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : PolicyNotFoundExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Policy Not Found)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Policy Not Found",
    "status":"404",
    "detail":"Policy does not exist or has been deleted, or the authenticated user or client application does not have access to the policy.",
    "o:errorCode":"OCE-SITEMGMT-009022",
    "policy":{
        "id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
    }
}

406 Response

Not Acceptable

409 Response

Conflict
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : PolicyReadOnlyExceptionDetail
Match All
Show Source
Nested Schema : ExceptionDetail
Type: object

In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Show Source
Nested Schema : PolicyReadOnlyExceptionDetail-allOf[1]
Type: object
Show Source
Nested Schema : o:errorDetails
Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source
Nested Schema : items
Match All
Show Source
  • ExceptionDetail

    In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.

Example Response (Policy Read Only)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Policy Read Only",
    "status":"409",
    "detail":"The policy is read-only and cannot be modified.",
    "o:errorCode":"OCE-SITEMGMT-009032",
    "policy":{
        "id":"721af08b-32db-4eee-b6af-0c38d3ba4681"
    }
}
Example Response (Missing Template Localization Policy)
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Missing Template Localization Policy",
    "status":"409",
    "detail":"The template does not have a localization policy, or the localization policy associated with the template has been deleted.",
    "o:errorCode":"OCE-SITEMGMT-009030",
    "template":{
        "id":"F30F08EB205D44AD20B5A48D1B1B3DD7D74F45978AB6"
    }
}

412 Response

Precondition Failed

413 Response

Payload Too Large

415 Response

Unsupported Media Type

416 Response

Range Not Satisfiable

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