updateType
put
/ccadmin/v1/appeasementTypes/{id}
Updates the specified appeasement type.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID corresponding to the appeasement type to be fetched.
Header Parameters
-
X-CCAsset-Language: string
The asset language of the request. E.g., en,de,fr_CA.
Root Schema : updateType_request
Type:
Show Source
object
-
active(optional):
boolean
Indicates whether appeasement type is enabled or disabled.
-
description(optional):
string
Description of the appeasement type.
-
displayName:
string
Name of the appeasement type.
-
isOrderRequired(optional):
boolean
Indicates whether order is mandatory for the type.
Example:
{
"displayName":"Order",
"description":"Appeasement to be applied on a given order",
"active":true,
"isOrderRequired":true
}
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateType_response
Type:
Show Source
object
-
active(optional):
boolean
Indicates whether appeasement type is enabled or disabled.
-
description(optional):
string
Description of the appeasement type.
-
displayName(optional):
string
Name of the appeasement type.
-
id(optional):
string
Id of the appeasement type.
-
isOrderRequired(optional):
boolean
Indicates whether order is mandatory for the type.
Example:
{
"displayName":"Order",
"description":"Appeasement to be applied on a given order",
"active":true,
"id":"order",
"isOrderRequired":true
}
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.|
|900023|No appeasement type found with given appeasement id|
|900024|An internal error occured while updating the appeasement type.|
|13001|Input validation error|
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