Package org.alfresco.rest.requests.workflowAPI

Class RestWorkflowAPI

java.lang.Object

org.alfresco.rest.requests.ModelRequest<RestWorkflowAPI>

org.alfresco.rest.requests.workflowAPI.RestWorkflowAPI

public class RestWorkflowAPI
extends ModelRequest<RestWorkflowAPI>

Defines the entire Rest Workflow API {@link https://api-explorer.alfresco.com/api-explorer/} select "Workflow API"

Field Summary

Fields inherited from class org.alfresco.rest.requests.ModelRequest

restWrapper

Constructor Summary

Constructors

Constructor	Description
RestWorkflowAPI(RestWrapper restWrapper)

Method Summary

Modifier and Type	Method	Description
RestProcessModel	addProcess(java.lang.String processDefinitionKey, org.alfresco.utility.model.UserModel assignee, boolean sendEmailNotifications, org.alfresco.dataprep.CMISUtil.Priority priority)	Provides DSL on all REST calls under /processes/{processId}/... API path
RestProcessModel	addProcessWithBody(javax.json.JsonObject postBody)	Provides DSL on all REST calls under /processes/{processId}/... API path
RestProcessDefinitionModelsCollection	getAllProcessDefinitions()	Provides all ProcessDefinitions of current user logged in
RestDeploymentModelsCollection	getDeployments()	Provides all deployments of current user logged in
RestProcessModelsCollection	getProcesses()	Provides get all process /processesof current user logged in
RestTaskModelsCollection	getTasks()	Provides all tasks of the current user
Deployments	usingDeployment(RestDeploymentModel deployment)	Provides DSL on all REST calls under /deployments/{deploymentID} API path
Processes	usingProcess(org.alfresco.utility.model.ProcessModel processModel)	Provides DSL on all REST calls under /process-definition/{processDefinitionID} API path
ProcessDefinitions	usingProcessDefinitions(RestProcessDefinitionModel processDefinition)	Provides DSL on all REST calls under /process-definition/{processDefinitionID} API path
Task	usingTask(org.alfresco.utility.model.TaskModel task)	Provides DSL on all REST calls under /tasks/{taskId}/... API path

Methods inherited from class org.alfresco.rest.requests.ModelRequest

includePath, usingParams

Methods inherited from class java.lang.Object

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

Constructor Detail

RestWorkflowAPI

public RestWorkflowAPI(RestWrapper restWrapper)

Method Detail

addProcess

public RestProcessModel addProcess(java.lang.String processDefinitionKey,
                                   org.alfresco.utility.model.UserModel assignee,
                                   boolean sendEmailNotifications,
                                   org.alfresco.dataprep.CMISUtil.Priority priority)
                            throws java.lang.Exception

Provides DSL on all REST calls under /processes/{processId}/... API path

Returns:

RestProcessModel

Throws:

java.lang.Exception

addProcessWithBody

public RestProcessModel addProcessWithBody(javax.json.JsonObject postBody)
                                    throws java.lang.Exception

Provides DSL on all REST calls under /processes/{processId}/... API path

Returns:

RestProcessModel

Throws:

java.lang.Exception

usingTask

public Task usingTask(org.alfresco.utility.model.TaskModel task)

Provides DSL on all REST calls under /tasks/{taskId}/... API path

Returns:

Task

getProcesses

public RestProcessModelsCollection getProcesses()
                                         throws java.lang.Exception

Provides get all process /processesof current user logged in

Returns:

RestProcessModelsCollection

Throws:

java.lang.Exception

getDeployments

public RestDeploymentModelsCollection getDeployments()
                                              throws java.lang.Exception

Provides all deployments of current user logged in

Returns:

RestDeploymentModelsCollection

Throws:

java.lang.Exception

usingDeployment

public Deployments usingDeployment(RestDeploymentModel deployment)

Provides DSL on all REST calls under /deployments/{deploymentID} API path

Returns:

Deployments

getAllProcessDefinitions

public RestProcessDefinitionModelsCollection getAllProcessDefinitions()
                                                               throws java.lang.Exception

Provides all ProcessDefinitions of current user logged in

Returns:

RestProcessDefinitionModelsCollection

Throws:

java.lang.Exception

usingProcessDefinitions

public ProcessDefinitions usingProcessDefinitions(RestProcessDefinitionModel processDefinition)

Provides DSL on all REST calls under /process-definition/{processDefinitionID} API path

Returns:

ProcessDefinitions

usingProcess

public Processes usingProcess(org.alfresco.utility.model.ProcessModel processModel)
                       throws java.lang.Exception

Provides DSL on all REST calls under /process-definition/{processDefinitionID} API path

Returns:

Processes

Throws:

java.lang.Exception

getTasks

public RestTaskModelsCollection getTasks()
                                  throws java.lang.Exception

Provides all tasks of the current user

Returns:

RestTaskModelsCollection

Throws:

java.lang.Exception