zen_api/em/workflow/v1/run_workflow_service.proto#
Version: 2026.5.1
Package: zen_api.em.workflow.v1
Service RunWorkflowService#
The IRunWorkflowService interface.
Break#
Execution of Break command.
rpc Break (zen_api.em.workflow.v1.RunWorkflowServiceBreakRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceBreakResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceBreakRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceBreakResponse
DefineAndRunCompleteWorkflow#
Trigger a run of the complete workflow.
rpc DefineAndRunCompleteWorkflow (zen_api.em.workflow.v1.RunWorkflowServiceDefineAndRunCompleteWorkflowRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceDefineAndRunCompleteWorkflowResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceDefineAndRunCompleteWorkflowRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceDefineAndRunCompleteWorkflowResponse
GetWorkflowById#
Retrieves the workflow by the given id. If workflow is not yet defined an Empty.String will be returned.
rpc GetWorkflowById (zen_api.em.workflow.v1.RunWorkflowServiceGetWorkflowByIdRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceGetWorkflowByIdResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceGetWorkflowByIdRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceGetWorkflowByIdResponse
GetWorkflowState#
Gets Workflow State.
rpc GetWorkflowState (zen_api.em.workflow.v1.RunWorkflowServiceGetWorkflowStateRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceGetWorkflowStateResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceGetWorkflowStateRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceGetWorkflowStateResponse
Next#
Execution of Next command.
rpc Next (zen_api.em.workflow.v1.RunWorkflowServiceNextRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceNextResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceNextRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceNextResponse
Pause#
Trigger pauses the currently running workflow.
rpc Pause (zen_api.em.workflow.v1.RunWorkflowServicePauseRequest) returns (zen_api.em.workflow.v1.RunWorkflowServicePauseResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServicePauseRequest
Response: zen_api.em.workflow.v1.RunWorkflowServicePauseResponse
RegisterOnActionExecutionIdChanged#
Notification about change of the currently executed action id.
rpc RegisterOnActionExecutionIdChanged (zen_api.em.workflow.v1.RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest) returns (stream zen_api.em.workflow.v1.RunWorkflowServiceRegisterOnActionExecutionIdChangedResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceRegisterOnActionExecutionIdChangedResponse
RegisterOnWorkflowStateChanged#
Notification about change of the Workflow state.
rpc RegisterOnWorkflowStateChanged (zen_api.em.workflow.v1.RunWorkflowServiceRegisterOnWorkflowStateChangedRequest) returns (stream zen_api.em.workflow.v1.RunWorkflowServiceRegisterOnWorkflowStateChangedResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceRegisterOnWorkflowStateChangedRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceRegisterOnWorkflowStateChangedResponse
Resume#
Trigger resumes the currently paused workflow.
rpc Resume (zen_api.em.workflow.v1.RunWorkflowServiceResumeRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceResumeResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceResumeRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceResumeResponse
RunWorkflow#
Trigger a run of the specified workflow.
rpc RunWorkflow (zen_api.em.workflow.v1.RunWorkflowServiceRunWorkflowRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceRunWorkflowResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceRunWorkflowRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceRunWorkflowResponse
SetNormalMode#
Execution of set normal / step mode command.
rpc SetNormalMode (zen_api.em.workflow.v1.RunWorkflowServiceSetNormalModeRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceSetNormalModeResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceSetNormalModeRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceSetNormalModeResponse
SetStepMode#
Execution of set normal / step mode command.
rpc SetStepMode (zen_api.em.workflow.v1.RunWorkflowServiceSetStepModeRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceSetStepModeResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceSetStepModeRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceSetStepModeResponse
Start#
Trigger starts the stopped workflow.
rpc Start (zen_api.em.workflow.v1.RunWorkflowServiceStartRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceStartResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceStartRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceStartResponse
Step#
Execution of Step command in step mode.
rpc Step (zen_api.em.workflow.v1.RunWorkflowServiceStepRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceStepResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceStepRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceStepResponse
Stop#
Trigger stops the currently running workflow. The workflow not necessary was started from API.
rpc Stop (zen_api.em.workflow.v1.RunWorkflowServiceStopRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceStopResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceStopRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceStopResponse
StopEmergency#
Trigger stops emergency.
rpc StopEmergency (zen_api.em.workflow.v1.RunWorkflowServiceStopEmergencyRequest) returns (zen_api.em.workflow.v1.RunWorkflowServiceStopEmergencyResponse);
Request: zen_api.em.workflow.v1.RunWorkflowServiceStopEmergencyRequest
Response: zen_api.em.workflow.v1.RunWorkflowServiceStopEmergencyResponse
Message RunWorkflowServiceBreakRequest#
The RunWorkflowServiceBreakRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
break_elements |
1 | string |
singular | List of elements, that shall be skipped. |
Message RunWorkflowServiceBreakResponse#
The RunWorkflowServiceBreakResponse class.
Message RunWorkflowServiceDefineAndRunCompleteWorkflowRequest#
The RunWorkflowServiceDefineAndRunCompleteWorkflowRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
workflow_definition |
1 | string |
singular | Complete and consistent definition of the workflow which should be executed. |
Message RunWorkflowServiceDefineAndRunCompleteWorkflowResponse#
Response object of the RunWorkflow method.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
task_success |
1 | bool |
singular | A value indicating whether the task to run workflow succeeded or not. |
Message RunWorkflowServiceGetWorkflowByIdRequest#
The RunWorkflowServiceGetWorkflowByIdRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
workflow_id |
1 | string |
singular | Identifier of the workflow which should be returned. |
Message RunWorkflowServiceGetWorkflowByIdResponse#
Response object of the GetWorkflow method.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
workflow |
1 | string |
singular | A value with workflow xml. |
Message RunWorkflowServiceGetWorkflowStateRequest#
The RunWorkflowServiceGetWorkflowStateRequest class.
Message RunWorkflowServiceGetWorkflowStateResponse#
Response object of the RunWorkflowApi.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
workflow_state |
1 | zen_api.em.workflow.v1.WorkflowState | singular | A Workflow state value. |
Message RunWorkflowServiceNextRequest#
The RunWorkflowServiceNextRequest class.
Message RunWorkflowServiceNextResponse#
The RunWorkflowServiceNextResponse class.
Message RunWorkflowServicePauseRequest#
The RunWorkflowServicePauseRequest class.
Message RunWorkflowServicePauseResponse#
The RunWorkflowServicePauseResponse class.
Message RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest#
The RunWorkflowServiceRegisterOnActionExecutionIdChangedRequest class.
Message RunWorkflowServiceRegisterOnActionExecutionIdChangedResponse#
ActionExecutionId response.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
action_id |
1 | string |
singular | The action id which is curently executed. |
Message RunWorkflowServiceRegisterOnWorkflowStateChangedRequest#
The RunWorkflowServiceRegisterOnWorkflowStateChangedRequest class.
Message RunWorkflowServiceRegisterOnWorkflowStateChangedResponse#
Response object of the RunWorkflowApi.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
workflow_state |
1 | zen_api.em.workflow.v1.WorkflowState | singular | A Workflow state value. |
Message RunWorkflowServiceResumeRequest#
The RunWorkflowServiceResumeRequest class.
Message RunWorkflowServiceResumeResponse#
The RunWorkflowServiceResumeResponse class.
Message RunWorkflowServiceRunWorkflowRequest#
The RunWorkflowServiceRunWorkflowRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
workflow_id |
1 | string |
singular | Identifier of the workflow which should be executed. |
Message RunWorkflowServiceRunWorkflowResponse#
Response object of the RunWorkflow method.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
task_success |
1 | bool |
singular | A value indicating whether the task to run workflow succeeded or not. |
Message RunWorkflowServiceSetNormalModeRequest#
The RunWorkflowServiceSetNormalModeRequest class.
Message RunWorkflowServiceSetNormalModeResponse#
The RunWorkflowServiceSetNormalModeResponse class.
Message RunWorkflowServiceSetStepModeRequest#
The RunWorkflowServiceSetStepModeRequest class.
Message RunWorkflowServiceSetStepModeResponse#
The RunWorkflowServiceSetStepModeResponse class.
Message RunWorkflowServiceStartRequest#
The RunWorkflowServiceStartRequest class.
Message RunWorkflowServiceStartResponse#
The RunWorkflowServiceStartResponse class.
Message RunWorkflowServiceStepRequest#
The RunWorkflowServiceStepRequest class.
Message RunWorkflowServiceStepResponse#
The RunWorkflowServiceStepResponse class.
Message RunWorkflowServiceStopEmergencyRequest#
The RunWorkflowServiceStopEmergencyRequest class.
Message RunWorkflowServiceStopEmergencyResponse#
The RunWorkflowServiceStopEmergencyResponse class.
Message RunWorkflowServiceStopRequest#
The RunWorkflowServiceStopRequest class.
Message RunWorkflowServiceStopResponse#
The RunWorkflowServiceStopResponse class.