Jump to

• Request
• Response

Get Site Permissions

get

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

RELATION

Read the permissions the authenticated user or client application has for a site. The permissions list the actions that can be performed on a site and resources related to the site, such as conversations, share links, members and annotations.

Introduced in release 22.7.2.

Authorization

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

• Owner
• Manager
• Contributor
• Downloader
• Viewer

Path Alternative Identifiers

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

nameSite Name

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

http://api.example.com/sites/management/api/v1/sites/name:MyNewProduct/permissions

Introduced in release 19.4.1.

Successful Response Examples

This operation responds with the following success (2xx) responses. For a full list of response HTTP status codes and example bodies, consult the Response section of this operation.

200OK - Site Permissions

Returns the site permissions for the authenticated user or client application.

Request

GET https://api.example.com/sites/management/api/v1/sites/{id}/permissions

Response Body

{
  "self": [
      "preview",
      "read",
      "write",
      "update"
  ],
  "file": [
      "preview",
      "read",
      "write",
      "update"
  ],
  "members": [
      "read"
  ],
  "shareLink": [
      "read",
      "create",
      "update",
      "delete"
  ],
  "annotation": [
      "read",
      "write",
      "update",
      "delete"
  ],
  "conversation": [
      "read",
      "write",
      "update",
      "delete"
  ]
}

Introduced in release 22.7.2.

Client Error Response Examples

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

404Not Found - Site Not Found

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

Error Code

OCE-SITEMGMT-009003

Resolution - Check Identifier

Check that the site identifier is valid.

Resolution - Check Membership

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

Exception Detail Fields

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

Field Name	Description
site	Site that does not exist or is not visible to the authenticated user.

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

Example Response Body

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Site Not Found",
  "status": "404",
  "detail": "Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
  "o:errorCode": "OCE-SITEMGMT-009003",
  "site": {
    "id": "FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
  }
}

404Not Found - Relationship Not Found

An attempt to read a relationship has failed because the relationship does not exist. Reading a relationship can fail if the relationship no longer exists or the authenticated identity is not authorized to read the relationship details.

Error Code

PAAS-005027

Example Response Body

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Relationship Not Found",
  "status": "404",
  "detail": "Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
  "o:errorCode": "PAAS-005027"
}

This resource represents the relationship between a Site and Site Permissions resource. If the Site Permissions has been deleted or the authenticated user is not authorized to read the resource then the response status code will be 404 Not Found and a Relationship Not Found error will be returned in the response body.

Request

Path Parameters

• id: string

  Immutable identifier for the site.

Query Parameters

• excludeFields(optional): string

  Comma-delimited string of field names that should not be included in the response.

• excludeLinks(optional): string

  Comma-separated list of link relation names to exclude from the response.

• fields(optional): string

  Comma-delimited string of field names to include in the response. Nested fields can be identified using a dot to separate the field names. Field names are case-sensitive. Field names are ignored if the field does not exist.

• includeDeleted(optional): boolean

  Resources that have been marked for deletion can be read, modified, and support extended operations as long this query parameter is set to true. When the includeDeleted query parameter is not sent then the response to read, modification, and extended operations will be identical to that which would be returned if the resource was permanently deleted.

• links(optional): string

  Comma-separated list of link relation names to include in the response. By default, all links are returned.

  The following links are provided by this resource:

  Link Relationship	Description
  parent	Describes where the parent resource can be read. Equivalent to an up link, this link provides the link to the parent resource, such as the collection resource that contains a singular resource.
  self	Describes the current returned representation of the resource. Used for links that represent the resource itself. For example, if a resource is returned as part of a collection, the self link will provide the URL path for the individual resource.
  canonical	Describes the preferred representation of the requested resource. Used for links that represent the canonical form of the resource. For example, if a resource is returned as part of a collection, the canonical link will provide the URL path for the canonical form of the individual resource.
  describedBy	Describes the schema resource providing metadata information about the resource. Used on collection, singular and relation resources to indicate where the schema resource is that describes the resource.

• return(optional): string

  Specify the resource representation that should be used to control the response fields and links. If no representation is specified, the client-defined representation is returned, based on the values of the fields, excludeFields, links, excludeLinks and expand query parameters.

  The following representations are supported with the return query parameter:

  Representation	Description
  representation	Full resource representation includes all properties and links and expands most relationships.
  default	Default resource representation includes most properties and links.
  basic	Basic resource representation includes some properties and some links.
  minimal	Minimal resource representation, includes essential properties and no links.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=singular

200 Response

OK

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

Type: object

Show Source

• annotation(optional): array annotation

  Set of annotation permissions the user has.

  Valid values are:

  • read - Read annotation
  • write - Write an annotation
  • update - Update annotation
  • delete - Delete annotation

  Introduced in release 22.7.2.
• conversation(optional): array conversation

  Set of conversation permissions the user has.

  Valid values are:

  • read - Read a conversation
  • write - Write to a conversation
  • update - Update a conversation
  • delete - Delete a conversation

  Introduced in release 22.7.2.
• file(optional): array file

  Set of file level permissions the user has.

  Valid values are:

  • preview - Preview file
  • read - Read file
  • write - Write to file
  • update - Update file
  • delete - Delete file

  Introduced in release 22.7.2.
• links(optional): array links

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

• members(optional): array members

  Set of members permissions the user has.

  Valid values are:

  • read - Read and list members
  • add - Add to members
  • update - Update members
  • remove - Remove members

  Introduced in release 22.7.2.
• self(optional): array self

  Set of folder level permissions the user has.

  Valid values are:

  • preview - Preview folder
  • read - Read folder
  • write - Write to folder
  • update - Update folder
  • delete - Delete folder

  Introduced in release 22.7.2.
• shareLink(optional): array shareLink

  Set of share link permissions the user has.

  Valid values are:

  • read - Read and list shared links
  • create - Create a share link
  • update - Update a share link
  • delete - Delete a share link

  Introduced in release 22.7.2.

{
    "type":"object",
    "properties":{
        "links":{
            "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/Link"
                    }
                ]
            }
        },
        "self":{
            "description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "file":{
            "description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "members":{
            "description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "shareLink":{
            "description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "annotation":{
            "description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "conversation":{
            "description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : annotation

Type: array

Set of annotation permissions the user has.

Valid values are:

• read - Read annotation
• write - Write an annotation
• update - Update annotation
• delete - Delete annotation

Introduced in release 22.7.2.

Show Source

• Array of: string

{
    "description":"<p>Set of annotation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read annotation</li><li> <code>write</code> - Write an annotation</li><li> <code>update</code> - Update annotation</li><li> <code>delete</code> - Delete annotation</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : conversation

Type: array

Set of conversation permissions the user has.

Valid values are:

• read - Read a conversation
• write - Write to a conversation
• update - Update a conversation
• delete - Delete a conversation

Introduced in release 22.7.2.

Show Source

• Array of: string

{
    "description":"<p>Set of conversation permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read a conversation</li><li> <code>write</code> - Write to a conversation</li><li> <code>update</code> - Update a conversation</li><li> <code>delete</code> - Delete a conversation</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : file

Type: array

Set of file level permissions the user has.

Valid values are:

• preview - Preview file
• read - Read file
• write - Write to file
• update - Update file
• delete - Delete file

Introduced in release 22.7.2.

Show Source

• Array of: string

{
    "description":"<p>Set of file level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview file</li><li> <code>read</code> - Read file</li><li> <code>write</code> - Write to file</li><li> <code>update</code> - Update file</li><li> <code>delete</code> - Delete file</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

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

Show Source

• Array of: items

{
    "description":"<p>HATEOS link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.</p>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/Link"
            }
        ]
    }
}

Nested Schema : members

Type: array

Set of members permissions the user has.

Valid values are:

• read - Read and list members
• add - Add to members
• update - Update members
• remove - Remove members

Introduced in release 22.7.2.

Show Source

• Array of: string

{
    "description":"<p>Set of members permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list members</li><li> <code>add</code> - Add to members</li><li> <code>update</code> - Update members</li><li> <code>remove</code> - Remove members</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : self

Type: array

Set of folder level permissions the user has.

Valid values are:

• preview - Preview folder
• read - Read folder
• write - Write to folder
• update - Update folder
• delete - Delete folder

Introduced in release 22.7.2.

Show Source

• Array of: string

{
    "description":"<p>Set of folder level permissions the user has.</p><p>Valid values are:\n<ul><li> <code>preview</code> - Preview folder</li><li> <code>read</code> - Read folder</li><li> <code>write</code> - Write to folder</li><li> <code>update</code> - Update folder</li><li> <code>delete</code> - Delete folder</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : shareLink

Type: array

Set of share link permissions the user has.

Valid values are:

• read - Read and list shared links
• create - Create a share link
• update - Update a share link
• delete - Delete a share link

Introduced in release 22.7.2.

Show Source

• Array of: string

{
    "description":"<p>Set of share link permissions the user has.</p><p>Valid values are:\n<ul><li> <code>read</code> - Read and list shared links</li><li> <code>create</code> - Create a share link</li><li> <code>update</code> - Update a share link</li><li> <code>delete</code> - Delete a share link</li></p><small>Introduced in release 22.7.2.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Match All

Show Source

• object Link

  REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

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

Nested Schema : Link

Type: object

REST HATEOAS link and related metadata. If responses provide links (for example, a self link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

• href(optional): string

  The target resource URI. URI RFC3986 or URI Template RFC6570. If the value is set to URI Template, then the templated property must be set to true.

• mediaType(optional): string

  Media type, as defined by RFC 2046, describing the link target.

• method(optional): string

  HTTP method for requesting the target of the link.

  Valid values are:

  • OPTIONS - HTTP OPTIONS
  • HEAD - HTTP HEAD
  • GET - HTTP GET
  • POST - HTTP POST
  • PUT - HTTP PUT
  • PATCH - HTTP PATCH
  • DELETE - HTTP DELETE

• profile(optional): string(uri)

  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.

• rel(optional): string

  Name of the link relation that, in addition to the type property, can be used to retrieve link details.

• templated(optional): boolean

  Boolean flag that specifies the href property is a URI or URI Template. The property can be assumed to be false if the property is not present.

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

Example Response (Site Permissions)

{
    "self":[
        "preview",
        "read",
        "write",
        "update"
    ],
    "file":[
        "preview",
        "read",
        "write",
        "update"
    ],
    "members":[
        "read"
    ],
    "shareLink":[
        "read",
        "create",
        "update",
        "delete"
    ],
    "annotation":[
        "read",
        "write",
        "update",
        "delete"
    ],
    "conversation":[
        "read",
        "write",
        "update",
        "delete"
    ]
}

400 Response

Bad Request

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 SiteNotFoundExceptionDetail

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

Nested Schema : SiteNotFoundExceptionDetail

Match All

Show Source

• object ExceptionDetail

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

• object SiteNotFoundExceptionDetail-allOf[1]

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

Nested Schema : ExceptionDetail

Type: object

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

Show Source

• detail(optional): string

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

• instance(optional): string(uri)

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

• o:errorCode(optional): string

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

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

  Multiple errors can be organized in a hierarchical structure.

• o:errorPath(optional): string

  XPath or JSON path to indicate where the error occurs.

• status(optional): integer(int32)

  Corresponding HTTP status code for the error.

• title(optional): string

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

• type(optional): string(uri)

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

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

Nested Schema : SiteNotFoundExceptionDetail-allOf[1]

Type: object

Show Source

• site(optional): string

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

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

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: items

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

Nested Schema : items

Match All

Show Source

• object ExceptionDetail

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

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

Example Response (Site Not Found)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Site Not Found",
    "status":"404",
    "detail":"Site does not exist or has been deleted, or the authenticated user or client application does not have access to the site.",
    "o:errorCode":"OCE-SITEMGMT-009003",
    "site":{
        "id":"FCA9C0E5CDCB549A19FFB85987A2352778961003B8A0"
    }
}

Example Response (Relationship Not Found)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Relationship Not Found",
    "status":"404",
    "detail":"Relationship resource not found. There is a relationship to a resource, but the resource at the end of the relationship does not exist, or the authenticated identity cannot see the resource.",
    "o:errorCode":"PAAS-005027"
}

406 Response

Not Acceptable

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