REST Resource: projects.locations.workflows.executions

Resource: Execution

A running instance of a Workflow.

JSON representation
{
  "name": string,
  "startTime": string,
  "endTime": string,
  "state": enum (State),
  "argument": string,
  "result": string,
  "error": {
    object (Error)
  },
  "workflowRevisionId": string
}
Fields
name

string

Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

startTime

string (Timestamp format)

Output only. Marks the beginning of execution.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Output only. Marks the end of execution, successful or not.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Output only. Current state of the execution.

argument

string

Input parameters of the execution represented as a JSON string. The size limit is 32KB.

Note: If you are using the REST API directly to run your workflow, you must escape any JSON string value of argument. Example: '{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'

result

string

Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is SUCCEEDED.

error

object (Error)

Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is FAILED or CANCELLED.

workflowRevisionId

string

Output only. Revision of the workflow this execution is using.

State

Describes the current state of the execution. More states may be added in the future.

Enums
STATE_UNSPECIFIED Invalid state.
ACTIVE The execution is in progress.
SUCCEEDED The execution finished successfully.
FAILED The execution failed with an error.
CANCELLED The execution was stopped intentionally.

Error

Error describes why the execution was abnormally terminated.

JSON representation
{
  "payload": string,
  "context": string
}
Fields
payload

string

Error payload returned by the execution, represented as a JSON string.

context

string

Human readable error context, helpful for debugging purposes.

Methods

cancel

Cancels an execution of the given name.

create

Creates a new execution using the latest revision of the given workflow.

get

Returns an execution of the given name.

list

Returns a list of executions which belong to the workflow with the given name.