Jump to

• Request
• Response

Get an Example Request Body for Creating Template Resources

get

/sites/management/api/v1/templates/create-form

CREATE FORM

Get a template request body suitable for creating a new template.The create-form resource provides an example request body that clients can use as a template when creating a new Template. The example request body property values can be edited, removed or added to and then used as the request body when creating a Template. Use of the create form is optional, it is only provided as a guide to the request body format.

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

Request

GET https://api.example.com/sites/management/api/v1/templates/create-form

Response Body

{
  "file": "F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8",
  "template": {
    "resolution": "create",
    "name": "CafeSupremo"
  },
  "theme": {
    "resolution": "create",
    "name": "CafeSupremoTheme"
  },
  "components": {
    "resolution": "conflict",
    "forceCreate": [
        "ContentNavMenu"
    ]
  },
  "defaultResolution": "overwrite",
  "shareWith": "1234"
}

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 - Deleted Filter Required

When listing resources such as components, themes, sites and templates you can either list resources in the trash or not in the trash; you cannot list resources that are both in and not in the trash. This error indicates that the combination of includeDeleted and the q query parameter are trying to list resources in the trash and not in the trash.

Error Code

OCE-DOCS-001007

Resolution - Listing Resources in Trash

Specify both includeDeleted=true and deleted eq "true" to list resources in the trash.

Resolution - Listing Resources Not in Trash

Do not specify includeDeleted=true or use the expression deleted eq "true" in the filter to list resources not in the trash.

Example Response Body

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
  "title": "Deleted Filter Required",
  "status": "400",
  "detail": "You cannot list resources in the trash and not in the trash at the same time.",
  "o:errorCode": "OCE-DOCS-001007"
}

Introduced in release 19.4.3.

Request

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.

• 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.
  create	Describes where the resource can be created. Used on collection resources to indicate where a post can be performed to create a new resource in the collection.
  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.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=create-form

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

• components(optional): object components

  Details of how component conflict resolution is performed.

  Introduced in release 19.4.1.
• defaultResolution(optional): string

  Default conflict resolution for templates, themes and components.

  Valid values are:

  • overwrite - Overwrite the conflicting resources with the one being imported if a resource exists with the same identity
  • skip - Do not import the resource if there is a conflict

  Introduced in release 22.5.2.
• file: string

  Template package file.

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

• shareWith(optional): string

  Optional group name or identifier that the imported artifacts, such as template, theme and components, will be shared with. The group will be given the manager role.

  Introduced in release 22.5.2.
• template(optional): object template

  Details of how template conflict resolution is performed.

  Introduced in release 19.4.1.
• theme(optional): object theme

  Details of how theme conflict resolution is performed.

  Introduced in release 19.4.1.

{
    "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"
                    }
                ]
            }
        },
        "file":{
            "description":"<p>Template package file.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "template":{
            "description":"<p>Details of how template conflict resolution is performed.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "resolution":{
                    "description":"<p>How to handle template conflicts.</p><p>Valid values are:\n<ul><li> <code>create</code> - Import the template with a new identity if a template exists with the same identity. Optionally, a new template name can</li></ul>be specified to avoid any name conflict.\n<ul><li> <code>rename</code> - Import the template with a new name but keeping its identity.  If rename conflict resolution is chosen,</li></ul>then a new template name will also have to be specified.\n<ul><li> <code>overwrite</code> - Overwrite the conflicting template with the one being imported if a template exists with the same identity</li><li> <code>skip</code> - Do not import the template if there is a conflict</li></p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>If a resolution of <code>rename</code> is chosen, a template name must be provided. If a resolution of <code>create</code> is chosen, a template name may optionally be provided. </p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":242
                }
            },
            "required":[
                "resolution"
            ]
        },
        "theme":{
            "description":"<p>Details of how theme conflict resolution is performed.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "resolution":{
                    "description":"<p>How to handle theme conflicts.</p><p>Valid values are:\n<ul><li> <code>create</code> - Import the theme with a new identity if a theme exists with the same identity. Optionally, a new theme name can</li></ul>be specified to avoid any name conflict.\n<ul><li> <code>rename</code> - Import the theme with a new name but keeping its identity.  If rename conflict resolution is chosen,</li></ul>then a new theme name will also have to be specified.\n<ul><li> <code>overwrite</code> - Overwrite the conflicting theme with the one being imported if a theme exists with the same identity</li><li> <code>skip</code> - Do not import the theme if there is a conflict</li></p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "name":{
                    "description":"<p>If a resolution of <code>rename</code> is chosen, a theme name must be provided. If a resolution of <code>create</code> is chosen, a theme name may optionally be provided. </p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string",
                    "maxLength":255
                }
            },
            "required":[
                "resolution"
            ]
        },
        "components":{
            "description":"<p>Details of how component conflict resolution is performed.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"object",
            "properties":{
                "resolution":{
                    "description":"<p>How to handle component conflicts for components not listed in the forceCreate field.</p><p>Valid values are:\n<ul><li> <code>conflict</code> - Do not import the component if there is a conflict, and respond with an error</li><li> <code>overwrite</code> - Overwrite the component with the component in the component package</li></p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"string"
                },
                "forceCreate":{
                    "description":"<p>List of component names that should always be created as new components if they already exist. If the component name is already is use, the new component name will be automatically generated using the existing name and a suffix so it is unique. Components not in this list will be overwritten or cause a conflict response depending on the value of the resolution field.</p><small>Introduced in release 19.4.1.</small>",
                    "x-returnedIn":[
                        "representation",
                        "default",
                        "basic"
                    ],
                    "type":"array",
                    "items":{
                        "type":"string",
                        "maxLength":255
                    }
                }
            },
            "required":[
                "resolution"
            ]
        },
        "defaultResolution":{
            "description":"<p>Default conflict resolution for templates, themes and components.</p><p>Valid values are:\n<ul><li> <code>overwrite</code> - Overwrite the conflicting resources with the one being imported if a resource exists with the same identity</li><li> <code>skip</code> - Do not import the resource if there is a conflict</li></p><small>Introduced in release 22.5.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "shareWith":{
            "description":"<p>Optional group name or identifier that the imported artifacts, such as template, theme and components, will be shared with. The group will be given the manager role.</p><small>Introduced in release 22.5.2.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        }
    },
    "required":[
        "file"
    ]
}

Nested Schema : components

Type: object

Details of how component conflict resolution is performed.

Introduced in release 19.4.1.

Show Source

• forceCreate(optional): array forceCreate

  List of component names that should always be created as new components if they already exist. If the component name is already is use, the new component name will be automatically generated using the existing name and a suffix so it is unique. Components not in this list will be overwritten or cause a conflict response depending on the value of the resolution field.

  Introduced in release 19.4.1.
• resolution: string

  How to handle component conflicts for components not listed in the forceCreate field.

  Valid values are:

  • conflict - Do not import the component if there is a conflict, and respond with an error
  • overwrite - Overwrite the component with the component in the component package

  Introduced in release 19.4.1.

{
    "description":"<p>Details of how component conflict resolution is performed.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "resolution":{
            "description":"<p>How to handle component conflicts for components not listed in the forceCreate field.</p><p>Valid values are:\n<ul><li> <code>conflict</code> - Do not import the component if there is a conflict, and respond with an error</li><li> <code>overwrite</code> - Overwrite the component with the component in the component package</li></p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "forceCreate":{
            "description":"<p>List of component names that should always be created as new components if they already exist. If the component name is already is use, the new component name will be automatically generated using the existing name and a suffix so it is unique. Components not in this list will be overwritten or cause a conflict response depending on the value of the resolution field.</p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"array",
            "items":{
                "type":"string",
                "maxLength":255
            }
        }
    },
    "required":[
        "resolution"
    ]
}

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 : template

Type: object

Details of how template conflict resolution is performed.

Introduced in release 19.4.1.

Show Source

• name(optional): string
  Maximum Length: 242

  If a resolution of rename is chosen, a template name must be provided. If a resolution of create is chosen, a template name may optionally be provided.

  Introduced in release 19.4.1.
• resolution: string

  How to handle template conflicts.

  Valid values are:

  • create - Import the template with a new identity if a template exists with the same identity. Optionally, a new template name can

  be specified to avoid any name conflict.

  • rename - Import the template with a new name but keeping its identity. If rename conflict resolution is chosen,

  then a new template name will also have to be specified.

  • overwrite - Overwrite the conflicting template with the one being imported if a template exists with the same identity
  • skip - Do not import the template if there is a conflict

  Introduced in release 19.4.1.

{
    "description":"<p>Details of how template conflict resolution is performed.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "resolution":{
            "description":"<p>How to handle template conflicts.</p><p>Valid values are:\n<ul><li> <code>create</code> - Import the template with a new identity if a template exists with the same identity. Optionally, a new template name can</li></ul>be specified to avoid any name conflict.\n<ul><li> <code>rename</code> - Import the template with a new name but keeping its identity.  If rename conflict resolution is chosen,</li></ul>then a new template name will also have to be specified.\n<ul><li> <code>overwrite</code> - Overwrite the conflicting template with the one being imported if a template exists with the same identity</li><li> <code>skip</code> - Do not import the template if there is a conflict</li></p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>If a resolution of <code>rename</code> is chosen, a template name must be provided. If a resolution of <code>create</code> is chosen, a template name may optionally be provided. </p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":242
        }
    },
    "required":[
        "resolution"
    ]
}

Nested Schema : theme

Type: object

Details of how theme conflict resolution is performed.

Introduced in release 19.4.1.

Show Source

• name(optional): string
  Maximum Length: 255

  If a resolution of rename is chosen, a theme name must be provided. If a resolution of create is chosen, a theme name may optionally be provided.

  Introduced in release 19.4.1.
• resolution: string

  How to handle theme conflicts.

  Valid values are:

  • create - Import the theme with a new identity if a theme exists with the same identity. Optionally, a new theme name can

  be specified to avoid any name conflict.

  • rename - Import the theme with a new name but keeping its identity. If rename conflict resolution is chosen,

  then a new theme name will also have to be specified.

  • overwrite - Overwrite the conflicting theme with the one being imported if a theme exists with the same identity
  • skip - Do not import the theme if there is a conflict

  Introduced in release 19.4.1.

{
    "description":"<p>Details of how theme conflict resolution is performed.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"object",
    "properties":{
        "resolution":{
            "description":"<p>How to handle theme conflicts.</p><p>Valid values are:\n<ul><li> <code>create</code> - Import the theme with a new identity if a theme exists with the same identity. Optionally, a new theme name can</li></ul>be specified to avoid any name conflict.\n<ul><li> <code>rename</code> - Import the theme with a new name but keeping its identity.  If rename conflict resolution is chosen,</li></ul>then a new theme name will also have to be specified.\n<ul><li> <code>overwrite</code> - Overwrite the conflicting theme with the one being imported if a theme exists with the same identity</li><li> <code>skip</code> - Do not import the theme if there is a conflict</li></p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string"
        },
        "name":{
            "description":"<p>If a resolution of <code>rename</code> is chosen, a theme name must be provided. If a resolution of <code>create</code> is chosen, a theme name may optionally be provided. </p><small>Introduced in release 19.4.1.</small>",
            "x-returnedIn":[
                "representation",
                "default",
                "basic"
            ],
            "type":"string",
            "maxLength":255
        }
    },
    "required":[
        "resolution"
    ]
}

Nested Schema : forceCreate

Type: array

List of component names that should always be created as new components if they already exist. If the component name is already is use, the new component name will be automatically generated using the existing name and a suffix so it is unique. Components not in this list will be overwritten or cause a conflict response depending on the value of the resolution field.

Introduced in release 19.4.1.

Show Source

• Array of: string
  Maximum Length: 255

{
    "description":"<p>List of component names that should always be created as new components if they already exist. If the component name is already is use, the new component name will be automatically generated using the existing name and a suffix so it is unique. Components not in this list will be overwritten or cause a conflict response depending on the value of the resolution field.</p><small>Introduced in release 19.4.1.</small>",
    "x-returnedIn":[
        "representation",
        "default",
        "basic"
    ],
    "type":"array",
    "items":{
        "type":"string",
        "maxLength":255
    }
}

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 ()

{
    "file":"F40B9BE3E69F6DC440559A1F033BB2482DB740ECB2D8",
    "template":{
        "resolution":"create",
        "name":"CafeSupremo"
    },
    "theme":{
        "resolution":"create",
        "name":"CafeSupremoTheme"
    },
    "components":{
        "resolution":"conflict",
        "forceCreate":[
            "ContentNavMenu"
        ]
    },
    "defaultResolution":"overwrite",
    "shareWith":"1234"
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• allOf DeletedRequiredExceptionDetail
  Introduced in release 19.4.3.

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

Nested Schema : DeletedRequiredExceptionDetail

Introduced in release 19.4.3.

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.

{
    "description":"<small>Introduced in release 19.4.3.</small>",
    "allOf":[
        {
            "$ref":"#/definitions/ExceptionDetail"
        },
        {
        }
    ]
}

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 : 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 (Deleted Filter Required)

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Deleted Filter Required",
    "status":"400",
    "detail":"You cannot list resources in the trash and not in the trash at the same time.",
    "o:errorCode":"OCE-DOCS-001007"
}

401 Response

Unauthorized

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