| Package | Description |
|---|---|
| org.openapitools.client | |
| org.openapitools.client.api |
| Modifier and Type | Method and Description |
|---|---|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call)
|
<T> ApiResponse<T> |
ApiClient.execute(okhttp3.Call call,
Type returnType)
Execute HTTP call and deserialize the HTTP response body into the given return type.
|
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<AttachmentDto> |
TaskAttachmentApi.addAttachmentWithHttpInfo(String id,
String attachmentName,
String attachmentDescription,
String attachmentType,
String url,
File content)
Create
Creates an attachment for a task.
|
ApiResponse<Void> |
TaskIdentityLinkApi.addIdentityLinkWithHttpInfo(String id,
IdentityLinkDto identityLinkDto)
Add
Adds an identity link to a task by id.
|
ApiResponse<ResourceOptionsDto> |
GroupApi.availableGroupInstanceOperationsWithHttpInfo(String id)
Group Resource Instance Options
The `/group` resource supports two custom OPTIONS requests, one for the resource as such and this one for individual group instances.
|
ApiResponse<ResourceOptionsDto> |
GroupApi.availableGroupMembersOperationsWithHttpInfo(String id)
Group Membership Resource Options
The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the resource.
|
ApiResponse<ResourceOptionsDto> |
GroupApi.availableGroupOperationsWithHttpInfo()
Group Resource Options
The `/group` resource supports two custom OPTIONS requests, this one for the resource as such and one for individual group instances.
|
ApiResponse<ResourceOptionsDto> |
UserApi.availableOperationsWithHttpInfo()
Options
The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances.
|
ApiResponse<ResourceOptionsDto> |
TenantApi.availableTenantGroupMembersOperationsWithHttpInfo(String id)
Tenant Group Membership Resource Options
The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the resource.
|
ApiResponse<ResourceOptionsDto> |
TenantApi.availableTenantInstanceOperationsWithHttpInfo(String id)
Tenant Resource Options
The `/tenant` resource supports two custom OPTIONS requests, one for the resource as such and this one for individual tenant instances.
|
ApiResponse<ResourceOptionsDto> |
TenantApi.availableTenantResourceOperationsWithHttpInfo()
Tenant Resource Options
The `/tenant` resource supports two custom OPTIONS requests, this one for the resource as such and one for individual tenant instances.
|
ApiResponse<ResourceOptionsDto> |
TenantApi.availableTenantUserMembersOperationsWithHttpInfo(String id)
Tenant User Membership Resource Options
The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the resource.
|
ApiResponse<ResourceOptionsDto> |
UserApi.availableUserOperationsWithHttpInfo(String id)
Options
The `/user` resource supports two custom `OPTIONS` requests, one for the resource as such and one for individual user instances.
|
ApiResponse<CheckPasswordPolicyResultDto> |
IdentityApi.checkPasswordWithHttpInfo(PasswordPolicyRequestDto passwordPolicyRequestDto)
Validate Password
A password policy consists of a list of rules that new passwords must follow to be policy compliant.
|
ApiResponse<Void> |
TaskApi.claimWithHttpInfo(String id,
UserIdDto userIdDto)
Claim
Claims a task for a specific user.
|
ApiResponse<Void> |
IncidentApi.clearIncidentAnnotationWithHttpInfo(String id)
Clear Incident Annotation
Clears the annotation of an incident with given id.
|
ApiResponse<Void> |
ExternalTaskApi.completeExternalTaskResourceWithHttpInfo(String id,
CompleteExternalTaskDto completeExternalTaskDto)
Complete
Completes an external task by id and updates process variables.
|
ApiResponse<Map<String,VariableValueDto>> |
TaskApi.completeWithHttpInfo(String id,
CompleteTaskDto completeTaskDto)
Complete
Completes a task and updates process variables.
|
ApiResponse<Void> |
TelemetryApi.configureTelemetryWithHttpInfo(TelemetryConfigurationDto telemetryConfigurationDto)
Configure Telemetry
Configures whether Camunda receives data collection of the process engine setup and usage.
|
ApiResponse<CommentDto> |
TaskCommentApi.createCommentWithHttpInfo(String id,
CommentDto commentDto)
Create
Creates a comment for a task by id.
|
ApiResponse<DeploymentWithDefinitionsDto> |
DeploymentApi.createDeploymentWithHttpInfo(String tenantId,
String deploymentSource,
Boolean deployChangedOnly,
Boolean enableDuplicateFiltering,
String deploymentName,
File data)
Create
Creates a deployment.
|
ApiResponse<Void> |
TenantApi.createGroupMembershipWithHttpInfo(String id,
String groupId)
Create Tenant Group Membership
Creates a membership between a tenant and a group.
|
ApiResponse<Void> |
GroupApi.createGroupMemberWithHttpInfo(String id,
String userId)
Create Group Member
Adds a member to a group.
|
ApiResponse<Void> |
GroupApi.createGroupWithHttpInfo(GroupDto groupDto)
Create Group
Creates a new group.
|
ApiResponse<IncidentDto> |
ExecutionApi.createIncidentWithHttpInfo(String id,
CreateIncidentDto createIncidentDto)
Create Incident
Creates a custom incident with given properties.
|
ApiResponse<Void> |
TaskApi.createTaskWithHttpInfo(TaskDto taskDto)
Create
Creates a new task.
|
ApiResponse<Void> |
TenantApi.createTenantWithHttpInfo(TenantDto tenantDto)
Create Tenant
Create a new tenant.
|
ApiResponse<Void> |
TenantApi.createUserMembershipWithHttpInfo(String id,
String userId)
Create Tenant User Membership
Creates a membership between a tenant and an user.
|
ApiResponse<Void> |
UserApi.createUserWithHttpInfo(UserDto userDto)
Create
Create a new user.
|
ApiResponse<Void> |
TaskApi.delegateTaskWithHttpInfo(String id,
UserIdDto userIdDto)
Delegate
Delegates a task to another user.
|
ApiResponse<BatchDto> |
ProcessInstanceApi.deleteAsyncHistoricQueryBasedWithHttpInfo(DeleteProcessInstancesDto deleteProcessInstancesDto)
Delete Async Historic Query Based (POST)
Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
|
ApiResponse<Void> |
TaskAttachmentApi.deleteAttachmentWithHttpInfo(String id,
String attachmentId)
Delete
Removes an attachment from a task by id.
|
ApiResponse<Void> |
BatchApi.deleteBatchWithHttpInfo(String id,
Boolean cascade)
Delete
Deletes a batch by id, including all related jobs and job definitions.
|
ApiResponse<Void> |
DeploymentApi.deleteDeploymentWithHttpInfo(String id,
Boolean cascade,
Boolean skipCustomListeners,
Boolean skipIoMappings)
Delete
Deletes a deployment by id.
|
ApiResponse<Void> |
TenantApi.deleteGroupMembershipWithHttpInfo(String id,
String groupId)
Create Tenant Group Membership
Creates a membership between a tenant and a group.
|
ApiResponse<Void> |
GroupApi.deleteGroupMemberWithHttpInfo(String id,
String userId)
Delete a Group Member
Removes a member from a group.
|
ApiResponse<Void> |
GroupApi.deleteGroupWithHttpInfo(String id)
Delete Group
Deletes a group by id.
|
ApiResponse<BatchDto> |
HistoricProcessInstanceApi.deleteHistoricProcessInstancesAsyncWithHttpInfo(DeleteHistoricProcessInstancesDto deleteHistoricProcessInstancesDto)
Delete Async (POST)
Delete multiple historic process instances asynchronously (batch).
|
ApiResponse<Void> |
HistoricProcessInstanceApi.deleteHistoricProcessInstanceWithHttpInfo(String id,
Boolean failIfNotExists)
Delete
Deletes a process instance from the history by id.
|
ApiResponse<Void> |
HistoricProcessInstanceApi.deleteHistoricVariableInstancesOfHistoricProcessInstanceWithHttpInfo(String id)
Delete Variable Instances
Deletes all variables of a process instance from the history by id.
|
ApiResponse<Void> |
TaskIdentityLinkApi.deleteIdentityLinkWithHttpInfo(String id,
IdentityLinkDto identityLinkDto)
Delete
Removes an identity link from a task by id
|
ApiResponse<Void> |
ExecutionApi.deleteLocalExecutionVariableWithHttpInfo(String id,
String varName)
Delete Local Execution Variable
Deletes a variable in the context of a given execution by id.
|
ApiResponse<Void> |
ProcessDefinitionApi.deleteProcessDefinitionsByKeyAndTenantIdWithHttpInfo(String key,
String tenantId,
Boolean cascade,
Boolean skipCustomListeners,
Boolean skipIoMappings)
Delete By Key
Deletes process definitions by a given key and which belong to a tenant id.
|
ApiResponse<Void> |
ProcessDefinitionApi.deleteProcessDefinitionsByKeyWithHttpInfo(String key,
Boolean cascade,
Boolean skipCustomListeners,
Boolean skipIoMappings)
Delete By Key
Deletes process definitions by a given key which belong to no tenant id.
|
ApiResponse<Void> |
ProcessDefinitionApi.deleteProcessDefinitionWithHttpInfo(String id,
Boolean cascade,
Boolean skipCustomListeners,
Boolean skipIoMappings)
Delete
Deletes a running process instance by id.
|
ApiResponse<BatchDto> |
ProcessInstanceApi.deleteProcessInstancesAsyncOperationWithHttpInfo(DeleteProcessInstancesDto deleteProcessInstancesDto)
Delete Async (POST)
Deletes multiple process instances asynchronously (batch).
|
ApiResponse<Void> |
ProcessInstanceApi.deleteProcessInstanceVariableWithHttpInfo(String id,
String varName)
Delete Process Variable
Deletes a variable of a process instance by id.
|
ApiResponse<Void> |
ProcessInstanceApi.deleteProcessInstanceWithHttpInfo(String id,
Boolean skipCustomListeners,
Boolean skipIoMappings,
Boolean skipSubprocesses,
Boolean failIfNotExists)
Delete
Deletes a running process instance by id.
|
ApiResponse<Void> |
TaskLocalVariableApi.deleteTaskLocalVariableWithHttpInfo(String id,
String varName)
Delete Local Task Variable
Removes a local variable from a task by id.
|
ApiResponse<Void> |
MetricsApi.deleteTaskMetricsWithHttpInfo(Date date)
Delete Task Worker Metrics
Deletes all task worker metrics prior to the given date or all if no date is provided.
|
ApiResponse<Void> |
TaskVariableApi.deleteTaskVariableWithHttpInfo(String id,
String varName)
Delete Task Variable
Removes a variable that is visible to a task.
|
ApiResponse<Void> |
TaskApi.deleteTaskWithHttpInfo(String id)
Delete
Removes a task by id.
|
ApiResponse<Void> |
TenantApi.deleteTenantWithHttpInfo(String id)
Delete Tenant
Deletes a tenant by id.
|
ApiResponse<Void> |
TenantApi.deleteUserMembershipWithHttpInfo(String id,
String userId)
Delete a Tenant User Membership
Deletes a membership between a tenant and an user.
|
ApiResponse<Void> |
UserApi.deleteUserWithHttpInfo(String id)
Delete
Deletes a user by id.
|
ApiResponse<List<MessageCorrelationResultWithVariableDto>> |
MessageApi.deliverMessageWithHttpInfo(CorrelationMessageDto correlationMessageDto)
Correlate
Correlates a message to the process engine to either trigger a message start event or an intermediate message catching event.
|
ApiResponse<List<ProcessInstanceDto>> |
ConditionApi.evaluateConditionWithHttpInfo(EvaluationConditionDto evaluationConditionDto)
Evaluate
Triggers evaluation of conditions for conditional start event(s).
|
ApiResponse<List<Map<String,VariableValueDto>>> |
DecisionDefinitionApi.evaluateDecisionByIdWithHttpInfo(String id,
EvaluateDecisionDto evaluateDecisionDto)
Evaluate By Id
Evaluates a given decision and returns the result.
|
ApiResponse<List<Map<String,VariableValueDto>>> |
DecisionDefinitionApi.evaluateDecisionByKeyAndTenantWithHttpInfo(String key,
String tenantId,
EvaluateDecisionDto evaluateDecisionDto)
Evaluate By Key And Tenant
Evaluates the latest version of the decision definition for tenant.
|
ApiResponse<List<Map<String,VariableValueDto>>> |
DecisionDefinitionApi.evaluateDecisionByKeyWithHttpInfo(String key,
EvaluateDecisionDto evaluateDecisionDto)
Evaluate By Key
Evaluates the latest version of the decision definition which belongs to no tenant.
|
ApiResponse<Void> |
JobApi.executeJobWithHttpInfo(String id)
Execute Job
Executes a job by id.
|
ApiResponse<Void> |
ExternalTaskApi.extendLockWithHttpInfo(String id,
ExtendLockOnExternalTaskDto extendLockOnExternalTaskDto)
Extend Lock
Extends the timeout of the lock by a given amount of time.
|
ApiResponse<List<LockedExternalTaskDto>> |
ExternalTaskApi.fetchAndLockWithHttpInfo(FetchExternalTasksDto fetchExternalTasksDto)
Fetch and Lock
Fetches and locks a specific number of external tasks for execution by a worker.
|
ApiResponse<ActivityInstanceDto> |
ProcessInstanceApi.getActivityInstanceTreeWithHttpInfo(String id)
Get Activity Instance
Retrieves an Activity Instance (Tree) for a given process instance by id.
|
ApiResponse<List<ActivityStatisticsResultDto>> |
ProcessDefinitionApi.getActivityStatisticsByProcessDefinitionKeyAndTenantIdWithHttpInfo(String key,
String tenantId,
Boolean failedJobs,
Boolean incidents,
String incidentsForType)
Get Activity Instance Statistics
Retrieves runtime statistics of the latest version of the given process definition for a tenant, grouped by activities.
|
ApiResponse<List<ActivityStatisticsResultDto>> |
ProcessDefinitionApi.getActivityStatisticsByProcessDefinitionKeyWithHttpInfo(String key,
Boolean failedJobs,
Boolean incidents,
String incidentsForType)
Get Activity Instance Statistics
Retrieves runtime statistics of the latest version of the given process definition which belongs to no tenant, grouped by activities.
|
ApiResponse<List<ActivityStatisticsResultDto>> |
ProcessDefinitionApi.getActivityStatisticsWithHttpInfo(String id,
Boolean failedJobs,
Boolean incidents,
String incidentsForType)
Get Activity Instance Statistics
Retrieves runtime statistics of a given process definition, grouped by activities.
|
ApiResponse<File> |
TaskAttachmentApi.getAttachmentDataWithHttpInfo(String id,
String attachmentId)
Get (Binary)
Retrieves the binary content of a task attachment by task id and attachment id.
|
ApiResponse<List<AttachmentDto>> |
TaskAttachmentApi.getAttachmentsWithHttpInfo(String id)
Get List
Gets the attachments for a task.
|
ApiResponse<AttachmentDto> |
TaskAttachmentApi.getAttachmentWithHttpInfo(String id,
String attachmentId)
Get
Retrieves a task attachment by task id and attachment id.
|
ApiResponse<CountResultDto> |
BatchApi.getBatchesCountWithHttpInfo(String batchId,
String type,
String tenantIdIn,
Boolean withoutTenantId,
Boolean suspended)
Get List Count
Requests the number of batches that fulfill the query criteria.
|
ApiResponse<List<BatchDto>> |
BatchApi.getBatchesWithHttpInfo(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String batchId,
String type,
String tenantIdIn,
Boolean withoutTenantId,
Boolean suspended)
Get List
Queries for batches that fulfill given parameters.
|
ApiResponse<CountResultDto> |
BatchApi.getBatchStatisticsCountWithHttpInfo(String batchId,
String type,
String tenantIdIn,
Boolean withoutTenantId,
Boolean suspended)
Get Statistics Count
Requests the number of batch statistics that fulfill the query criteria.
|
ApiResponse<List<BatchStatisticsDto>> |
BatchApi.getBatchStatisticsWithHttpInfo(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String batchId,
String type,
String tenantIdIn,
Boolean withoutTenantId,
Boolean suspended)
Get Statistics
Queries for batch statistics that fulfill given parameters.
|
ApiResponse<BatchDto> |
BatchApi.getBatchWithHttpInfo(String id)
Get
Retrieves a batch by id, according to the Batch interface in the engine.
|
ApiResponse<List<CommentDto>> |
TaskCommentApi.getCommentsWithHttpInfo(String id)
Get List
Gets the comments for a task by id.
|
ApiResponse<CommentDto> |
TaskCommentApi.getCommentWithHttpInfo(String id,
String commentId)
Get
Retrieves a task comment by task id and comment id.
|
ApiResponse<DecisionDefinitionDto> |
DecisionDefinitionApi.getDecisionDefinitionByIdWithHttpInfo(String id)
Get Decision Definition By Id
Retrieves a decision definition by id, according to the `DecisionDefinition` interface in the engine.
|
ApiResponse<DecisionDefinitionDto> |
DecisionDefinitionApi.getDecisionDefinitionByKeyAndTenantIdWithHttpInfo(String key,
String tenantId)
Get Decision Definition By Key And Tenant Id
Retrieves the latest version of the decision definition for tenant
|
ApiResponse<DecisionDefinitionDto> |
DecisionDefinitionApi.getDecisionDefinitionByKeyWithHttpInfo(String key)
Get Decision Definition By Key
Retrieves the latest version of the decision definition which belongs to no tenant.
|
ApiResponse<File> |
DecisionDefinitionApi.getDecisionDefinitionDiagramByKeyAndTenantWithHttpInfo(String key,
String tenantId)
Get Diagram By Key And Tenant
Returns the XML of the latest version of the decision definition for tenant.
|
ApiResponse<File> |
DecisionDefinitionApi.getDecisionDefinitionDiagramByKeyWithHttpInfo(String key)
Get Diagram By Key
Returns the diagram for the latest version of the decision definition which belongs to no tenant
|
ApiResponse<File> |
DecisionDefinitionApi.getDecisionDefinitionDiagramWithHttpInfo(String id)
Get Diagram
Retrieves the diagram of a decision definition.
|
ApiResponse<DecisionDefinitionDiagramDto> |
DecisionDefinitionApi.getDecisionDefinitionDmnXmlByIdWithHttpInfo(String id)
Get XML By Id
Retrieves the DMN XML of a decision definition.
|
ApiResponse<DecisionDefinitionDiagramDto> |
DecisionDefinitionApi.getDecisionDefinitionDmnXmlByKeyAndTenantWithHttpInfo(String key,
String tenantId)
Get XML By Key and Tenant
Retrieves the XML of the latest version of the decision definition for tenant
|
ApiResponse<DecisionDefinitionDiagramDto> |
DecisionDefinitionApi.getDecisionDefinitionDmnXmlByKeyWithHttpInfo(String key)
Get XML By Key
Retrieves the XML for the latest version of the decision definition which belongs to no tenant.
|
ApiResponse<CountResultDto> |
DecisionDefinitionApi.getDecisionDefinitionsCountWithHttpInfo(String decisionDefinitionId,
String decisionDefinitionIdIn,
String name,
String nameLike,
String deploymentId,
Date deployedAfter,
Date deployedAt,
String key,
String keyLike,
String category,
String categoryLike,
Integer version,
Boolean latestVersion,
String resourceName,
String resourceNameLike,
String decisionRequirementsDefinitionId,
String decisionRequirementsDefinitionKey,
Boolean withoutDecisionRequirementsDefinition,
String tenantIdIn,
Boolean withoutTenantId,
Boolean includeDecisionDefinitionsWithoutTenantId,
String versionTag,
String versionTagLike)
Get List Count
Requests the number of decision definitions that fulfill the query criteria.
|
ApiResponse<List<DecisionDefinitionDto>> |
DecisionDefinitionApi.getDecisionDefinitionsWithHttpInfo(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String decisionDefinitionId,
String decisionDefinitionIdIn,
String name,
String nameLike,
String deploymentId,
Date deployedAfter,
Date deployedAt,
String key,
String keyLike,
String category,
String categoryLike,
Integer version,
Boolean latestVersion,
String resourceName,
String resourceNameLike,
String decisionRequirementsDefinitionId,
String decisionRequirementsDefinitionKey,
Boolean withoutDecisionRequirementsDefinition,
String tenantIdIn,
Boolean withoutTenantId,
Boolean includeDecisionDefinitionsWithoutTenantId,
String versionTag,
String versionTagLike)
Get List
Queries for decision definitions that fulfill given parameters.
|
ApiResponse<File> |
TaskApi.getDeployedFormWithHttpInfo(String id)
Get Deployed Form
Retrieves the deployed form that is referenced from a given task.
|
ApiResponse<File> |
ProcessDefinitionApi.getDeployedStartFormByKeyAndTenantIdWithHttpInfo(String key,
String tenantId)
Get Deployed Start Form
Retrieves the deployed form that can be referenced from a start event.
|
ApiResponse<File> |
ProcessDefinitionApi.getDeployedStartFormByKeyWithHttpInfo(String key)
Get Deployed Start Form
Retrieves the deployed form that can be referenced from a start event.
|
ApiResponse<File> |
ProcessDefinitionApi.getDeployedStartFormWithHttpInfo(String id)
Get Deployed Start Form
Retrieves the deployed form that can be referenced from a start event.
|
ApiResponse<File> |
DeploymentApi.getDeploymentResourceDataWithHttpInfo(String id,
String resourceId)
Get Resource (Binary)
Retrieves the binary content of a deployment resource for the given deployment by id.
|
ApiResponse<List<DeploymentResourceDto>> |
DeploymentApi.getDeploymentResourcesWithHttpInfo(String id)
Get Resources
Retrieves all deployment resources of a given deployment.
|
ApiResponse<DeploymentResourceDto> |
DeploymentApi.getDeploymentResourceWithHttpInfo(String id,
String resourceId)
Get Resource
Retrieves a deployment resource by resource id for the given deployment.
|
ApiResponse<CountResultDto> |
DeploymentApi.getDeploymentsCountWithHttpInfo(String id,
String name,
String nameLike,
String source,
Boolean withoutSource,
String tenantIdIn,
Boolean withoutTenantId,
Boolean includeDeploymentsWithoutTenantId,
Date after,
Date before)
Get List Count
Queries for the number of deployments that fulfill given parameters.
|
ApiResponse<List<DeploymentDto>> |
DeploymentApi.getDeploymentsWithHttpInfo(String id,
String name,
String nameLike,
String source,
Boolean withoutSource,
String tenantIdIn,
Boolean withoutTenantId,
Boolean includeDeploymentsWithoutTenantId,
Date after,
Date before,
String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults)
Get List
Queries for deployments that fulfill given parameters.
|
ApiResponse<DeploymentDto> |
DeploymentApi.getDeploymentWithHttpInfo(String id)
Get
Retrieves a deployment by id, according to the `Deployment` interface of the engine.
|
ApiResponse<CountResultDto> |
EventSubscriptionApi.getEventSubscriptionsCountWithHttpInfo(String eventSubscriptionId,
String eventName,
String eventType,
String executionId,
String processInstanceId,
String activityId,
String tenantIdIn,
Boolean withoutTenantId,
Boolean includeEventSubscriptionsWithoutTenantId)
Get List Count
Queries for the number of event subscriptions that fulfill given parameters.
|
ApiResponse<List<EventSubscriptionDto>> |
EventSubscriptionApi.getEventSubscriptionsWithHttpInfo(String eventSubscriptionId,
String eventName,
String eventType,
String executionId,
String processInstanceId,
String activityId,
String tenantIdIn,
Boolean withoutTenantId,
Boolean includeEventSubscriptionsWithoutTenantId,
String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults)
Get List
Queries for event subscriptions that fulfill given parameters.
|
ApiResponse<CountResultDto> |
ExecutionApi.getExecutionsCountWithHttpInfo(String businessKey,
String processDefinitionId,
String processDefinitionKey,
String processInstanceId,
String activityId,
String signalEventSubscriptionName,
String messageEventSubscriptionName,
Boolean active,
Boolean suspended,
String incidentId,
String incidentType,
String incidentMessage,
String incidentMessageLike,
String tenantIdIn,
String variables,
String processVariables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase)
Get Execution Count
Queries for the number of executions that fulfill given parameters.
|
ApiResponse<List<ExecutionDto>> |
ExecutionApi.getExecutionsWithHttpInfo(String businessKey,
String processDefinitionId,
String processDefinitionKey,
String processInstanceId,
String activityId,
String signalEventSubscriptionName,
String messageEventSubscriptionName,
Boolean active,
Boolean suspended,
String incidentId,
String incidentType,
String incidentMessage,
String incidentMessageLike,
String tenantIdIn,
String variables,
String processVariables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase,
String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults)
Get Executions
Queries for the executions that fulfill given parameters.
|
ApiResponse<ExecutionDto> |
ExecutionApi.getExecutionWithHttpInfo(String id)
Get Execution
Retrieves an execution by id, according to the `Execution` interface in the engine.
|
ApiResponse<String> |
ExternalTaskApi.getExternalTaskErrorDetailsWithHttpInfo(String id)
Get Error Details
Retrieves the error details in the context of a running external task by id.
|
ApiResponse<CountResultDto> |
ExternalTaskApi.getExternalTasksCountWithHttpInfo(String externalTaskId,
String externalTaskIdIn,
String topicName,
String workerId,
Boolean locked,
Boolean notLocked,
Boolean withRetriesLeft,
Boolean noRetriesLeft,
Date lockExpirationAfter,
Date lockExpirationBefore,
String activityId,
String activityIdIn,
String executionId,
String processInstanceId,
String processInstanceIdIn,
String processDefinitionId,
String tenantIdIn,
Boolean active,
Boolean suspended,
Long priorityHigherThanOrEquals,
Long priorityLowerThanOrEquals)
Get List Count
Queries for the number of external tasks that fulfill given parameters.
|
ApiResponse<List<ExternalTaskDto>> |
ExternalTaskApi.getExternalTasksWithHttpInfo(String externalTaskId,
String externalTaskIdIn,
String topicName,
String workerId,
Boolean locked,
Boolean notLocked,
Boolean withRetriesLeft,
Boolean noRetriesLeft,
Date lockExpirationAfter,
Date lockExpirationBefore,
String activityId,
String activityIdIn,
String executionId,
String processInstanceId,
String processInstanceIdIn,
String processDefinitionId,
String tenantIdIn,
Boolean active,
Boolean suspended,
Long priorityHigherThanOrEquals,
Long priorityLowerThanOrEquals,
String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults)
Get List
Queries for the external tasks that fulfill given parameters.
|
ApiResponse<ExternalTaskDto> |
ExternalTaskApi.getExternalTaskWithHttpInfo(String id)
Get
Retrieves an external task by id, corresponding to the `ExternalTask` interface in the engine.
|
ApiResponse<Map<String,VariableValueDto>> |
TaskApi.getFormVariablesWithHttpInfo(String id,
String variableNames,
Boolean deserializeValues)
Get Task Form Variables
Retrieves the form variables for a task.
|
ApiResponse<FormDto> |
TaskApi.getFormWithHttpInfo(String id)
Get Form Key
Retrieves the form key for a task.
|
ApiResponse<CountResultDto> |
GroupApi.getGroupCountWithHttpInfo(String id,
String idIn,
String name,
String nameLike,
String type,
String member,
String memberOfTenant)
Get List Count
Queries for groups using a list of parameters and retrieves the count.
|
ApiResponse<IdentityServiceGroupInfoDto> |
IdentityApi.getGroupInfoWithHttpInfo(String userId)
Get a User's Groups
Gets the groups of a user by id and includes all users that share a group with the given user.
|
ApiResponse<GroupDto> |
GroupApi.getGroupWithHttpInfo(String id)
Get Group
Retrieves a group by id.
|
ApiResponse<CountResultDto> |
HistoricActivityInstanceApi.getHistoricActivityInstancesCountWithHttpInfo(String activityInstanceId,
String processInstanceId,
String processDefinitionId,
String executionId,
String activityId,
String activityName,
String activityType,
String taskAssignee,
Boolean finished,
Boolean unfinished,
Boolean canceled,
Boolean completeScope,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
String tenantIdIn,
Boolean withoutTenantId)
Get List Count
Queries for the number of historic activity instances that fulfill the given parameters.
|
ApiResponse<List<HistoricActivityInstanceDto>> |
HistoricActivityInstanceApi.getHistoricActivityInstancesWithHttpInfo(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String activityInstanceId,
String processInstanceId,
String processDefinitionId,
String executionId,
String activityId,
String activityName,
String activityType,
String taskAssignee,
Boolean finished,
Boolean unfinished,
Boolean canceled,
Boolean completeScope,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
String tenantIdIn,
Boolean withoutTenantId)
Get List
Queries for historic activity instances that fulfill the given parameters.
|
ApiResponse<HistoricActivityInstanceDto> |
HistoricActivityInstanceApi.getHistoricActivityInstanceWithHttpInfo(String id)
Get
Retrieves a historic activity instance by id, according to the `HistoricActivityInstance` interface in the engine.
|
ApiResponse<List<DurationReportResultDto>> |
HistoricProcessInstanceApi.getHistoricProcessInstanceDurationReportWithHttpInfo(String reportType,
String periodUnit,
String processDefinitionIdIn,
String processDefinitionKeyIn,
Date startedBefore,
Date startedAfter)
Get Duration Report
Retrieves a report about the duration of completed process instances, grouped by a period.
|
ApiResponse<CountResultDto> |
HistoricProcessInstanceApi.getHistoricProcessInstancesCountWithHttpInfo(String processInstanceId,
String processInstanceIds,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String processDefinitionKeyNotIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyLike,
Boolean rootProcessInstances,
Boolean finished,
Boolean unfinished,
Boolean withIncidents,
Boolean withRootIncidents,
String incidentType,
String incidentStatus,
String incidentMessage,
String incidentMessageLike,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
Date executedActivityAfter,
Date executedActivityBefore,
Date executedJobAfter,
Date executedJobBefore,
String startedBy,
String superProcessInstanceId,
String subProcessInstanceId,
String superCaseInstanceId,
String subCaseInstanceId,
String caseInstanceId,
String tenantIdIn,
Boolean withoutTenantId,
String executedActivityIdIn,
String activeActivityIdIn,
Boolean active,
Boolean suspended,
Boolean completed,
Boolean externallyTerminated,
Boolean internallyTerminated,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase)
Get List Count
Queries for the number of historic process instances that fulfill the given parameters.
|
ApiResponse<List<HistoricProcessInstanceDto>> |
HistoricProcessInstanceApi.getHistoricProcessInstancesWithHttpInfo(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String processInstanceId,
String processInstanceIds,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String processDefinitionKeyNotIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyLike,
Boolean rootProcessInstances,
Boolean finished,
Boolean unfinished,
Boolean withIncidents,
Boolean withRootIncidents,
String incidentType,
String incidentStatus,
String incidentMessage,
String incidentMessageLike,
Date startedBefore,
Date startedAfter,
Date finishedBefore,
Date finishedAfter,
Date executedActivityAfter,
Date executedActivityBefore,
Date executedJobAfter,
Date executedJobBefore,
String startedBy,
String superProcessInstanceId,
String subProcessInstanceId,
String superCaseInstanceId,
String subCaseInstanceId,
String caseInstanceId,
String tenantIdIn,
Boolean withoutTenantId,
String executedActivityIdIn,
String activeActivityIdIn,
Boolean active,
Boolean suspended,
Boolean completed,
Boolean externallyTerminated,
Boolean internallyTerminated,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase)
Get List
Queries for historic process instances that fulfill the given parameters.
|
ApiResponse<HistoricProcessInstanceDto> |
HistoricProcessInstanceApi.getHistoricProcessInstanceWithHttpInfo(String id)
Get
Retrieves a historic process instance by id, according to the `HistoricProcessInstance` interface in the engine.
|
ApiResponse<List<IdentityLinkDto>> |
TaskIdentityLinkApi.getIdentityLinksWithHttpInfo(String id,
String type)
Get List
Gets the identity links for a task by id, which are the users and groups that are in *some* relation to it (including assignee and owner).
|
ApiResponse<List<CountResultDto>> |
IncidentApi.getIncidentsCountWithHttpInfo(String incidentId,
String incidentType,
String incidentMessage,
String incidentMessageLike,
String processDefinitionId,
String processDefinitionKeyIn,
String processInstanceId,
String executionId,
Date incidentTimestampBefore,
Date incidentTimestampAfter,
String activityId,
String failedActivityId,
String causeIncidentId,
String rootCauseIncidentId,
String _configuration,
String tenantIdIn,
String jobDefinitionIdIn)
Get List Count
Queries for the number of incidents that fulfill given parameters.
|
ApiResponse<List<IncidentDto>> |
IncidentApi.getIncidentsWithHttpInfo(String incidentId,
String incidentType,
String incidentMessage,
String incidentMessageLike,
String processDefinitionId,
String processDefinitionKeyIn,
String processInstanceId,
String executionId,
Date incidentTimestampBefore,
Date incidentTimestampAfter,
String activityId,
String failedActivityId,
String causeIncidentId,
String rootCauseIncidentId,
String _configuration,
String tenantIdIn,
String jobDefinitionIdIn,
String sortBy,
String sortOrder)
Get List
Queries for incidents that fulfill given parameters.
|
ApiResponse<IncidentDto> |
IncidentApi.getIncidentWithHttpInfo(String id)
Get Incident
Retrieves an incident by ID.
|
ApiResponse<CountResultDto> |
JobApi.getJobsCountWithHttpInfo(String jobId,
String jobIds,
String jobDefinitionId,
String processInstanceId,
String processInstanceIds,
String executionId,
String processDefinitionId,
String processDefinitionKey,
String activityId,
Boolean withRetriesLeft,
Boolean executable,
Boolean timers,
Boolean messages,
String dueDates,
String createTimes,
Boolean withException,
String exceptionMessage,
String failedActivityId,
Boolean noRetriesLeft,
Boolean active,
Boolean suspended,
Long priorityLowerThanOrEquals,
Long priorityHigherThanOrEquals,
String tenantIdIn,
Boolean withoutTenantId,
Boolean includeJobsWithoutTenantId)
Get Job Count
Queries for the number of jobs that fulfill given parameters.
|
ApiResponse<List<JobDto>> |
JobApi.getJobsWithHttpInfo(String jobId,
String jobIds,
String jobDefinitionId,
String processInstanceId,
String processInstanceIds,
String executionId,
String processDefinitionId,
String processDefinitionKey,
String activityId,
Boolean withRetriesLeft,
Boolean executable,
Boolean timers,
Boolean messages,
String dueDates,
String createTimes,
Boolean withException,
String exceptionMessage,
String failedActivityId,
Boolean noRetriesLeft,
Boolean active,
Boolean suspended,
Long priorityLowerThanOrEquals,
Long priorityHigherThanOrEquals,
String tenantIdIn,
Boolean withoutTenantId,
Boolean includeJobsWithoutTenantId,
String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults)
Get Jobs
Queries for jobs that fulfill given parameters.
|
ApiResponse<JobDto> |
JobApi.getJobWithHttpInfo(String id)
Get Job
Retrieves a job by id, according to the `Job` interface in the engine.
|
ApiResponse<ProcessDefinitionDto> |
ProcessDefinitionApi.getLatestProcessDefinitionByTenantIdWithHttpInfo(String key,
String tenantId)
Get
Retrieves the latest version of the process definition for tenant according to the `ProcessDefinition` interface in the engine.
|
ApiResponse<File> |
ExecutionApi.getLocalExecutionVariableBinaryWithHttpInfo(String id,
String varName)
Get Local Execution Variable (Binary)
Retrieves a binary variable from the context of a given execution by id.
|
ApiResponse<Map<String,VariableValueDto>> |
ExecutionApi.getLocalExecutionVariablesWithHttpInfo(String id,
Boolean deserializeValues)
Get Local Execution Variables
Retrieves all variables of a given execution by id.
|
ApiResponse<VariableValueDto> |
ExecutionApi.getLocalExecutionVariableWithHttpInfo(String id,
String varName,
Boolean deserializeValue)
Get Local Execution Variable
Retrieves a variable from the context of a given execution by id.
|
ApiResponse<EventSubscriptionDto> |
ExecutionApi.getMessageEventSubscriptionWithHttpInfo(String id,
String messageName)
Get Message Event Subscription
Retrieves a message event subscription for a given execution by id and a message name.
|
ApiResponse<MetricsResultDto> |
MetricsApi.getMetricsWithHttpInfo(String metricsName,
Date startDate,
Date endDate)
Get Sum
Retrieves the `sum` (count) for a given metric.
|
ApiResponse<PasswordPolicyDto> |
IdentityApi.getPasswordPolicyWithHttpInfo()
Get Password Policy
A password policy consists of a list of rules that new passwords must follow to be policy compliant.
|
ApiResponse<ProcessDefinitionDiagramDto> |
ProcessDefinitionApi.getProcessDefinitionBpmn20XmlByKeyAndTenantIdWithHttpInfo(String key,
String tenantId)
Get XML
Retrieves latest version the BPMN 2.0 XML of a process definition.
|
ApiResponse<ProcessDefinitionDiagramDto> |
ProcessDefinitionApi.getProcessDefinitionBpmn20XmlByKeyWithHttpInfo(String key)
Get XML
Retrieves latest version the BPMN 2.0 XML of a process definition.
|
ApiResponse<ProcessDefinitionDiagramDto> |
ProcessDefinitionApi.getProcessDefinitionBpmn20XmlWithHttpInfo(String id)
Get XML
Retrieves the BPMN 2.0 XML of a process definition.
|
ApiResponse<ProcessDefinitionDto> |
ProcessDefinitionApi.getProcessDefinitionByKeyWithHttpInfo(String key)
Get
Retrieves the latest version of the process definition which belongs to no tenant according to the `ProcessDefinition` interface in the engine.
|
ApiResponse<File> |
ProcessDefinitionApi.getProcessDefinitionDiagramByKeyAndTenantIdWithHttpInfo(String key,
String tenantId)
Get Diagram
Retrieves the diagram for the latest version of the process definition for tenant.
|
ApiResponse<File> |
ProcessDefinitionApi.getProcessDefinitionDiagramByKeyWithHttpInfo(String key)
Get Diagram
Retrieves the diagram for the latest version of the process definition which belongs to no tenant.
|
ApiResponse<File> |
ProcessDefinitionApi.getProcessDefinitionDiagramWithHttpInfo(String id)
Get Diagram
Retrieves the diagram of a process definition.
|
ApiResponse<CountResultDto> |
ProcessDefinitionApi.getProcessDefinitionsCountWithHttpInfo(String processDefinitionId,
String processDefinitionIdIn,
String name,
String nameLike,
String deploymentId,
Date deployedAfter,
Date deployedAt,
String key,
String keysIn,
String keyLike,
String category,
String categoryLike,
Integer version,
Boolean latestVersion,
String resourceName,
String resourceNameLike,
String startableBy,
Boolean active,
Boolean suspended,
String incidentId,
String incidentType,
String incidentMessage,
String incidentMessageLike,
String tenantIdIn,
Boolean withoutTenantId,
Boolean includeProcessDefinitionsWithoutTenantId,
String versionTag,
String versionTagLike,
Boolean withoutVersionTag,
Boolean startableInTasklist,
Boolean notStartableInTasklist,
Boolean startablePermissionCheck)
Get List Count
Requests the number of process definitions that fulfill the query criteria.
|
ApiResponse<List<ProcessDefinitionStatisticsResultDto>> |
ProcessDefinitionApi.getProcessDefinitionStatisticsWithHttpInfo(Boolean failedJobs,
Boolean incidents,
String incidentsForType,
Boolean rootIncidents)
Get Process Instance Statistics
Retrieves runtime statistics of the process engine, grouped by process definitions.
|
ApiResponse<List<ProcessDefinitionDto>> |
ProcessDefinitionApi.getProcessDefinitionsWithHttpInfo(String processDefinitionId,
String processDefinitionIdIn,
String name,
String nameLike,
String deploymentId,
Date deployedAfter,
Date deployedAt,
String key,
String keysIn,
String keyLike,
String category,
String categoryLike,
Integer version,
Boolean latestVersion,
String resourceName,
String resourceNameLike,
String startableBy,
Boolean active,
Boolean suspended,
String incidentId,
String incidentType,
String incidentMessage,
String incidentMessageLike,
String tenantIdIn,
Boolean withoutTenantId,
Boolean includeProcessDefinitionsWithoutTenantId,
String versionTag,
String versionTagLike,
Boolean withoutVersionTag,
Boolean startableInTasklist,
Boolean notStartableInTasklist,
Boolean startablePermissionCheck,
String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults)
Get List
Queries for process definitions that fulfill given parameters.
|
ApiResponse<ProcessDefinitionDto> |
ProcessDefinitionApi.getProcessDefinitionWithHttpInfo(String id)
Get
Retrieves a process definition according to the `ProcessDefinition` interface in the engine.
|
ApiResponse<List<ProcessEngineDto>> |
EngineApi.getProcessEngineNamesWithHttpInfo()
Get List
Retrieves the names of all process engines available on your platform.
|
ApiResponse<CountResultDto> |
ProcessInstanceApi.getProcessInstancesCountWithHttpInfo(String processInstanceIds,
String businessKey,
String businessKeyLike,
String caseInstanceId,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionKeyNotIn,
String deploymentId,
String superProcessInstance,
String subProcessInstance,
String superCaseInstance,
String subCaseInstance,
Boolean active,
Boolean suspended,
Boolean withIncident,
String incidentId,
String incidentType,
String incidentMessage,
String incidentMessageLike,
String tenantIdIn,
Boolean withoutTenantId,
Boolean processDefinitionWithoutTenantId,
String activityIdIn,
Boolean rootProcessInstances,
Boolean leafProcessInstances,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase)
Get List Count
Queries for the number of process instances that fulfill given parameters.
|
ApiResponse<List<ProcessInstanceDto>> |
ProcessInstanceApi.getProcessInstancesWithHttpInfo(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String processInstanceIds,
String businessKey,
String businessKeyLike,
String caseInstanceId,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionKeyNotIn,
String deploymentId,
String superProcessInstance,
String subProcessInstance,
String superCaseInstance,
String subCaseInstance,
Boolean active,
Boolean suspended,
Boolean withIncident,
String incidentId,
String incidentType,
String incidentMessage,
String incidentMessageLike,
String tenantIdIn,
Boolean withoutTenantId,
Boolean processDefinitionWithoutTenantId,
String activityIdIn,
Boolean rootProcessInstances,
Boolean leafProcessInstances,
String variables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase)
Get List
Queries for process instances that fulfill given parameters.
|
ApiResponse<File> |
ProcessInstanceApi.getProcessInstanceVariableBinaryWithHttpInfo(String id,
String varName)
Get Process Variable (Binary)
Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name.
|
ApiResponse<Map<String,VariableValueDto>> |
ProcessInstanceApi.getProcessInstanceVariablesWithHttpInfo(String id,
Boolean deserializeValues)
Get Process Variables
Retrieves all variables of a given process instance by id.
|
ApiResponse<VariableValueDto> |
ProcessInstanceApi.getProcessInstanceVariableWithHttpInfo(String id,
String varName,
Boolean deserializeValue)
Get Process Variable
Retrieves a variable of a given process instance by id.
|
ApiResponse<ProcessInstanceDto> |
ProcessInstanceApi.getProcessInstanceWithHttpInfo(String id)
Get Process Instance
Retrieves a process instance by id, according to the `ProcessInstance` interface in the engine.
|
ApiResponse<List<GroupDto>> |
GroupApi.getQueryGroupsWithHttpInfo(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String id,
String idIn,
String name,
String nameLike,
String type,
String member,
String memberOfTenant)
Get List
Queries for a list of groups using a list of parameters.
|
ApiResponse<File> |
TaskApi.getRenderedFormWithHttpInfo(String id)
Get Rendered Form
Retrieves the rendered form for a task.
|
ApiResponse<File> |
ProcessDefinitionApi.getRenderedStartFormByKeyAndTenantIdWithHttpInfo(String key,
String tenantId)
Get Rendered Start Form
Retrieves the rendered form for the latest version of the process definition for a tenant.
|
ApiResponse<File> |
ProcessDefinitionApi.getRenderedStartFormByKeyWithHttpInfo(String key)
Get Rendered Start Form
Retrieves the rendered form for the latest version of the process definition which belongs to no tenant.
|
ApiResponse<File> |
ProcessDefinitionApi.getRenderedStartFormWithHttpInfo(String id)
Get Rendered Start Form
Retrieves the rendered form for a process definition.
|
ApiResponse<VersionDto> |
VersionApi.getRestAPIVersionWithHttpInfo()
Get Rest API version
Retrieves the version of the Rest API.
|
ApiResponse<List<SchemaLogEntryDto>> |
SchemaLogApi.getSchemaLogWithHttpInfo(String version,
Integer firstResult,
Integer maxResults)
Get List
Queries for schema log entries that fulfill given parameters.
|
ApiResponse<Object> |
JobApi.getStacktraceWithHttpInfo(String id)
Get Exception Stacktrace
Retrieves the exception stacktrace corresponding to the passed job id.
|
ApiResponse<FormDto> |
ProcessDefinitionApi.getStartFormByKeyAndTenantIdWithHttpInfo(String key,
String tenantId)
Get Start Form Key
Retrieves the key of the start form for the latest version of the process definition for a tenant.
|
ApiResponse<FormDto> |
ProcessDefinitionApi.getStartFormByKeyWithHttpInfo(String key)
Get Start Form Key
Retrieves the key of the start form for the latest version of the process definition which belongs to no tenant.
|
ApiResponse<Map<String,VariableValueDto>> |
ProcessDefinitionApi.getStartFormVariablesByKeyAndTenantIdWithHttpInfo(String key,
String tenantId,
String variableNames,
Boolean deserializeValues)
Get Start Form Variables
Retrieves the start form variables for the latest process definition for a tenant (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.15/user-guide/task-forms/#generated-task-forms) approach).
|
ApiResponse<Map<String,VariableValueDto>> |
ProcessDefinitionApi.getStartFormVariablesByKeyWithHttpInfo(String key,
String variableNames,
Boolean deserializeValues)
Get Start Form Variables
Retrieves the start form variables for the latest process definition which belongs to no tenant (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.15/user-guide/task-forms/#generated-task-forms) approach).
|
ApiResponse<Map<String,VariableValueDto>> |
ProcessDefinitionApi.getStartFormVariablesWithHttpInfo(String id,
String variableNames,
Boolean deserializeValues)
Get Start Form Variables
Retrieves the start form variables for a process definition (only if they are defined via the [Generated Task Form](https://docs.camunda.org/manual/7.15/user-guide/task-forms/#generated-task-forms) approach).
|
ApiResponse<FormDto> |
ProcessDefinitionApi.getStartFormWithHttpInfo(String id)
Get Start Form Key
Retrieves the key of the start form for a process definition.
|
ApiResponse<File> |
TaskLocalVariableApi.getTaskLocalVariableBinaryWithHttpInfo(String id,
String varName)
Get Local Task Variable (Binary)
Retrieves a binary variable from the context of a given task by id.
|
ApiResponse<Map<String,VariableValueDto>> |
TaskLocalVariableApi.getTaskLocalVariablesWithHttpInfo(String id,
Boolean deserializeValues)
Get Local Task Variables
Retrieves all variables of a given task by id.
|
ApiResponse<VariableValueDto> |
TaskLocalVariableApi.getTaskLocalVariableWithHttpInfo(String id,
String varName,
Boolean deserializeValue)
Get Local Task Variable
Retrieves a variable from the context of a given task by id.
|
ApiResponse<CountResultDto> |
TaskApi.getTasksCountWithHttpInfo(String taskId,
String taskIdIn,
String processInstanceId,
String processInstanceIdIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyExpression,
String processInstanceBusinessKeyIn,
String processInstanceBusinessKeyLike,
String processInstanceBusinessKeyLikeExpression,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String executionId,
String caseInstanceId,
String caseInstanceBusinessKey,
String caseInstanceBusinessKeyLike,
String caseDefinitionId,
String caseDefinitionKey,
String caseDefinitionName,
String caseDefinitionNameLike,
String caseExecutionId,
String activityInstanceIdIn,
String tenantIdIn,
Boolean withoutTenantId,
String assignee,
String assigneeExpression,
String assigneeLike,
String assigneeLikeExpression,
String assigneeIn,
String owner,
String ownerExpression,
String candidateGroup,
String candidateGroupExpression,
String candidateUser,
String candidateUserExpression,
Boolean includeAssignedTasks,
String involvedUser,
String involvedUserExpression,
Boolean assigned,
Boolean unassigned,
String taskDefinitionKey,
String taskDefinitionKeyIn,
String taskDefinitionKeyLike,
String name,
String nameNotEqual,
String nameLike,
String nameNotLike,
String description,
String descriptionLike,
Integer priority,
Integer maxPriority,
Integer minPriority,
String dueDate,
String dueDateExpression,
String dueAfter,
String dueAfterExpression,
String dueBefore,
String dueBeforeExpression,
Boolean withoutDueDate,
String followUpDate,
String followUpDateExpression,
String followUpAfter,
String followUpAfterExpression,
String followUpBefore,
String followUpBeforeExpression,
String followUpBeforeOrNotExistent,
String followUpBeforeOrNotExistentExpression,
String createdOn,
String createdOnExpression,
String createdAfter,
String createdAfterExpression,
String createdBefore,
String createdBeforeExpression,
String delegationState,
String candidateGroups,
String candidateGroupsExpression,
Boolean withCandidateGroups,
Boolean withoutCandidateGroups,
Boolean withCandidateUsers,
Boolean withoutCandidateUsers,
Boolean active,
Boolean suspended,
String taskVariables,
String processVariables,
String caseInstanceVariables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase,
String parentTaskId)
Get List Count
Retrieves the number of tasks that fulfill a provided filter.
|
ApiResponse<List<TaskDto>> |
TaskApi.getTasksWithHttpInfo(String taskId,
String taskIdIn,
String processInstanceId,
String processInstanceIdIn,
String processInstanceBusinessKey,
String processInstanceBusinessKeyExpression,
String processInstanceBusinessKeyIn,
String processInstanceBusinessKeyLike,
String processInstanceBusinessKeyLikeExpression,
String processDefinitionId,
String processDefinitionKey,
String processDefinitionKeyIn,
String processDefinitionName,
String processDefinitionNameLike,
String executionId,
String caseInstanceId,
String caseInstanceBusinessKey,
String caseInstanceBusinessKeyLike,
String caseDefinitionId,
String caseDefinitionKey,
String caseDefinitionName,
String caseDefinitionNameLike,
String caseExecutionId,
String activityInstanceIdIn,
String tenantIdIn,
Boolean withoutTenantId,
String assignee,
String assigneeExpression,
String assigneeLike,
String assigneeLikeExpression,
String assigneeIn,
String owner,
String ownerExpression,
String candidateGroup,
String candidateGroupExpression,
String candidateUser,
String candidateUserExpression,
Boolean includeAssignedTasks,
String involvedUser,
String involvedUserExpression,
Boolean assigned,
Boolean unassigned,
String taskDefinitionKey,
String taskDefinitionKeyIn,
String taskDefinitionKeyLike,
String name,
String nameNotEqual,
String nameLike,
String nameNotLike,
String description,
String descriptionLike,
Integer priority,
Integer maxPriority,
Integer minPriority,
String dueDate,
String dueDateExpression,
String dueAfter,
String dueAfterExpression,
String dueBefore,
String dueBeforeExpression,
Boolean withoutDueDate,
String followUpDate,
String followUpDateExpression,
String followUpAfter,
String followUpAfterExpression,
String followUpBefore,
String followUpBeforeExpression,
String followUpBeforeOrNotExistent,
String followUpBeforeOrNotExistentExpression,
String createdOn,
String createdOnExpression,
String createdAfter,
String createdAfterExpression,
String createdBefore,
String createdBeforeExpression,
String delegationState,
String candidateGroups,
String candidateGroupsExpression,
Boolean withCandidateGroups,
Boolean withoutCandidateGroups,
Boolean withCandidateUsers,
Boolean withoutCandidateUsers,
Boolean active,
Boolean suspended,
String taskVariables,
String processVariables,
String caseInstanceVariables,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase,
String parentTaskId,
String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults)
Get List
Queries for tasks that fulfill a given filter.
|
ApiResponse<File> |
TaskVariableApi.getTaskVariableBinaryWithHttpInfo(String id,
String varName)
Get Task Variable (Binary)
Retrieves a binary variable from the context of a given task.
|
ApiResponse<Map<String,VariableValueDto>> |
TaskVariableApi.getTaskVariablesWithHttpInfo(String id,
Boolean deserializeValues)
Get Task Variables
Retrieves all variables visible from the task.
|
ApiResponse<VariableValueDto> |
TaskVariableApi.getTaskVariableWithHttpInfo(String id,
String varName,
Boolean deserializeValue)
Get Task Variable
Retrieves a variable from the context of a given task.
|
ApiResponse<TaskDto> |
TaskApi.getTaskWithHttpInfo(String id)
Get
Retrieves a task by id.
|
ApiResponse<TelemetryConfigurationDto> |
TelemetryApi.getTelemetryConfigurationWithHttpInfo()
Fetch Telemetry Configuration
Fetches Telemetry Configuration.
|
ApiResponse<CountResultDto> |
TenantApi.getTenantCountWithHttpInfo(String id,
String name,
String nameLike,
String userMember,
String groupMember,
Boolean includingGroupsOfUser)
Get Tenant Count
Query for tenants using a list of parameters and retrieves the count.
|
ApiResponse<TenantDto> |
TenantApi.getTenantWithHttpInfo(String id)
Get Tenant
Retrieves a tenant.
|
ApiResponse<List<String>> |
ExternalTaskApi.getTopicNamesWithHttpInfo(Boolean withLockedTasks,
Boolean withUnlockedTasks,
Boolean withRetriesLeft)
Get External Task Topic Names
Queries for distinct topic names of external tasks that fulfill given parameters.
|
ApiResponse<CountResultDto> |
UserApi.getUserCountWithHttpInfo(String id,
String idIn,
String firstName,
String firstNameLike,
String lastName,
String lastNameLike,
String email,
String emailLike,
String memberOfGroup,
String memberOfTenant,
String potentialStarter)
Get List Count
Queries for the number of deployments that fulfill given parameters.
|
ApiResponse<UserProfileDto> |
UserApi.getUserProfileWithHttpInfo(String id)
Get Profile
Retrieves a user's profile.
|
ApiResponse<List<UserProfileDto>> |
UserApi.getUsersWithHttpInfo(String id,
String idIn,
String firstName,
String firstNameLike,
String lastName,
String lastNameLike,
String email,
String emailLike,
String memberOfGroup,
String memberOfTenant,
String potentialStarter,
String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults)
Get List
Query for a list of users using a list of parameters.
|
ApiResponse<File> |
VariableInstanceApi.getVariableInstanceBinaryWithHttpInfo(String id)
Get Variable Instance (Binary)
Retrieves the content of a variable by id.
|
ApiResponse<CountResultDto> |
VariableInstanceApi.getVariableInstancesCountWithHttpInfo(String variableName,
String variableNameLike,
String processInstanceIdIn,
String executionIdIn,
String caseInstanceIdIn,
String caseExecutionIdIn,
String taskIdIn,
String batchIdIn,
String activityInstanceIdIn,
String tenantIdIn,
String variableValues,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase,
String sortBy,
String sortOrder)
Get Variable Instance Count
Query for the number of variable instances that fulfill given parameters.
|
ApiResponse<List<VariableInstanceDto>> |
VariableInstanceApi.getVariableInstancesWithHttpInfo(String variableName,
String variableNameLike,
String processInstanceIdIn,
String executionIdIn,
String caseInstanceIdIn,
String caseExecutionIdIn,
String taskIdIn,
String batchIdIn,
String activityInstanceIdIn,
String tenantIdIn,
String variableValues,
Boolean variableNamesIgnoreCase,
Boolean variableValuesIgnoreCase,
String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
Boolean deserializeValues)
Get Variable Instances
Query for variable instances that fulfill given parameters.
|
ApiResponse<VariableInstanceDto> |
VariableInstanceApi.getVariableInstanceWithHttpInfo(String id,
Boolean deserializeValue)
Get Variable Instance
Retrieves a variable by id.
|
ApiResponse<Void> |
TaskApi.handleBpmnErrorWithHttpInfo(String id,
TaskBpmnErrorDto taskBpmnErrorDto)
Handle BPMN Error
Reports a business error in the context of a running task by id.
|
ApiResponse<Void> |
TaskApi.handleEscalationWithHttpInfo(String id,
TaskEscalationDto taskEscalationDto)
Handle BPMN Escalation
Reports an escalation in the context of a running task by id.
|
ApiResponse<Void> |
ExternalTaskApi.handleExternalTaskBpmnErrorWithHttpInfo(String id,
ExternalTaskBpmnError externalTaskBpmnError)
Handle BPMN Error
Reports a business error in the context of a running external task by id.
|
ApiResponse<Void> |
ExternalTaskApi.handleFailureWithHttpInfo(String id,
ExternalTaskFailureDto externalTaskFailureDto)
Handle Failure
Reports a failure to execute an external task by id.
|
ApiResponse<List<MetricsIntervalResultDto>> |
MetricsApi.intervalWithHttpInfo(String name,
String reporter,
Date startDate,
Date endDate,
Integer firstResult,
Integer maxResults,
String interval,
String aggregateByReporter)
Get Metrics in Interval
Retrieves a list of metrics, aggregated for a given interval.
|
ApiResponse<Void> |
ExternalTaskApi.lockWithHttpInfo(String id,
LockExternalTaskDto lockExternalTaskDto)
Lock an external task by a given id for a specified worker and amount of time.
|
ApiResponse<Void> |
ExecutionApi.modifyLocalExecutionVariablesWithHttpInfo(String id,
PatchVariablesDto patchVariablesDto)
Update/Delete Local Execution Variables
Updates or deletes the variables in the context of an execution by id.
|
ApiResponse<BatchDto> |
ProcessInstanceApi.modifyProcessInstanceAsyncOperationWithHttpInfo(String id,
ProcessInstanceModificationDto processInstanceModificationDto)
Modify Process Instance Execution State Async
Submits a list of modification instructions to change a process instance's execution state async.
|
ApiResponse<Void> |
ProcessInstanceApi.modifyProcessInstanceVariablesWithHttpInfo(String id,
PatchVariablesDto patchVariablesDto)
Update/Delete Process Variables
Updates or deletes the variables of a process instance by id.
|
ApiResponse<Void> |
ProcessInstanceApi.modifyProcessInstanceWithHttpInfo(String id,
ProcessInstanceModificationDto processInstanceModificationDto)
Modify Process Instance Execution State
Submits a list of modification instructions to change a process instance's execution state.
|
ApiResponse<Void> |
TaskLocalVariableApi.modifyTaskLocalVariablesWithHttpInfo(String id,
PatchVariablesDto patchVariablesDto)
Update/Delete Local Task Variables
Updates or deletes the variables in the context of a task.
|
ApiResponse<Void> |
TaskVariableApi.modifyTaskVariablesWithHttpInfo(String id,
PatchVariablesDto patchVariablesDto)
Update/Delete Task Variables
Updates or deletes the variables visible from the task.
|
ApiResponse<List<GroupDto>> |
GroupApi.postQueryGroupsWithHttpInfo(Integer firstResult,
Integer maxResults,
GroupQueryDto groupQueryDto)
Get List (POST)
Queries for a list of groups using a list of parameters.
|
ApiResponse<Void> |
ExecutionApi.putLocalExecutionVariableWithHttpInfo(String id,
String varName,
VariableValueDto variableValueDto)
Put Local Execution Variable
Sets a variable in the context of a given execution by id.
|
ApiResponse<Void> |
TaskLocalVariableApi.putTaskLocalVariableWithHttpInfo(String id,
String varName,
VariableValueDto variableValueDto)
Update Local Task Variable
Sets a variable in the context of a given task.
|
ApiResponse<Void> |
TaskVariableApi.putTaskVariableWithHttpInfo(String id,
String varName,
VariableValueDto variableValueDto)
Update Task Variable
Updates a process variable that is visible from the Task scope.
|
ApiResponse<CountResultDto> |
ExecutionApi.queryExecutionsCountWithHttpInfo(ExecutionQueryDto executionQueryDto)
Get Execution Count (POST)
Queries for the number of executions that fulfill given parameters.
|
ApiResponse<List<ExecutionDto>> |
ExecutionApi.queryExecutionsWithHttpInfo(Integer firstResult,
Integer maxResults,
ExecutionQueryDto executionQueryDto)
Get Executions (POST)
Queries for executions that fulfill given parameters through a JSON object.
|
ApiResponse<CountResultDto> |
ExternalTaskApi.queryExternalTasksCountWithHttpInfo(ExternalTaskQueryDto externalTaskQueryDto)
Get List Count (POST)
Queries for the number of external tasks that fulfill given parameters.
|
ApiResponse<List<ExternalTaskDto>> |
ExternalTaskApi.queryExternalTasksWithHttpInfo(Integer firstResult,
Integer maxResults,
ExternalTaskQueryDto externalTaskQueryDto)
Get List (POST)
Queries for external tasks that fulfill given parameters in the form of a JSON object.
|
ApiResponse<CountResultDto> |
GroupApi.queryGroupCountWithHttpInfo(GroupQueryDto groupQueryDto)
Get List Count (POST)
Queries for groups using a list of parameters and retrieves the count.
|
ApiResponse<CountResultDto> |
HistoricActivityInstanceApi.queryHistoricActivityInstancesCountWithHttpInfo(HistoricActivityInstanceQueryDto historicActivityInstanceQueryDto)
Get List Count (POST)
Queries for the number of historic activity instances that fulfill the given parameters.
|
ApiResponse<List<HistoricActivityInstanceDto>> |
HistoricActivityInstanceApi.queryHistoricActivityInstancesWithHttpInfo(Integer firstResult,
Integer maxResults,
HistoricActivityInstanceQueryDto historicActivityInstanceQueryDto)
Get List (POST)
Queries for historic activity instances that fulfill the given parameters.
|
ApiResponse<CountResultDto> |
HistoricProcessInstanceApi.queryHistoricProcessInstancesCountWithHttpInfo(HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto)
Get List Count (POST)
Queries for the number of historic process instances that fulfill the given parameters.
|
ApiResponse<List<HistoricProcessInstanceDto>> |
HistoricProcessInstanceApi.queryHistoricProcessInstancesWithHttpInfo(Integer firstResult,
Integer maxResults,
HistoricProcessInstanceQueryDto historicProcessInstanceQueryDto)
Get List (POST)
Queries for historic process instances that fulfill the given parameters.
|
ApiResponse<CountResultDto> |
JobApi.queryJobsCountWithHttpInfo(JobQueryDto jobQueryDto)
Get Job Count (POST)
Queries for jobs that fulfill given parameters.
|
ApiResponse<List<JobDto>> |
JobApi.queryJobsWithHttpInfo(Integer firstResult,
Integer maxResults,
JobQueryDto jobQueryDto)
Get Jobs (POST)
Queries for jobs that fulfill given parameters.
|
ApiResponse<CountResultDto> |
ProcessInstanceApi.queryProcessInstancesCountWithHttpInfo(ProcessInstanceQueryDto processInstanceQueryDto)
Get List Count (POST)
Queries for the number of process instances that fulfill the given parameters.
|
ApiResponse<List<ProcessInstanceDto>> |
ProcessInstanceApi.queryProcessInstancesWithHttpInfo(Integer firstResult,
Integer maxResults,
ProcessInstanceQueryDto processInstanceQueryDto)
Get List (POST)
Queries for process instances that fulfill given parameters through a JSON object.
|
ApiResponse<List<SchemaLogEntryDto>> |
SchemaLogApi.querySchemaLogWithHttpInfo(Integer firstResult,
Integer maxResults,
SchemaLogQueryDto schemaLogQueryDto)
Get List (POST)
Queries for schema log entries that fulfill given parameters.
|
ApiResponse<CountResultDto> |
TaskApi.queryTasksCountWithHttpInfo(TaskQueryDto taskQueryDto)
Get List Count (POST)
Retrieves the number of tasks that fulfill the given filter.
|
ApiResponse<List<TaskDto>> |
TaskApi.queryTasksWithHttpInfo(Integer firstResult,
Integer maxResults,
TaskQueryDto taskQueryDto)
Get List (POST)
Queries for tasks that fulfill a given filter.
|
ApiResponse<List<TenantDto>> |
TenantApi.queryTenantsWithHttpInfo(String sortBy,
String sortOrder,
Integer firstResult,
Integer maxResults,
String id,
String name,
String nameLike,
String userMember,
String groupMember,
Boolean includingGroupsOfUser)
Get Tenants
Query for a list of tenants using a list of parameters.
|
ApiResponse<CountResultDto> |
VariableInstanceApi.queryVariableInstancesCountWithHttpInfo(VariableInstanceQueryDto variableInstanceQueryDto)
Get Variable Instance Count (POST)
Query for the number of variable instances that fulfill given parameters.
|
ApiResponse<List<VariableInstanceDto>> |
VariableInstanceApi.queryVariableInstancesWithHttpInfo(Integer firstResult,
Integer maxResults,
Boolean deserializeValues,
VariableInstanceQueryDto variableInstanceQueryDto)
Get Variable Instances (POST)
Query for variable instances that fulfill given parameters through a JSON object.
|
ApiResponse<Void> |
JobApi.recalculateDuedateWithHttpInfo(String id,
Boolean creationDateBased)
Recalculate Job Due Date
Recalculates the due date of a job by id.
|
ApiResponse<DeploymentWithDefinitionsDto> |
DeploymentApi.redeployWithHttpInfo(String id,
RedeploymentDto redeploymentDto)
Redeploy
Re-deploys an existing deployment.
|
ApiResponse<Void> |
IncidentApi.resolveIncidentWithHttpInfo(String id)
Resolve Incident
Resolves an incident with given id.
|
ApiResponse<Void> |
TaskApi.resolveWithHttpInfo(String id,
CompleteTaskDto completeTaskDto)
Resolve
Resolves a task and updates execution variables.
|
ApiResponse<BatchDto> |
ProcessDefinitionApi.restartProcessInstanceAsyncOperationWithHttpInfo(String id,
RestartProcessInstanceDto restartProcessInstanceDto)
Restart Process Instance Async
Restarts process instances that were canceled or terminated asynchronously.
|
ApiResponse<Void> |
ProcessDefinitionApi.restartProcessInstanceWithHttpInfo(String id,
RestartProcessInstanceDto restartProcessInstanceDto)
Restart Process Instance
Restarts process instances that were canceled or terminated synchronously.
|
ApiResponse<Void> |
TaskApi.setAssigneeWithHttpInfo(String id,
UserIdDto userIdDto)
Set Assignee
Changes the assignee of a task to a specific user.
|
ApiResponse<Void> |
TaskLocalVariableApi.setBinaryTaskLocalVariableWithHttpInfo(String id,
String varName,
File data,
String valueType)
Update Local Task Variable (Binary)
Sets the serialized value for a binary variable or the binary value for a file variable.
|
ApiResponse<Void> |
TaskVariableApi.setBinaryTaskVariableWithHttpInfo(String id,
String varName,
File data,
String valueType)
Update Task Variable (Binary)
Sets the serialized value for a binary variable or the binary value for a file variable visible from the task.
|
ApiResponse<Void> |
ExternalTaskApi.setExternalTaskResourcePriorityWithHttpInfo(String id,
PriorityDto priorityDto)
Set Priority
Sets the priority of an existing external task by id.
|
ApiResponse<Void> |
ExternalTaskApi.setExternalTaskResourceRetriesWithHttpInfo(String id,
RetriesDto retriesDto)
Set Retries
Sets the number of retries left to execute an external task by id.
|
ApiResponse<BatchDto> |
ExternalTaskApi.setExternalTaskRetriesAsyncOperationWithHttpInfo(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto)
Set Retries Async
Sets the number of retries left to execute external tasks by id asynchronously.
|
ApiResponse<Void> |
ExternalTaskApi.setExternalTaskRetriesWithHttpInfo(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto)
Set Retries Sync
Sets the number of retries left to execute external tasks by id synchronously.
|
ApiResponse<Void> |
IncidentApi.setIncidentAnnotationWithHttpInfo(String id,
AnnotationDto annotationDto)
Set Incident Annotation
Sets the annotation of an incident with given id.
|
ApiResponse<Void> |
JobApi.setJobDuedateWithHttpInfo(String id,
JobDuedateDto jobDuedateDto)
Set Job Due Date
Updates the due date of a job by id.
|
ApiResponse<Void> |
JobApi.setJobPriorityWithHttpInfo(String id,
PriorityDto priorityDto)
Set Job Priority
Sets the execution priority of a job by id.
|
ApiResponse<BatchDto> |
JobApi.setJobRetriesAsyncOperationWithHttpInfo(SetJobRetriesDto setJobRetriesDto)
Set Job Retries Async (POST)
Create a batch to set retries of jobs asynchronously.
|
ApiResponse<Void> |
JobApi.setJobRetriesWithHttpInfo(String id,
RetriesDto retriesDto)
Set Job Retries
Sets the retries of the job to the given number of retries by id.
|
ApiResponse<Void> |
ExecutionApi.setLocalExecutionVariableBinaryWithHttpInfo(String id,
String varName,
File data,
String valueType)
Post Local Execution Variable (Binary)
Sets the serialized value for a binary variable or the binary value for a file variable in the context of a given execution by id.
|
ApiResponse<Void> |
ProcessInstanceApi.setProcessInstanceVariableBinaryWithHttpInfo(String id,
String varName,
File data,
String valueType)
Update Process Variable (Binary)
Sets the serialized value for a binary variable or the binary value for a file variable.
|
ApiResponse<Void> |
ProcessInstanceApi.setProcessInstanceVariableWithHttpInfo(String id,
String varName,
VariableValueDto variableValueDto)
Update Process Variable
Sets a variable of a given process instance by id.
|
ApiResponse<BatchDto> |
HistoricProcessInstanceApi.setRemovalTimeAsyncWithHttpInfo(SetRemovalTimeToHistoricProcessInstancesDto setRemovalTimeToHistoricProcessInstancesDto)
Set Removal Time Async (POST)
Sets the removal time to multiple historic process instances asynchronously (batch).
|
ApiResponse<BatchDto> |
ProcessInstanceApi.setRetriesByProcessHistoricQueryBasedWithHttpInfo(SetJobRetriesByProcessDto setJobRetriesByProcessDto)
Set Job Retries Async Historic Query Based (POST)
Create a batch to set retries of jobs asynchronously based on a historic process instance query.
|
ApiResponse<BatchDto> |
ProcessInstanceApi.setRetriesByProcessWithHttpInfo(SetJobRetriesByProcessDto setJobRetriesByProcessDto)
Set Job Retries Async (POST)
Create a batch to set retries of jobs associated with given processes asynchronously.
|
ApiResponse<BatchDto> |
ProcessInstanceApi.setVariablesAsyncOperationWithHttpInfo(SetVariablesAsyncDto setVariablesAsyncDto)
Set Variables Async (POST)
Update or create runtime process variables in the root scope of process instances.
|
ApiResponse<Void> |
ExecutionApi.signalExecutionWithHttpInfo(String id,
ExecutionTriggerDto executionTriggerDto)
Trigger Execution
Signals an execution by id.
|
ApiResponse<ProcessInstanceWithVariablesDto> |
ProcessDefinitionApi.startProcessInstanceByKeyAndTenantIdWithHttpInfo(String key,
String tenantId,
StartProcessInstanceDto startProcessInstanceDto)
Start Instance
Instantiates a given process definition, starts the latest version of the process definition for tenant.
|
ApiResponse<ProcessInstanceWithVariablesDto> |
ProcessDefinitionApi.startProcessInstanceByKeyWithHttpInfo(String key,
StartProcessInstanceDto startProcessInstanceDto)
Start Instance
Instantiates a given process definition, starts the latest version of the process definition which belongs to no tenant.
|
ApiResponse<ProcessInstanceWithVariablesDto> |
ProcessDefinitionApi.startProcessInstanceWithHttpInfo(String id,
StartProcessInstanceDto startProcessInstanceDto)
Start Instance
Instantiates a given process definition.
|
ApiResponse<ProcessInstanceDto> |
ProcessDefinitionApi.submitFormByKeyAndTenantIdWithHttpInfo(String key,
String tenantId,
StartProcessInstanceFormDto startProcessInstanceFormDto)
Submit Start Form
Starts the latest version of the process definition for a tenant using a set of process variables and the business key.
|
ApiResponse<ProcessInstanceDto> |
ProcessDefinitionApi.submitFormByKeyWithHttpInfo(String key,
StartProcessInstanceFormDto startProcessInstanceFormDto)
Submit Start Form
Starts the latest version of the process definition which belongs to no tenant using a set of process variables and the business key.
|
ApiResponse<ProcessInstanceDto> |
ProcessDefinitionApi.submitFormWithHttpInfo(String id,
StartProcessInstanceFormDto startProcessInstanceFormDto)
Submit Start Form
Starts a process instance using a set of process variables and the business key.
|
ApiResponse<Map<String,VariableValueDto>> |
TaskApi.submitWithHttpInfo(String id,
CompleteTaskDto completeTaskDto)
Submit Form
Completes a task and updates process variables using a form submit.
|
ApiResponse<Void> |
SignalApi.throwSignalWithHttpInfo(SignalDto signalDto)
Event
A signal is an event of global scope (broadcast semantics) and is delivered to all active handlers.
|
ApiResponse<Void> |
ExecutionApi.triggerEventWithHttpInfo(String id,
String messageName,
ExecutionTriggerDto executionTriggerDto)
Trigger Message Event Subscription
Delivers a message to a specific execution by id, to trigger an existing message event subscription.
|
ApiResponse<Void> |
TaskApi.unclaimWithHttpInfo(String id)
Unclaim
Resets a task's assignee.
|
ApiResponse<Void> |
UserApi.unlockUserWithHttpInfo(String id)
Unlock User
Unlocks a user by id.
|
ApiResponse<Void> |
ExternalTaskApi.unlockWithHttpInfo(String id)
Unlock
Unlocks an external task by id.
|
ApiResponse<Void> |
BatchApi.updateBatchSuspensionStateWithHttpInfo(String id,
SuspensionStateDto suspensionStateDto)
Activate/Suspend
Activates or suspends a batch by id.
|
ApiResponse<Object> |
UserApi.updateCredentialsWithHttpInfo(String id,
String password,
String authenticatedUserPassword,
UserCredentialsDto userCredentialsDto)
Update Credentials
Updates a user's credentials (password)
|
ApiResponse<Void> |
GroupApi.updateGroupWithHttpInfo(String id,
GroupDto groupDto)
Update Group
Updates a given group by id.
|
ApiResponse<Void> |
DecisionDefinitionApi.updateHistoryTimeToLiveByDecisionDefinitionIdWithHttpInfo(String id,
HistoryTimeToLiveDto historyTimeToLiveDto)
Update History Time to Live
Updates history time to live for decision definition.
|
ApiResponse<Void> |
DecisionDefinitionApi.updateHistoryTimeToLiveByDecisionDefinitionKeyAndTenantWithHttpInfo(String key,
String tenantId,
HistoryTimeToLiveDto historyTimeToLiveDto)
Update History Time to Live By Key And Tenant
Updates the latest version of the decision definition for tenant.
|
ApiResponse<Void> |
DecisionDefinitionApi.updateHistoryTimeToLiveByDecisionDefinitionKeyWithHttpInfo(String key,
HistoryTimeToLiveDto historyTimeToLiveDto)
Update History Time to Live By Key
Updates the latest version of the decision definition which belongs to no tenant.
|
ApiResponse<Void> |
ProcessDefinitionApi.updateHistoryTimeToLiveByProcessDefinitionIdWithHttpInfo(String id,
HistoryTimeToLiveDto historyTimeToLiveDto)
Update History Time to Live
Updates history time to live for process definition.
|
ApiResponse<Void> |
ProcessDefinitionApi.updateHistoryTimeToLiveByProcessDefinitionKeyAndTenantIdWithHttpInfo(String key,
String tenantId,
HistoryTimeToLiveDto historyTimeToLiveDto)
Update History Time to Live
Updates history time to live for the latest version of the process definition for a tenant.
|
ApiResponse<Void> |
ProcessDefinitionApi.updateHistoryTimeToLiveByProcessDefinitionKeyWithHttpInfo(String key,
HistoryTimeToLiveDto historyTimeToLiveDto)
Update History Time to Live
Updates history time to live for the latest version of the process definition which belongs to no tenant.
|
ApiResponse<Void> |
JobApi.updateJobSuspensionStateWithHttpInfo(String id,
SuspensionStateDto suspensionStateDto)
Activate/Suspend Job By Id
Activates or suspends a given job by id.
|
ApiResponse<Void> |
ProcessDefinitionApi.updateProcessDefinitionSuspensionStateByIdWithHttpInfo(String id,
ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto)
Activate/Suspend By Id
Activates or suspends a given process definition by id.
|
ApiResponse<Void> |
ProcessDefinitionApi.updateProcessDefinitionSuspensionStateByKeyAndTenantIdWithHttpInfo(String key,
String tenantId,
ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto)
Activate/Suspend by Id
Activates or suspends a given process definition by the latest version of the process definition for tenant.
|
ApiResponse<Void> |
ProcessDefinitionApi.updateProcessDefinitionSuspensionStateByKeyWithHttpInfo(String key,
ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto)
Activate/Suspend by Id
Activates or suspends a given process definition by latest version of process definition key which belongs to no tenant.
|
ApiResponse<Void> |
ProcessDefinitionApi.updateProcessDefinitionSuspensionStateWithHttpInfo(ProcessDefinitionSuspensionStateDto processDefinitionSuspensionStateDto)
Activate/Suspend By Key
Activates or suspends process definitions with the given process definition key.
|
ApiResponse<Void> |
UserApi.updateProfileWithHttpInfo(String id,
UserProfileDto userProfileDto)
Update User Profile
Updates the profile information of an already existing user.
|
ApiResponse<BatchDto> |
ProcessInstanceApi.updateSuspensionStateAsyncOperationWithHttpInfo(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto)
Activate/Suspend In Batch
Activates or suspends process instances asynchronously with a list of process instance ids, a process instance query, and/or a historical process instance query.
|
ApiResponse<Void> |
ProcessInstanceApi.updateSuspensionStateByIdWithHttpInfo(String id,
SuspensionStateDto suspensionStateDto)
Activate/Suspend Process Instance By Id
Activates or suspends a given process instance by id.
|
ApiResponse<Void> |
JobApi.updateSuspensionStateByWithHttpInfo(JobSuspensionStateDto jobSuspensionStateDto)
Activate/Suspend Jobs
Activates or suspends jobs matching the given criterion.
|
ApiResponse<Void> |
ProcessInstanceApi.updateSuspensionStateWithHttpInfo(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto)
Activate/Suspend In Group
Activates or suspends process instances by providing certain criteria: # Activate/Suspend Process Instance By Process Definition Id * `suspend` * `processDefinitionId` # Activate/Suspend Process Instance By Process Definition Key * `suspend` * `processDefinitionKey` * `processDefinitionTenantId` * `processDefinitionWithoutTenantId` # Activate/Suspend Process Instance In Group * `suspend` * `processInstanceIds` * `processInstanceQuery` * `historicProcessInstanceQuery`
|
ApiResponse<Void> |
TaskApi.updateTaskWithHttpInfo(String id,
TaskDto taskDto)
Update
Updates a task.
|
ApiResponse<Void> |
TenantApi.updateTenantWithHttpInfo(String id,
TenantDto tenantDto)
Update Tenant
Updates a given tenant.
|
ApiResponse<AuthenticationResult> |
IdentityApi.verifyUserWithHttpInfo(BasicUserCredentialsDto basicUserCredentialsDto)
Verify User
Verifies that user credentials are valid.
|
Copyright © 2022. All rights reserved.