Workflows Service, REST: Execution.GetHistory
Retrieves detailed history of specified Workflow execution.
HTTP request
GET https://serverless-workflows.api.yandexcloud.kz/workflows/v1/execution/{executionId}/history
Path parameters
|
Field |
Description |
|
executionId |
string Required field. ID of the Workflow execution. |
Response
HTTP Code: 200 - OK
{
"execution": {
"id": "string",
"workflowId": "string",
"status": "string",
"startedAt": "string",
"duration": "string"
},
"entries": [
{
"id": "string",
"title": "string",
"description": "string",
"startedAt": "string",
"duration": "string",
"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": "string",
"type": "string",
"attempts": "string",
"lastError": {
"message": "string",
"errorCode": "string"
}
}
]
}
|
Field |
Description |
|
execution |
Workflow execution details. |
|
entries[] |
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
|
|
startedAt |
string (date-time) Start timestamp for the Workflow execution. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
duration |
string (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 |
string (date-time) Start timestamp for the Workflow step. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
duration |
string (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) Status of the Workflow step.
|
|
type |
string Type of the Workflow step (for example, FunctionCall or HttpCall). |
|
attempts |
string (int64) Number of attempts (including all retries of unsuccessful attempts). Value "1" means there were no retries. |
|
lastError |
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 |
HistoryEntryOutput
|
Field |
Description |
|
outputJson |
string JSON result for the Workflow step. Includes only one of the fields |
HistoryEntryError
|
Field |
Description |
|
message |
string Error message of the Workflow step. |
|
errorCode |
string Error code of the Workflow step. |