zen_api/workflows/v3beta/workflow_service.proto#
Version: 2026.5.1
Package: zen_api.workflows.v3beta
Service WorkflowService#
The IWorkflowService interface.
GetAvailableJobTemplates#
Retrieves a list of all available job templates.
rpc GetAvailableJobTemplates (zen_api.workflows.v3beta.WorkflowServiceGetAvailableJobTemplatesRequest) returns (zen_api.workflows.v3beta.WorkflowServiceGetAvailableJobTemplatesResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceGetAvailableJobTemplatesRequest
Response: zen_api.workflows.v3beta.WorkflowServiceGetAvailableJobTemplatesResponse
GetStatus#
Gets the job status.
rpc GetStatus (zen_api.workflows.v3beta.WorkflowServiceGetStatusRequest) returns (zen_api.workflows.v3beta.WorkflowServiceGetStatusResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceGetStatusRequest
Response: zen_api.workflows.v3beta.WorkflowServiceGetStatusResponse
IsJobRunning#
Checks if the loaded job is currently running.
rpc IsJobRunning (zen_api.workflows.v3beta.WorkflowServiceIsJobRunningRequest) returns (zen_api.workflows.v3beta.WorkflowServiceIsJobRunningResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceIsJobRunningRequest
Response: zen_api.workflows.v3beta.WorkflowServiceIsJobRunningResponse
IsJobTemplateLoaded#
Checks if a job template is loaded.
rpc IsJobTemplateLoaded (zen_api.workflows.v3beta.WorkflowServiceIsJobTemplateLoadedRequest) returns (zen_api.workflows.v3beta.WorkflowServiceIsJobTemplateLoadedResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceIsJobTemplateLoadedRequest
Response: zen_api.workflows.v3beta.WorkflowServiceIsJobTemplateLoadedResponse
LoadJobTemplate#
Loads a job template and prepares it for execution.
rpc LoadJobTemplate (zen_api.workflows.v3beta.WorkflowServiceLoadJobTemplateRequest) returns (zen_api.workflows.v3beta.WorkflowServiceLoadJobTemplateResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceLoadJobTemplateRequest
Response: zen_api.workflows.v3beta.WorkflowServiceLoadJobTemplateResponse
RegisterOnStatusChanged#
Register on job status changed events.
rpc RegisterOnStatusChanged (zen_api.workflows.v3beta.WorkflowServiceRegisterOnStatusChangedRequest) returns (stream zen_api.workflows.v3beta.WorkflowServiceRegisterOnStatusChangedResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceRegisterOnStatusChangedRequest
Response: zen_api.workflows.v3beta.WorkflowServiceRegisterOnStatusChangedResponse
RunJob#
Runs the loaded job template to completion.
rpc RunJob (zen_api.workflows.v3beta.WorkflowServiceRunJobRequest) returns (zen_api.workflows.v3beta.WorkflowServiceRunJobResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceRunJobRequest
Response: zen_api.workflows.v3beta.WorkflowServiceRunJobResponse
StartJob#
Starts the loaded job template but it doesn't wait for it to complete.
rpc StartJob (zen_api.workflows.v3beta.WorkflowServiceStartJobRequest) returns (zen_api.workflows.v3beta.WorkflowServiceStartJobResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceStartJobRequest
Response: zen_api.workflows.v3beta.WorkflowServiceStartJobResponse
StopJob#
Stops the currently running job and waits for it to complete.
rpc StopJob (zen_api.workflows.v3beta.WorkflowServiceStopJobRequest) returns (zen_api.workflows.v3beta.WorkflowServiceStopJobResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceStopJobRequest
Response: zen_api.workflows.v3beta.WorkflowServiceStopJobResponse
UnloadJobTemplate#
Unloads the loaded job template.
rpc UnloadJobTemplate (zen_api.workflows.v3beta.WorkflowServiceUnloadJobTemplateRequest) returns (zen_api.workflows.v3beta.WorkflowServiceUnloadJobTemplateResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceUnloadJobTemplateRequest
Response: zen_api.workflows.v3beta.WorkflowServiceUnloadJobTemplateResponse
WaitJob#
Waits for currently running job to complete.
rpc WaitJob (zen_api.workflows.v3beta.WorkflowServiceWaitJobRequest) returns (zen_api.workflows.v3beta.WorkflowServiceWaitJobResponse);
Request: zen_api.workflows.v3beta.WorkflowServiceWaitJobRequest
Response: zen_api.workflows.v3beta.WorkflowServiceWaitJobResponse
Message WorkflowServiceGetAvailableJobTemplatesRequest#
The WorkflowServiceGetAvailableJobTemplatesRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
category |
1 | string |
singular | Optional filter for job templates. If category is provided then only job templates that are in the specified category will be listed. |
subcategory |
2 | string |
singular | Optional filter for job templates. If subcategory is provided then only job templates that are in the specified subcategory will be listed. |
Message WorkflowServiceGetAvailableJobTemplatesResponse#
Represents a list of all available job templates.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
job_templates |
1 | zen_api.workflows.v3beta.JobTemplateInfo | repeated | The available job templates. |
Message WorkflowServiceGetStatusRequest#
The WorkflowServiceGetStatusRequest class.
Message WorkflowServiceGetStatusResponse#
Response containing the job status.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
job_status |
1 | zen_api.workflows.v3beta.JobStatus | singular | The job status. |
Message WorkflowServiceIsJobRunningRequest#
The WorkflowServiceIsJobRunningRequest class.
Message WorkflowServiceIsJobRunningResponse#
Response object representing the return value of IsJobRunning() method of the Workflow service.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
is_job_running |
1 | bool |
singular | A value indicating whether the loaded job is currently running. |
Message WorkflowServiceIsJobTemplateLoadedRequest#
The WorkflowServiceIsJobTemplateLoadedRequest class.
Message WorkflowServiceIsJobTemplateLoadedResponse#
Response object representing the return value of IsJobTemplateLoaded() method of the Workflow service.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
is_job_template_loaded |
1 | bool |
singular | A value indicating whether a job template is loaded. |
Message WorkflowServiceLoadJobTemplateRequest#
The WorkflowServiceLoadJobTemplateRequest class.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
job_template_name |
1 | string |
singular | The name of the job template. |
result_path |
2 | string |
singular | Optional parameter for storing the result outside of ZEN archive. If provided the job result will be stored in the selected location and will not be uploaded to the archive. |
Message WorkflowServiceLoadJobTemplateResponse#
The WorkflowServiceLoadJobTemplateResponse class.
Message WorkflowServiceRegisterOnStatusChangedRequest#
The WorkflowServiceRegisterOnStatusChangedRequest class.
Message WorkflowServiceRegisterOnStatusChangedResponse#
Response containing the job status.
| Field | Number | Type | Presence | Description |
|---|---|---|---|---|
job_status |
1 | zen_api.workflows.v3beta.JobStatus | singular | The job status. |
Message WorkflowServiceRunJobRequest#
The WorkflowServiceRunJobRequest class.
Message WorkflowServiceRunJobResponse#
Response object representing the return value of RunJob() method of the Workflow service.
Message WorkflowServiceStartJobRequest#
The WorkflowServiceStartJobRequest class.
Message WorkflowServiceStartJobResponse#
The WorkflowServiceStartJobResponse class.
Message WorkflowServiceStopJobRequest#
The WorkflowServiceStopJobRequest class.
Message WorkflowServiceStopJobResponse#
Response object representing the return value of StopJob() method of the Workflow service.
Message WorkflowServiceUnloadJobTemplateRequest#
The WorkflowServiceUnloadJobTemplateRequest class.
Message WorkflowServiceUnloadJobTemplateResponse#
The WorkflowServiceUnloadJobTemplateResponse class.
Message WorkflowServiceWaitJobRequest#
The WorkflowServiceWaitJobRequest class.
Message WorkflowServiceWaitJobResponse#
Response object representing the return value of WaitJob() method of the Workflow service.