doServerRestart
post
/ccadminx/custom/v1/servers/restart
Do Server Restart. Restarts the workers that belong to the extension server matched with this Oracle Commerce server.
Request
Supported Media Types
- application/json
Query Parameters
-
trackProgress(optional): boolean
If true, then the response will contain workRequestId which can be used to track the extension server restart status.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
202 Response
The following model is returned when track progress query parameter is passed as true.
Root Schema : doServerRestart_response_accepted
Type:
Show Source
object
-
message(optional):
string
The message describing the status
-
workRequestId(optional):
string
The id of the restart request which can be used to track the extension server restart status.
Example Response (application/json)
{
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminx/custom/v1/servers/restart?trackProgress=true"
}
],
"message":"The extension server restart request has been accepted. Please use the workRequestId to track the restart status.",
"workRequestId":"mblNhrQ2D2"
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code