README.md

aps-rest-api-java-client

Process Services Enterprise API

• API version: 1.0
  • Build date: 2018-09-26T11:35:07.343+01:00

Provides access to the complete features provided by Alfresco Process Services powered by Activiti. You can use this API to integrate Alfresco Process Services with external applications.

For more information, please visit http://www.alfresco.com/

Automatically generated by the Swagger Codegen

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.activiti</groupId>
  <artifactId>aps-rest-api-java-client</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.activiti:aps-rest-api-java-client:1.0.0-SNAPSHOT"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/aps-rest-api-java-client-1.0.0-SNAPSHOT.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import org.activiti.engine.remote.client.*;
import org.activiti.engine.remote.client.auth.*;
import org.activiti.engine.remote.client.model.*;
import org.activiti.engine.remote.client.api.AboutApi;

import java.io.File;
import java.util.*;

public class AboutApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: basicAuth
        HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
        basicAuth.setUsername("YOUR USERNAME");
        basicAuth.setPassword("YOUR PASSWORD");

        AboutApi apiInstance = new AboutApi();
        try {
            Map<String, String> result = apiInstance.getAppVersionUsingGET();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AboutApi#getAppVersionUsingGET");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AboutApi	getAppVersionUsingGET	GET /enterprise/app-version	Get server type and version
AccountIntegrationApi	getAccountsUsingGET	GET /enterprise/account/integration	Retrieve external account information
AdminEndpointsApi	createBasicAuthConfigurationUsingPOST	POST /enterprise/admin/basic-auths	Add an endpoint authorization
AdminEndpointsApi	createEndpointConfigurationUsingPOST	POST /enterprise/admin/endpoints	Create an endpoint
AdminEndpointsApi	getBasicAuthConfigurationUsingGET	GET /enterprise/admin/basic-auths/{basicAuthId}	Get an endpoint authorization
AdminEndpointsApi	getBasicAuthConfigurationsUsingGET	GET /enterprise/admin/basic-auths	List endpoint authorizations
AdminEndpointsApi	getEndpointConfigurationUsingGET1	GET /enterprise/admin/endpoints/{endpointConfigurationId}	Get an endpoint
AdminEndpointsApi	getEndpointConfigurationsUsingGET1	GET /enterprise/admin/endpoints	List endpoints
AdminEndpointsApi	removeBasicAuthonfigurationUsingDELETE	DELETE /enterprise/admin/basic-auths/{basicAuthId}	Delete an endpoint authorization
AdminEndpointsApi	removeEndpointConfigurationUsingDELETE	DELETE /enterprise/admin/endpoints/{endpointConfigurationId}	Delete an endpoint
AdminEndpointsApi	updateBasicAuthConfigurationUsingPUT	PUT /enterprise/admin/basic-auths/{basicAuthId}	Update an endpoint authorization
AdminEndpointsApi	updateEndpointConfigurationUsingPUT	PUT /enterprise/admin/endpoints/{endpointConfigurationId}	Update an endpoint
AdminGroupsApi	activateUsingPOST	POST /enterprise/admin/groups/{groupId}/action/activate	Activate a group
AdminGroupsApi	addAllUsersToGroupUsingPOST	POST /enterprise/admin/groups/{groupId}/add-all-users	Add users to a group
AdminGroupsApi	addGroupCapabilitiesUsingPOST	POST /enterprise/admin/groups/{groupId}/capabilities	Add capabilities to a group
AdminGroupsApi	addGroupMemberUsingPOST	POST /enterprise/admin/groups/{groupId}/members/{userId}	Add a user to a group
AdminGroupsApi	addRelatedGroupUsingPOST	POST /enterprise/admin/groups/{groupId}/related-groups/{relatedGroupId}	Get a related group
AdminGroupsApi	createNewGroupUsingPOST	POST /enterprise/admin/groups	Create a group
AdminGroupsApi	deleteGroupCapabilityUsingDELETE	DELETE /enterprise/admin/groups/{groupId}/capabilities/{groupCapabilityId}	Remove a capability from a group
AdminGroupsApi	deleteGroupMemberUsingDELETE	DELETE /enterprise/admin/groups/{groupId}/members/{userId}	Delete a member from a group
AdminGroupsApi	deleteGroupUsingDELETE	DELETE /enterprise/admin/groups/{groupId}	Delete a group
AdminGroupsApi	deleteRelatedGroupUsingDELETE	DELETE /enterprise/admin/groups/{groupId}/related-groups/{relatedGroupId}	Delete a related group
AdminGroupsApi	getCapabilitiesUsingGET	GET /enterprise/admin/groups/{groupId}/potential-capabilities	List group capabilities
AdminGroupsApi	getGroupUsersUsingGET	GET /enterprise/admin/groups/{groupId}/users	Get group members
AdminGroupsApi	getGroupUsingGET	GET /enterprise/admin/groups/{groupId}	Get a group
AdminGroupsApi	getGroupsUsingGET1	GET /enterprise/admin/groups	Query groups
AdminGroupsApi	getRelatedGroupsUsingGET	GET /enterprise/admin/groups/{groupId}/related-groups	Get related groups
AdminGroupsApi	updateGroupUsingPUT	PUT /enterprise/admin/groups/{groupId}	Update a group
AdminTenantsApi	createTenantUsingPOST	POST /enterprise/admin/tenants	Create a tenant
AdminTenantsApi	deleteTenantUsingDELETE	DELETE /enterprise/admin/tenants/{tenantId}	Delete a tenant
AdminTenantsApi	getTenantEventsUsingGET	GET /enterprise/admin/tenants/{tenantId}/events	Get tenant events
AdminTenantsApi	getTenantLogoUsingGET	GET /enterprise/admin/tenants/{tenantId}/logo	Get a tenant's logo
AdminTenantsApi	getTenantUsingGET	GET /enterprise/admin/tenants/{tenantId}	Get a tenant
AdminTenantsApi	getTenantsUsingGET	GET /enterprise/admin/tenants	List tenants
AdminTenantsApi	updateUsingPUT	PUT /enterprise/admin/tenants/{tenantId}	Update a tenant
AdminTenantsApi	uploadTenantLogoUsingPOST	POST /enterprise/admin/tenants/{tenantId}/logo	Update a tenant's logo
AdminUsersApi	bulkUpdateUsersUsingPUT	PUT /enterprise/admin/users	Bulk update a list of users
AdminUsersApi	createNewUserUsingPOST	POST /enterprise/admin/users	Create a user
AdminUsersApi	getUserUsingGET	GET /enterprise/admin/users/{userId}	Get a user
AdminUsersApi	getUsersUsingGET	GET /enterprise/admin/users	Query users
AdminUsersApi	updateUserDetailsUsingPUT	PUT /enterprise/admin/users/{userId}	Update a user
AppDefinitionsApi	deleteAppDefinitionUsingDELETE	DELETE /enterprise/app-definitions/{appDefinitionId}	deleteAppDefinition
AppDefinitionsApi	exportAppDefinitionUsingGET	GET /enterprise/app-definitions/{modelId}/export	Export an app definition
AppDefinitionsApi	getAppDefinitionUsingGET	GET /enterprise/app-definitions/{modelId}	Get an app definition
AppDefinitionsApi	importAndPublishAppUsingPOST	POST /enterprise/app-definitions/publish-app	importAndPublishApp
AppDefinitionsApi	importAndPublishAppUsingPOST1	POST /enterprise/app-definitions/{modelId}/publish-app	importAndPublishApp
AppDefinitionsApi	importAppDefinitionUsingPOST	POST /enterprise/app-definitions/import	Import a new app definition
AppDefinitionsApi	importAppDefinitionUsingPOST1	POST /enterprise/app-definitions/{modelId}/import	Update the content of an existing app
AppDefinitionsApi	publishAppDefinitionUsingPOST	POST /enterprise/app-definitions/{modelId}/publish	Publish an app definition
AppDefinitionsApi	updateAppDefinitionUsingPUT	PUT /enterprise/app-definitions/{modelId}	Update an app definition
ChecklistsApi	addSubtaskUsingPOST	POST /enterprise/tasks/{taskId}/checklist	Create a task checklist
ChecklistsApi	getChecklistUsingGET	GET /enterprise/tasks/{taskId}/checklist	Get checklist for a task
ChecklistsApi	orderChecklistUsingPUT	PUT /enterprise/tasks/{taskId}/checklist	Change the order of items on a checklist
CommentsApi	addProcessInstanceCommentUsingPOST	POST /enterprise/process-instances/{processInstanceId}/comments	Add a comment to a process instance
CommentsApi	addTaskCommentUsingPOST	POST /enterprise/tasks/{taskId}/comments	Add a comment to a task
CommentsApi	getProcessInstanceCommentsUsingGET	GET /enterprise/process-instances/{processInstanceId}/comments	Get comments for a process
CommentsApi	getTaskCommentsUsingGET	GET /enterprise/tasks/{taskId}/comments	Get comments for a task
ContentApi	createRelatedContentOnProcessInstanceUsingPOST	POST /enterprise/process-instances/{processInstanceId}/content	Attach existing content to a process instance
ContentApi	createRelatedContentOnProcessInstanceUsingPOST1	POST /enterprise/process-instances/{processInstanceId}/raw-content	Upload content and attach to a process instance
ContentApi	createRelatedContentOnTaskUsingPOST	POST /enterprise/tasks/{taskId}/content	Attach existing content to a task
ContentApi	createRelatedContentOnTaskUsingPOST1	POST /enterprise/tasks/{taskId}/raw-content	Upload content and attach to a task
ContentApi	createTemporaryRawRelatedContentUsingPOST	POST /enterprise/content/raw	Upload content and create a local representation
ContentApi	createTemporaryRelatedContentUsingPOST	POST /enterprise/content	Create a local representation of content from a remote repository
ContentApi	deleteContentUsingDELETE	DELETE /enterprise/content/{contentId}	Remove a local content representation
ContentApi	getContentUsingGET	GET /enterprise/content/{contentId}	Get a local content representation
ContentApi	getRawContentUsingGET	GET /enterprise/content/{contentId}/rendition/{renditionType}	Stream content rendition
ContentApi	getRawContentUsingGET1	GET /enterprise/content/{contentId}/raw	Stream content from a local content representation
ContentApi	getRelatedContentForProcessInstanceUsingGET	GET /enterprise/process-instances/{processInstanceId}/content	List content attached to a process instance
ContentApi	getRelatedContentForTaskUsingGET	GET /enterprise/tasks/{taskId}/content	List content attached to a task
DataSourcesApi	getDataSourcesUsingGET	GET /enterprise/editor/data-sources	Get data sources
DecisionAuditsApi	getAuditTrailUsingGET	GET /enterprise/decisions/audits/{auditTrailId}	Get an audit trail
DecisionAuditsApi	getAuditTrailsUsingGET	GET /enterprise/decisions/audits	Query decision table audit trails
DecisionTablesApi	getDecisionTableEditorJsonUsingGET	GET /enterprise/decisions/decision-tables/{decisionTableId}/editorJson	Get definition for a decision table
DecisionTablesApi	getDecisionTableUsingGET	GET /enterprise/decisions/decision-tables/{decisionTableId}	Get a decision table
DecisionTablesApi	getDecisionTablesUsingGET	GET /enterprise/decisions/decision-tables	Query decision tables
EndpointsApi	getEndpointConfigurationUsingGET	GET /enterprise/editor/endpoints/{endpointConfigurationId}	Get an endpoint configuration
EndpointsApi	getEndpointConfigurationsUsingGET	GET /enterprise/editor/endpoints	List endpoint configurations
FormModelsApi	getFormEditorJsonUsingGET	GET /enterprise/forms/{formId}/editorJson	Get form content
FormModelsApi	getFormHistoryUsingGET	GET /enterprise/editor/form-models/{formId}/history/{formHistoryId}	Get form history
FormModelsApi	getFormUsingGET	GET /enterprise/editor/form-models/{formId}	Get a form model
FormModelsApi	getFormUsingGET1	GET /enterprise/forms/{formId}	Get a form
FormModelsApi	getFormsUsingGET	GET /enterprise/editor/form-models/values	Get forms
FormModelsApi	getFormsUsingGET1	GET /enterprise/editor/form-models	List form models
FormModelsApi	getFormsUsingGET2	GET /enterprise/forms	Query forms
FormModelsApi	saveFormUsingPUT	PUT /enterprise/editor/form-models/{formId}	Update form model content
FormModelsApi	validateModelUsingPUT	PUT /enterprise/editor/form-models/{formId}/validate	Validate form model content
GroupsApi	getGroupsUsingGET	GET /enterprise/groups	Query groups
GroupsApi	getUsersForGroupUsingGET	GET /enterprise/groups/{groupId}/users	List members of a group
IdmSyncApi	getLogFileUsingGET	GET /enterprise/idm-sync-log-entries/{syncLogEntryId}/logfile	Get log file for a sync log entry
IdmSyncApi	getSyncLogEntriesUsingGET	GET /enterprise/idm-sync-log-entries	List sync log entries
IntegrationAlfrescoCloudApi	confirmAuthorisationUsingGET	GET /enterprise/integration/alfresco-cloud/confirm-auth-request	Alfresco Cloud Authorization
IntegrationAlfrescoCloudApi	getAllNetworksUsingGET	GET /enterprise/integration/alfresco-cloud/networks	List Alfresco networks
IntegrationAlfrescoCloudApi	getAllSitesUsingGET	GET /enterprise/integration/alfresco-cloud/networks/{networkId}/sites	List Alfresco sites
IntegrationAlfrescoCloudApi	getContentInFolderPathUsingGET	GET /enterprise/integration/alfresco-cloud/networks/{networkId}/sites/{siteId}/folderpath/{folderPath}/content	List files and folders inside a specific folder identified by path
IntegrationAlfrescoCloudApi	getContentInFolderUsingGET	GET /enterprise/integration/alfresco-cloud/networks/{networkId}/folders/{folderId}/content	List files and folders inside a specific folder
IntegrationAlfrescoCloudApi	getContentInSiteUsingGET	GET /enterprise/integration/alfresco-cloud/networks/{networkId}/sites/{siteId}/content	List files and folders inside a specific site
IntegrationAlfrescoOnpremiseApi	getAllSitesUsingGET1	GET /enterprise/integration/alfresco/{repositoryId}/sites	List Alfresco sites
IntegrationAlfrescoOnpremiseApi	getContentInFolderPathUsingGET1	GET /enterprise/rest/integration/alfresco/{repositoryId}/sites/{siteId}/folderpath/{folderPath}/content	List files and folders inside a specific folder identified by folder path
IntegrationAlfrescoOnpremiseApi	getContentInFolderUsingGET1	GET /enterprise/integration/alfresco/{repositoryId}/folders/{folderId}/content	List files and folders inside a specific folder
IntegrationAlfrescoOnpremiseApi	getContentInSiteUsingGET1	GET /enterprise/integration/alfresco/{repositoryId}/sites/{siteId}/content	List files and folders inside a specific site
IntegrationAlfrescoOnpremiseApi	getRepositoriesUsingGET	GET /enterprise/profile/accounts/alfresco	List Alfresco repositories
IntegrationBoxApi	confirmAuthorisationUsingGET1	GET /enterprise/integration/box/confirm-auth-request	Box Authorization
IntegrationBoxApi	createRepositoryAccountUsingPOST	POST /enterprise/integration/box/{userId}/account	Add Box account
IntegrationBoxApi	deleteRepositoryAccountUsingDELETE	DELETE /enterprise/integration/box/{userId}/account	Delete account information
IntegrationBoxApi	getBoxPluginStatusUsingGET	GET /enterprise/integration/box/status	Get status information
IntegrationBoxApi	getFilesUsingGET	GET /enterprise/integration/box/files	List file and folders
IntegrationBoxApi	getRepositoryAccountUsingGET	GET /enterprise/integration/box/{userId}/account	Get account information
IntegrationBoxApi	updateRepositoryAccountUsingPUT	PUT /enterprise/integration/box/{userId}/account	Update account information
IntegrationDriveApi	confirmAuthorisationUsingGET2	GET /enterprise/integration/google-drive/confirm-auth-request	Drive Authorization
IntegrationDriveApi	getFilesUsingGET1	GET /enterprise/integration/google-drive/files	List files and folders
ModelsApi	createModelUsingPOST	POST /enterprise/models	Create a new model
ModelsApi	deleteModelUsingDELETE	DELETE /enterprise/models/{modelId}	Delete a model
ModelsApi	duplicateModelUsingPOST	POST /enterprise/models/{modelId}/clone	Duplicate an existing model
ModelsApi	getModelJSONUsingGET	GET /enterprise/models/{modelId}/editor/json	Get model content
ModelsApi	getModelThumbnailUsingGET	GET /enterprise/models/{modelId}/thumbnail	Get a model's thumbnail image
ModelsApi	getModelUsingGET	GET /enterprise/models/{modelId}	Get a model
ModelsApi	getModelsToIncludeInAppDefinitionUsingGET	GET /enterprise/models-for-app-definition	List process definition models shared with the current user
ModelsApi	getModelsUsingGET	GET /enterprise/models	List models (process, form, decision rule or app)
ModelsApi	importNewVersionUsingPOST	POST /enterprise/models/{modelId}/newversion	Create a new version of a model
ModelsApi	importProcessModelUsingPOST	POST /enterprise/process-models/import	Import a BPMN 2.0 XML file
ModelsApi	saveModelUsingPOST	POST /enterprise/models/{modelId}/editor/json	Update model content
ModelsApi	updateModelUsingPUT	PUT /enterprise/models/{modelId}	Update a model
ModelsApi	validateModelUsingPOST	POST /enterprise/models/{modelId}/editor/validate	Validate model content
ModelsBpmnApi	getHistoricProcessModelBpmn20XmlUsingGET	GET /enterprise/models/{processModelId}/history/{processModelHistoryId}/bpmn20	Export a historic version of a process definition as BPMN 2.0 XML
ModelsBpmnApi	getProcessModelBpmn20XmlUsingGET	GET /enterprise/models/{processModelId}/bpmn20	Export a process definition as BPMN 2.0 XML
ModelsHistoryApi	getModelHistoryCollectionUsingGET	GET /enterprise/models/{modelId}/history	List a model's historic versions
ModelsHistoryApi	getProcessModelHistoryUsingGET	GET /enterprise/models/{modelId}/history/{modelHistoryId}	Get a historic version of a model
ProcessDefinitionsApi	createIdentityLinkUsingPOST	POST /enterprise/process-definitions/{processDefinitionId}/identitylinks	Add a user or group involvement to a process definition
ProcessDefinitionsApi	deleteIdentityLinkUsingDELETE	DELETE /enterprise/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId}	Remove a user or group involvement from a process definition
ProcessDefinitionsApi	getIdentityLinkTypeUsingGET	GET /enterprise/process-definitions/{processDefinitionId}/identitylinks/{family}/{identityId}	Get a user or group involvement with a process definition
ProcessDefinitionsApi	getIdentityLinksForFamilyUsingGET	GET /enterprise/process-definitions/{processDefinitionId}/identitylinks/{family}	List either the users or groups involved with a process definition
ProcessDefinitionsApi	getIdentityLinksUsingGET	GET /enterprise/process-definitions/{processDefinitionId}/identitylinks	List the users and groups involved with a process definition
ProcessDefinitionsApi	getProcessDefinitionDecisionTablesUsingGET	GET /enterprise/process-definitions/{processDefinitionId}/decision-tables	List the decision tables associated with a process definition
ProcessDefinitionsApi	getProcessDefinitionFormsUsingGET	GET /enterprise/process-definitions/{processDefinitionId}/forms	List the forms associated with a process definition
ProcessDefinitionsApi	getProcessDefinitionStartFormUsingGET	GET /enterprise/process-definitions/{processDefinitionId}/start-form	Retrieve the start form for a process definition
ProcessDefinitionsApi	getProcessDefinitionsUsingGET	GET /enterprise/process-definitions	Retrieve a list of process definitions
ProcessDefinitionsApi	getRestFieldValuesUsingGET	GET /enterprise/process-definitions/{processDefinitionId}/start-form-values/{field}	Retrieve field values (eg. the typeahead field)
ProcessDefinitionsApi	getRestTableFieldValuesUsingGET	GET /enterprise/process-definitions/{processDefinitionId}/start-form-values/{field}/{column}	Retrieve field values (eg. the table field)
ProcessInstanceVariablesApi	createOrUpdateProcessInstanceVariablesUsingPUT	PUT /enterprise/process-instances/{processInstanceId}/variables	Create or update variables
ProcessInstanceVariablesApi	createProcessInstanceVariablesUsingPOST	POST /enterprise/process-instances/{processInstanceId}/variables	Create variables
ProcessInstanceVariablesApi	deleteProcessInstanceVariableUsingDELETE	DELETE /enterprise/process-instances/{processInstanceId}/variables/{variableName}	Delete a variable
ProcessInstanceVariablesApi	getProcessInstanceVariableUsingGET	GET /enterprise/process-instances/{processInstanceId}/variables/{variableName}	Get a variable
ProcessInstanceVariablesApi	getProcessInstanceVariablesUsingGET	GET /enterprise/process-instances/{processInstanceId}/variables	List variables
ProcessInstanceVariablesApi	updateProcessInstanceVariableUsingPUT	PUT /enterprise/process-instances/{processInstanceId}/variables/{variableName}	Update a variable
ProcessInstancesApi	activateProcessInstanceUsingPUT	PUT /enterprise/process-instances/{processInstanceId}/activate	Activate a process instance
ProcessInstancesApi	createIdentityLinkUsingPOST1	POST /enterprise/process-instances/{processInstanceId}/identitylinks	Add a user or group involvement to a process instance
ProcessInstancesApi	deleteIdentityLinkUsingDELETE1	DELETE /enterprise/process-instances/{processInstanceId}/identitylinks/{family}/{identityId}/{type}	Remove a user or group involvement from a process instance
ProcessInstancesApi	deleteProcessInstanceUsingDELETE	DELETE /enterprise/process-instances/{processInstanceId}	Cancel or remove a process instance
ProcessInstancesApi	filterProcessInstancesUsingPOST	POST /enterprise/process-instances/filter	List process instances using a filter
ProcessInstancesApi	getHistoricProcessInstanceDecisionTasksUsingGET	GET /enterprise/process-instances/{processInstanceId}/decision-tasks	Get decision tasks in a process instance
ProcessInstancesApi	getHistoricProcessInstanceVariablesUsingGET	GET /enterprise/process-instances/{processInstanceId}/historic-variables	Get historic variables for a process instance
ProcessInstancesApi	getHistoricProcessInstancesUsingPOST	POST /enterprise/historic-process-instances/query	Query historic process instances
ProcessInstancesApi	getIdentityLinkTypeUsingGET1	GET /enterprise/process-instances/{processInstanceId}/identitylinks/{family}/{identityId}/{type}	Get a user or group involvement with a process instance
ProcessInstancesApi	getIdentityLinksForFamilyUsingGET1	GET /enterprise/process-instances/{processInstanceId}/identitylinks/{family}	List either the users or groups involved with a process instance
ProcessInstancesApi	getIdentityLinksUsingGET1	GET /enterprise/process-instances/{processInstanceId}/identitylinks	List the users and groups involved with a process instance
ProcessInstancesApi	getProcessInstanceContentUsingGET	GET /enterprise/process-instances/{processInstanceId}/field-content	List content attached to process instance fields
ProcessInstancesApi	getProcessInstanceDiagramUsingGET	GET /enterprise/process-instances/{processInstanceId}/diagram	Get the process diagram for the process instance
ProcessInstancesApi	getProcessInstanceStartFormUsingGET	GET /enterprise/process-instances/{processInstanceId}/start-form	Get a process instance start form
ProcessInstancesApi	getProcessInstanceUsingGET	GET /enterprise/process-instances/{processInstanceId}	Get a process instance
ProcessInstancesApi	getProcessInstancesUsingPOST	POST /enterprise/process-instances/query	Query process instances
ProcessInstancesApi	getTaskAuditLogUsingGET	GET /enterprise/process-instances/{processInstanceId}/audit-log	Get the audit log for a process instance
ProcessInstancesApi	startNewProcessInstanceUsingPOST	POST /enterprise/process-instances	Start a process instance
ProcessInstancesApi	suspendProcessInstanceUsingPUT	PUT /enterprise/process-instances/{processInstanceId}/suspend	Suspend a process instance
ProcessScopesApi	getRuntimeProcessScopesUsingPOST	POST /enterprise/process-scopes	List runtime process scopes
RuntimeAppDefinitionsApi	deployAppDefinitionsUsingPOST	POST /enterprise/runtime-app-definitions	Deploy a published app
RuntimeAppDefinitionsApi	getAppDefinitionUsingGET1	GET /enterprise/runtime-app-definitions/{appDefinitionId}	Get a runtime app
RuntimeAppDefinitionsApi	getAppDefinitionsUsingGET	GET /enterprise/runtime-app-definitions	List runtime apps
RuntimeAppDeploymentsApi	deleteAppDeploymentUsingDELETE	DELETE /enterprise/runtime-app-deployments/{appDeploymentId}	Remove an app deployment
RuntimeAppDeploymentsApi	exportAppDefinitionUsingGET1	GET /enterprise/export-app-deployment/{deploymentId}	Export the app archive for a deployment
RuntimeAppDeploymentsApi	getAppDefinitionsUsingGET1	GET /enterprise/runtime-app-deployments	Query app deployments
RuntimeAppDeploymentsApi	getAppDeploymentUsingGET	GET /enterprise/runtime-app-deployments/{appDeploymentId}	Get an app deployment
RuntimeAppDeploymentsApi	getRuntimeAppDeploymentByDeploymentUsingGET	GET /enterprise/runtime-app-deployment	Get an app by deployment ID or DMN deployment ID
ScriptFilesApi	getControllersUsingGET	GET /enterprise/script-files/controllers	getControllers
ScriptFilesApi	getLibrariesUsingGET	GET /enterprise/script-files/libraries	getLibraries
SubmittedFormsApi	getFormSubmittedFromsUsingGET	GET /enterprise/form-submitted-forms/{formId}	List submissions for a form
SubmittedFormsApi	getProcessSubmittedFromsUsingGET	GET /enterprise/process-submitted-forms/{processId}	List submissions for a process instance
SubmittedFormsApi	getSubmittedFromUsingGET	GET /enterprise/submitted-forms/{submittedFormId}	Get a form submission
SubmittedFormsApi	getTaskSubmittedFromsUsingGET	GET /enterprise/task-submitted-form/{taskId}	Get the submitted form for a task
SystemPropertiesApi	getGlobalDateFormatUsingGET	GET /enterprise/system/properties/global-date-format/{tenantId}	Get global date format
SystemPropertiesApi	getPasswordValidationConstraintsUsingGET	GET /enterprise/system/properties/password-validation-constraints/{tenantId}	Get password validation constraints
SystemPropertiesApi	getPropertiesUsingGET	GET /enterprise/system/properties	Retrieve system properties
SystemPropertiesApi	involvedUsersCanEditFormsUsingGET	GET /enterprise/system/properties/involved-users-can-edit-forms/{tenantId}	Get involved users who can edit forms
TaskActionsApi	assignTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/assign	Assign a task to a user
TaskActionsApi	attachFormUsingPUT	PUT /enterprise/tasks/{taskId}/action/attach-form	Attach a form to a task
TaskActionsApi	claimTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/claim	Claim a task
TaskActionsApi	completeTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/complete	Complete a task
TaskActionsApi	delegateTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/delegate	Delegate a task
TaskActionsApi	involveGroupUsingPOST	POST /enterprise/tasks/{taskId}/groups/{groupId}	Involve a group with a task
TaskActionsApi	involveUserUsingPUT	PUT /enterprise/tasks/{taskId}/action/involve	Involve a user with a task
TaskActionsApi	removeFormUsingDELETE	DELETE /enterprise/tasks/{taskId}/action/remove-form	Remove a form from a task
TaskActionsApi	removeInvolvedUserUsingDELETE	DELETE /enterprise/tasks/{taskId}/groups/{groupId}	Remove an involved group from a task
TaskActionsApi	removeInvolvedUserUsingPUT	PUT /enterprise/tasks/{taskId}/action/remove-involved	Remove an involved user from a task
TaskActionsApi	resolveTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/resolve	Resolve a task
TaskActionsApi	unclaimTaskUsingPUT	PUT /enterprise/tasks/{taskId}/action/unclaim	Unclaim a task
TaskFormsApi	completeTaskFormUsingPOST	POST /enterprise/task-forms/{taskId}	Complete a task form
TaskFormsApi	getProcessInstanceVariablesUsingGET1	GET /enterprise/task-forms/{taskId}/variables	Get task variables
TaskFormsApi	getRestFieldValuesUsingGET1	GET /enterprise/task-forms/{taskId}/form-values/{field}/{column}	Retrieve column field values
TaskFormsApi	getRestFieldValuesUsingGET2	GET /enterprise/task-forms/{taskId}/form-values/{field}	Retrieve populated field values
TaskFormsApi	getTaskFormUsingGET	GET /enterprise/task-forms/{taskId}	Get a task form
TaskFormsApi	saveTaskFormUsingPOST	POST /enterprise/task-forms/{taskId}/save-form	Save a task form
TaskVariablesApi	createTaskVariableUsingPOST	POST /enterprise/tasks/{taskId}/variables	Create variables
TaskVariablesApi	deleteAllLocalTaskVariablesUsingDELETE	DELETE /enterprise/tasks/{taskId}/variables	Create or update variables
TaskVariablesApi	deleteVariableUsingDELETE	DELETE /enterprise/tasks/{taskId}/variables/{variableName}	Delete a variable
TaskVariablesApi	getVariableUsingGET	GET /enterprise/tasks/{taskId}/variables/{variableName}	Get a variable
TaskVariablesApi	getVariablesUsingGET	GET /enterprise/tasks/{taskId}/variables	List variables
TaskVariablesApi	updateVariableUsingPUT	PUT /enterprise/tasks/{taskId}/variables/{variableName}	Update a variable
TasksApi	createIdentityLinkUsingPOST2	POST /enterprise/tasks/{taskId}/identitylinks	List the users and groups involved with a task
TasksApi	createNewTaskUsingPOST	POST /enterprise/tasks	Create a standalone task
TasksApi	deleteIdentityLinkUsingDELETE2	DELETE /enterprise/tasks/{taskId}/identitylinks/{family}/{identityId}/{type}	Remove a user or group involvement from a task
TasksApi	deleteTaskUsingDELETE	DELETE /enterprise/tasks/{taskId}	Delete a task
TasksApi	filterTasksUsingPOST	POST /enterprise/tasks/filter	Filter a list of tasks
TasksApi	getIdentityLinkTypeUsingGET2	GET /enterprise/tasks/{taskId}/identitylinks/{family}/{identityId}/{type}	Get a user or group involvement with a task
TasksApi	getIdentityLinksForFamilyUsingGET2	GET /enterprise/tasks/{taskId}/identitylinks/{family}	List either the users or groups involved with a process instance
TasksApi	getIdentityLinksUsingGET2	GET /enterprise/tasks/{taskId}/identitylinks	getIdentityLinks
TasksApi	getTaskAuditLogUsingGET1	GET /enterprise/tasks/{taskId}/audit	Get the audit log for a task
TasksApi	getTaskUsingGET	GET /enterprise/tasks/{taskId}	Get a task
TasksApi	listHistoricTasksUsingPOST	POST /enterprise/historic-tasks/query	Query historic tasks
TasksApi	listTasksUsingPOST	POST /enterprise/tasks/query	List tasks
TasksApi	updateTaskUsingPUT	PUT /enterprise/tasks/{taskId}	Update a task
UserFiltersApi	createUserProcessInstanceFilterUsingPOST	POST /enterprise/filters/processes	Create a process instance filter
UserFiltersApi	createUserTaskFilterUsingPOST	POST /enterprise/filters/tasks	Create a task filter
UserFiltersApi	deleteUserProcessInstanceFilterUsingDELETE	DELETE /enterprise/filters/processes/{userFilterId}	Delete a process instance filter
UserFiltersApi	deleteUserTaskFilterUsingDELETE	DELETE /enterprise/filters/tasks/{userFilterId}	Delete a task filter
UserFiltersApi	getUserProcessInstanceFilterUsingGET	GET /enterprise/filters/processes/{userFilterId}	Get a process instance filter
UserFiltersApi	getUserProcessInstanceFiltersUsingGET	GET /enterprise/filters/processes	List process instance filters
UserFiltersApi	getUserTaskFilterUsingGET	GET /enterprise/filters/tasks/{userFilterId}	Get a task filter
UserFiltersApi	getUserTaskFiltersUsingGET	GET /enterprise/filters/tasks	List task filters
UserFiltersApi	orderUserProcessInstanceFiltersUsingPUT	PUT /enterprise/filters/processes	Re-order the list of user process instance filters
UserFiltersApi	orderUserTaskFiltersUsingPUT	PUT /enterprise/filters/tasks	Re-order the list of user task filters
UserFiltersApi	updateUserProcessInstanceFilterUsingPUT	PUT /enterprise/filters/processes/{userFilterId}	Update a process instance filter
UserFiltersApi	updateUserTaskFilterUsingPUT	PUT /enterprise/filters/tasks/{userFilterId}	Update a task filter
UserProfileApi	changePasswordUsingPOST	POST /enterprise/profile-password	Change user password
UserProfileApi	getProfilePictureUsingGET	GET /enterprise/profile-picture	Retrieve user profile picture
UserProfileApi	getProfileUsingGET	GET /enterprise/profile	Get user profile
UserProfileApi	updateProfile	POST /enterprise/profile	Update user profile
UserProfileApi	uploadProfilePictureUsingPOST	POST /enterprise/profile-picture	Change user profile picture
UsersApi	executeActionUsingPOST	POST /enterprise/users/{userId}	Execute an action for a specific user
UsersApi	getProfilePictureUsingGET1	GET /enterprise/users/{userId}/picture	Stream user profile picture
UsersApi	getUserUsingGET1	GET /enterprise/users/{userId}	Get a user
UsersApi	getUsersUsingGET1	GET /enterprise/users	Query users
UsersApi	requestPasswordResetUsingPOST	POST /enterprise/idm/passwords	Request a password reset
UsersApi	updateUserUsingPUT	PUT /enterprise/users/{userId}	Update a user

Documentation for Models

• AbstractGroupRepresentation
• AbstractUserRepresentation
• AccountRepresentation
• AddGroupCapabilitiesRepresentation
• AlfrescoContentRepresentation
• AlfrescoEndpointRepresentation
• AlfrescoNetworkRepresenation
• AlfrescoSiteRepresenation
• AppDefinition
• AppDefinitionPublishRepresentation
• AppDefinitionRepresentation
• AppDefinitionSaveRepresentation
• AppDefinitionUpdateResultRepresentation
• AppDeploymentRepresentation
• AppModelDefinition
• AssigneeIdentifierRepresentation
• AuditCalculatedValueRepresentation
• AuditDecisionExpressionInfoRepresentation
• AuditDecisionInfoRepresentation
• AuditDecisionRuleInfoRepresentation
• AuditLogEntryRepresentation
• AuditLogFormDataRepresentation
• BoxContent
• BoxUserAccountCredentialsRepresentation
• BulkUserUpdateRepresentation
• ChangePasswordRepresentation
• ChecklistOrderRepresentation
• CommentAuditInfo
• CommentRepresentation
• CompleteFormRepresentation
• ConditionRepresentation
• CreateEndpointBasicAuthRepresentation
• CreateProcessInstanceRepresentation
• CreateTenantRepresentation
• DataSourceConfigRepresentation
• DataSourceRepresentation
• DecisionAuditRepresentation
• DecisionTaskRepresentation
• EndpointBasicAuthRepresentation
• EndpointConfigurationRepresentation
• EndpointRequestHeaderRepresentation
• EntityAttributeScopeRepresentation
• EntityVariableScopeRepresentation
• FieldValueInfo
• FormDefinitionRepresentation
• FormFieldRepresentation
• FormIdentifierRepresentation
• FormJavascriptEventRepresentation
• FormOutcomeRepresentation
• FormRepresentation
• FormSaveRepresentation
• FormScopeRepresentation
• FormTabRepresentation
• FormValueRepresentation
• FormVariableRepresentation
• GlobalDateFormatRepresentation
• GoogleDriveContent
• GroupCapabilityRepresentation
• GroupRepresentation
• HistoricProcessInstanceQueryRepresentation
• HistoricTaskInstanceQueryRepresentation
• IdentityLinkRepresentation
• ImageUploadRepresentation
• JsonNode
• LayoutRepresentation
• LightAppRepresentation
• LightGroupRepresentation
• LightTenantRepresentation
• LightUserRepresentation
• ModelRepresentation
• NamedObject
• ObjectNode
• OptionRepresentation
• PasswordValidationConstraints
• ProcessContentRepresentation
• ProcessDefinitionMetaDataRepresentation
• ProcessDefinitionRepresentation
• ProcessInstanceAuditInfoRepresentation
• ProcessInstanceFilterRepresentation
• ProcessInstanceFilterRequestRepresentation
• ProcessInstanceQueryRepresentation
• ProcessInstanceRepresentation
• ProcessInstanceVariableRepresentation
• ProcessScopeIdentifierRepresentation
• ProcessScopeRepresentation
• ProcessScopesRequestRepresentation
• PublishIdentityInfoRepresentation
• QueryVariable
• RelatedContentRepresentation
• ResetPasswordRepresentation
• RestVariable
• ResultListDataRepresentationAbstractUserRepresentation
• ResultListDataRepresentationAccountRepresentation
• ResultListDataRepresentationAlfrescoContentRepresentation
• ResultListDataRepresentationAlfrescoEndpointRepresentation
• ResultListDataRepresentationAlfrescoNetworkRepresenation
• ResultListDataRepresentationAlfrescoSiteRepresenation
• ResultListDataRepresentationAppDefinitionRepresentation
• ResultListDataRepresentationAppDeploymentRepresentation
• ResultListDataRepresentationBoxContent
• ResultListDataRepresentationCommentRepresentation
• ResultListDataRepresentationDataSourceRepresentation
• ResultListDataRepresentationDecisionAuditRepresentation
• ResultListDataRepresentationDecisionTaskRepresentation
• ResultListDataRepresentationFormRepresentation
• ResultListDataRepresentationGoogleDriveContent
• ResultListDataRepresentationLightGroupRepresentation
• ResultListDataRepresentationLightUserRepresentation
• ResultListDataRepresentationModelRepresentation
• ResultListDataRepresentationProcessContentRepresentation
• ResultListDataRepresentationProcessDefinitionRepresentation
• ResultListDataRepresentationProcessInstanceRepresentation
• ResultListDataRepresentationRelatedContentRepresentation
• ResultListDataRepresentationRuntimeDecisionTableRepresentation
• ResultListDataRepresentationRuntimeFormRepresentation
• ResultListDataRepresentationSubmittedFormRepresentation
• ResultListDataRepresentationTaskRepresentation
• ResultListDataRepresentationUserProcessInstanceFilterRepresentation
• ResultListDataRepresentationUserTaskFilterRepresentation
• RuntimeAppDefinitionSaveRepresentation
• RuntimeDecisionTableRepresentation
• RuntimeFormRepresentation
• SaveFormRepresentation
• SubmittedFormRepresentation
• SyncLogEntryRepresentation
• SystemPropertiesRepresentation
• TaskAuditInfoRepresentation
• TaskFilterRepresentation
• TaskFilterRequestRepresentation
• TaskQueryRepresentation
• TaskRepresentation
• TaskUpdateRepresentation
• TenantEvent
• TenantRepresentation
• UserAccountCredentialsRepresentation
• UserActionRepresentation
• UserFilterOrderRepresentation
• UserIdentifierRepresentation
• UserProcessInstanceFilterRepresentation
• UserRepresentation
• UserTaskFilterRepresentation
• ValidationErrorRepresentation
• VariableMappingRepresentation
• VariableScopeRepresentation

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author