getReason
get
/ccagent/v1/reasons/{id}
Gets an appeasement reason based on the ID provided.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID corresponding to the appeasement reason to be fetched.
Query Parameters
-
type: string
Type of the reason for which id should be presented. Possible value appeasementReason
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getReason_response
Type:
Show Source
object
-
active(optional):
boolean
Indicates whether appeasement reason is enabled or disabled.
-
description(optional):
string
Description of the appeasement reason.
-
id(optional):
string
Id of the appeasement reason.
-
readableDescription(optional):
string
Name of the appeasement reason.
Example:
{
"readableDescription":"Order Arrived Late",
"description":"orderArrivedLate",
"active":true,
"id":"orderArrivedLate"
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|900000|An internal error occurred.|
|900028|No AppeasementReason found with given AppeasementReason id|
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