Cancel Action Run Using PATCH

Cancels an action run which is currently being executed

Request

URI

PATCH

https://{api_host}//sc2-10-185-6-200.eng.vmware.com/abx/api/resources/action-runs/{id}/cancel

COPY

Path Parameters

string

Required

ID of the action run

Request Body

body

ActionRun of type(s) application/json

Required

{
    "actionId": "string",
    "actionType": "string",
    "actionVersionId": "string",
    "actionVersionName": "string",
    "createdMillis": 0,
    "endTimeMillis": 0,
    "errorMessage": "string",
    "id": "string",
    "logs": "string",
    "name": "string",
    "orgId": "string",
    "projectId": "string",
    "provider": "string",
    "runState": "string",
    "runtime": "string",
    "source": "string",
    "startTimeMillis": 0,
    "system": false,
    "timeoutSeconds": 0
}

string

actionId

Optional

ID of the action

string

actionType

Optional

Type of the action

Possible values are : SCRIPT, REST_CALL, REST_POLL, FLOW,

string

actionVersionId

Optional

ID of the action version used for the execution

string

actionVersionName

Optional

Name of the action version used for the execution

object

configuration

Optional

Configuration of the action run for specific providers

integer As int64 As int64

createdMillis

Optional

Creation time in millis

integer As int64 As int64

endTimeMillis

Optional

Completion time in millis

string

errorMessage

Optional

Error message in case the run completed with an error

string

Optional

ID of the resource

object

inputs

Optional

Input parameters of the action

string

logs

Optional

Action run logs

string

name

Optional

Name of the resource

string

orgId

Optional

Org ID of the resource

object

outputs

Optional

Output parameters generated by the action

string

projectId

Optional

Project Id of the action (required for non-system actions)

string

provider

Optional

Provider used for code execution

string

runState

Optional

State of the action run

Possible values are : CREATED, DEPLOYING, RUNNING, FINISHING, COMPLETED, DEPLOYMENT_FAILED, FAILED, CANCELLED, UNKNOWN, DEPLOYED, HANDLING_ERROR,

string

runtime

Optional

Runtime of the action run (python, nodejs, etc...)

string

source

Optional

Source used for the execution

integer As int64 As int64

startTimeMillis

Optional

Start time in millis

boolean

system

Optional

system

integer As int32 As int32

timeoutSeconds

Optional

Timeout in seconds for execution

Responses

200

Action run cancelled

Returns ActionRun of type(s) application/json

{
    "actionId": "string",
    "actionType": "string",
    "actionVersionId": "string",
    "actionVersionName": "string",
    "createdMillis": 0,
    "endTimeMillis": 0,
    "errorMessage": "string",
    "id": "string",
    "logs": "string",
    "name": "string",
    "orgId": "string",
    "projectId": "string",
    "provider": "string",
    "runState": "string",
    "runtime": "string",
    "source": "string",
    "startTimeMillis": 0,
    "system": false,
    "timeoutSeconds": 0
}

string

actionId

Optional

ID of the action

string

actionType

Optional

Type of the action

Possible values are : SCRIPT, REST_CALL, REST_POLL, FLOW,

string

actionVersionId

Optional