Contact UsGet started

Workflows Service, gRPC: ExecutionService.Get

Written by
Updated at October 17, 2024

Retrieves specified Workflow execution.

gRPC request

rpc Get (GetExecutionRequest) returns (GetExecutionResponse)

GetExecutionRequest

{
  "executionId": "string"
}

Field

Description

executionId

string

Required field. ID of the Workflow execution.

GetExecutionResponse

{
  "execution": {
    "id": "string",
    "workflowId": "string",
    "input": {
      // Includes only one of the fields `inputJson`
      "inputJson": "string"
      // end of the list of possible fields
    },
    "result": {
      // Includes only one of the fields `resultJson`
      "resultJson": "string"
      // end of the list of possible fields
    },
    "error": {
      "message": "string",
      "errorCode": "string"
    },
    "status": "Status",
    "startedAt": "google.protobuf.Timestamp",
    "duration": "google.protobuf.Duration"
  }
}

Field

Description

execution

Execution

Workflow execution details.

Execution

Field

Description

id

string

ID of the Workflow execution. Generated at creation time.

workflowId

string

ID of the Workflow.

input

ExecutionInput

Input data for the Workflow execution.

result

ExecutionResult

Result of the Workflow execution.

error

ExecutionError

Error details, in case Workflow execution failed.

status

enum Status

Status of the Workflow execution

  • STATUS_UNSPECIFIED
  • QUEUED: Workflow execution is being queued.
  • RUNNING: Workflow execution is running.
  • PAUSED: Workflow execution is being paused.
  • STOPPED: Workflow execution is stopped.
  • FAILED: Workflow execution is failed.
  • FINISHED: Workflow execution is finished.

startedAt

google.protobuf.Timestamp

Start timestamp for the Workflow execution.

duration

google.protobuf.Duration

Duration of the Workflow execution.

ExecutionInput

Field

Description

inputJson

string

JSON input data for the Workflow execution.

Includes only one of the fields inputJson.

ExecutionResult

Field

Description

resultJson

string

JSON result of the Workflow execution.

Includes only one of the fields resultJson.

ExecutionError

Field

Description

message

string

Error message of the Workflow execution.

errorCode

string

Error code of the Workflow execution.
Previous
Terminate
Next
GetHistory