REST API for Oracle Commerce Cloud 21B

updateFailedMessages

put

/ccadmin/v1/webhookFailedMessages

Update Failed Messages. Updates one or more existing failed messages. Currently the only updatable property is the "resend" property.

Request

Supported Media Types

application/json

Root Schema : updateFailedMessages_request

Type: object

Show Source

resend(optional): boolean

The boolean that specifies whether the messages should be queued for resend.

{
    "properties":{
        "resend":{
            "description":"The boolean that specifies whether the messages should be queued for resend.",
            "type":"boolean"
        }
    },
    "example":"PUT /ccadmin/v1/webhookFailedMessages?q=messageType eq \"atg.cloud.deployment.PublishingEvent\" "
}

Example:

PUT /ccadmin/v1/webhookFailedMessages?q=messageType eq "atg.cloud.deployment.PublishingEvent"

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : updateFailedMessages_response

Show Source

{
    "properties":{
    }
}

Example Response (application/json)

{
    "remainingTargetUrls":[
        "http://posthere.iov/ce27-4065bhara-a487"
    ],
    "messageType":"atg.cloud.deployment.PublishingEvent",
    "lastErrorMessage":"atg.service.webhook.WebHookException: Invalid response code of 502 received for webhook publishEvent from http://posthere.iov/ce27-4065bhara-a487",
    "savedTime":"2017-01-09T10:50:30.000Z",
    "resend":false,
    "serverType":"publishing",
    "asRaw":"??????\u0000\u0005sr\u0000$atg.cloud.deployment.PublishingEventU?????\"???7???\u0002\u0000\u0007I\u0000\nmPhaseCodeL\u0000\u0015mAdditionalDeployDatat\u0000\u000fLjava/util/Map;L\u0000\u001bmExpectedStoreDataStoreNamet\u0000\u0012Ljava/lang/String;L\u0000\u000emOperationTypeq\u0000~\u0000\u0002L\u0000\u000fmRepoDeployDataq\u0000~\u0000\u0001[\u0000!mSelectiveCacheInvalidationEventst\u00002[Latg/adapter/gsa/SelectiveCacheInvalidationEvent;L\u0000\u0005mTimet\u0000\u0010Ljava/util/Date;xr\u0000\"atg.dms.forward.ForwardMessageImpl???>??????g???\u000b???\u0002\u0000\nL\u0000\u000bmAttributesq\u0000~\u0000\u0001L\u0000\u0003mIdq\u0000~\u0000\u0002L\u0000\u000bmOriginalIdq\u0000~\u0000\u0002L\u0000\u000fmOriginalSourceq\u0000~\u0000\u0002L\u0000\u000fmOriginalUserIdq\u0000~\u0000\u0002L\u0000\u0010mParentSessionIdq\u0000~\u0000\u0002L\u0000\nmSessionIdq\u0000~\u0000\u0002L\u0000\u0007mSiteIdq\u0000~\u0000\u0002L\u0000\u0007mSourceq\u0000~\u0000\u0002L\u0000\u0007mUserIdq\u0000~\u0000\u0002xpsr\u0000%java.util.Collections$SynchronizedMap\u001bs???\tKK9{\u0003\u0000\u0002L\u0000\u0001mq\u0000~\u0000\u0001L\u0000\u0005mutext\u0000\u0012Ljava/lang/Object;xpsr\u0000\u0011java.util.HashMap\u0005\u0007?????????\u0016`???\u0003\u0000\u0002F\u0000\nloadFactorI\u0000\tthresholdxp?@\u0000\u0000\u0000\u0000\u0000\fw\b\u0000\u0000\u0000\u0010\u0000\u0000\u0000\u0002t\u0000\u0015ATG_JMS_DELIVERY_DATEsr\u0000\u000ejava.lang.Long;????????#???\u0002\u0000\u0001J\u0000\u0005valuexr\u0000\u0010java.lang.Number?????????\u001d\u000b?????????\u0002\u0000\u0000xp\u0000\u0000\u0001Y?????????5t\u00005atg.service.webhook.WebHookSendingFilter.retryCountersr\u0000\u0011java.lang.Integer\u0012????????????8\u0002\u0000\u0001I\u0000\u0005valuexq\u0000~\u0000\u000e\u0000\u0000\u0000\u0002xq\u0000~\u0000\txt\u0000\u000530004ppppppt\u0000\u0014MessageForwardFilterp\u0000\u0000\u0002lpt\u0000\u0004catBt\u0000\u0011selective_publishppsr\u0000\u000ejava.util.Datehj???\u0001KYt\u0019\u0003\u0000\u0000xpw\b\u0000\u0000\u0001Y??????\u001e???x",
    "id":"100003",
    "serviceName":"publishEvent",
    "forwardMessage":{
        "additionalDeployData":null,
        "parentSessionId":null,
        "sessionId":null,
        "source":"MessageForwardFilter",
        "type":"atg.cloud.deployment.PublishingEvent",
        "userId":null,
        "deployData":null,
        "originalUserId":null,
        "siteId":null,
        "operationType":"selective_publish",
        "id":"30004",
        "originalId":null,
        "phaseCode":620,
        "time":"2017-01-09T10:36:37.960Z",
        "expectedStoreDataStoreName":"catB",
        "phaseName":"DONE_PUBLISH_COMPLETE",
        "selectiveCacheInvalidationEvents":null,
        "originalSource":null
    }
}

Default Response

The error response

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"
        }
    }
}