Jump to

• Request
• Response

Add or Remove Users, Applications or Groups from the Access List

patch

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

COLLECTION

Specify a set of users, applications or groups to add and remove from the access list. An invalid user, client application or group error response will be returned if any user, client application or group name does not match a user, client application or group. Attempts to add the same user, client application or group are ignored, as are any attempts to remove a user, client application or group that is not a member of the access list. Note that this operation only allows a maximum of 50 users and/or groups to be added or removed per request.

Introduced in release 19.3.1.

Authorization

Users, client applications and groups can be added or removed from the access list by site administrators.

Enabling the Access List

The access list is only used if the accessType of the associated policy is set to restricted. If the access type is set to everyone the members of the access list are ignored. However, it is valid to alter the access list members when the policy access type is set to everyone.

For more information, see Update the Fields of a Policy.

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 - Add

Users, client applications and groups can be added in the same request. A group is identified using the group:groupname syntax. A user is identified using the user:username syntax. A client application is identified using the user:applicationname syntax.

Request

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

Request Body

{
  "add": [
      "user:jsmith",
      "group:marketing"
  ]
}

200OK - Remove

Users, client applications and groups can be removed in the same request. A group is identified using the group:groupname syntax. A user is identified using the user:username syntax. A client application is identified using the user:applicationname syntax.

Request

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

Request Body

{
  "remove": [
      "user:jsmith",
      "group:marketing"
  ]
}

200OK - Add and Remove

Users, client applications and groups can be added and removed in the same request. A group is identified using the group:groupname syntax. A user is identified using the user:username syntax. A client application is identified using the user:applicationname syntax.

Request

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

Request Body

{
  "add": [
      "user:jsmith",
      "user:jdoe"
  ],
  "remove": [
      "group:marketing"
  ]
}

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 User or Application

A user or client application identified cannot be found.

Error Code

OCE-IDS-001004

Resolution - Check User Exists

Check that the user name is valid.

Resolution - Check Client Application Exists

Check that the client application name is valid.

Exception Detail Fields

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

Field Name	Description
user	User or application that does not exist.

For detailed information about this exception detail type, consult the InvalidIdentityExceptionDetail 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 User or Application",
  "status": "400",
  "detail": "User or client application does not exist.",
  "o:errorCode": "OCE-IDS-001004",
  "user": {
    "id": "1234"
  }
}

Introduced in release 19.3.1.

400Bad Request - Invalid Group

A group identified with an identifier such as the group name cannot be found.

Error Code

OCE-IDS-001007

Resolution - Check Group Exists

Check that the group identifier or group name is valid.

Exception Detail Fields

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

Field Name	Description
group	Group that does not exist.

For detailed information about this exception detail type, consult the InvalidGroupExceptionDetail 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 Group",
  "status": "400",
  "detail": "Group does not exist.",
  "o:errorCode": "OCE-IDS-001007",
  "group": {
    "id": "1234"
  }
}

Introduced in release 19.3.1.

400Bad Request - Too Many Members

When adding, removing or replacing users, applications or groups in a members list the server may enforce a maximum number of elements that can be processed in a single call. This is to ensure that a single synchronous request does not have an unbounded processing time.

Error Code

OCE-IDS-001028

Resolution - Reduce the Number of Members

Reduce the number of users and groups to be equal or less than the maximum number specified.

Resolution - Add Members Individually

Use the POST on the collection resource to add members individually.

Resolution - Remove Members Individually

Use the member resource to remove members individually.

Exception Detail Fields

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

Field Name	Description
maximum	Maximum number of elements.
actual	Number of elements provided.

For detailed information about this exception detail type, consult the TooManyMembersExceptionDetail 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": "Too Many Members",
  "status": "400",
  "detail": "A single request cannot process more than '{maximum}' users and groups. The number of users and groups provided was '{actual}'.",
  "o:errorCode": "OCE-IDS-001028",
  "maximum": 1234,
  "actual": 1234
}

Introduced in release 19.3.1.

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 Name	Description
field	Field 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"
}

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 Name	Description
policy	Policy 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 Name	Description
policy	Policy 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"
  }
}

Request

Supported Media Types

• application/merge-patch+json

Path Parameters

• id: string

  Globally unique identifier for a policy.

Body ()

Users and groups to add or remove from the access list.

Root Schema : schema

Type: object

Show Source

• add(optional): array add

  Members to add.

  Introduced in release 19.3.1.
• remove(optional): array remove

  Members to remove.

  Introduced in release 19.3.1.

{
    "type":"object",
    "properties":{
        "add":{
            "description":"<p>Members to add.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "remove":{
            "description":"<p>Members to remove.</p><small>Introduced in release 19.3.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "example":{
        "add":[
            "user:jsmith",
            "user:jdoe"
        ],
        "remove":[
            "group:marketing"
        ]
    }
}

Example:

{
    "add":[
        "user:jsmith",
        "user:jdoe"
    ],
    "remove":[
        "group:marketing"
    ]
}

Nested Schema : add

Type: array

Members to add.

Introduced in release 19.3.1.

Show Source

• Array of: string

{
    "description":"<p>Members to add.</p><small>Introduced in release 19.3.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : remove

Type: array

Members to remove.

Introduced in release 19.3.1.

Show Source

• Array of: string

{
    "description":"<p>Members to remove.</p><small>Introduced in release 19.3.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

200 Response

OK

Headers

• ETag: string

  Opaque identifier assigned by the origin server to a specific version of a resource.

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• allOf InvalidIdentityExceptionDetail
  Introduced in release 19.3.1.

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

Nested Schema : InvalidIdentityExceptionDetail

Introduced in release 19.3.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 InvalidIdentityExceptionDetail-allOf[1]

{
    "description":"<small>Introduced in release 19.3.1.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "user":{
                    "description":"<p>User or application that does not exist.</p><small>Introduced in release 19.3.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 : InvalidIdentityExceptionDetail-allOf[1]

Type: object

Show Source

• user(optional): string

  User or application that does not exist.

  Introduced in release 19.3.1.

{
    "properties":{
        "user":{
            "description":"<p>User or application that does not exist.</p><small>Introduced in release 19.3.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 (Invalid User or Application)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid User or Application",
    "status":"400",
    "detail":"User or client application does not exist.",
    "o:errorCode":"OCE-IDS-001004",
    "user":{
        "id":"1234"
    }
}

Example Response (Invalid Group)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Invalid Group",
    "status":"400",
    "detail":"Group does not exist.",
    "o:errorCode":"OCE-IDS-001007",
    "group":{
        "id":"1234"
    }
}

Example Response (Too Many Members)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Too Many Members",
    "status":"400",
    "detail":"A single request cannot process more than '{maximum}' users and groups. The number of users and groups provided was '{actual}'.",
    "o:errorCode":"OCE-IDS-001028",
    "maximum":1234,
    "actual":1234
}

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

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

Headers

• Cache-Control: string

  Directives for caching mechanisms.

• Content-Length: string

  Size of the response body.

• Content-Type: string

  Content type of the response.

Body ()

Root Schema : schema

Match All

Show Source

• allOf PolicyNotFoundExceptionDetail

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

Nested Schema : PolicyNotFoundExceptionDetail

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

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

Nested Schema : ExceptionDetail

Type: object

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

Show Source

• detail(optional): string

  Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.

• instance(optional): string(uri)

  URI to the link that provides more detail about the error.

• o:errorCode(optional): string

  Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the title or detail.

• o:errorDetails(optional): array o:errorDetails

  Multiple errors can be organized in a hierarchical structure.

• o:errorPath(optional): string

  XPath or JSON path to indicate where the error occurs.

• status(optional): integer(int32)

  Corresponding HTTP status code for the error.

• title(optional): string

  Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the o:errorCode for this purpose.

• type(optional): string(uri)

  Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : PolicyNotFoundExceptionDetail-allOf[1]

Type: object

Show Source

• policy(optional): string

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

{
    "properties":{
        "policy":{
            "description":"<p>Policy 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 (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"
    }
}

409 Response

Conflict

Body ()

Root Schema : schema

Match All

Show Source

• allOf PolicyReadOnlyExceptionDetail

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

Nested Schema : PolicyReadOnlyExceptionDetail

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

{
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
            "properties":{
                "policy":{
                    "description":"<p>Policy that is read only.</p>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : ExceptionDetail

Type: object

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

Show Source

• detail(optional): string

  Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.

• instance(optional): string(uri)

  URI to the link that provides more detail about the error.

• o:errorCode(optional): string

  Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the title or detail.

• o:errorDetails(optional): array o:errorDetails

  Multiple errors can be organized in a hierarchical structure.

• o:errorPath(optional): string

  XPath or JSON path to indicate where the error occurs.

• status(optional): integer(int32)

  Corresponding HTTP status code for the error.

• title(optional): string

  Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the o:errorCode for this purpose.

• type(optional): string(uri)

  Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.

{
    "description":"<p>In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.</p>",
    "properties":{
        "type":{
            "description":"<p>Absolute URI that identifies the problem type. When this URI dereferenced, it <strong>should</strong> provide a human-readable summary of the problem, for example, as a HTML page.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "title":{
            "description":"<p>Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the <code>o:errorCode</code> for this purpose.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "status":{
            "description":"<p>Corresponding HTTP status code for the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"integer",
            "format":"int32"
        },
        "detail":{
            "description":"<p>Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.</p>",
            "x-multiLingual":true,
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "instance":{
            "description":"<p>URI to the link that provides more detail about the error.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "format":"uri"
        },
        "o:errorCode":{
            "description":"<p>Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the <code>title</code> or <code>detail</code>.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorPath":{
            "description":"<p>XPath or JSON path to indicate where the error occurs.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "o:errorDetails":{
            "description":"<p>Multiple errors can be organized in a hierarchical structure.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ExceptionDetail"
                    }
                ]
            }
        }
    }
}

Nested Schema : PolicyReadOnlyExceptionDetail-allOf[1]

Type: object

Show Source

• policy(optional): string

  Policy that is read only.

{
    "properties":{
        "policy":{
            "description":"<p>Policy that is read only.</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 (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"
    }
}

413 Response

Payload Too Large

415 Response

Unsupported Media Type

429 Response

Too Many Requests

500 Response

Internal Server Error

501 Response

Not Implemented

502 Response

Bad Gateway

503 Response

Service Unavailable

504 Response

Gateway Timeout

Back to Top