Jump to

• Request
• Response

Performs an update to the failedEventAction of a queued message.

put

/ccstore/v1/selfservice/queuedActions/{id}

Authenticated endpoint to update the failedEventAction of a queued message belonging to the currently logged-in user. Note: This endpoint only updates the failedEventAction field and does not modify any other part of the queued message.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  ID of queued message.

Body ()

Root Schema : UpdateQueuedActionRequest

Type: object

Show Source

• failedEventAction(required): string
  name of action to perform on queued message. Possible actions are: COPY, DISMISS and GENERATE_PROPOSAL

{
    "properties":{
        "failedEventAction":{
            "description":"name of action to perform on queued message. Possible actions are: COPY, DISMISS and GENERATE_PROPOSAL",
            "type":"string"
        }
    },
    "required":[
        "failedEventAction"
    ],
    "example":{
        "failedEventAction":"COPY"
    }
}

Example:

{
    "failedEventAction":"COPY"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response containing updated queued message

Body ()

Root Schema : updateQueuedActionsResponse

Type: object

Show Source

• action: string
  Name of action performed
• entityId: string
  entityId
• entityName: string
  entity name
• entityType: string
  entity type.
• errorMessage: string
  Error message received from downstream system
• failedEventAction: string
  Name of action performed after event was failed.
• failedEventActionAt: string
  Timestamp when failedEventAction was performed.
• failedEventActionBy: string
  profileId, who performed the failedEventAction.
• organizationId: string
  organizationId
• processedAt: string
  Timestamp when entity was processed.
• profileId: string
  profileId.
• queuedActionId: string
  queuedActionId
• receivedAt: string
  Timestamp when it was received
• siteId: string
  siteId
• status: string
  Current Status of queued event

{
    "properties":{
        "entityType":{
            "description":"entity type.",
            "type":"string"
        },
        "errorMessage":{
            "description":"Error message received from downstream system",
            "type":"string"
        },
        "entityId":{
            "description":"entityId",
            "type":"string"
        },
        "receivedAt":{
            "description":"Timestamp when it was received",
            "type":"string"
        },
        "failedEventAction":{
            "description":"Name of action performed after event was failed.",
            "type":"string"
        },
        "organizationId":{
            "description":"organizationId",
            "type":"string"
        },
        "failedEventActionAt":{
            "description":"Timestamp when failedEventAction was performed.",
            "type":"string"
        },
        "profileId":{
            "description":"profileId.",
            "type":"string"
        },
        "entityName":{
            "description":"entity name",
            "type":"string"
        },
        "queuedActionId":{
            "description":"queuedActionId",
            "type":"string"
        },
        "processedAt":{
            "description":"Timestamp when entity was processed.",
            "type":"string"
        },
        "siteId":{
            "description":"siteId",
            "type":"string"
        },
        "action":{
            "description":"Name of action performed",
            "type":"string"
        },
        "failedEventActionBy":{
            "description":"profileId, who performed the failedEventAction.",
            "type":"string"
        },
        "status":{
            "description":" Current Status of queued event",
            "type":"string"
        }
    },
    "example":{
        "entityType":"order",
        "errorMessage":null,
        "entityId":"o990431",
        "receivedAt":"2025-04-04T12:11:17.150Z",
        "failedEventAction":"COPY",
        "organizationId":"or-100001",
        "failedEventActionAt":"2025-04-05T12:11:45.210Z",
        "profileId":"bb-110034",
        "entityName":null,
        "repositoryId":"msg-205",
        "processedAt":"2025-04-04T12:11:45.210Z",
        "queuedActionId":"msg-205",
        "siteId":"siteUS",
        "action":"submitOrder",
        "links":[
            {
                "rel":"self",
                "href":"http://localhost:8080/ccstore/v1/selfservice/queuedActions/msg-205"
            }
        ],
        "failedEventActionBy":"bb-110034",
        "status":"FAILED"
    }
}

Example:

{
    "entityType":"order",
    "errorMessage":null,
    "entityId":"o990431",
    "receivedAt":"2025-04-04T12:11:17.150Z",
    "failedEventAction":"COPY",
    "organizationId":"or-100001",
    "failedEventActionAt":"2025-04-05T12:11:45.210Z",
    "profileId":"bb-110034",
    "entityName":null,
    "repositoryId":"msg-205",
    "processedAt":"2025-04-04T12:11:45.210Z",
    "queuedActionId":"msg-205",
    "siteId":"siteUS",
    "action":"submitOrder",
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/selfservice/queuedActions/msg-205"
        }
    ],
    "failedEventActionBy":"bb-110034",
    "status":"FAILED"
}

400 Response

Bad query params in the request

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

Back to Top