TaskActionsApi

All URIs are relative to https://localhost:9080/activiti-app/api

Method	HTTP request	Description
assignTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/assign	Assign a task to a user
attachFormUsingPUT	PUT /enterprise/tasks/{taskId}/action/attach-form	Attach a form to a task
claimTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/claim	Claim a task
completeTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/complete	Complete a task
delegateTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/delegate	Delegate a task
involveGroupUsingPOST	POST /enterprise/tasks/{taskId}/groups/{groupId}	Involve a group with a task
involveUserUsingPUT	PUT /enterprise/tasks/{taskId}/action/involve	Involve a user with a task
removeFormUsingDELETE	DELETE /enterprise/tasks/{taskId}/action/remove-form	Remove a form from a task
removeInvolvedUserUsingDELETE	DELETE /enterprise/tasks/{taskId}/groups/{groupId}	Remove an involved group from a task
removeInvolvedUserUsingPUT	PUT /enterprise/tasks/{taskId}/action/remove-involved	Remove an involved user from a task
resolveTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/resolve	Resolve a task
unclaimTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/unclaim	Unclaim a task

assignTaskUsingPUT

TaskRepresentation assignTaskUsingPUT(taskId, userIdentifier)

Assign a task to a user

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
AssigneeIdentifierRepresentation userIdentifier = new AssigneeIdentifierRepresentation(); // AssigneeIdentifierRepresentation | userIdentifier
try {
    TaskRepresentation result = apiInstance.assignTaskUsingPUT(taskId, userIdentifier);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#assignTaskUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId
userIdentifier	AssigneeIdentifierRepresentation	userIdentifier

Return type

TaskRepresentation

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

attachFormUsingPUT

attachFormUsingPUT(taskId, formIdentifier)

Attach a form to a task

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
FormIdentifierRepresentation formIdentifier = new FormIdentifierRepresentation(); // FormIdentifierRepresentation | formIdentifier
try {
    apiInstance.attachFormUsingPUT(taskId, formIdentifier);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#attachFormUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId
formIdentifier	FormIdentifierRepresentation	formIdentifier

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

claimTaskUsingPUT

claimTaskUsingPUT(taskId)

Claim a task

To claim a task (in case the task is assigned to a group)

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
try {
    apiInstance.claimTaskUsingPUT(taskId);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#claimTaskUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

completeTaskUsingPUT

completeTaskUsingPUT(taskId)

Complete a task

Use this endpoint to complete a standalone task or task without a form

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
try {
    apiInstance.completeTaskUsingPUT(taskId);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#completeTaskUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

delegateTaskUsingPUT

delegateTaskUsingPUT(taskId, userIdentifier)

Delegate a task

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
UserIdentifierRepresentation userIdentifier = new UserIdentifierRepresentation(); // UserIdentifierRepresentation | userIdentifier
try {
    apiInstance.delegateTaskUsingPUT(taskId, userIdentifier);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#delegateTaskUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId
userIdentifier	UserIdentifierRepresentation	userIdentifier

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

involveGroupUsingPOST

involveGroupUsingPOST(taskId, groupId)

Involve a group with a task

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
String groupId = "groupId_example"; // String | groupId
try {
    apiInstance.involveGroupUsingPOST(taskId, groupId);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#involveGroupUsingPOST");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId
groupId	String	groupId

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

involveUserUsingPUT

involveUserUsingPUT(taskId, userIdentifier)

Involve a user with a task

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
UserIdentifierRepresentation userIdentifier = new UserIdentifierRepresentation(); // UserIdentifierRepresentation | userIdentifier
try {
    apiInstance.involveUserUsingPUT(taskId, userIdentifier);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#involveUserUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId
userIdentifier	UserIdentifierRepresentation	userIdentifier

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

removeFormUsingDELETE

removeFormUsingDELETE(taskId)

Remove a form from a task

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
try {
    apiInstance.removeFormUsingDELETE(taskId);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#removeFormUsingDELETE");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

removeInvolvedUserUsingDELETE

removeInvolvedUserUsingDELETE(taskId, groupId)

Remove an involved group from a task

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
String groupId = "groupId_example"; // String | groupId
try {
    apiInstance.removeInvolvedUserUsingDELETE(taskId, groupId);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#removeInvolvedUserUsingDELETE");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId
groupId	String	groupId

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

removeInvolvedUserUsingPUT

removeInvolvedUserUsingPUT(taskId, userIdentifier)

Remove an involved user from a task

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
UserIdentifierRepresentation userIdentifier = new UserIdentifierRepresentation(); // UserIdentifierRepresentation | userIdentifier
try {
    apiInstance.removeInvolvedUserUsingPUT(taskId, userIdentifier);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#removeInvolvedUserUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId
userIdentifier	UserIdentifierRepresentation	userIdentifier

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

resolveTaskUsingPUT

resolveTaskUsingPUT(taskId)

Resolve a task

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
try {
    apiInstance.resolveTaskUsingPUT(taskId);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#resolveTaskUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

unclaimTaskUsingPUT

unclaimTaskUsingPUT(taskId)

Unclaim a task

To unclaim a task (in case the task was assigned to a group)

Example

// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.TaskActionsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

TaskActionsApi apiInstance = new TaskActionsApi();
String taskId = "taskId_example"; // String | taskId
try {
    apiInstance.unclaimTaskUsingPUT(taskId);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskActionsApi#unclaimTaskUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
taskId	String	taskId

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

TaskActionsApi.md

Latest commit

History

TaskActionsApi.md

File metadata and controls

TaskActionsApi

assignTaskUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers

attachFormUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers

claimTaskUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers

completeTaskUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers

delegateTaskUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers

involveGroupUsingPOST

Example

Parameters

Return type

Authorization

HTTP request headers

involveUserUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers

removeFormUsingDELETE

Example

Parameters

Return type

Authorization

HTTP request headers

removeInvolvedUserUsingDELETE

Example

Parameters

Return type

Authorization

HTTP request headers

removeInvolvedUserUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers

resolveTaskUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers

unclaimTaskUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers