Jump to

• Request
• Response

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.|

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getFailedMessages_response

Type: object

Show Source

• 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

{
    "properties":{
        "total":{
            "description":"The total number of items. Deprecated.",
            "type":"integer"
        },
        "totalResults":{
            "description":"The total number of items",
            "type":"integer"
        },
        "offset":{
            "description":"The starting offset of the first tiem returned.",
            "type":"integer"
        },
        "limit":{
            "description":"The maximum number of items to return.",
            "type":"integer"
        },
        "sort":{
            "description":"The sorting criteria.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"The property the listing is sorted by.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Sort order: asc or desc.",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"The array of failed message items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "remainingTargetUrls":{
                        "description":"The remaining target URLs to which this message has not successfully been sent.",
                        "type":"array",
                        "items":{
                            "type":"string"
                        }
                    },
                    "messageType":{
                        "description":"The message type of this message.",
                        "type":"string"
                    },
                    "lastErrorMessage":{
                        "description":"The error from the last send attempt.",
                        "type":"string"
                    },
                    "savedTime":{
                        "description":"The last time with message was saved.",
                        "type":"string"
                    },
                    "resend":{
                        "description":"Whether this message is marked to be requeued for WebHook send.",
                        "type":"boolean"
                    },
                    "serverType":{
                        "description":"The server type of the server that failed to send this message.",
                        "type":"string"
                    },
                    "asRaw":{
                        "description":"The raw byte stream of the failed message rendered as a String that may be in useful cases where deserialization fails.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The repository ID of this failed message.",
                        "type":"string"
                    },
                    "serviceName":{
                        "description":"The nucleus name of the webhook target.",
                        "type":"string"
                    },
                    "forwardMessage":{
                        "description":"The message being forwarded. Note that specific message types will have additional properties.",
                        "type":"object",
                        "properties":{
                            "parentSessionId":{
                                "description":"The parent sesison ID of the session from which the message was sent.",
                                "type":"string"
                            },
                            "originalUserId":{
                                "description":"The original user ID.",
                                "type":"string"
                            },
                            "siteId":{
                                "description":"The site ID.",
                                "type":"string"
                            },
                            "id":{
                                "description":"The ID for the forward message. ",
                                "type":"string"
                            },
                            "originalId":{
                                "description":"The ID of the original message.",
                                "type":"string"
                            },
                            "sessionId":{
                                "description":"the Session ID",
                                "type":"string"
                            },
                            "source":{
                                "description":"The source of the message.",
                                "type":"string"
                            },
                            "type":{
                                "description":"The type of the message.",
                                "type":"string"
                            },
                            "userId":{
                                "description":"The ID of the end user who last acted on this message.",
                                "type":"string"
                            },
                            "originalSource":{
                                "description":"The original source of the message.",
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The array of failed message items.

Show Source

• Array of: object items

{
    "description":"The array of failed message items.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "remainingTargetUrls":{
                "description":"The remaining target URLs to which this message has not successfully been sent.",
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "messageType":{
                "description":"The message type of this message.",
                "type":"string"
            },
            "lastErrorMessage":{
                "description":"The error from the last send attempt.",
                "type":"string"
            },
            "savedTime":{
                "description":"The last time with message was saved.",
                "type":"string"
            },
            "resend":{
                "description":"Whether this message is marked to be requeued for WebHook send.",
                "type":"boolean"
            },
            "serverType":{
                "description":"The server type of the server that failed to send this message.",
                "type":"string"
            },
            "asRaw":{
                "description":"The raw byte stream of the failed message rendered as a String that may be in useful cases where deserialization fails.",
                "type":"string"
            },
            "id":{
                "description":"The repository ID of this failed message.",
                "type":"string"
            },
            "serviceName":{
                "description":"The nucleus name of the webhook target.",
                "type":"string"
            },
            "forwardMessage":{
                "description":"The message being forwarded. Note that specific message types will have additional properties.",
                "type":"object",
                "properties":{
                    "parentSessionId":{
                        "description":"The parent sesison ID of the session from which the message was sent.",
                        "type":"string"
                    },
                    "originalUserId":{
                        "description":"The original user ID.",
                        "type":"string"
                    },
                    "siteId":{
                        "description":"The site ID.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The ID for the forward message. ",
                        "type":"string"
                    },
                    "originalId":{
                        "description":"The ID of the original message.",
                        "type":"string"
                    },
                    "sessionId":{
                        "description":"the Session ID",
                        "type":"string"
                    },
                    "source":{
                        "description":"The source of the message.",
                        "type":"string"
                    },
                    "type":{
                        "description":"The type of the message.",
                        "type":"string"
                    },
                    "userId":{
                        "description":"The ID of the end user who last acted on this message.",
                        "type":"string"
                    },
                    "originalSource":{
                        "description":"The original source of the message.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : sort

Type: array

The sorting criteria.

Show Source

• Array of: object items

{
    "description":"The sorting criteria.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"The property the listing is sorted by.",
                "type":"string"
            },
            "order":{
                "description":"Sort order: asc or desc.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "remainingTargetUrls":{
            "description":"The remaining target URLs to which this message has not successfully been sent.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "messageType":{
            "description":"The message type of this message.",
            "type":"string"
        },
        "lastErrorMessage":{
            "description":"The error from the last send attempt.",
            "type":"string"
        },
        "savedTime":{
            "description":"The last time with message was saved.",
            "type":"string"
        },
        "resend":{
            "description":"Whether this message is marked to be requeued for WebHook send.",
            "type":"boolean"
        },
        "serverType":{
            "description":"The server type of the server that failed to send this message.",
            "type":"string"
        },
        "asRaw":{
            "description":"The raw byte stream of the failed message rendered as a String that may be in useful cases where deserialization fails.",
            "type":"string"
        },
        "id":{
            "description":"The repository ID of this failed message.",
            "type":"string"
        },
        "serviceName":{
            "description":"The nucleus name of the webhook target.",
            "type":"string"
        },
        "forwardMessage":{
            "description":"The message being forwarded. Note that specific message types will have additional properties.",
            "type":"object",
            "properties":{
                "parentSessionId":{
                    "description":"The parent sesison ID of the session from which the message was sent.",
                    "type":"string"
                },
                "originalUserId":{
                    "description":"The original user ID.",
                    "type":"string"
                },
                "siteId":{
                    "description":"The site ID.",
                    "type":"string"
                },
                "id":{
                    "description":"The ID for the forward message. ",
                    "type":"string"
                },
                "originalId":{
                    "description":"The ID of the original message.",
                    "type":"string"
                },
                "sessionId":{
                    "description":"the Session ID",
                    "type":"string"
                },
                "source":{
                    "description":"The source of the message.",
                    "type":"string"
                },
                "type":{
                    "description":"The type of the message.",
                    "type":"string"
                },
                "userId":{
                    "description":"The ID of the end user who last acted on this message.",
                    "type":"string"
                },
                "originalSource":{
                    "description":"The original source of the message.",
                    "type":"string"
                }
            }
        }
    }
}

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.

{
    "description":"The message being forwarded. Note that specific message types will have additional properties.",
    "type":"object",
    "properties":{
        "parentSessionId":{
            "description":"The parent sesison ID of the session from which the message was sent.",
            "type":"string"
        },
        "originalUserId":{
            "description":"The original user ID.",
            "type":"string"
        },
        "siteId":{
            "description":"The site ID.",
            "type":"string"
        },
        "id":{
            "description":"The ID for the forward message. ",
            "type":"string"
        },
        "originalId":{
            "description":"The ID of the original message.",
            "type":"string"
        },
        "sessionId":{
            "description":"the Session ID",
            "type":"string"
        },
        "source":{
            "description":"The source of the message.",
            "type":"string"
        },
        "type":{
            "description":"The type of the message.",
            "type":"string"
        },
        "userId":{
            "description":"The ID of the end user who last acted on this message.",
            "type":"string"
        },
        "originalSource":{
            "description":"The original source of the message.",
            "type":"string"
        }
    }
}

Nested Schema : remainingTargetUrls

Type: array

The remaining target URLs to which this message has not successfully been sent.

Show Source

• Array of: string

{
    "description":"The remaining target URLs to which this message has not successfully been sent.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

• order(optional): string
  Sort order: asc or desc.
• property(optional): string
  The property the listing is sorted by.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"The property the listing is sorted by.",
            "type":"string"
        },
        "order":{
            "description":"Sort order: asc or desc.",
            "type":"string"
        }
    }
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top