deleteFailedMessages
post
/ccadmin/v1/webhookFailedMessages/delete
Delete Failed Messages. Deletes a set of existing failed messages with specific service name, server type and date range.
Request
Supported Media Types
- application/json
Root Schema : deleteFailedMessages_request
Type:
Show Source
object
-
dateRange(optional):
object dateRange
The date range in which messages should be deleted (values in GMT).
-
serverType(optional):
string
The type of the server.
-
serviceName(optional):
string
The nucleus name of the webhook target.
Example:
{
"dateRange":{
"fromDate":"2018-11-09 11:53:06",
"toDate":"2018-11-16 11:53:06"
},
"serverType":"publishing",
"serviceName":"updateProfile"
}
Nested Schema : dateRange
Type:
object
The date range in which messages should be deleted (values in GMT).
Show Source
-
fromDate(optional):
string
The starting date.
-
toDate(optional):
string
The ending date.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : deleteFailedMessage_response
Type:
Show Source
object
-
message(optional):
string
The localized success message.
Example Response (application/json)
{
"message":"3 messages have been deleted successfully"
}
Default Response
The error response.
34023 : If the service name is invalid
34024 : If the server type is invalid
34025 : If start date or end date is invalid
34017 : If operation fails due to some internal 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