tech.powerjob.server.web.controller

类 OpenAPIController

java.lang.Object

tech.powerjob.server.web.controller.OpenAPIController

@RestController
 @RequestMapping(value="/openApi")
public class OpenAPIController
extends Object

开放接口（OpenAPI）控制器，对接 oms-client

从以下版本开始:

2020/4/15

作者:

tjq

构造器概要

构造器

构造器和说明
OpenAPIController()

方法概要

限定符和类型	方法和说明
ResultDTO<Long>	assertAppName(String appName, String password)
ResultDTO<Void>	cancelInstance(Long instanceId, Long appId)
ResultDTO<Long>	copy(Long workflowId, Long appId)
ResultDTO<Long>	copyJob(Long jobId)
ResultDTO<Void>	deleteJob(Long jobId, Long appId)
ResultDTO<Void>	deleteWorkflow(Long workflowId, Long appId)
ResultDTO<Void>	disableJob(Long jobId, Long appId)
ResultDTO<Void>	disableWorkflow(Long workflowId, Long appId)
ResultDTO<Void>	enableJob(Long jobId, Long appId)
ResultDTO<Void>	enableWorkflow(Long workflowId, Long appId)
ResultDTO<SaveJobInfoRequest>	exportJob(Long jobId, Long appId)
ResultDTO<List<JobInfoDTO>>	fetchAllJob(Long appId)
ResultDTO<InstanceInfoDTO>	fetchInstanceInfo(Long instanceId)
ResultDTO<Integer>	fetchInstanceStatus(Long instanceId)
ResultDTO<JobInfoDTO>	fetchJob(Long jobId, Long appId)
ResultDTO<WorkflowInfoVO>	fetchWorkflow(Long workflowId, Long appId)
ResultDTO<WorkflowInstanceInfoDTO>	fetchWorkflowInstanceInfo(Long wfInstanceId, Long appId)
ResultDTO<Void>	markWorkflowNodeAsSuccess(Long wfInstanceId, Long nodeId, Long appId)
ResultDTO<List<InstanceInfoDTO>>	queryInstance(PowerQuery powerQuery)
ResultDTO<List<JobInfoDTO>>	queryJob(JobInfoQuery powerQuery)
ResultDTO<Void>	retryInstance(Long instanceId, Long appId)
ResultDTO<Void>	retryWorkflowInstance(Long wfInstanceId, Long appId)
ResultDTO<Long>	runJob(Long appId, Long jobId, String instanceParams, Long delay)
ResultDTO<Long>	runWorkflow(Long workflowId, Long appId, String initParams, Long delay)
ResultDTO<Long>	saveJob(SaveJobInfoRequest request)
ResultDTO<Long>	saveWorkflow(SaveWorkflowRequest request)
ResultDTO<List<tech.powerjob.server.persistence.remote.model.WorkflowNodeInfoDO>>	saveWorkflowNode(List<SaveWorkflowNodeRequest> request)
ResultDTO<Void>	stopInstance(Long instanceId, Long appId)
ResultDTO<Void>	stopWorkflowInstance(Long wfInstanceId, Long appId)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

OpenAPIController

public OpenAPIController()

方法详细资料

assertAppName

@PostMapping(value="/assert")
public ResultDTO<Long> assertAppName(String appName,
                                                                   @RequestParam(required=false)
                                                                   String password)

saveJob

@PostMapping(value="/saveJob")
public ResultDTO<Long> saveJob(@RequestBody
                                                              SaveJobInfoRequest request)

copyJob

@PostMapping(value="/copyJob")
public ResultDTO<Long> copyJob(Long jobId)

exportJob

@PostMapping(value="/exportJob")
public ResultDTO<SaveJobInfoRequest> exportJob(Long jobId,
                                                                                Long appId)

fetchJob

@PostMapping(value="/fetchJob")
public ResultDTO<JobInfoDTO> fetchJob(Long jobId,
                                                                      Long appId)

fetchAllJob

@PostMapping(value="/fetchAllJob")
public ResultDTO<List<JobInfoDTO>> fetchAllJob(Long appId)

queryJob

@PostMapping(value="/queryJob")
public ResultDTO<List<JobInfoDTO>> queryJob(@RequestBody
                                                                            JobInfoQuery powerQuery)

deleteJob

@PostMapping(value="/deleteJob")
public ResultDTO<Void> deleteJob(Long jobId,
                                                                  Long appId)

disableJob

@PostMapping(value="/disableJob")
public ResultDTO<Void> disableJob(Long jobId,
                                                                    Long appId)

enableJob

@PostMapping(value="/enableJob")
public ResultDTO<Void> enableJob(Long jobId,
                                                                  Long appId)

runJob

@PostMapping(value="/runJob")
public ResultDTO<Long> runJob(Long appId,
                                                            Long jobId,
                                                            @RequestParam(required=false)
                                                            String instanceParams,
                                                            @RequestParam(required=false)
                                                            Long delay)

stopInstance

@PostMapping(value="/stopInstance")
public ResultDTO<Void> stopInstance(Long instanceId,
                                                                        Long appId)

cancelInstance

@PostMapping(value="/cancelInstance")
public ResultDTO<Void> cancelInstance(Long instanceId,
                                                                            Long appId)

retryInstance

@PostMapping(value="/retryInstance")
public ResultDTO<Void> retryInstance(Long instanceId,
                                                                          Long appId)

fetchInstanceStatus

@PostMapping(value="/fetchInstanceStatus")
public ResultDTO<Integer> fetchInstanceStatus(Long instanceId)

fetchInstanceInfo

@PostMapping(value="/fetchInstanceInfo")
public ResultDTO<InstanceInfoDTO> fetchInstanceInfo(Long instanceId)

queryInstance

@PostMapping(value="/queryInstance")
public ResultDTO<List<InstanceInfoDTO>> queryInstance(@RequestBody
                                                                                           PowerQuery powerQuery)

saveWorkflow

@PostMapping(value="/saveWorkflow")
public ResultDTO<Long> saveWorkflow(@RequestBody
                                                                        SaveWorkflowRequest request)

copy

@PostMapping(value="/copyWorkflow")
public ResultDTO<Long> copy(Long workflowId,
                                                                Long appId)

fetchWorkflow

@PostMapping(value="/fetchWorkflow")
public ResultDTO<WorkflowInfoVO> fetchWorkflow(Long workflowId,
                                                                                    Long appId)

deleteWorkflow

@PostMapping(value="/deleteWorkflow")
public ResultDTO<Void> deleteWorkflow(Long workflowId,
                                                                            Long appId)

disableWorkflow

@PostMapping(value="/disableWorkflow")
public ResultDTO<Void> disableWorkflow(Long workflowId,
                                                                              Long appId)

enableWorkflow

@PostMapping(value="/enableWorkflow")
public ResultDTO<Void> enableWorkflow(Long workflowId,
                                                                            Long appId)

runWorkflow

@PostMapping(value="/runWorkflow")
public ResultDTO<Long> runWorkflow(Long workflowId,
                                                                      Long appId,
                                                                      @RequestParam(required=false)
                                                                      String initParams,
                                                                      @RequestParam(required=false)
                                                                      Long delay)

saveWorkflowNode

@PostMapping(value="/addWorkflowNode")
public ResultDTO<List<tech.powerjob.server.persistence.remote.model.WorkflowNodeInfoDO>> saveWorkflowNode(@RequestBody
                                                                                                                                                 List<SaveWorkflowNodeRequest> request)

stopWorkflowInstance

@PostMapping(value="/stopWfInstance")
public ResultDTO<Void> stopWorkflowInstance(Long wfInstanceId,
                                                                                  Long appId)

retryWorkflowInstance

@PostMapping(value="/retryWfInstance")
public ResultDTO<Void> retryWorkflowInstance(Long wfInstanceId,
                                                                                    Long appId)

markWorkflowNodeAsSuccess

@PostMapping(value="/markWorkflowNodeAsSuccess")
public ResultDTO<Void> markWorkflowNodeAsSuccess(Long wfInstanceId,
                                                                                                  Long nodeId,
                                                                                                  Long appId)

fetchWorkflowInstanceInfo

@PostMapping(value="/fetchWfInstanceInfo")
public ResultDTO<WorkflowInstanceInfoDTO> fetchWorkflowInstanceInfo(Long wfInstanceId,
                                                                                                               Long appId)