Workflows Service, gRPC: ExecutionService.Get
Retrieves specified Workflow execution.
gRPC request
rpc Get (GetExecutionRequest) returns (GetExecutionResponse)
GetExecutionRequest
{
"execution_id": "string"
}
|
Field |
Description |
|
execution_id |
string Required field. ID of the Workflow execution. |
GetExecutionResponse
{
"execution": {
"id": "string",
"workflow_id": "string",
"input": {
// Includes only one of the fields `input_json`, `input_value`
"input_json": "string",
"input_value": {
// Includes only one of the fields `nullValue`, `numberValue`, `stringValue`, `boolValue`, `structValue`, `listValue`
"nullValue": "NullValue",
"numberValue": "double",
"stringValue": "string",
"boolValue": "bool",
"structValue": "google.protobuf.Struct",
"listValue": {
"values": [
"Value"
]
}
// end of the list of possible fields
}
// end of the list of possible fields
},
"result": {
// Includes only one of the fields `result_json`
"result_json": "string"
// end of the list of possible fields
},
"error": {
"message": "string",
"error_code": "string"
},
"status": "Status",
"started_at": "google.protobuf.Timestamp",
"duration": "google.protobuf.Duration"
}
}
|
Field |
Description |
|
execution |
Required field. Workflow execution details. |
Execution
|
Field |
Description |
|
id |
string Required field. ID of the Workflow execution. Generated at creation time. |
|
workflow_id |
string Required field. ID of the Workflow. |
|
input |
Input data for the Workflow execution. |
|
result |
Result of the Workflow execution. |
|
error |
Error details, in case Workflow execution failed. |
|
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. |
ExecutionInput
|
Field |
Description |
|
input_json |
string JSON input data for the Workflow execution. Includes only one of the fields |
|
input_value |
Input value for the Workflow execution. Includes only one of the fields |
Value
|
Field |
Description |
|
nullValue |
enum NullValue Includes only one of the fields |
|
numberValue |
double Includes only one of the fields |
|
stringValue |
string Includes only one of the fields |
|
boolValue |
bool Includes only one of the fields |
|
structValue |
Includes only one of the fields |
|
listValue |
Includes only one of the fields |
ListValue
|
Field |
Description |
|
values[] |
ExecutionResult
|
Field |
Description |
|
result_json |
string JSON result of the Workflow execution. Includes only one of the fields |
ExecutionError
|
Field |
Description |
|
message |
string Error message of the Workflow execution. |
|
error_code |
string Error code of the Workflow execution. |