Skip to content

Latest commit

 

History

History
340 lines (252 loc) · 10.8 KB

TaskVariablesApi.md

File metadata and controls

340 lines (252 loc) · 10.8 KB

TaskVariablesApi

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

Method HTTP request Description
createTaskVariableUsingPOST POST /enterprise/tasks/{taskId}/variables Create variables
deleteAllLocalTaskVariablesUsingDELETE DELETE /enterprise/tasks/{taskId}/variables Create or update variables
deleteVariableUsingDELETE DELETE /enterprise/tasks/{taskId}/variables/{variableName} Delete a variable
getVariableUsingGET GET /enterprise/tasks/{taskId}/variables/{variableName} Get a variable
getVariablesUsingGET GET /enterprise/tasks/{taskId}/variables List variables
updateVariableUsingPUT PUT /enterprise/tasks/{taskId}/variables/{variableName} Update a variable

createTaskVariableUsingPOST

List<RestVariable> createTaskVariableUsingPOST(taskId, restVariables)

Create variables

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.TaskVariablesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

TaskVariablesApi apiInstance = new TaskVariablesApi();
String taskId = "taskId_example"; // String | taskId
List<RestVariable> restVariables = Arrays.asList(new RestVariable()); // List<RestVariable> | restVariables
try {
    List<RestVariable> result = apiInstance.createTaskVariableUsingPOST(taskId, restVariables);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskVariablesApi#createTaskVariableUsingPOST");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taskId String taskId
restVariables List<RestVariable> restVariables

Return type

List<RestVariable>

Authorization

basicAuth

HTTP request headers

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

deleteAllLocalTaskVariablesUsingDELETE

deleteAllLocalTaskVariablesUsingDELETE(taskId)

Create or update variables

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.TaskVariablesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

TaskVariablesApi apiInstance = new TaskVariablesApi();
String taskId = "taskId_example"; // String | taskId
try {
    apiInstance.deleteAllLocalTaskVariablesUsingDELETE(taskId);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskVariablesApi#deleteAllLocalTaskVariablesUsingDELETE");
    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

deleteVariableUsingDELETE

deleteVariableUsingDELETE(taskId, variableName, scope)

Delete a variable

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.TaskVariablesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

TaskVariablesApi apiInstance = new TaskVariablesApi();
String taskId = "taskId_example"; // String | taskId
String variableName = "variableName_example"; // String | variableName
String scope = "scope_example"; // String | scope
try {
    apiInstance.deleteVariableUsingDELETE(taskId, variableName, scope);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskVariablesApi#deleteVariableUsingDELETE");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taskId String taskId
variableName String variableName
scope String scope [optional]

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

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

getVariableUsingGET

RestVariable getVariableUsingGET(taskId, variableName, scope)

Get a variable

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.TaskVariablesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

TaskVariablesApi apiInstance = new TaskVariablesApi();
String taskId = "taskId_example"; // String | taskId
String variableName = "variableName_example"; // String | variableName
String scope = "scope_example"; // String | scope
try {
    RestVariable result = apiInstance.getVariableUsingGET(taskId, variableName, scope);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskVariablesApi#getVariableUsingGET");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taskId String taskId
variableName String variableName
scope String scope [optional]

Return type

RestVariable

Authorization

basicAuth

HTTP request headers

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

getVariablesUsingGET

List<RestVariable> getVariablesUsingGET(taskId, scope)

List variables

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.TaskVariablesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

TaskVariablesApi apiInstance = new TaskVariablesApi();
String taskId = "taskId_example"; // String | taskId
String scope = "scope_example"; // String | scope
try {
    List<RestVariable> result = apiInstance.getVariablesUsingGET(taskId, scope);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskVariablesApi#getVariablesUsingGET");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taskId String taskId
scope String scope [optional]

Return type

List<RestVariable>

Authorization

basicAuth

HTTP request headers

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

updateVariableUsingPUT

RestVariable updateVariableUsingPUT(taskId, variableName, restVariable)

Update a variable

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.TaskVariablesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

TaskVariablesApi apiInstance = new TaskVariablesApi();
String taskId = "taskId_example"; // String | taskId
String variableName = "variableName_example"; // String | variableName
RestVariable restVariable = new RestVariable(); // RestVariable | restVariable
try {
    RestVariable result = apiInstance.updateVariableUsingPUT(taskId, variableName, restVariable);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TaskVariablesApi#updateVariableUsingPUT");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taskId String taskId
variableName String variableName
restVariable RestVariable restVariable

Return type

RestVariable

Authorization

basicAuth

HTTP request headers

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