Workflows Service, gRPC: ExecutionService.GetHistory
Retrieves detailed history of specified Workflow execution.
gRPC request
rpc GetHistory (GetExecutionHistoryRequest) returns (GetExecutionHistoryResponse)
GetExecutionHistoryRequest
{
"execution_id": "string"
}
|
Field |
Description |
|
execution_id |
string Required field. ID of the Workflow execution. |
GetExecutionHistoryResponse
{
"execution": {
"id": "string",
"workflow_id": "string",
"status": "Status",
"started_at": "google.protobuf.Timestamp",
"duration": "google.protobuf.Duration"
},
"entries": [
{
"id": "string",
"title": "string",
"description": "string",
"started_at": "google.protobuf.Timestamp",
"duration": "google.protobuf.Duration",
"input": {
// Includes only one of the fields `input_json`
"input_json": "string"
// end of the list of possible fields
},
"output": {
// Includes only one of the fields `output_json`
"output_json": "string"
// end of the list of possible fields
},
"error": {
"message": "string",
"error_code": "string"
},
"status": "Status",
"type": "string",
"attempts": "int64",
"last_error": {
"message": "string",
"error_code": "string"
}
}
]
}
|
Field |
Description |
|
execution |
Required field. Workflow execution details. |
|
entries[] |
Workflow execution detailed history items. The number of elements must be greater than 0. |
ExecutionPreview
|
Field |
Description |
|
id |
string Required field. ID of the Workflow execution. Generated at creation time. |
|
workflow_id |
string Required field. ID of the Workflow. |
|
status |
enum Status Required field. Status of the Workflow execution
|
|
started_at |
Required field. Start timestamp for the Workflow execution. |
|
duration |
Duration of the Workflow execution. |
HistoryEntry
|
Field |
Description |
|
id |
string Required field. ID of the Workflow step. |
|
title |
string Required field. Title of the Workflow step. |
|
description |
string Description of the Workflow step. |
|
started_at |
Required field. Start timestamp for the Workflow step. |
|
duration |
Duration of the Workflow step. |
|
input |
Input data for the Workflow step. |
|
output |
Result of the Workflow step. |
|
error |
Error details, in case Workflow step failed. |
|
status |
enum Status Required field. Status of the Workflow step.
|
|
type |
string Required field. 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. |
|
last_error |
Last received error details in case of retries. |
HistoryEntryInput
|
Field |
Description |
|
input_json |
string JSON input data for the Workflow step. Includes only one of the fields |
HistoryEntryOutput
|
Field |
Description |
|
output_json |
string JSON result for the Workflow step. Includes only one of the fields |
HistoryEntryError
|
Field |
Description |
|
message |
string Error message of the Workflow step. |
|
error_code |
string Error code of the Workflow step. |