Skip to content

Latest commit

 

History

History
170 lines (124 loc) · 5.46 KB

ChecklistsApi.md

File metadata and controls

170 lines (124 loc) · 5.46 KB

ChecklistsApi

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

Method HTTP request Description
addSubtaskUsingPOST POST /enterprise/tasks/{taskId}/checklist Create a task checklist
getChecklistUsingGET GET /enterprise/tasks/{taskId}/checklist Get checklist for a task
orderChecklistUsingPUT PUT /enterprise/tasks/{taskId}/checklist Change the order of items on a checklist

addSubtaskUsingPOST

TaskRepresentation addSubtaskUsingPOST(taskId, taskRepresentation)

Create a task checklist

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
taskId String taskId
taskRepresentation TaskRepresentation taskRepresentation

Return type

TaskRepresentation

Authorization

basicAuth

HTTP request headers

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

getChecklistUsingGET

ResultListDataRepresentationTaskRepresentation getChecklistUsingGET(taskId)

Get checklist for 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.ChecklistsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ChecklistsApi apiInstance = new ChecklistsApi();
String taskId = "taskId_example"; // String | taskId
try {
    ResultListDataRepresentationTaskRepresentation result = apiInstance.getChecklistUsingGET(taskId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ChecklistsApi#getChecklistUsingGET");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taskId String taskId

Return type

ResultListDataRepresentationTaskRepresentation

Authorization

basicAuth

HTTP request headers

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

orderChecklistUsingPUT

orderChecklistUsingPUT(taskId, orderRepresentation)

Change the order of items on a checklist

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

ChecklistsApi apiInstance = new ChecklistsApi();
String taskId = "taskId_example"; // String | taskId
ChecklistOrderRepresentation orderRepresentation = new ChecklistOrderRepresentation(); // ChecklistOrderRepresentation | orderRepresentation
try {
    apiInstance.orderChecklistUsingPUT(taskId, orderRepresentation);
} catch (ApiException e) {
    System.err.println("Exception when calling ChecklistsApi#orderChecklistUsingPUT");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
taskId String taskId
orderRepresentation ChecklistOrderRepresentation orderRepresentation

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

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