Contact UsGet started

Workflows Service, gRPC: ExecutionService.GetHistory

Written by
Updated at October 17, 2024

Retrieves detailed history of specified Workflow execution.

gRPC request

rpc GetHistory (GetExecutionHistoryRequest) returns (GetExecutionHistoryResponse)

GetExecutionHistoryRequest

{
  "executionId": "string"
}

Field

Description

executionId

string

Required field. ID of the Workflow execution.

GetExecutionHistoryResponse

{
  "execution": {
    "id": "string",
    "workflowId": "string",
    "status": "Status",
    "startedAt": "google.protobuf.Timestamp",
    "duration": "google.protobuf.Duration"
  },
  "entries": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "startedAt": "google.protobuf.Timestamp",
      "duration": "google.protobuf.Duration",
      "input": {
        // Includes only one of the fields `inputJson`
        "inputJson": "string"
        // end of the list of possible fields
      },
      "output": {
        // Includes only one of the fields `outputJson`
        "outputJson": "string"
        // end of the list of possible fields
      },
      "error": {
        "message": "string",
        "errorCode": "string"
      },
      "status": "Status",
      "type": "string",
      "attempts": "int64",
      "lastError": {
        "message": "string",
        "errorCode": "string"
      }
    }
  ]
}

Field

Description

execution

ExecutionPreview

Workflow execution details.

entries[]

HistoryEntry

Workflow execution detailed history items.

ExecutionPreview

Field

Description

id

string

ID of the Workflow execution. Generated at creation time.

workflowId

string

ID of the Workflow.

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.

HistoryEntry

Field

Description

id

string

ID of the Workflow step.

title

string

Title of the Workflow step.

description

string

Description of the Workflow step.

startedAt

google.protobuf.Timestamp

Start timestamp for the Workflow step.

duration

google.protobuf.Duration

Duration of the Workflow step.

input

HistoryEntryInput

Input data for the Workflow step.

output

HistoryEntryOutput

Result of the Workflow step.

error

HistoryEntryError

Error details, in case Workflow step failed.

status

enum Status

Status of the Workflow step.

  • STATUS_UNSPECIFIED
  • SCHEDULED: Step execution is being scheduled.
  • STARTED: Step execution is started.
  • COMPLETED: Step execution is completed.
  • FAILED: Step execution is failed.
  • CANCEL_REQUESTED: Step execution is requested to be cancelled.
  • CANCELLED: Step execution is canceled.

type

string

Type of the Workflow step (for example, FunctionCall or HttpCall).

attempts

int64

Number of attempts (including all retries of unsuccessful attempts). Value "1" means there were no retries.

lastError

HistoryEntryError

Last received error details in case of retries.

HistoryEntryInput

Field

Description

inputJson

string

JSON input data for the Workflow step.

Includes only one of the fields inputJson.

HistoryEntryOutput

Field

Description

outputJson

string

JSON result for the Workflow step.

Includes only one of the fields outputJson.

HistoryEntryError

Field

Description

message

string

Error message of the Workflow step.

errorCode

string

Error code of the Workflow step.
Previous
Get
Next
List