Skip to content

Latest commit

 

History

History
226 lines (166 loc) · 7.55 KB

SubmittedFormsApi.md

File metadata and controls

226 lines (166 loc) · 7.55 KB

SubmittedFormsApi

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

Method HTTP request Description
getFormSubmittedFromsUsingGET GET /enterprise/form-submitted-forms/{formId} List submissions for a form
getProcessSubmittedFromsUsingGET GET /enterprise/process-submitted-forms/{processId} List submissions for a process instance
getSubmittedFromUsingGET GET /enterprise/submitted-forms/{submittedFormId} Get a form submission
getTaskSubmittedFromsUsingGET GET /enterprise/task-submitted-form/{taskId} Get the submitted form for a task

getFormSubmittedFromsUsingGET

ResultListDataRepresentationSubmittedFormRepresentation getFormSubmittedFromsUsingGET(formId, submittedBy, start, size)

List submissions for 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.SubmittedFormsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

SubmittedFormsApi apiInstance = new SubmittedFormsApi();
Long formId = 789L; // Long | formId
Long submittedBy = 789L; // Long | submittedBy
Integer start = 56; // Integer | start
Integer size = 56; // Integer | size
try {
    ResultListDataRepresentationSubmittedFormRepresentation result = apiInstance.getFormSubmittedFromsUsingGET(formId, submittedBy, start, size);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubmittedFormsApi#getFormSubmittedFromsUsingGET");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
formId Long formId
submittedBy Long submittedBy [optional]
start Integer start [optional]
size Integer size [optional]

Return type

ResultListDataRepresentationSubmittedFormRepresentation

Authorization

basicAuth

HTTP request headers

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

getProcessSubmittedFromsUsingGET

ResultListDataRepresentationSubmittedFormRepresentation getProcessSubmittedFromsUsingGET(processId)

List submissions for a process instance

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

SubmittedFormsApi apiInstance = new SubmittedFormsApi();
String processId = "processId_example"; // String | processId
try {
    ResultListDataRepresentationSubmittedFormRepresentation result = apiInstance.getProcessSubmittedFromsUsingGET(processId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubmittedFormsApi#getProcessSubmittedFromsUsingGET");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
processId String processId

Return type

ResultListDataRepresentationSubmittedFormRepresentation

Authorization

basicAuth

HTTP request headers

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

getSubmittedFromUsingGET

SubmittedFormRepresentation getSubmittedFromUsingGET(submittedFormId)

Get a form submission

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

SubmittedFormsApi apiInstance = new SubmittedFormsApi();
Long submittedFormId = 789L; // Long | submittedFormId
try {
    SubmittedFormRepresentation result = apiInstance.getSubmittedFromUsingGET(submittedFormId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubmittedFormsApi#getSubmittedFromUsingGET");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
submittedFormId Long submittedFormId

Return type

SubmittedFormRepresentation

Authorization

basicAuth

HTTP request headers

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

getTaskSubmittedFromsUsingGET

SubmittedFormRepresentation getTaskSubmittedFromsUsingGET(taskId)

Get the submitted form 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.SubmittedFormsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

Parameters

Name Type Description Notes
taskId String taskId

Return type

SubmittedFormRepresentation

Authorization

basicAuth

HTTP request headers

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