@Path(value="/workflows") public class WorkflowsResource extends Object
Constructor and Description |
---|
WorkflowsResource() |
Modifier and Type | Method and Description |
---|---|
String |
createExecution(String workflowId,
boolean run)
Create a execution by execution JSON
|
String |
createWorkflow(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input)
Create workflow via workflow JSON.
|
Workflow |
createWorkflow(Workflow workflow)
Create a new workflow
|
boolean |
deleteWorkflow(String workflowId)
Delete a workflow by Id
|
List<Execution> |
getExecutions(String workflowId,
int size,
int page,
boolean showdeleted)
Get all executions by workflow id
|
WorkflowStep |
getStep(String workflowId,
String stepId)
Get a workflow step associated with a workflow
|
List<WorkflowStep> |
getSteps(String workflowId)
Get steps associated with a workflow
|
Workflow |
getWorkflow(String workflowId)
Get a workflow by Id
|
List<Workflow> |
getWorkflows(int size,
int page,
String email,
boolean showdeleted)
Get all workflows
|
javax.ws.rs.core.Response |
getWorkflowZip(String workflowId)
Get a workflow by Id
|
Workflow |
updateWorkflow(Workflow workflow)
Update workflow by id
|
@POST @Consumes(value="application/json") @Produces(value="application/json") public Workflow createWorkflow(Workflow workflow)
workflow
- Workflow to create@PUT @Path(value="{workflow-id}") @Consumes(value="application/json") @Produces(value="application/json") public Workflow updateWorkflow(Workflow workflow)
workflow
- Updated workflow@POST @Consumes(value="multipart/form-data") @Produces(value="text/plain") public String createWorkflow(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput input)
workflow
- a workflow created from JSON@GET @Produces(value="application/json") public List<Workflow> getWorkflows(@QueryParam(value="size")@DefaultValue(value="-1") int size, @QueryParam(value="page")@DefaultValue(value="0") int page, @QueryParam(value="email")@DefaultValue(value="") String email, @QueryParam(value="showdeleted")@DefaultValue(value="false") boolean showdeleted)
size
- number of workflows per page (default -1)page
- page number starting 0@GET @Path(value="{workflow-id}") @Produces(value="application/json") public Workflow getWorkflow(@PathParam(value="workflow-id") String workflowId)
workflowId
- workflow Id@DELETE @Path(value="{workflow-id}") @Produces(value="application/json") public boolean deleteWorkflow(@PathParam(value="workflow-id")@DefaultValue(value="") String workflowId) throws Exception
workflowId
- id of workflow to deleteException
@GET @Path(value="{workflow-id}/zip") @Produces(value="application/octet-stream") public javax.ws.rs.core.Response getWorkflowZip(@PathParam(value="workflow-id") String workflowId)
workflowId
- workflow Id@POST @Path(value="{workflow-id}/executions") @Consumes(value="application/json") public String createExecution(@PathParam(value="workflow-id") String workflowId, @QueryParam(value="run")@DefaultValue(value="true") boolean run)
workflowId
- workflow idrun
- after create an execution, whether run it or not@GET @Path(value="{workflow-id}/executions") @Produces(value="application/json") public List<Execution> getExecutions(@PathParam(value="workflow-id") String workflowId, @QueryParam(value="size")@DefaultValue(value="100") int size, @QueryParam(value="page")@DefaultValue(value="0") int page, @QueryParam(value="showdeleted")@DefaultValue(value="false") boolean showdeleted)
workflowId
- workflow idsize
- number of workflows per pagepage
- page number starting 0@GET @Path(value="{workflow-id}/steps") @Produces(value="application/json") public List<WorkflowStep> getSteps(@PathParam(value="workflow-id")@DefaultValue(value="") String workflowId) throws Exception
workflowId
- id of workflow to get steps forException
@GET @Path(value="{workflow-id}/steps/{step-id}") @Produces(value="application/json") public WorkflowStep getStep(@PathParam(value="workflow-id")@DefaultValue(value="") String workflowId, @PathParam(value="step-id")@DefaultValue(value="") String stepId) throws Exception
workflowId
- id of workflow to get step forstepId
- id of the step to getException
Copyright © 2016. All rights reserved.