Workflows Service, REST: Execution methods
Set of methods for managing Workflows Executions.
JSON Representation
{
"id": "string",
"workflowId": "string",
"input": {
"inputJson": "string"
},
"result": {
"resultJson": "string"
},
"error": {
"message": "string",
"errorCode": "string"
},
"status": "string",
"startedAt": "string",
"duration": "string"
}
Field | Description |
---|---|
id | string ID of the Workflow execution. Generated at creation time. |
workflowId | string ID of the Workflow. |
input | object Input data for the Workflow execution. |
input. inputJson |
string JSON input data for the Workflow execution. |
result | object Result of the Workflow execution. |
result. resultJson |
string JSON result of the Workflow execution. |
error | object Error details, in case Workflow execution failed. |
error. message |
string Error message of the Workflow execution. |
error. errorCode |
string Error code of the Workflow execution. |
status | string 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 Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
duration | string Duration of the Workflow execution. |
Methods
Method | Description |
---|---|
get | Retrieves specified Workflow execution. |
getHistory | Retrieves detailed history of specified Workflow execution. |
list | Retrieves list of Workflow executions. |
start | Starts new Workflow execution. |
stop | Stops specified Workflow execution. |