REST API for Oracle Commerce Cloud December 2017

updateSettings

put

/ccadmin/v1/notificationSettings

Update Settings. Update the notification settings.

Supported Media Types

Body Parameter

Root Schema : updateSettings_request

PUT /ccadminui/v1/notificationSettings

age: Type: integer

Age in minutes after which the messages will be purged
maxCount: Type: integer

maximum number for messages to retain,
rollUpCount: Type: integer

maximum number for messages after which rollup should trigger .

Supported Media Types

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : updateSettings_response

age: Type: integer

Age in minutes after which the messages will be purged
maxCount: Type: integer

maximum number for messages to retain,
rollUpCount: Type: integer

maximum number for messages after which rollup should trigger .


{
    "rollUpCount":25,
    "maxCount":1000,
    "age":2880
}

Default Response

The error response

Body

Root Schema : errorModel

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Nested Schema : items

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Sample Request:

PUT /ccadminui/v1/notificationSettings

Sample Response Payload returned by endpoint:

{
  "rollUpCount": 25,
  "maxCount": 1000,
  "age": 2880
}