camunda-rest-api

CamundaRestApi - JavaScript client for camunda-rest-api OpenApi Spec for Camunda Platform REST API. This SDK is automatically generated by the Swagger Codegen project:

• API version: 7.20.0
• Package version: 7.20.0
• Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install camunda-rest-api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install [email protected]:nubitech/camunda-rest-api.git --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var CamundaRestApi = require('camunda-rest-api');
var defaultClient = CamundaRestApi.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new CamundaRestApi.AuthorizationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.availableOperationsAuthorization(callback);

Documentation for API Endpoints

All URIs are relative to http://{host}:{port}/{contextPath}

Class	Method	HTTP request	Description
CamundaRestApi.AuthorizationApi	availableOperationsAuthorization	OPTIONS /authorization	Authorization Resource Options
CamundaRestApi.AuthorizationApi	availableOperationsAuthorizationInstance	OPTIONS /authorization/{id}	Authorization Resource Options
CamundaRestApi.AuthorizationApi	createAuthorization	POST /authorization/create	Create a New Authorization
CamundaRestApi.AuthorizationApi	deleteAuthorization	DELETE /authorization/{id}	Delete Authorization
CamundaRestApi.AuthorizationApi	getAuthorization	GET /authorization/{id}	Get Authorization
CamundaRestApi.AuthorizationApi	getAuthorizationCount	GET /authorization/count	Get Authorization Count
CamundaRestApi.AuthorizationApi	isUserAuthorized	GET /authorization/check	Perform an Authorization Check
CamundaRestApi.AuthorizationApi	queryAuthorizations	GET /authorization	Get Authorizations
CamundaRestApi.AuthorizationApi	updateAuthorization	PUT /authorization/{id}	Update an Authorization
CamundaRestApi.BatchApi	deleteBatch	DELETE /batch/{id}	Delete
CamundaRestApi.BatchApi	getBatch	GET /batch/{id}	Get
CamundaRestApi.BatchApi	getBatchStatistics	GET /batch/statistics	Get Statistics
CamundaRestApi.BatchApi	getBatchStatisticsCount	GET /batch/statistics/count	Get Statistics Count
CamundaRestApi.BatchApi	getBatches	GET /batch	Get List
CamundaRestApi.BatchApi	getBatchesCount	GET /batch/count	Get List Count
CamundaRestApi.BatchApi	updateBatchSuspensionState	PUT /batch/{id}/suspended	Activate/Suspend
CamundaRestApi.ConditionApi	evaluateCondition	POST /condition	Evaluate
CamundaRestApi.DecisionDefinitionApi	evaluateDecisionById	POST /decision-definition/{id}/evaluate	Evaluate By Id
CamundaRestApi.DecisionDefinitionApi	evaluateDecisionByKey	POST /decision-definition/key/{key}/evaluate	Evaluate By Key
CamundaRestApi.DecisionDefinitionApi	evaluateDecisionByKeyAndTenant	POST /decision-definition/key/{key}/tenant-id/{tenant-id}/evaluate	Evaluate By Key And Tenant
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitionById	GET /decision-definition/{id}	Get Decision Definition By Id
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitionByKey	GET /decision-definition/key/{key}	Get Decision Definition By Key
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitionByKeyAndTenantId	GET /decision-definition/key/{key}/tenant-id/{tenant-id}	Get Decision Definition By Key And Tenant Id
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitionDiagram	GET /decision-definition/{id}/diagram	Get Diagram
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitionDiagramByKey	GET /decision-definition/key/{key}/diagram	Get Diagram By Key
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitionDiagramByKeyAndTenant	GET /decision-definition/key/{key}/tenant-id/{tenant-id}/diagram	Get Diagram By Key And Tenant
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitionDmnXmlById	GET /decision-definition/{id}/xml	Get XML By Id
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitionDmnXmlByKey	GET /decision-definition/key/{key}/xml	Get XML By Key
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitionDmnXmlByKeyAndTenant	GET /decision-definition/key/{key}/tenant-id/{tenant-id}/xml	Get XML By Key and Tenant
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitions	GET /decision-definition	Get List
CamundaRestApi.DecisionDefinitionApi	getDecisionDefinitionsCount	GET /decision-definition/count	Get List Count
CamundaRestApi.DecisionDefinitionApi	updateHistoryTimeToLiveByDecisionDefinitionId	PUT /decision-definition/{id}/history-time-to-live	Update History Time to Live
CamundaRestApi.DecisionDefinitionApi	updateHistoryTimeToLiveByDecisionDefinitionKey	PUT /decision-definition/key/{key}/history-time-to-live	Update History Time to Live By Key
CamundaRestApi.DecisionDefinitionApi	updateHistoryTimeToLiveByDecisionDefinitionKeyAndTenant	PUT /decision-definition/key/{key}/tenant-id/{tenant-id}/history-time-to-live	Update History Time to Live By Key And Tenant
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitionById	GET /decision-requirements-definition/{id}	Get Decision Requirements Definition by ID
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitionByKey	GET /decision-requirements-definition/key/{key}	Get Decision Requirements Definition by Key
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitionByKeyAndTenantId	GET /decision-requirements-definition/key/{key}/tenant-id/{tenant-id}	Get Decision Requirements Definition by Key and Tenant ID
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitionDiagramById	GET /decision-requirements-definition/{id}/diagram	Get Decision Requirements Diagram by ID
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitionDiagramByKey	GET /decision-requirements-definition/key/{key}/diagram	Get Decision Requirements Diagram by Key
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitionDiagramByKeyAndTenantId	GET /decision-requirements-definition/key/{key}/tenant-id/{tenant-id}/diagram	Get Decision Requirements Diagram by Key and Tenant ID
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitionDmnXmlById	GET /decision-requirements-definition/{id}/xml	Get DMN XML by ID
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitionDmnXmlByKey	GET /decision-requirements-definition/key/{key}/xml	Get DMN XML by Key
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitionDmnXmlByKeyAndTenantId	GET /decision-requirements-definition/key/{key}/tenant-id/{tenant-id}/xml	Get DMN XML by Key and Tenant ID
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitions	GET /decision-requirements-definition	Get Decision Requirements Definitions
CamundaRestApi.DecisionRequirementsDefinitionApi	getDecisionRequirementsDefinitionsCount	GET /decision-requirements-definition/count	Get Decision Requirements Definition Count
CamundaRestApi.DeploymentApi	createDeployment	POST /deployment/create	Create
CamundaRestApi.DeploymentApi	deleteDeployment	DELETE /deployment/{id}	Delete
CamundaRestApi.DeploymentApi	getDeployment	GET /deployment/{id}	Get
CamundaRestApi.DeploymentApi	getDeploymentResource	GET /deployment/{id}/resources/{resourceId}	Get Resource
CamundaRestApi.DeploymentApi	getDeploymentResourceData	GET /deployment/{id}/resources/{resourceId}/data	Get Resource (Binary)
CamundaRestApi.DeploymentApi	getDeploymentResources	GET /deployment/{id}/resources	Get Resources
CamundaRestApi.DeploymentApi	getDeployments	GET /deployment	Get List
CamundaRestApi.DeploymentApi	getDeploymentsCount	GET /deployment/count	Get List Count
CamundaRestApi.DeploymentApi	getRegisteredDeployments	GET /deployment/registered	Get Registered Deployments
CamundaRestApi.DeploymentApi	redeploy	POST /deployment/{id}/redeploy	Redeploy
CamundaRestApi.EngineApi	getProcessEngineNames	GET /engine	Get List
CamundaRestApi.EventSubscriptionApi	getEventSubscriptions	GET /event-subscription	Get List
CamundaRestApi.EventSubscriptionApi	getEventSubscriptionsCount	GET /event-subscription/count	Get List Count
CamundaRestApi.ExecutionApi	createIncident	POST /execution/{id}/create-incident	Create Incident
CamundaRestApi.ExecutionApi	deleteLocalExecutionVariable	DELETE /execution/{id}/localVariables/{varName}	Delete Local Execution Variable
CamundaRestApi.ExecutionApi	getExecution	GET /execution/{id}	Get Execution
CamundaRestApi.ExecutionApi	getExecutions	GET /execution	Get Executions
CamundaRestApi.ExecutionApi	getExecutionsCount	GET /execution/count	Get Execution Count
CamundaRestApi.ExecutionApi	getLocalExecutionVariable	GET /execution/{id}/localVariables/{varName}	Get Local Execution Variable
CamundaRestApi.ExecutionApi	getLocalExecutionVariableBinary	GET /execution/{id}/localVariables/{varName}/data	Get Local Execution Variable (Binary)
CamundaRestApi.ExecutionApi	getLocalExecutionVariables	GET /execution/{id}/localVariables	Get Local Execution Variables
CamundaRestApi.ExecutionApi	getMessageEventSubscription	GET /execution/{id}/messageSubscriptions/{messageName}	Get Message Event Subscription
CamundaRestApi.ExecutionApi	modifyLocalExecutionVariables	POST /execution/{id}/localVariables	Update/Delete Local Execution Variables
CamundaRestApi.ExecutionApi	putLocalExecutionVariable	PUT /execution/{id}/localVariables/{varName}	Put Local Execution Variable
CamundaRestApi.ExecutionApi	queryExecutions	POST /execution	Get Executions (POST)
CamundaRestApi.ExecutionApi	queryExecutionsCount	POST /execution/count	Get Execution Count (POST)
CamundaRestApi.ExecutionApi	setLocalExecutionVariableBinary	POST /execution/{id}/localVariables/{varName}/data	Post Local Execution Variable (Binary)
CamundaRestApi.ExecutionApi	signalExecution	POST /execution/{id}/signal	Trigger Execution
CamundaRestApi.ExecutionApi	triggerEvent	POST /execution/{id}/messageSubscriptions/{messageName}/trigger	Trigger Message Event Subscription
CamundaRestApi.ExternalTaskApi	completeExternalTaskResource	POST /external-task/{id}/complete	Complete
CamundaRestApi.ExternalTaskApi	extendLock	POST /external-task/{id}/extendLock	Extend Lock
CamundaRestApi.ExternalTaskApi	fetchAndLock	POST /external-task/fetchAndLock	Fetch and Lock
CamundaRestApi.ExternalTaskApi	getExternalTask	GET /external-task/{id}	Get
CamundaRestApi.ExternalTaskApi	getExternalTaskErrorDetails	GET /external-task/{id}/errorDetails	Get Error Details
CamundaRestApi.ExternalTaskApi	getExternalTasks	GET /external-task	Get List
CamundaRestApi.ExternalTaskApi	getExternalTasksCount	GET /external-task/count	Get List Count
CamundaRestApi.ExternalTaskApi	getTopicNames	GET /external-task/topic-names	Get External Task Topic Names
CamundaRestApi.ExternalTaskApi	handleExternalTaskBpmnError	POST /external-task/{id}/bpmnError	Handle BPMN Error
CamundaRestApi.ExternalTaskApi	handleFailure	POST /external-task/{id}/failure	Handle Failure
CamundaRestApi.ExternalTaskApi	lock	POST /external-task/{id}/lock
CamundaRestApi.ExternalTaskApi	queryExternalTasks	POST /external-task	Get List (POST)
CamundaRestApi.ExternalTaskApi	queryExternalTasksCount	POST /external-task/count	Get List Count (POST)
CamundaRestApi.ExternalTaskApi	setExternalTaskResourcePriority	PUT /external-task/{id}/priority	Set Priority
CamundaRestApi.ExternalTaskApi	setExternalTaskResourceRetries	PUT /external-task/{id}/retries	Set Retries
CamundaRestApi.ExternalTaskApi	setExternalTaskRetries	PUT /external-task/retries	Set Retries Sync
CamundaRestApi.ExternalTaskApi	setExternalTaskRetriesAsyncOperation	POST /external-task/retries-async	Set Retries Async
CamundaRestApi.ExternalTaskApi	unlock	POST /external-task/{id}/unlock	Unlock
CamundaRestApi.FilterApi	createFilter	POST /filter/create	Create Filter
CamundaRestApi.FilterApi	deleteFilter	DELETE /filter/{id}	Delete Filter
CamundaRestApi.FilterApi	executeFilterCount	GET /filter/{id}/count	Execute Filter Count
CamundaRestApi.FilterApi	executeFilterList	GET /filter/{id}/list	Execute Filter List
CamundaRestApi.FilterApi	executeFilterSingleResult	GET /filter/{id}/singleResult	Execute Filter Single Result
CamundaRestApi.FilterApi	filterResourceOptions	OPTIONS /filter	Filter Resource Options
CamundaRestApi.FilterApi	filterResourceOptionsSingle	OPTIONS /filter/{id}	Filter Resource Options
CamundaRestApi.FilterApi	getFilterCount	GET /filter/count	Get Filter Count
CamundaRestApi.FilterApi	getFilterList	GET /filter	Get Filters
CamundaRestApi.FilterApi	getSingleFilter	GET /filter/{id}	Get Single Filter
CamundaRestApi.FilterApi	postExecuteFilterCount	POST /filter/{id}/count	Execute Filter Count (POST)
CamundaRestApi.FilterApi	postExecuteFilterList	POST /filter/{id}/list	Execute Filter List (POST)
CamundaRestApi.FilterApi	postExecuteFilterSingleResult	POST /filter/{id}/singleResult	Execute Filter Single Result (POST)
CamundaRestApi.FilterApi	updateFilter	PUT /filter/{id}	Update Filter
CamundaRestApi.GroupApi	availableGroupInstanceOperations	OPTIONS /group/{id}	Group Resource Instance Options
CamundaRestApi.GroupApi	availableGroupMembersOperations	OPTIONS /group/{id}/members	Group Membership Resource Options
CamundaRestApi.GroupApi	availableGroupOperations	OPTIONS /group	Group Resource Options
CamundaRestApi.GroupApi	createGroup	POST /group/create	Create Group
CamundaRestApi.GroupApi	createGroupMember	PUT /group/{id}/members/{userId}	Create Group Member
CamundaRestApi.GroupApi	deleteGroup	DELETE /group/{id}	Delete Group
CamundaRestApi.GroupApi	deleteGroupMember	DELETE /group/{id}/members/{userId}	Delete a Group Member
CamundaRestApi.GroupApi	getGroup	GET /group/{id}	Get Group
CamundaRestApi.GroupApi	getGroupCount	GET /group/count	Get List Count
CamundaRestApi.GroupApi	getQueryGroups	GET /group	Get List
CamundaRestApi.GroupApi	postQueryGroups	POST /group	Get List (POST)
CamundaRestApi.GroupApi	queryGroupCount	POST /group/count	Get List Count (POST)
CamundaRestApi.GroupApi	updateGroup	PUT /group/{id}	Update Group
CamundaRestApi.HistoricActivityInstanceApi	getHistoricActivityInstance	GET /history/activity-instance/{id}	Get
CamundaRestApi.HistoricActivityInstanceApi	getHistoricActivityInstances	GET /history/activity-instance	Get List
CamundaRestApi.HistoricActivityInstanceApi	getHistoricActivityInstancesCount	GET /history/activity-instance/count	Get List Count
CamundaRestApi.HistoricActivityInstanceApi	queryHistoricActivityInstances	POST /history/activity-instance	Get List (POST)
CamundaRestApi.HistoricActivityInstanceApi	queryHistoricActivityInstancesCount	POST /history/activity-instance/count	Get List Count (POST)
CamundaRestApi.HistoricBatchApi	deleteHistoricBatch	DELETE /history/batch/{id}	Delete Historic Batch
CamundaRestApi.HistoricBatchApi	getCleanableHistoricBatchesReport	GET /history/batch/cleanable-batch-report	Get Cleanable Batch Report
CamundaRestApi.HistoricBatchApi	getCleanableHistoricBatchesReportCount	GET /history/batch/cleanable-batch-report/count	Get Cleanable Batch Report Count
CamundaRestApi.HistoricBatchApi	getHistoricBatch	GET /history/batch/{id}	Get Historic Batch
CamundaRestApi.HistoricBatchApi	getHistoricBatches	GET /history/batch	Get Historic Batches
CamundaRestApi.HistoricBatchApi	getHistoricBatchesCount	GET /history/batch/count	Get Historic Batch Count
CamundaRestApi.HistoricBatchApi	setRemovalTimeAsyncHistoricBatch	POST /history/batch/set-removal-time	Set Removal Time Async (POST)
CamundaRestApi.HistoricDecisionDefinitionApi	getCleanableHistoricDecisionInstanceReport	GET /history/decision-definition/cleanable-decision-instance-report	Get Cleanable Decision Instance Report
CamundaRestApi.HistoricDecisionDefinitionApi	getCleanableHistoricDecisionInstanceReportCount	GET /history/decision-definition/cleanable-decision-instance-report/count	Get Cleanable Decision Instance Report Count
CamundaRestApi.HistoricDecisionInstanceApi	deleteAsync	POST /history/decision-instance/delete	Delete Async (POST)
CamundaRestApi.HistoricDecisionInstanceApi	getHistoricDecisionInstance	GET /history/decision-instance/{id}	Get Historic Decision Instance
CamundaRestApi.HistoricDecisionInstanceApi	getHistoricDecisionInstances	GET /history/decision-instance	Get Historic Decision Instances
CamundaRestApi.HistoricDecisionInstanceApi	getHistoricDecisionInstancesCount	GET /history/decision-instance/count	Get Historic Decision Instance Count
CamundaRestApi.HistoricDecisionInstanceApi	setRemovalTimeAsyncHistoricDecisionInstance	POST /history/decision-instance/set-removal-time	Set Removal Time Async (POST)
CamundaRestApi.HistoricDecisionRequirementsDefinitionApi	getDecisionStatistics	GET /history/decision-requirements-definition/{id}/statistics	Get DRD Statistics
CamundaRestApi.HistoricDetailApi	getHistoricDetails	GET /history/detail	Get Historic Details
CamundaRestApi.HistoricDetailApi	getHistoricDetailsCount	GET /history/detail/count	Get Historic Detail Count
CamundaRestApi.HistoricDetailApi	historicDetail	GET /history/detail/{id}	Get Historic Detail
CamundaRestApi.HistoricDetailApi	historicDetailBinary	GET /history/detail/{id}/data	Get Historic Detail (Binary)
CamundaRestApi.HistoricDetailApi	queryHistoricDetails	POST /history/detail	Get Historic Details (POST)
CamundaRestApi.HistoricExternalTaskLogApi	getErrorDetailsHistoricExternalTaskLog	GET /history/external-task-log/{id}/error-details	Get External Task Log Error Details
CamundaRestApi.HistoricExternalTaskLogApi	getHistoricExternalTaskLog	GET /history/external-task-log/{id}	Get External Task Log
CamundaRestApi.HistoricExternalTaskLogApi	getHistoricExternalTaskLogs	GET /history/external-task-log	Get External Task Logs
CamundaRestApi.HistoricExternalTaskLogApi	getHistoricExternalTaskLogsCount	GET /history/external-task-log/count	Get External Task Log Count
CamundaRestApi.HistoricExternalTaskLogApi	queryHistoricExternalTaskLogs	POST /history/external-task-log	Get External Task Logs (POST)
CamundaRestApi.HistoricExternalTaskLogApi	queryHistoricExternalTaskLogsCount	POST /history/external-task-log/count	Get External Task Log Count (POST)
CamundaRestApi.HistoricIdentityLinkLogApi	getHistoricIdentityLinks	GET /history/identity-link-log	Get Identity Link Logs
CamundaRestApi.HistoricIdentityLinkLogApi	getHistoricIdentityLinksCount	GET /history/identity-link-log/count	Get Identity Link Log Count
CamundaRestApi.HistoricIncidentApi	getHistoricIncidents	GET /history/incident	Get Incidents
CamundaRestApi.HistoricIncidentApi	getHistoricIncidentsCount	GET /history/incident/count	Get Incident Count
CamundaRestApi.HistoricJobLogApi	getHistoricJobLog	GET /history/job-log/{id}	Get Job Log
CamundaRestApi.HistoricJobLogApi	getHistoricJobLogs	GET /history/job-log	Get Job Logs
CamundaRestApi.HistoricJobLogApi	getHistoricJobLogsCount	GET /history/job-log/count	Get Job Log Count
CamundaRestApi.HistoricJobLogApi	getStacktraceHistoricJobLog	GET /history/job-log/{id}/stacktrace	Get Job Log Exception Stacktrace
CamundaRestApi.HistoricJobLogApi	queryHistoricJobLogs	POST /history/job-log	Get Job Logs (POST)
CamundaRestApi.HistoricJobLogApi	queryHistoricJobLogsCount	POST /history/job-log/count	Get Job Log Count (POST)
CamundaRestApi.HistoricProcessDefinitionApi	getCleanableHistoricProcessInstanceReport	GET /history/process-definition/cleanable-process-instance-report	Get Cleanable Process Instance Report
CamundaRestApi.HistoricProcessDefinitionApi	getCleanableHistoricProcessInstanceReportCount	GET /history/process-definition/cleanable-process-instance-report/count	Get Cleanable Process Instance Report Count
CamundaRestApi.HistoricProcessDefinitionApi	getHistoricActivityStatistics	GET /history/process-definition/{id}/statistics	Get Historic Activity Statistics
CamundaRestApi.HistoricProcessInstanceApi	deleteHistoricProcessInstance	DELETE /history/process-instance/{id}	Delete
CamundaRestApi.HistoricProcessInstanceApi	deleteHistoricProcessInstancesAsync	POST /history/process-instance/delete	Delete Async (POST)
CamundaRestApi.HistoricProcessInstanceApi	deleteHistoricVariableInstancesOfHistoricProcessInstance	DELETE /history/process-instance/{id}/variable-instances	Delete Variable Instances
CamundaRestApi.HistoricProcessInstanceApi	getHistoricProcessInstance	GET /history/process-instance/{id}	Get
CamundaRestApi.HistoricProcessInstanceApi	getHistoricProcessInstanceDurationReport	GET /history/process-instance/report	Get Duration Report
CamundaRestApi.HistoricProcessInstanceApi	getHistoricProcessInstances	GET /history/process-instance	Get List
CamundaRestApi.HistoricProcessInstanceApi	getHistoricProcessInstancesCount	GET /history/process-instance/count	Get List Count
CamundaRestApi.HistoricProcessInstanceApi	queryHistoricProcessInstances	POST /history/process-instance	Get List (POST)
CamundaRestApi.HistoricProcessInstanceApi	queryHistoricProcessInstancesCount	POST /history/process-instance/count	Get List Count (POST)
CamundaRestApi.HistoricProcessInstanceApi	setRemovalTimeAsync	POST /history/process-instance/set-removal-time	Set Removal Time Async (POST)
CamundaRestApi.HistoricTaskInstanceApi	getHistoricTaskInstanceReport	GET /history/task/report	Get Task Report (Historic)
CamundaRestApi.HistoricTaskInstanceApi	getHistoricTaskInstances	GET /history/task	Get Tasks (Historic)
CamundaRestApi.HistoricTaskInstanceApi	getHistoricTaskInstancesCount	GET /history/task/count	Get Task Count
CamundaRestApi.HistoricTaskInstanceApi	queryHistoricTaskInstances	POST /history/task	Get Tasks (Historic) (POST)
CamundaRestApi.HistoricTaskInstanceApi	queryHistoricTaskInstancesCount	POST /history/task/count	Get Task Count (POST)
CamundaRestApi.HistoricUserOperationLogApi	clearAnnotationUserOperationLog	PUT /history/user-operation/{operationId}/clear-annotation	Clear Annotation of an User Operation Log (Historic)
CamundaRestApi.HistoricUserOperationLogApi	queryUserOperationCount	GET /history/user-operation/count	Get User Operation Log Count
CamundaRestApi.HistoricUserOperationLogApi	queryUserOperationEntries	GET /history/user-operation	Get User Operation Log (Historic)
CamundaRestApi.HistoricUserOperationLogApi	setAnnotationUserOperationLog	PUT /history/user-operation/{operationId}/set-annotation	Set Annotation to an User Operation Log (Historic)
CamundaRestApi.HistoricVariableInstanceApi	deleteHistoricVariableInstance	DELETE /history/variable-instance/{id}	Delete Variable Instance
CamundaRestApi.HistoricVariableInstanceApi	getHistoricVariableInstance	GET /history/variable-instance/{id}	Get Variable Instance
CamundaRestApi.HistoricVariableInstanceApi	getHistoricVariableInstanceBinary	GET /history/variable-instance/{id}/data	Get Variable Instance (Binary)
CamundaRestApi.HistoricVariableInstanceApi	getHistoricVariableInstances	GET /history/variable-instance	Get Variable Instances
CamundaRestApi.HistoricVariableInstanceApi	getHistoricVariableInstancesCount	GET /history/variable-instance/count	Get Variable Instance Count
CamundaRestApi.HistoricVariableInstanceApi	queryHistoricVariableInstances	POST /history/variable-instance	Get Variable Instances (POST)
CamundaRestApi.HistoricVariableInstanceApi	queryHistoricVariableInstancesCount	POST /history/variable-instance/count	Get Variable Instance Count (POST)
CamundaRestApi.HistoryCleanupApi	cleanupAsync	POST /history/cleanup	Clean up history (POST)
CamundaRestApi.HistoryCleanupApi	findCleanupJob	GET /history/cleanup/job	Find clean up history job (GET)
CamundaRestApi.HistoryCleanupApi	findCleanupJobs	GET /history/cleanup/jobs	Find clean up history jobs (GET)
CamundaRestApi.HistoryCleanupApi	getHistoryCleanupConfiguration	GET /history/cleanup/configuration	Get History Cleanup Configuration
CamundaRestApi.IdentityApi	checkPassword	POST /identity/password-policy	Validate Password
CamundaRestApi.IdentityApi	getGroupInfo	GET /identity/groups	Get a User's Groups
CamundaRestApi.IdentityApi	getPasswordPolicy	GET /identity/password-policy	Get Password Policy
CamundaRestApi.IdentityApi	verifyUser	POST /identity/verify	Verify User
CamundaRestApi.IncidentApi	clearIncidentAnnotation	DELETE /incident/{id}/annotation	Clear Incident Annotation
CamundaRestApi.IncidentApi	getIncident	GET /incident/{id}	Get Incident
CamundaRestApi.IncidentApi	getIncidents	GET /incident	Get List
CamundaRestApi.IncidentApi	getIncidentsCount	GET /incident/count	Get List Count
CamundaRestApi.IncidentApi	resolveIncident	DELETE /incident/{id}	Resolve Incident
CamundaRestApi.IncidentApi	setIncidentAnnotation	PUT /incident/{id}/annotation	Set Incident Annotation
CamundaRestApi.JobApi	deleteJob	DELETE /job/{id}	Delete Job
CamundaRestApi.JobApi	executeJob	POST /job/{id}/execute	Execute Job
CamundaRestApi.JobApi	getJob	GET /job/{id}	Get Job
CamundaRestApi.JobApi	getJobs	GET /job	Get Jobs
CamundaRestApi.JobApi	getJobsCount	GET /job/count	Get Job Count
CamundaRestApi.JobApi	getStacktrace	GET /job/{id}/stacktrace	Get Exception Stacktrace
CamundaRestApi.JobApi	queryJobs	POST /job	Get Jobs (POST)
CamundaRestApi.JobApi	queryJobsCount	POST /job/count	Get Job Count (POST)
CamundaRestApi.JobApi	recalculateDuedate	POST /job/{id}/duedate/recalculate	Recalculate Job Due Date
CamundaRestApi.JobApi	setJobDuedate	PUT /job/{id}/duedate	Set Job Due Date
CamundaRestApi.JobApi	setJobPriority	PUT /job/{id}/priority	Set Job Priority
CamundaRestApi.JobApi	setJobRetries	PUT /job/{id}/retries	Set Job Retries
CamundaRestApi.JobApi	setJobRetriesAsyncOperation	POST /job/retries	Set Job Retries Async (POST)
CamundaRestApi.JobApi	updateJobSuspensionState	PUT /job/{id}/suspended	Activate/Suspend Job By Id
CamundaRestApi.JobApi	updateSuspensionStateBy	PUT /job/suspended	Activate/Suspend Jobs
CamundaRestApi.JobDefinitionApi	getJobDefinition	GET /job-definition/{id}	Get Job Definition
CamundaRestApi.JobDefinitionApi	getJobDefinitions	GET /job-definition	Get Job Definitions
CamundaRestApi.JobDefinitionApi	getJobDefinitionsCount	GET /job-definition/count	Get Job Definition Count
CamundaRestApi.JobDefinitionApi	queryJobDefinitions	POST /job-definition	Get Job Definitions (POST)
CamundaRestApi.JobDefinitionApi	queryJobDefinitionsCount	POST /job-definition/count	Get Job Definition Count (POST)
CamundaRestApi.JobDefinitionApi	setJobPriorityJobDefinition	PUT /job-definition/{id}/jobPriority	Set Job Definition Priority by Id
CamundaRestApi.JobDefinitionApi	setJobRetriesJobDefinition	PUT /job-definition/{id}/retries	Set Job Retries By Job Definition Id
CamundaRestApi.JobDefinitionApi	updateSuspensionStateJobDefinition	PUT /job-definition/{id}/suspended	Activate/Suspend Job Definition By Id
CamundaRestApi.JobDefinitionApi	updateSuspensionStateJobDefinitions	PUT /job-definition/suspended	Activate/Suspend Job Definitions
CamundaRestApi.MessageApi	deliverMessage	POST /message	Correlate
CamundaRestApi.MetricsApi	deleteTaskMetrics	DELETE /metrics/task-worker	Delete Task Worker Metrics
CamundaRestApi.MetricsApi	getMetrics	GET /metrics/{metrics-name}/sum	Get Sum
CamundaRestApi.MetricsApi	interval	GET /metrics	Get Metrics in Interval
CamundaRestApi.MigrationApi	executeMigrationPlan	POST /migration/execute	Execute Migration Plan
CamundaRestApi.MigrationApi	executeMigrationPlanAsync	POST /migration/executeAsync	Execute Migration Plan Async (Batch)
CamundaRestApi.MigrationApi	generateMigrationPlan	POST /migration/generate	Generate Migration Plan
CamundaRestApi.MigrationApi	validateMigrationPlan	POST /migration/validate	Validate Migration Plan
CamundaRestApi.ModificationApi	executeModification	POST /modification/execute	Execute Modification
CamundaRestApi.ModificationApi	executeModificationAsync	POST /modification/executeAsync	Execute Modification Async (Batch)
CamundaRestApi.ProcessDefinitionApi	deleteProcessDefinition	DELETE /process-definition/{id}	Delete
CamundaRestApi.ProcessDefinitionApi	deleteProcessDefinitionsByKey	DELETE /process-definition/key/{key}	Delete By Key
CamundaRestApi.ProcessDefinitionApi	deleteProcessDefinitionsByKeyAndTenantId	DELETE /process-definition/key/{key}/tenant-id/{tenant-id}	Delete By Key
CamundaRestApi.ProcessDefinitionApi	getActivityStatistics	GET /process-definition/{id}/statistics	Get Activity Instance Statistics
CamundaRestApi.ProcessDefinitionApi	getActivityStatisticsByProcessDefinitionKey	GET /process-definition/key/{key}/statistics	Get Activity Instance Statistics
CamundaRestApi.ProcessDefinitionApi	getActivityStatisticsByProcessDefinitionKeyAndTenantId	GET /process-definition/key/{key}/tenant-id/{tenant-id}/statistics	Get Activity Instance Statistics
CamundaRestApi.ProcessDefinitionApi	getDeployedStartForm	GET /process-definition/{id}/deployed-start-form	Get Deployed Start Form
CamundaRestApi.ProcessDefinitionApi	getDeployedStartFormByKey	GET /process-definition/key/{key}/deployed-start-form	Get Deployed Start Form
CamundaRestApi.ProcessDefinitionApi	getDeployedStartFormByKeyAndTenantId	GET /process-definition/key/{key}/tenant-id/{tenant-id}/deployed-start-form	Get Deployed Start Form
CamundaRestApi.ProcessDefinitionApi	getLatestProcessDefinitionByTenantId	GET /process-definition/key/{key}/tenant-id/{tenant-id}	Get
CamundaRestApi.ProcessDefinitionApi	getProcessDefinition	GET /process-definition/{id}	Get
CamundaRestApi.ProcessDefinitionApi	getProcessDefinitionBpmn20Xml	GET /process-definition/{id}/xml	Get XML
CamundaRestApi.ProcessDefinitionApi	getProcessDefinitionBpmn20XmlByKey	GET /process-definition/key/{key}/xml	Get XML
CamundaRestApi.ProcessDefinitionApi	getProcessDefinitionBpmn20XmlByKeyAndTenantId	GET /process-definition/key/{key}/tenant-id/{tenant-id}/xml	Get XML
CamundaRestApi.ProcessDefinitionApi	getProcessDefinitionByKey	GET /process-definition/key/{key}	Get
CamundaRestApi.ProcessDefinitionApi	getProcessDefinitionDiagram	GET /process-definition/{id}/diagram	Get Diagram
CamundaRestApi.ProcessDefinitionApi	getProcessDefinitionDiagramByKey	GET /process-definition/key/{key}/diagram	Get Diagram
CamundaRestApi.ProcessDefinitionApi	getProcessDefinitionDiagramByKeyAndTenantId	GET /process-definition/key/{key}/tenant-id/{tenant-id}/diagram	Get Diagram
CamundaRestApi.ProcessDefinitionApi	getProcessDefinitionStatistics	GET /process-definition/statistics	Get Process Instance Statistics
CamundaRestApi.ProcessDefinitionApi	getProcessDefinitions	GET /process-definition	Get List
CamundaRestApi.ProcessDefinitionApi	getProcessDefinitionsCount	GET /process-definition/count	Get List Count
CamundaRestApi.ProcessDefinitionApi	getRenderedStartForm	GET /process-definition/{id}/rendered-form	Get Rendered Start Form
CamundaRestApi.ProcessDefinitionApi	getRenderedStartFormByKey	GET /process-definition/key/{key}/rendered-form	Get Rendered Start Form
CamundaRestApi.ProcessDefinitionApi	getRenderedStartFormByKeyAndTenantId	GET /process-definition/key/{key}/tenant-id/{tenant-id}/rendered-form	Get Rendered Start Form
CamundaRestApi.ProcessDefinitionApi	getStartForm	GET /process-definition/{id}/startForm	Get Start Form Key
CamundaRestApi.ProcessDefinitionApi	getStartFormByKey	GET /process-definition/key/{key}/startForm	Get Start Form Key
CamundaRestApi.ProcessDefinitionApi	getStartFormByKeyAndTenantId	GET /process-definition/key/{key}/tenant-id/{tenant-id}/startForm	Get Start Form Key
CamundaRestApi.ProcessDefinitionApi	getStartFormVariables	GET /process-definition/{id}/form-variables	Get Start Form Variables
CamundaRestApi.ProcessDefinitionApi	getStartFormVariablesByKey	GET /process-definition/key/{key}/form-variables	Get Start Form Variables
CamundaRestApi.ProcessDefinitionApi	getStartFormVariablesByKeyAndTenantId	GET /process-definition/key/{key}/tenant-id/{tenant-id}/form-variables	Get Start Form Variables
CamundaRestApi.ProcessDefinitionApi	getStaticCalledProcessDefinitions	GET /process-definition/{id}/static-called-process-definitions	Get Static Called Process Definitions
CamundaRestApi.ProcessDefinitionApi	restartProcessInstance	POST /process-definition/{id}/restart	Restart Process Instance
CamundaRestApi.ProcessDefinitionApi	restartProcessInstanceAsyncOperation	POST /process-definition/{id}/restart-async	Restart Process Instance Async
CamundaRestApi.ProcessDefinitionApi	startProcessInstance	POST /process-definition/{id}/start	Start Instance
CamundaRestApi.ProcessDefinitionApi	startProcessInstanceByKey	POST /process-definition/key/{key}/start	Start Instance
CamundaRestApi.ProcessDefinitionApi	startProcessInstanceByKeyAndTenantId	POST /process-definition/key/{key}/tenant-id/{tenant-id}/start	Start Instance
CamundaRestApi.ProcessDefinitionApi	submitForm	POST /process-definition/{id}/submit-form	Submit Start Form
CamundaRestApi.ProcessDefinitionApi	submitFormByKey	POST /process-definition/key/{key}/submit-form	Submit Start Form
CamundaRestApi.ProcessDefinitionApi	submitFormByKeyAndTenantId	POST /process-definition/key/{key}/tenant-id/{tenant-id}/submit-form	Submit Start Form
CamundaRestApi.ProcessDefinitionApi	updateHistoryTimeToLiveByProcessDefinitionId	PUT /process-definition/{id}/history-time-to-live	Update History Time to Live
CamundaRestApi.ProcessDefinitionApi	updateHistoryTimeToLiveByProcessDefinitionKey	PUT /process-definition/key/{key}/history-time-to-live	Update History Time to Live
CamundaRestApi.ProcessDefinitionApi	updateHistoryTimeToLiveByProcessDefinitionKeyAndTenantId	PUT /process-definition/key/{key}/tenant-id/{tenant-id}/history-time-to-live	Update History Time to Live
CamundaRestApi.ProcessDefinitionApi	updateProcessDefinitionSuspensionState	PUT /process-definition/suspended	Activate/Suspend By Key
CamundaRestApi.ProcessDefinitionApi	updateProcessDefinitionSuspensionStateById	PUT /process-definition/{id}/suspended	Activate/Suspend By Id
CamundaRestApi.ProcessDefinitionApi	updateProcessDefinitionSuspensionStateByKey	PUT /process-definition/key/{key}/suspended	Activate/Suspend by Id
CamundaRestApi.ProcessDefinitionApi	updateProcessDefinitionSuspensionStateByKeyAndTenantId	PUT /process-definition/key/{key}/tenant-id/{tenant-id}/suspended	Activate/Suspend by Id
CamundaRestApi.ProcessInstanceApi	correlateMessageAsyncOperation	POST /process-instance/message-async	Correlate Message Async (POST)
CamundaRestApi.ProcessInstanceApi	deleteAsyncHistoricQueryBased	POST /process-instance/delete-historic-query-based	Delete Async Historic Query Based (POST)
CamundaRestApi.ProcessInstanceApi	deleteProcessInstance	DELETE /process-instance/{id}	Delete
CamundaRestApi.ProcessInstanceApi	deleteProcessInstanceVariable	DELETE /process-instance/{id}/variables/{varName}	Delete Process Variable
CamundaRestApi.ProcessInstanceApi	deleteProcessInstancesAsyncOperation	POST /process-instance/delete	Delete Async (POST)
CamundaRestApi.ProcessInstanceApi	getActivityInstanceTree	GET /process-instance/{id}/activity-instances	Get Activity Instance
CamundaRestApi.ProcessInstanceApi	getProcessInstance	GET /process-instance/{id}	Get Process Instance
CamundaRestApi.ProcessInstanceApi	getProcessInstanceComments	GET /process-instance/{id}/comment	Get Process Instance Comments
CamundaRestApi.ProcessInstanceApi	getProcessInstanceVariable	GET /process-instance/{id}/variables/{varName}	Get Process Variable
CamundaRestApi.ProcessInstanceApi	getProcessInstanceVariableBinary	GET /process-instance/{id}/variables/{varName}/data	Get Process Variable (Binary)
CamundaRestApi.ProcessInstanceApi	getProcessInstanceVariables	GET /process-instance/{id}/variables	Get Process Variables
CamundaRestApi.ProcessInstanceApi	getProcessInstances	GET /process-instance	Get List
CamundaRestApi.ProcessInstanceApi	getProcessInstancesCount	GET /process-instance/count	Get List Count
CamundaRestApi.ProcessInstanceApi	modifyProcessInstance	POST /process-instance/{id}/modification	Modify Process Instance Execution State
CamundaRestApi.ProcessInstanceApi	modifyProcessInstanceAsyncOperation	POST /process-instance/{id}/modification-async	Modify Process Instance Execution State Async
CamundaRestApi.ProcessInstanceApi	modifyProcessInstanceVariables	POST /process-instance/{id}/variables	Update/Delete Process Variables
CamundaRestApi.ProcessInstanceApi	queryProcessInstances	POST /process-instance	Get List (POST)
CamundaRestApi.ProcessInstanceApi	queryProcessInstancesCount	POST /process-instance/count	Get List Count (POST)
CamundaRestApi.ProcessInstanceApi	setProcessInstanceVariable	PUT /process-instance/{id}/variables/{varName}	Update Process Variable
CamundaRestApi.ProcessInstanceApi	setProcessInstanceVariableBinary	POST /process-instance/{id}/variables/{varName}/data	Update Process Variable (Binary)
CamundaRestApi.ProcessInstanceApi	setRetriesByProcess	POST /process-instance/job-retries	Set Job Retries Async (POST)
CamundaRestApi.ProcessInstanceApi	setRetriesByProcessHistoricQueryBased	POST /process-instance/job-retries-historic-query-based	Set Job Retries Async Historic Query Based (POST)
CamundaRestApi.ProcessInstanceApi	setVariablesAsyncOperation	POST /process-instance/variables-async	Set Variables Async (POST)
CamundaRestApi.ProcessInstanceApi	updateSuspensionState	PUT /process-instance/suspended	Activate/Suspend In Group
CamundaRestApi.ProcessInstanceApi	updateSuspensionStateAsyncOperation	POST /process-instance/suspended-async	Activate/Suspend In Batch
CamundaRestApi.ProcessInstanceApi	updateSuspensionStateById	PUT /process-instance/{id}/suspended	Activate/Suspend Process Instance By Id
CamundaRestApi.SchemaLogApi	getSchemaLog	GET /schema/log	Get List
CamundaRestApi.SchemaLogApi	querySchemaLog	POST /schema/log	Get List (POST)
CamundaRestApi.SignalApi	throwSignal	POST /signal	Event
CamundaRestApi.TaskApi	claim	POST /task/{id}/claim	Claim
CamundaRestApi.TaskApi	complete	POST /task/{id}/complete	Complete
CamundaRestApi.TaskApi	createTask	POST /task/create	Create
CamundaRestApi.TaskApi	delegateTask	POST /task/{id}/delegate	Delegate
CamundaRestApi.TaskApi	deleteTask	DELETE /task/{id}	Delete
CamundaRestApi.TaskApi	getDeployedForm	GET /task/{id}/deployed-form	Get Deployed Form
CamundaRestApi.TaskApi	getForm	GET /task/{id}/form	Get Form Key
CamundaRestApi.TaskApi	getFormVariables	GET /task/{id}/form-variables	Get Task Form Variables
CamundaRestApi.TaskApi	getRenderedForm	GET /task/{id}/rendered-form	Get Rendered Form
CamundaRestApi.TaskApi	getTask	GET /task/{id}	Get
CamundaRestApi.TaskApi	getTaskCountByCandidateGroup	GET /task/report/candidate-group-count	Get Task Count By Candidate Group
CamundaRestApi.TaskApi	getTasks	GET /task	Get List
CamundaRestApi.TaskApi	getTasksCount	GET /task/count	Get List Count
CamundaRestApi.TaskApi	handleBpmnError	POST /task/{id}/bpmnError	Handle BPMN Error
CamundaRestApi.TaskApi	handleEscalation	POST /task/{id}/bpmnEscalation	Handle BPMN Escalation
CamundaRestApi.TaskApi	queryTasks	POST /task	Get List (POST)
CamundaRestApi.TaskApi	queryTasksCount	POST /task/count	Get List Count (POST)
CamundaRestApi.TaskApi	resolve	POST /task/{id}/resolve	Resolve
CamundaRestApi.TaskApi	setAssignee	POST /task/{id}/assignee	Set Assignee
CamundaRestApi.TaskApi	submit	POST /task/{id}/submit-form	Submit Form
CamundaRestApi.TaskApi	unclaim	POST /task/{id}/unclaim	Unclaim
CamundaRestApi.TaskApi	updateTask	PUT /task/{id}	Update
CamundaRestApi.TaskAttachmentApi	addAttachment	POST /task/{id}/attachment/create	Create
CamundaRestApi.TaskAttachmentApi	deleteAttachment	DELETE /task/{id}/attachment/{attachmentId}	Delete
CamundaRestApi.TaskAttachmentApi	getAttachment	GET /task/{id}/attachment/{attachmentId}	Get
CamundaRestApi.TaskAttachmentApi	getAttachmentData	GET /task/{id}/attachment/{attachmentId}/data	Get (Binary)
CamundaRestApi.TaskAttachmentApi	getAttachments	GET /task/{id}/attachment	Get List
CamundaRestApi.TaskCommentApi	createComment	POST /task/{id}/comment/create	Create
CamundaRestApi.TaskCommentApi	getComment	GET /task/{id}/comment/{commentId}	Get
CamundaRestApi.TaskCommentApi	getComments	GET /task/{id}/comment	Get List
CamundaRestApi.TaskIdentityLinkApi	addIdentityLink	POST /task/{id}/identity-links	Add
CamundaRestApi.TaskIdentityLinkApi	deleteIdentityLink	POST /task/{id}/identity-links/delete	Delete
CamundaRestApi.TaskIdentityLinkApi	getIdentityLinks	GET /task/{id}/identity-links	Get List
CamundaRestApi.TaskLocalVariableApi	deleteTaskLocalVariable	DELETE /task/{id}/localVariables/{varName}	Delete Local Task Variable
CamundaRestApi.TaskLocalVariableApi	getTaskLocalVariable	GET /task/{id}/localVariables/{varName}	Get Local Task Variable
CamundaRestApi.TaskLocalVariableApi	getTaskLocalVariableBinary	GET /task/{id}/localVariables/{varName}/data	Get Local Task Variable (Binary)
CamundaRestApi.TaskLocalVariableApi	getTaskLocalVariables	GET /task/{id}/localVariables	Get Local Task Variables
CamundaRestApi.TaskLocalVariableApi	modifyTaskLocalVariables	POST /task/{id}/localVariables	Update/Delete Local Task Variables
CamundaRestApi.TaskLocalVariableApi	putTaskLocalVariable	PUT /task/{id}/localVariables/{varName}	Update Local Task Variable
CamundaRestApi.TaskLocalVariableApi	setBinaryTaskLocalVariable	POST /task/{id}/localVariables/{varName}/data	Update Local Task Variable (Binary)
CamundaRestApi.TaskVariableApi	deleteTaskVariable	DELETE /task/{id}/variables/{varName}	Delete Task Variable
CamundaRestApi.TaskVariableApi	getTaskVariable	GET /task/{id}/variables/{varName}	Get Task Variable
CamundaRestApi.TaskVariableApi	getTaskVariableBinary	GET /task/{id}/variables/{varName}/data	Get Task Variable (Binary)
CamundaRestApi.TaskVariableApi	getTaskVariables	GET /task/{id}/variables	Get Task Variables
CamundaRestApi.TaskVariableApi	modifyTaskVariables	POST /task/{id}/variables	Update/Delete Task Variables
CamundaRestApi.TaskVariableApi	putTaskVariable	PUT /task/{id}/variables/{varName}	Update Task Variable
CamundaRestApi.TaskVariableApi	setBinaryTaskVariable	POST /task/{id}/variables/{varName}/data	Update Task Variable (Binary)
CamundaRestApi.TelemetryApi	configureTelemetry	POST /telemetry/configuration	Configure Telemetry
CamundaRestApi.TelemetryApi	getTelemetryConfiguration	GET /telemetry/configuration	Fetch Telemetry Configuration
CamundaRestApi.TelemetryApi	getTelemetryData	GET /telemetry/data	Fetch Telemetry Data
CamundaRestApi.TenantApi	availableTenantGroupMembersOperations	OPTIONS /tenant/{id}/group-members	Tenant Group Membership Resource Options
CamundaRestApi.TenantApi	availableTenantInstanceOperations	OPTIONS /tenant/{id}	Tenant Resource Options
CamundaRestApi.TenantApi	availableTenantResourceOperations	OPTIONS /tenant	Tenant Resource Options
CamundaRestApi.TenantApi	availableTenantUserMembersOperations	OPTIONS /tenant/{id}/user-members	Tenant User Membership Resource Options
CamundaRestApi.TenantApi	createGroupMembership	PUT /tenant/{id}/group-members/{groupId}	Create Tenant Group Membership
CamundaRestApi.TenantApi	createTenant	POST /tenant/create	Create Tenant
CamundaRestApi.TenantApi	createUserMembership	PUT /tenant/{id}/user-members/{userId}	Create Tenant User Membership
CamundaRestApi.TenantApi	deleteGroupMembership	DELETE /tenant/{id}/group-members/{groupId}	Create Tenant Group Membership
CamundaRestApi.TenantApi	deleteTenant	DELETE /tenant/{id}	Delete Tenant
CamundaRestApi.TenantApi	deleteUserMembership	DELETE /tenant/{id}/user-members/{userId}	Delete a Tenant User Membership
CamundaRestApi.TenantApi	getTenant	GET /tenant/{id}	Get Tenant
CamundaRestApi.TenantApi	getTenantCount	GET /tenant/count	Get Tenant Count
CamundaRestApi.TenantApi	queryTenants	GET /tenant	Get Tenants
CamundaRestApi.TenantApi	updateTenant	PUT /tenant/{id}	Update Tenant
CamundaRestApi.UserApi	availableOperations	OPTIONS /user	Options
CamundaRestApi.UserApi	availableUserOperations	OPTIONS /user/{id}	Options
CamundaRestApi.UserApi	createUser	POST /user/create	Create
CamundaRestApi.UserApi	deleteUser	DELETE /user/{id}	Delete
CamundaRestApi.UserApi	getUserCount	GET /user/count	Get List Count
CamundaRestApi.UserApi	getUserProfile	GET /user/{id}/profile	Get Profile
CamundaRestApi.UserApi	getUsers	GET /user	Get List
CamundaRestApi.UserApi	unlockUser	POST /user/{id}/unlock	Unlock User
CamundaRestApi.UserApi	updateCredentials	PUT /user/{id}/credentials	Update Credentials
CamundaRestApi.UserApi	updateProfile	PUT /user/{id}/profile	Update User Profile
CamundaRestApi.VariableInstanceApi	getVariableInstance	GET /variable-instance/{id}	Get Variable Instance
CamundaRestApi.VariableInstanceApi	getVariableInstanceBinary	GET /variable-instance/{id}/data	Get Variable Instance (Binary)
CamundaRestApi.VariableInstanceApi	getVariableInstances	GET /variable-instance	Get Variable Instances
CamundaRestApi.VariableInstanceApi	getVariableInstancesCount	GET /variable-instance/count	Get Variable Instance Count
CamundaRestApi.VariableInstanceApi	queryVariableInstances	POST /variable-instance	Get Variable Instances (POST)
CamundaRestApi.VariableInstanceApi	queryVariableInstancesCount	POST /variable-instance/count	Get Variable Instance Count (POST)
CamundaRestApi.VersionApi	getRestAPIVersion	GET /version	Get Rest API version

Documentation for Models

• CamundaRestApi.AbstractSetRemovalTimeDto
• CamundaRestApi.AbstractVendorVersionInformationDto
• CamundaRestApi.ActivityInstanceDto
• CamundaRestApi.ActivityInstanceIncidentDto
• CamundaRestApi.ActivityStatisticsResultDto
• CamundaRestApi.AnnotationDto
• CamundaRestApi.AnyValue
• CamundaRestApi.AtomLink
• CamundaRestApi.AttachmentDto
• CamundaRestApi.AuthenticationResult
• CamundaRestApi.AuthorizationCheckResultDto
• CamundaRestApi.AuthorizationCreateDto
• CamundaRestApi.AuthorizationDto
• CamundaRestApi.AuthorizationExceptionDto
• CamundaRestApi.AuthorizationUpdateDto
• CamundaRestApi.BasicUserCredentialsDto
• CamundaRestApi.BatchDto
• CamundaRestApi.BatchStatisticsDto
• CamundaRestApi.CalledProcessDefinitionDto
• CamundaRestApi.CamundaFormRef
• CamundaRestApi.CaseDefinitionDto
• CamundaRestApi.CheckPasswordPolicyResultDto
• CamundaRestApi.CheckPasswordPolicyRuleDto
• CamundaRestApi.CleanableHistoricBatchReportResultDto
• CamundaRestApi.CleanableHistoricDecisionInstanceReportResultDto
• CamundaRestApi.CleanableHistoricProcessInstanceReportResultDto
• CamundaRestApi.CommentDto
• CamundaRestApi.CompleteExternalTaskDto
• CamundaRestApi.CompleteTaskDto
• CamundaRestApi.ConditionQueryParameterDto
• CamundaRestApi.CorrelationMessageAsyncDto
• CamundaRestApi.CorrelationMessageDto
• CamundaRestApi.CountResultDto
• CamundaRestApi.CreateFilterDto
• CamundaRestApi.CreateIncidentDto
• CamundaRestApi.DecisionDefinitionDiagramDto
• CamundaRestApi.DecisionDefinitionDto
• CamundaRestApi.DecisionRequirementsDefinitionDto
• CamundaRestApi.DecisionRequirementsDefinitionXmlDto
• CamundaRestApi.DeleteHistoricDecisionInstancesDto
• CamundaRestApi.DeleteHistoricProcessInstancesDto
• CamundaRestApi.DeleteProcessInstancesDto
• CamundaRestApi.DeploymentDto
• CamundaRestApi.DeploymentResourceDto
• CamundaRestApi.DeploymentWithDefinitionsDto
• CamundaRestApi.DurationReportResultDto
• CamundaRestApi.EvaluateDecisionDto
• CamundaRestApi.EvaluationConditionDto
• CamundaRestApi.EventSubscriptionDto
• CamundaRestApi.EventSubscriptionQueryDto
• CamundaRestApi.EventSubscriptionQueryDtoSorting
• CamundaRestApi.ExceptionDto
• CamundaRestApi.ExecutionDto
• CamundaRestApi.ExecutionQueryDto
• CamundaRestApi.ExecutionQueryDtoSorting
• CamundaRestApi.ExecutionTriggerDto
• CamundaRestApi.ExtendLockOnExternalTaskDto
• CamundaRestApi.ExternalTaskBpmnError
• CamundaRestApi.ExternalTaskDto
• CamundaRestApi.ExternalTaskFailureDto
• CamundaRestApi.ExternalTaskQueryDto
• CamundaRestApi.ExternalTaskQueryDtoSorting
• CamundaRestApi.FetchExternalTaskTopicDto
• CamundaRestApi.FetchExternalTasksDto
• CamundaRestApi.FilterDto
• CamundaRestApi.FormDto
• CamundaRestApi.GroupDto
• CamundaRestApi.GroupQueryDto
• CamundaRestApi.GroupQueryDtoSorting
• CamundaRestApi.HandleExternalTaskDto
• CamundaRestApi.HistoricActivityInstanceDto
• CamundaRestApi.HistoricActivityInstanceQueryDto
• CamundaRestApi.HistoricActivityInstanceQueryDtoSorting
• CamundaRestApi.HistoricActivityStatisticsDto
• CamundaRestApi.HistoricBatchDto
• CamundaRestApi.HistoricBatchQueryDto
• CamundaRestApi.HistoricBatchQueryDtoSorting
• CamundaRestApi.HistoricDecisionInputInstanceDto
• CamundaRestApi.HistoricDecisionInstanceDto
• CamundaRestApi.HistoricDecisionInstanceQueryDto
• CamundaRestApi.HistoricDecisionInstanceStatisticsDto
• CamundaRestApi.HistoricDecisionOutputInstanceDto
• CamundaRestApi.HistoricDetailDto
• CamundaRestApi.HistoricDetailQueryDto
• CamundaRestApi.HistoricDetailQueryDtoSorting
• CamundaRestApi.HistoricExternalTaskLogDto
• CamundaRestApi.HistoricExternalTaskLogQueryDto
• CamundaRestApi.HistoricExternalTaskLogQueryDtoSorting
• CamundaRestApi.HistoricIdentityLinkLogDto
• CamundaRestApi.HistoricIncidentDto
• CamundaRestApi.HistoricJobLogDto
• CamundaRestApi.HistoricJobLogQueryDto
• CamundaRestApi.HistoricJobLogQueryDtoSorting
• CamundaRestApi.HistoricProcessInstanceDto
• CamundaRestApi.HistoricProcessInstanceQueryDto
• CamundaRestApi.HistoricProcessInstanceQueryDtoSorting
• CamundaRestApi.HistoricTaskInstanceDto
• CamundaRestApi.HistoricTaskInstanceQueryDto
• CamundaRestApi.HistoricTaskInstanceQueryDtoSorting
• CamundaRestApi.HistoricTaskInstanceReportResultDto
• CamundaRestApi.HistoricVariableInstanceDto
• CamundaRestApi.HistoricVariableInstanceQueryDto
• CamundaRestApi.HistoricVariableInstanceQueryDtoSorting
• CamundaRestApi.HistoryCleanupConfigurationDto
• CamundaRestApi.HistoryTimeToLiveDto
• CamundaRestApi.IdentityLinkDto
• CamundaRestApi.IdentityServiceGroupDto
• CamundaRestApi.IdentityServiceGroupInfoDto
• CamundaRestApi.IdentityServiceUserDto
• CamundaRestApi.IncidentDto
• CamundaRestApi.IncidentStatisticsResultDto
• CamundaRestApi.JobConditionQueryParameterDto
• CamundaRestApi.JobDefinitionDto
• CamundaRestApi.JobDefinitionPriorityDto
• CamundaRestApi.JobDefinitionQueryDto
• CamundaRestApi.JobDefinitionQueryDtoSorting
• CamundaRestApi.JobDefinitionSuspensionStateDto
• CamundaRestApi.JobDefinitionsSuspensionStateDto
• CamundaRestApi.JobDto
• CamundaRestApi.JobDuedateDto
• CamundaRestApi.JobQueryDto
• CamundaRestApi.JobQueryDtoSorting
• CamundaRestApi.JobRetriesDto
• CamundaRestApi.JobSuspensionStateDto
• CamundaRestApi.LinkableDto
• CamundaRestApi.LockExternalTaskDto
• CamundaRestApi.LockedExternalTaskDto
• CamundaRestApi.MessageCorrelationResultWithVariableDto
• CamundaRestApi.MetricsIntervalResultDto
• CamundaRestApi.MetricsResultDto
• CamundaRestApi.MigrationExecutionDto
• CamundaRestApi.MigrationInstructionDto
• CamundaRestApi.MigrationInstructionValidationReportDto
• CamundaRestApi.MigrationPlanDto
• CamundaRestApi.MigrationPlanGenerationDto
• CamundaRestApi.MigrationPlanReportDto
• CamundaRestApi.MigrationVariableValidationReportDto
• CamundaRestApi.MissingAuthorizationDto
• CamundaRestApi.ModificationDto
• CamundaRestApi.MultiFormAttachmentDto
• CamundaRestApi.MultiFormDeploymentDto
• CamundaRestApi.MultiFormVariableBinaryDto
• CamundaRestApi.MultipleProcessInstanceModificationInstructionDto
• CamundaRestApi.ParseExceptionDto
• CamundaRestApi.PasswordPolicyDto
• CamundaRestApi.PasswordPolicyRequestDto
• CamundaRestApi.PasswordPolicyRuleDto
• CamundaRestApi.PatchVariablesDto
• CamundaRestApi.PriorityDto
• CamundaRestApi.ProblemDto
• CamundaRestApi.ProcessDefinitionDiagramDto
• CamundaRestApi.ProcessDefinitionDto
• CamundaRestApi.ProcessDefinitionStatisticsResultDto
• CamundaRestApi.ProcessDefinitionSuspensionStateDto
• CamundaRestApi.ProcessEngineDto
• CamundaRestApi.ProcessInstanceDto
• CamundaRestApi.ProcessInstanceModificationDto
• CamundaRestApi.ProcessInstanceModificationInstructionDto
• CamundaRestApi.ProcessInstanceQueryDto
• CamundaRestApi.ProcessInstanceQueryDtoSorting
• CamundaRestApi.ProcessInstanceSuspensionStateAsyncDto
• CamundaRestApi.ProcessInstanceSuspensionStateDto
• CamundaRestApi.ProcessInstanceWithVariablesDto
• CamundaRestApi.RedeploymentDto
• CamundaRestApi.ResourceOptionsDto
• CamundaRestApi.ResourceReportDto
• CamundaRestApi.RestartProcessInstanceDto
• CamundaRestApi.RestartProcessInstanceModificationInstructionDto
• CamundaRestApi.RetriesDto
• CamundaRestApi.SchemaLogEntryDto
• CamundaRestApi.SchemaLogQueryDto
• CamundaRestApi.SchemaLogQueryDtoSorting
• CamundaRestApi.SetJobRetriesByProcessDto
• CamundaRestApi.SetJobRetriesDto
• CamundaRestApi.SetRemovalTimeToHistoricBatchesDto
• CamundaRestApi.SetRemovalTimeToHistoricDecisionInstancesDto
• CamundaRestApi.SetRemovalTimeToHistoricProcessInstancesDto
• CamundaRestApi.SetRetriesForExternalTasksDto
• CamundaRestApi.SetVariablesAsyncDto
• CamundaRestApi.SignalDto
• CamundaRestApi.SortTaskQueryParametersDto
• CamundaRestApi.StartProcessInstanceDto
• CamundaRestApi.StartProcessInstanceFormDto
• CamundaRestApi.SuspensionStateDto
• CamundaRestApi.TaskBpmnErrorDto
• CamundaRestApi.TaskCountByCandidateGroupResultDto
• CamundaRestApi.TaskDto
• CamundaRestApi.TaskEscalationDto
• CamundaRestApi.TaskQueryDto
• CamundaRestApi.TaskQueryDtoSorting
• CamundaRestApi.TelemetryConfigurationDto
• CamundaRestApi.TelemetryCountDto
• CamundaRestApi.TelemetryDataDto
• CamundaRestApi.TelemetryInternalsDto
• CamundaRestApi.TelemetryLicenseKeyDto
• CamundaRestApi.TelemetryProductDto
• CamundaRestApi.TenantDto
• CamundaRestApi.TransitionInstanceDto
• CamundaRestApi.TriggerVariableValueDto
• CamundaRestApi.UserCredentialsDto
• CamundaRestApi.UserDto
• CamundaRestApi.UserIdDto
• CamundaRestApi.UserOperationLogEntryDto
• CamundaRestApi.UserProfileDto
• CamundaRestApi.VariableInstanceDto
• CamundaRestApi.VariableInstanceQueryDto
• CamundaRestApi.VariableInstanceQueryDtoSorting
• CamundaRestApi.VariableQueryParameterDto
• CamundaRestApi.VariableValueDto
• CamundaRestApi.VersionDto

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication