Interface RequestModifyPayload

Hierarchy

  • RequestModifyPayload

Properties

action: string

The action to perform on the request. One of:

  1. cancel a pending or in-flight request (or cancel the sub-requests of a multiple app gen request that have not yet completed);

  2. pause a request that is not started (i.e. still in the queued state);

  3. resume a paused request;

  4. acknowledge a prior cancelation or

  5. acknowledge the failure of a prior, failed request.

autoAck?: string

An optional flag that can be supplied with the 'cancel' action that, when true, will automatically transition a canceled request to the 'canceled-ack' state following its actual cancelation. Without a 'true' setting for this parameter, the 'cancel' action will transition the state to 'canceled' following actual cancelation of processing (note that there may be a delay in the interim where the state is 'canceling'). Without passing autoAck = true, a subsequent 'ackcancel' action must be invoked using this endpoint to acknowledge the cancelation.

delGenApp?: boolean

An optional flag that will delete the generated app following a cancel (with autoAck), ackcancel or ackfailure action. This optional parameter is only considered in the cases where 'action' parameter is either 'cancel' (with auto-ack=true), 'ackcancel' or 'ackfailure'.

ignoreSucceeded?: string

An optional flag that can be supplied with the 'cancel' action that, when true, will not return an error if the request went to succeeded state while the request was being sent.