| 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)
Creates an attachment for a task.
|
ApiResponse<Void> |
TaskIdentityLinkApi.addIdentityLinkWithHttpInfo(String id,
IdentityLinkDto identityLinkDto)
Adds an identity link to a task by id.
|
ApiResponse<Void> |
TaskApi.claimWithHttpInfo(String id,
UserIdDto userIdDto)
Claims a task for a specific user.
|
ApiResponse<Void> |
ExternalTaskApi.completeExternalTaskResourceWithHttpInfo(String id,
CompleteExternalTaskDto completeExternalTaskDto)
Completes an external task by id and updates process variables.
|
ApiResponse<Map<String,VariableValueDto>> |
TaskApi.completeWithHttpInfo(String id,
CompleteTaskDto completeTaskDto)
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)
Creates a comment for a task by id.
|
ApiResponse<DeploymentWithDefinitionsDto> |
DeploymentApi.createDeploymentWithHttpInfo(String tenantId,
String deploymentSource,
Boolean deployChangedOnly,
Boolean enableDuplicateFiltering,
String deploymentName,
File data)
Creates a deployment.
|
ApiResponse<Void> |
TaskApi.createTaskWithHttpInfo(TaskDto taskDto)
Creates a new task.
|
ApiResponse<Void> |
TaskApi.delegateTaskWithHttpInfo(String id,
UserIdDto userIdDto)
Delegates a task to another user.
|
ApiResponse<BatchDto> |
ProcessInstanceApi.deleteAsyncHistoricQueryBasedWithHttpInfo(DeleteProcessInstancesDto deleteProcessInstancesDto)
Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
|
ApiResponse<Void> |
TaskAttachmentApi.deleteAttachmentWithHttpInfo(String id,
String attachmentId)
Removes an attachment from a task by id.
|
ApiResponse<Void> |
DeploymentApi.deleteDeploymentWithHttpInfo(String id,
Boolean cascade,
Boolean skipCustomListeners,
Boolean skipIoMappings)
Deletes a deployment by id.
|
ApiResponse<Void> |
TaskIdentityLinkApi.deleteIdentityLinkWithHttpInfo(String id,
IdentityLinkDto identityLinkDto)
Removes an identity link from a task 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)
Deletes multiple process instances asynchronously (batch).
|
ApiResponse<Void> |
ProcessInstanceApi.deleteProcessInstanceVariableWithHttpInfo(String id,
String varName)
Deletes a variable of a process instance by id.
|
ApiResponse<Void> |
ProcessInstanceApi.deleteProcessInstanceWithHttpInfo(String id,
Boolean skipCustomListeners,
Boolean skipIoMappings,
Boolean skipSubprocesses,
Boolean failIfNotExists)
Deletes a running process instance by id.
|
ApiResponse<Void> |
TaskLocalVariableApi.deleteTaskLocalVariableWithHttpInfo(String id,
String varName)
Removes a local variable from a task by id.
|
ApiResponse<Void> |
TaskVariableApi.deleteTaskVariableWithHttpInfo(String id,
String varName)
Removes a variable that is visible to a task.
|
ApiResponse<Void> |
TaskApi.deleteTaskWithHttpInfo(String id)
Removes a task by id.
|
ApiResponse<List<MessageCorrelationResultWithVariableDto>> |
MessageApi.deliverMessageWithHttpInfo(CorrelationMessageDto correlationMessageDto)
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)
Triggers evaluation of conditions for conditional start event(s).
|
ApiResponse<Void> |
ExternalTaskApi.extendLockWithHttpInfo(String id,
ExtendLockOnExternalTaskDto extendLockOnExternalTaskDto)
Extends the timeout of the lock by a given amount of time.
|
ApiResponse<List<LockedExternalTaskDto>> |
ExternalTaskApi.fetchAndLockWithHttpInfo(FetchExternalTasksDto fetchExternalTasksDto)
Fetches and locks a specific number of external tasks for execution by a worker.
|
ApiResponse<ActivityInstanceDto> |
ProcessInstanceApi.getActivityInstanceTreeWithHttpInfo(String id)
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)
Retrieves the binary content of a task attachment by task id and attachment id.
|
ApiResponse<List<AttachmentDto>> |
TaskAttachmentApi.getAttachmentsWithHttpInfo(String id)
Gets the attachments for a task.
|
ApiResponse<AttachmentDto> |
TaskAttachmentApi.getAttachmentWithHttpInfo(String id,
String attachmentId)
Retrieves a task attachment by task id and attachment id.
|
ApiResponse<List<CommentDto>> |
TaskCommentApi.getCommentsWithHttpInfo(String id)
Gets the comments for a task by id.
|
ApiResponse<CommentDto> |
TaskCommentApi.getCommentWithHttpInfo(String id,
String commentId)
Retrieves a task comment by task id and comment id.
|
ApiResponse<File> |
TaskApi.getDeployedFormWithHttpInfo(String id)
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)
Retrieves the binary content of a deployment resource for the given deployment by id.
|
ApiResponse<List<DeploymentResourceDto>> |
DeploymentApi.getDeploymentResourcesWithHttpInfo(String id)
Retrieves all deployment resources of a given deployment.
|
ApiResponse<DeploymentResourceDto> |
DeploymentApi.getDeploymentResourceWithHttpInfo(String id,
String resourceId)
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)
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)
Queries for deployments that fulfill given parameters.
|
ApiResponse<List<DeploymentDto>> |
DeploymentApi.getDeploymentWithHttpInfo(String id)
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)
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)
Queries for event subscriptions that fulfill given parameters.
|
ApiResponse<String> |
ExternalTaskApi.getExternalTaskErrorDetailsWithHttpInfo(String id)
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)
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)
Queries for the external tasks that fulfill given parameters.
|
ApiResponse<ExternalTaskDto> |
ExternalTaskApi.getExternalTaskWithHttpInfo(String id)
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)
Retrieves the form variables for a task.
|
ApiResponse<FormDto> |
TaskApi.getFormWithHttpInfo(String id)
Retrieves the form key for a task.
|
ApiResponse<List<IdentityLinkDto>> |
TaskIdentityLinkApi.getIdentityLinksWithHttpInfo(String id,
String type)
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<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<MetricsResultDto> |
MetricsApi.getMetricsWithHttpInfo(String metricsName,
Date startDate,
Date endDate)
Retrieves the `sum` (count) for a given metric.
|
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()
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)
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)
Queries for process instances that fulfill given parameters.
|
ApiResponse<File> |
ProcessInstanceApi.getProcessInstanceVariableBinaryWithHttpInfo(String id,
String varName)
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 deserializeValue)
Retrieves all variables of a given process instance by id.
|
ApiResponse<VariableValueDto> |
ProcessInstanceApi.getProcessInstanceVariableWithHttpInfo(String id,
String varName,
Boolean deserializeValue)
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<File> |
TaskApi.getRenderedFormWithHttpInfo(String id)
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()
Retrieves the version of the Rest API.
|
ApiResponse<List<SchemaLogEntryDto>> |
SchemaLogApi.getSchemaLogWithHttpInfo(String version,
Integer firstResult,
Integer maxResults)
Queries for schema log entries that fulfill given parameters.
|
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.13/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.13/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.13/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)
Retrieves a binary variable from the context of a given task by id.
|
ApiResponse<Map<String,VariableValueDto>> |
TaskLocalVariableApi.getTaskLocalVariablesWithHttpInfo(String id,
Boolean deserializeValues)
Retrieves all variables of a given task by id.
|
ApiResponse<VariableValueDto> |
TaskLocalVariableApi.getTaskLocalVariableWithHttpInfo(String id,
String varName,
Boolean deserializeValue)
Retrieves a variable from the context of a given task by id.
|
ApiResponse<CountResultDto> |
TaskApi.getTasksCountWithHttpInfo(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,
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)
Retrieves the number of tasks that fulfill a provided filter.
|
ApiResponse<List<TaskDto>> |
TaskApi.getTasksWithHttpInfo(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,
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)
Queries for tasks that fulfill a given filter.
|
ApiResponse<File> |
TaskVariableApi.getTaskVariableBinaryWithHttpInfo(String id,
String varName)
Retrieves a binary variable from the context of a given task.
|
ApiResponse<Map<String,VariableValueDto>> |
TaskVariableApi.getTaskVariablesWithHttpInfo(String id,
Boolean deserializeValue)
Retrieves all variables visible from the task.
|
ApiResponse<VariableValueDto> |
TaskVariableApi.getTaskVariableWithHttpInfo(String id,
String varName,
Boolean deserializeValue)
Retrieves a variable from the context of a given task.
|
ApiResponse<TaskDto> |
TaskApi.getTaskWithHttpInfo(String id)
Retrieves a task by id.
|
ApiResponse<TelemetryConfigurationDto> |
TelemetryApi.getTelemetryConfigurationWithHttpInfo()
Fetch Telemetry Configuration
Fetches Telemetry Configuration.
|
ApiResponse<List<String>> |
ExternalTaskApi.getTopicNamesWithHttpInfo(Boolean withLockedTasks,
Boolean withUnlockedTasks,
Boolean withRetriesLeft)
Queries for distinct topic names of external tasks that fulfill given parameters.
|
ApiResponse<Void> |
TaskApi.handleBpmnErrorWithHttpInfo(String id,
TaskBpmnErrorDto taskBpmnErrorDto)
Reports a business error in the context of a running task by id.
|
ApiResponse<Void> |
TaskApi.handleEscalationWithHttpInfo(String id,
TaskEscalationDto taskEscalationDto)
Reports an escalation in the context of a running task by id.
|
ApiResponse<Void> |
ExternalTaskApi.handleExternalTaskBpmnErrorWithHttpInfo(String id,
ExternalTaskBpmnError externalTaskBpmnError)
Reports a business error in the context of a running external task by id.
|
ApiResponse<Void> |
ExternalTaskApi.handleFailureWithHttpInfo(String id,
ExternalTaskFailureDto externalTaskFailureDto)
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)
Retrieves a list of metrics, aggregated for a given interval.
|
ApiResponse<BatchDto> |
ProcessInstanceApi.modifyProcessInstanceAsyncOperationWithHttpInfo(String id,
ProcessInstanceModificationDto processInstanceModificationDto)
Submits a list of modification instructions to change a process instance's execution state async.
|
ApiResponse<Void> |
ProcessInstanceApi.modifyProcessInstanceVariablesWithHttpInfo(String id,
PatchVariablesDto patchVariablesDto)
Updates or deletes the variables of a process instance by id.
|
ApiResponse<Void> |
ProcessInstanceApi.modifyProcessInstanceWithHttpInfo(String id,
ProcessInstanceModificationDto processInstanceModificationDto)
Submits a list of modification instructions to change a process instance's execution state.
|
ApiResponse<Void> |
TaskLocalVariableApi.modifyTaskLocalVariablesWithHttpInfo(String id,
PatchVariablesDto patchVariablesDto)
Updates or deletes the variables in the context of a task.
|
ApiResponse<Void> |
TaskVariableApi.modifyTaskVariablesWithHttpInfo(String id,
PatchVariablesDto patchVariablesDto)
Updates or deletes the variables visible from the task.
|
ApiResponse<Void> |
TaskLocalVariableApi.putTaskLocalVariableWithHttpInfo(String id,
String varName,
VariableValueDto variableValueDto)
Sets a variable in the context of a given task.
|
ApiResponse<Void> |
TaskVariableApi.putTaskVariableWithHttpInfo(String id,
String varName,
VariableValueDto variableValueDto)
Updates a process variable that is visible from the Task scope.
|
ApiResponse<CountResultDto> |
ExternalTaskApi.queryExternalTasksCountWithHttpInfo(ExternalTaskQueryDto externalTaskQueryDto)
Queries for the number of external tasks that fulfill given parameters.
|
ApiResponse<List<ExternalTaskDto>> |
ExternalTaskApi.queryExternalTasksWithHttpInfo(Integer firstResult,
Integer maxResults,
ExternalTaskQueryDto externalTaskQueryDto)
Queries for external tasks that fulfill given parameters in the form of a JSON object.
|
ApiResponse<CountResultDto> |
ProcessInstanceApi.queryProcessInstancesCountWithHttpInfo(ProcessInstanceQueryDto processInstanceQueryDto)
Queries for the number of process instances that fulfill the given parameters.
|
ApiResponse<List<ProcessInstanceDto>> |
ProcessInstanceApi.queryProcessInstancesWithHttpInfo(Integer firstResult,
Integer maxResults,
ProcessInstanceQueryDto processInstanceQueryDto)
Queries for process instances that fulfill given parameters through a JSON object.
|
ApiResponse<List<SchemaLogEntryDto>> |
SchemaLogApi.querySchemaLogWithHttpInfo(Integer firstResult,
Integer maxResults,
SchemaLogQueryDto schemaLogQueryDto)
Queries for schema log entries that fulfill given parameters.
|
ApiResponse<CountResultDto> |
TaskApi.queryTasksCountWithHttpInfo(TaskQueryDto taskQueryDto)
Retrieves the number of tasks that fulfill the given filter.
|
ApiResponse<List<TaskDto>> |
TaskApi.queryTasksWithHttpInfo(Integer firstResult,
Integer maxResults,
TaskQueryDto taskQueryDto)
Queries for tasks that fulfill a given filter.
|
ApiResponse<DeploymentWithDefinitionsDto> |
DeploymentApi.redeployWithHttpInfo(String id,
RedeploymentDto redeploymentDto)
Re-deploys an existing deployment.
|
ApiResponse<Void> |
TaskApi.resolveWithHttpInfo(String id,
CompleteTaskDto completeTaskDto)
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)
Changes the assignee of a task to a specific user.
|
ApiResponse<Void> |
TaskLocalVariableApi.setBinaryTaskLocalVariableWithHttpInfo(String id,
String varName,
File data,
String valueType)
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)
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)
Sets the priority of an existing external task by id.
|
ApiResponse<Void> |
ExternalTaskApi.setExternalTaskResourceRetriesWithHttpInfo(String id,
RetriesDto retriesDto)
Sets the number of retries left to execute an external task by id.
|
ApiResponse<BatchDto> |
ExternalTaskApi.setExternalTaskRetriesAsyncOperationWithHttpInfo(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto)
Sets the number of retries left to execute external tasks by id asynchronously.
|
ApiResponse<Void> |
ExternalTaskApi.setExternalTaskRetriesWithHttpInfo(SetRetriesForExternalTasksDto setRetriesForExternalTasksDto)
Sets the number of retries left to execute external tasks by id synchronously.
|
ApiResponse<Void> |
ProcessInstanceApi.setProcessInstanceVariableBinaryWithHttpInfo(String id,
String varName,
File data,
String valueType)
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)
Sets a variable of a given process instance by id.
|
ApiResponse<BatchDto> |
ProcessInstanceApi.setRetriesByProcessHistoricQueryBasedWithHttpInfo(SetJobRetriesByProcessDto setJobRetriesByProcessDto)
Create a batch to set retries of jobs asynchronously based on a historic process instance query.
|
ApiResponse<BatchDto> |
ProcessInstanceApi.setRetriesByProcessWithHttpInfo(SetJobRetriesByProcessDto setJobRetriesByProcessDto)
Create a batch to set retries of jobs associated with given processes asynchronously.
|
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)
Completes a task and updates process variables using a form submit.
|
ApiResponse<Void> |
SignalApi.throwSignalWithHttpInfo(SignalDto signalDto)
A signal is an event of global scope (broadcast semantics) and is delivered to all active handlers.
|
ApiResponse<Void> |
TaskApi.unclaimWithHttpInfo(String id)
Resets a task's assignee.
|
ApiResponse<Void> |
ExternalTaskApi.unlockWithHttpInfo(String id)
Unlocks an external task by id.
|
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> |
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<BatchDto> |
ProcessInstanceApi.updateSuspensionStateAsyncOperationWithHttpInfo(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto)
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)
Activates or suspends a given process instance by id.
|
ApiResponse<Void> |
ProcessInstanceApi.updateSuspensionStateWithHttpInfo(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto)
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)
Updates a task.
|
Copyright © 2021. All rights reserved.