Undelete a Soft-Deleted Request
/sites/management/api/v1/requests/{id}/undelete
Undo a soft delete of a request. If a request is marked as deleted, this operation changes the deleted state of the request back to normal. The restored request details are included in the response. If a request is not marked as deleted, this operation does nothing. Only the latest revision of a request can be restored. Forked requests are permanently marked as deleted and cannot be restored.
Authorization
Users can restore any request they created. Any request can be restored by a site administrator.
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.
201Created - Restored
If the resource is successfully restored a 201
status code is returned with a Location
where the restored resource can be read.
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 - Request Not Found
The request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.
Error Code
OCE-SITEMGMT-009001
Resolution - Check Identifier
Check that the request identifier is valid.
Resolution - Check Authorization
Check that the authenticated user can review the request or that the authenticated user is the user that created the request.
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
request | Request that does not exist or is not visible to the authenticated user. |
For detailed information about this exception detail type, consult the RequestNotFoundExceptionDetail 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": "Request Not Found", "status": "404", "detail": "Request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.", "o:errorCode": "OCE-SITEMGMT-009001", "request": { "id": "e77229e8-1f44-4c27-bacb-9a99b7c77af7" } }
409Conflict - Invalid Request Revision
A soft-deleted request can be restored only if the request is the latest revision. When requests are edited a copy of the request is made so there is a historical record of the requests life cycle. Only the latest request revision can be restored.
Error Code
OCE-SITEMGMT-009016
Exception Detail Fields
This error type includes the following fields/values in the response:
Field Name | Description |
request | Request can cannot be restored. |
For detailed information about this exception detail type, consult the InvalidRequestRevisionExceptionDetail 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 Request Revision", "status": "409", "detail": "Only the latest revision of the request can be restored.", "o:errorCode": "OCE-SITEMGMT-009016", "request": { "id": "e77229e8-1f44-4c27-bacb-9a99b7c77af7" } }
Request
-
id: string
Globally unique immutable identifier for a request.
-
If-Match(optional): string
The if match request header is used with a method to make it conditional. A client that has one or more entity tag values previously obtained with the resource can verify that one of those entity tag values is current. If the requested resource does not match any of the provided entity tag values a precondition failed response will be returned without any body.
-
If-None-Match(optional): string
The if none match request header is used with a method to make it conditional. A client that has one or more entity tag values previously obtained with the resource can verify that none of those entity tag values is current.
Response
201 Response
-
ETag: string
Opaque identifier assigned by the origin server to a specific version of a resource.
-
Location: string
Location of the resource.
400 Response
401 Response
403 Response
404 Response
-
Cache-Control: string
Directives for caching mechanisms.
-
Content-Length: string
Size of the response body.
-
Content-Type: string
Content type of the response.
-
object
ExceptionDetail
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
-
object
RequestNotFoundExceptionDetail-allOf[1]
object
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
object
-
request(optional):
string
Request that does not exist or is not visible to the authenticated user.
array
Multiple errors can be organized in a hierarchical structure.
-
object
ExceptionDetail
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Request Not Found",
"status":"404",
"detail":"Request does not exist or has been deleted, or the authenticated user or client application does not have access to the request.",
"o:errorCode":"OCE-SITEMGMT-009001",
"request":{
"id":"e77229e8-1f44-4c27-bacb-9a99b7c77af7"
}
}
409 Response
-
object
ExceptionDetail
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
-
object
InvalidRequestRevisionExceptionDetail-allOf[1]
object
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
-
detail(optional):
string
Description specific to this occurrence of the problem. The human-readable, potentially multi-line details describing the problem in more details.
-
instance(optional):
string(uri)
URI to the link that provides more detail about the error.
-
o:errorCode(optional):
string
Application error code, which is different from HTTP error code. This code should be used to check for specific errors, rather than comparing fields such as the
title
ordetail
. -
o:errorDetails(optional):
array o:errorDetails
Multiple errors can be organized in a hierarchical structure.
-
o:errorPath(optional):
string
XPath or JSON path to indicate where the error occurs.
-
status(optional):
integer(int32)
Corresponding HTTP status code for the error.
-
title(optional):
string
Short, human-readable summary of the problem. It is not advisable to use the title as a way of checking for specific errors, use the
o:errorCode
for this purpose. -
type(optional):
string(uri)
Absolute URI that identifies the problem type. When this URI dereferenced, it should provide a human-readable summary of the problem, for example, as a HTML page.
object
-
request(optional):
string
Request can cannot be restored.
array
Multiple errors can be organized in a hierarchical structure.
-
object
ExceptionDetail
In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such cases, the additional information will be included in the response body.
{
"type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"Invalid Request Revision",
"status":"409",
"detail":"Only the latest revision of the request can be restored.",
"o:errorCode":"OCE-SITEMGMT-009016",
"request":{
"id":"e77229e8-1f44-4c27-bacb-9a99b7c77af7"
}
}