getFailedMessages
get
/ccadmin/v1/webhookFailedMessages
Get Failed Messages. The failed messages.
Request
Supported Media Types
- application/json
Query Parameters
-
filter(optional): string
Specifies the bean filter id to be used. Supported values are detailed and short. When not specified or in case of invalid value, default filter, detailed will be used.
-
limit(optional): integer
The number of items to return.
-
offset(optional): integer
Index of the first element to return.
-
q(optional): string
The query in RQL syntax. Common query strings might limit by serverType or messageType.
-
queryFormat(optional): string
The format of the query. Specify "SCIM" to use SCIM rather than the default of RQL.
-
sort(optional): string
Sorting criteria. Following are the fields supported by this param: |Field|Type|Description| |------------------|------------------|------------------| |property|string|The property the listing is sorted by.| |order|string|Sort order: asc or desc.|
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getFailedMessages_response
Type:
Show Source
object
-
items(optional):
array items
The array of failed message items.
-
limit(optional):
integer
The maximum number of items to return.
-
offset(optional):
integer
The starting offset of the first tiem returned.
-
sort(optional):
array sort
The sorting criteria.
-
total(optional):
integer
The total number of items. Deprecated.
-
totalResults(optional):
integer
The total number of items
Nested Schema : items
Type:
Show Source
object
-
asRaw(optional):
string
The raw byte stream of the failed message rendered as a String that may be in useful cases where deserialization fails.
-
forwardMessage(optional):
object forwardMessage
The message being forwarded. Note that specific message types will have additional properties.
-
id(optional):
string
The repository ID of this failed message.
-
lastErrorMessage(optional):
string
The error from the last send attempt.
-
messageType(optional):
string
The message type of this message.
-
remainingTargetUrls(optional):
array remainingTargetUrls
The remaining target URLs to which this message has not successfully been sent.
-
resend(optional):
boolean
Whether this message is marked to be requeued for WebHook send.
-
savedTime(optional):
string
The last time with message was saved.
-
serverType(optional):
string
The server type of the server that failed to send this message.
-
serviceName(optional):
string
The nucleus name of the webhook target.
Nested Schema : forwardMessage
Type:
object
The message being forwarded. Note that specific message types will have additional properties.
Show Source
-
id(optional):
string
The ID for the forward message.
-
originalId(optional):
string
The ID of the original message.
-
originalSource(optional):
string
The original source of the message.
-
originalUserId(optional):
string
The original user ID.
-
parentSessionId(optional):
string
The parent sesison ID of the session from which the message was sent.
-
sessionId(optional):
string
the Session ID
-
siteId(optional):
string
The site ID.
-
source(optional):
string
The source of the message.
-
type(optional):
string
The type of the message.
-
userId(optional):
string
The ID of the end user who last acted on this message.
Nested Schema : remainingTargetUrls
Type:
array
The remaining target URLs to which this message has not successfully been sent.
Show Source
Nested Schema : items
Type:
Show Source
object
-
order(optional):
string
Sort order: asc or desc.
-
property(optional):
string
The property the listing is sorted by.
Example Response (application/json)
{
"total":1,
"totalResults":1,
"offset":0,
"limit":250,
"sort":[
{
"property":"id",
"order":"asc"
}
],
"items":[
{
"remainingTargetUrls":[
"http://localhost:8080/ccstore/v1/logging/logInfoPostWithHeaders",
"http://localhost:9080/ccstore/v1/logging/logInfoPostWithHeaders"
],
"messageType":"atg.commerce.fulfillment.SubmitOrder",
"lastErrorMessage":"atg.service.webhook.WebHookException: java.net.ConnectException: Connection refused (Connection refused)",
"savedTime":"2015-01-20T17:37:13.000Z",
"resend":false,
"serverType":"publishing",
"id":"100001",
"serviceName":"submitOrder",
"forwardMessage":{
"orderId":"o10007",
"parentSessionId":"2AA367F8A3B9BBC645E5F161A5891122",
"sessionId":"2AA367F8A3B9BBC645E5F161A5891122",
"source":"CheckoutProcess",
"type":"atg.commerce.fulfillment.SubmitOrder",
"userId":null,
"profileId":"se-570031",
"originalUserId":null,
"siteId":null,
"id":"10001",
"originalId":"10001",
"order":{
"priceInfo":{
"amount":29.97,
"total":54.97,
"shipping":25,
"discountAmount":0,
"tax":0,
"rawSubtotal":29.97,
"currencyCode":"USD"
},
"totalCommerceItemCount":3,
"id":"o10007",
"commerceItems":[
{
"priceInfo":{
"amount":29.97,
"currencyCode":"USD"
},
"quantity":3,
"productId":"Product_3Dii",
"productDisplayName":"He's Just Not that Into You",
"id":"ci1000008",
"catalogRefId":"Sku_3Eii"
}
]
},
"originalSource":"CheckoutProcess"
}
}
]
}
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