Skip to content

Latest commit

 

History

History
337 lines (249 loc) · 12.3 KB

ProcessInstanceVariablesApi.md

File metadata and controls

337 lines (249 loc) · 12.3 KB

ProcessInstanceVariablesApi

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

Method HTTP request Description
createOrUpdateProcessInstanceVariablesUsingPUT PUT /enterprise/process-instances/{processInstanceId}/variables Create or update variables
createProcessInstanceVariablesUsingPOST POST /enterprise/process-instances/{processInstanceId}/variables Create variables
deleteProcessInstanceVariableUsingDELETE DELETE /enterprise/process-instances/{processInstanceId}/variables/{variableName} Delete a variable
getProcessInstanceVariableUsingGET GET /enterprise/process-instances/{processInstanceId}/variables/{variableName} Get a variable
getProcessInstanceVariablesUsingGET GET /enterprise/process-instances/{processInstanceId}/variables List variables
updateProcessInstanceVariableUsingPUT PUT /enterprise/process-instances/{processInstanceId}/variables/{variableName} Update a variable

createOrUpdateProcessInstanceVariablesUsingPUT

List<RestVariable> createOrUpdateProcessInstanceVariablesUsingPUT(processInstanceId, restVariables)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ProcessInstanceVariablesApi apiInstance = new ProcessInstanceVariablesApi();
String processInstanceId = "processInstanceId_example"; // String | Process instance ID
List<RestVariable> restVariables = Arrays.asList(new RestVariable()); // List<RestVariable> | restVariables
try {
    List<RestVariable> result = apiInstance.createOrUpdateProcessInstanceVariablesUsingPUT(processInstanceId, restVariables);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessInstanceVariablesApi#createOrUpdateProcessInstanceVariablesUsingPUT");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
processInstanceId String Process instance ID
restVariables List<RestVariable> restVariables

Return type

List<RestVariable>

Authorization

basicAuth

HTTP request headers

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

createProcessInstanceVariablesUsingPOST

List<RestVariable> createProcessInstanceVariablesUsingPOST(processInstanceId, 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.ProcessInstanceVariablesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ProcessInstanceVariablesApi apiInstance = new ProcessInstanceVariablesApi();
String processInstanceId = "processInstanceId_example"; // String | Process instance ID
List<RestVariable> restVariables = Arrays.asList(new RestVariable()); // List<RestVariable> | restVariables
try {
    List<RestVariable> result = apiInstance.createProcessInstanceVariablesUsingPOST(processInstanceId, restVariables);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessInstanceVariablesApi#createProcessInstanceVariablesUsingPOST");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
processInstanceId String Process instance ID
restVariables List<RestVariable> restVariables

Return type

List<RestVariable>

Authorization

basicAuth

HTTP request headers

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

deleteProcessInstanceVariableUsingDELETE

deleteProcessInstanceVariableUsingDELETE(processInstanceId, variableName)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ProcessInstanceVariablesApi apiInstance = new ProcessInstanceVariablesApi();
String processInstanceId = "processInstanceId_example"; // String | processInstanceId
String variableName = "variableName_example"; // String | variableName
try {
    apiInstance.deleteProcessInstanceVariableUsingDELETE(processInstanceId, variableName);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessInstanceVariablesApi#deleteProcessInstanceVariableUsingDELETE");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
processInstanceId String processInstanceId
variableName String variableName

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

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

getProcessInstanceVariableUsingGET

RestVariable getProcessInstanceVariableUsingGET(processInstanceId, variableName)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ProcessInstanceVariablesApi apiInstance = new ProcessInstanceVariablesApi();
String processInstanceId = "processInstanceId_example"; // String | processInstanceId
String variableName = "variableName_example"; // String | variableName
try {
    RestVariable result = apiInstance.getProcessInstanceVariableUsingGET(processInstanceId, variableName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessInstanceVariablesApi#getProcessInstanceVariableUsingGET");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
processInstanceId String processInstanceId
variableName String variableName

Return type

RestVariable

Authorization

basicAuth

HTTP request headers

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

getProcessInstanceVariablesUsingGET

List<RestVariable> getProcessInstanceVariablesUsingGET(processInstanceId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ProcessInstanceVariablesApi apiInstance = new ProcessInstanceVariablesApi();
String processInstanceId = "processInstanceId_example"; // String | Process instance ID
try {
    List<RestVariable> result = apiInstance.getProcessInstanceVariablesUsingGET(processInstanceId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ProcessInstanceVariablesApi#getProcessInstanceVariablesUsingGET");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
processInstanceId String Process instance ID

Return type

List<RestVariable>

Authorization

basicAuth

HTTP request headers

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

updateProcessInstanceVariableUsingPUT

RestVariable updateProcessInstanceVariableUsingPUT(processInstanceId, 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.ProcessInstanceVariablesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

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

Return type

RestVariable

Authorization

basicAuth

HTTP request headers

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