Hvl Bpmn Engine Server
Havelsan bpmn engine services info
Version: 3.1.0-SNAPSHOT
Apache License Version 2.0
https://www.apache.org/licenses/LICENSE-2.0
Access
[ Jump to Models ]
Table of Contents
Up
post /historic/task/list
Query list. (queryList3)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : [ {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
}, {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseListHvlBpmnTaskModel
Up
post /historic/task/page
Query page. (queryPage3)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"data" : [ {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
}, {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
} ],
"totalPages" : 6,
"pageable" : {
"pageNumber" : 1,
"pageSize" : 5,
"sort" : {
"properties" : [ "properties", "properties" ],
"direction" : "ASC"
}
},
"totalElements" : 0
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlPageHvlBpmnTaskModel
Up
post /repository/activate
Activate process definition by id. (activateProcessDefinition)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /repository/deployXml
Deploy to engine from bpmn xml (deploy)
Consumes
This API call consumes the following media types via the request header:
Form parameters
xmlFile (required)
Form Parameter — format: binary
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /repository/deployXmls
Deploy to engine from list of bpmn xml. (deployList)
Consumes
This API call consumes the following media types via the request header:
Form parameters
xmlFileList (required)
Form Parameter — format: binary
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
get /repository/model/{id}
Gets bpmn model array by process definition id. (getBpmnModelArrayByProcessDefinitionId)
Path parameters
id (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : [ "", "" ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseByte[]
Query list. (queryList2)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : [ {
"deploymentId" : "deploymentId",
"tenantId" : "tenantId",
"name" : "name",
"description" : "description",
"id" : "id",
"category" : "category",
"version" : 1,
"key" : "key",
"suspended" : true
}, {
"deploymentId" : "deploymentId",
"tenantId" : "tenantId",
"name" : "name",
"description" : "description",
"id" : "id",
"category" : "category",
"version" : 1,
"key" : "key",
"suspended" : true
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseListHvlBpmnProcessDefinitionModel
Query page. (queryPage2)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"data" : [ {
"deploymentId" : "deploymentId",
"tenantId" : "tenantId",
"name" : "name",
"description" : "description",
"id" : "id",
"category" : "category",
"version" : 1,
"key" : "key",
"suspended" : true
}, {
"deploymentId" : "deploymentId",
"tenantId" : "tenantId",
"name" : "name",
"description" : "description",
"id" : "id",
"category" : "category",
"version" : 1,
"key" : "key",
"suspended" : true
} ],
"totalPages" : 6,
"pageable" : {
"pageNumber" : 1,
"pageSize" : 5,
"sort" : {
"properties" : [ "properties", "properties" ],
"direction" : "ASC"
}
},
"totalElements" : 0
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlPageHvlBpmnProcessDefinitionModel
Up
post /repository/suspend
Suspend process definition. (suspendProcessDefinition)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /runtime/variables/by-execution-id/{executionId}/by-variable-name/{variableName}
Gets execution variable. (getVariable)
Path parameters
executionId (required)
Path Parameter —
variableName (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseObject
Up
get /runtime/variables/by-execution-id/{executionId}
Gets execution variables. (getVariables1)
Path parameters
executionId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"key" : { }
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseMapStringObject
Up
get /runtime/is-execution-exists/by-business-key/{businessKey}
Check the execution is existed. (isExecutionExists)
Path parameters
businessKey (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseBoolean
Query list. (queryList1)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : [ {
"description" : "description",
"referenceType" : "referenceType",
"processDefinitionName" : "processDefinitionName",
"referenceId" : "referenceId",
"processDefinitionKey" : "processDefinitionKey",
"activityId" : "activityId",
"startUserId" : "startUserId",
"deploymentId" : "deploymentId",
"rootProcessInstanceId" : "rootProcessInstanceId",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : "id",
"localizedDescription" : "localizedDescription",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"localizedName" : "localizedName",
"businessStatus" : "businessStatus",
"parentId" : "parentId",
"suspended" : true,
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"callbackId" : "callbackId",
"superExecutionId" : "superExecutionId",
"tenantId" : "tenantId",
"name" : "name",
"businessKey" : "businessKey",
"ended" : true,
"processVariables" : {
"key" : { }
},
"processDefinitionVersion" : 0,
"callbackType" : "callbackType"
}, {
"description" : "description",
"referenceType" : "referenceType",
"processDefinitionName" : "processDefinitionName",
"referenceId" : "referenceId",
"processDefinitionKey" : "processDefinitionKey",
"activityId" : "activityId",
"startUserId" : "startUserId",
"deploymentId" : "deploymentId",
"rootProcessInstanceId" : "rootProcessInstanceId",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : "id",
"localizedDescription" : "localizedDescription",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"localizedName" : "localizedName",
"businessStatus" : "businessStatus",
"parentId" : "parentId",
"suspended" : true,
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"callbackId" : "callbackId",
"superExecutionId" : "superExecutionId",
"tenantId" : "tenantId",
"name" : "name",
"businessKey" : "businessKey",
"ended" : true,
"processVariables" : {
"key" : { }
},
"processDefinitionVersion" : 0,
"callbackType" : "callbackType"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseListHvlBpmnProcessInstanceModel
Query page. (queryPage1)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"data" : [ {
"description" : "description",
"referenceType" : "referenceType",
"processDefinitionName" : "processDefinitionName",
"referenceId" : "referenceId",
"processDefinitionKey" : "processDefinitionKey",
"activityId" : "activityId",
"startUserId" : "startUserId",
"deploymentId" : "deploymentId",
"rootProcessInstanceId" : "rootProcessInstanceId",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : "id",
"localizedDescription" : "localizedDescription",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"localizedName" : "localizedName",
"businessStatus" : "businessStatus",
"parentId" : "parentId",
"suspended" : true,
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"callbackId" : "callbackId",
"superExecutionId" : "superExecutionId",
"tenantId" : "tenantId",
"name" : "name",
"businessKey" : "businessKey",
"ended" : true,
"processVariables" : {
"key" : { }
},
"processDefinitionVersion" : 0,
"callbackType" : "callbackType"
}, {
"description" : "description",
"referenceType" : "referenceType",
"processDefinitionName" : "processDefinitionName",
"referenceId" : "referenceId",
"processDefinitionKey" : "processDefinitionKey",
"activityId" : "activityId",
"startUserId" : "startUserId",
"deploymentId" : "deploymentId",
"rootProcessInstanceId" : "rootProcessInstanceId",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : "id",
"localizedDescription" : "localizedDescription",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"localizedName" : "localizedName",
"businessStatus" : "businessStatus",
"parentId" : "parentId",
"suspended" : true,
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"callbackId" : "callbackId",
"superExecutionId" : "superExecutionId",
"tenantId" : "tenantId",
"name" : "name",
"businessKey" : "businessKey",
"ended" : true,
"processVariables" : {
"key" : { }
},
"processDefinitionVersion" : 0,
"callbackType" : "callbackType"
} ],
"totalPages" : 6,
"pageable" : {
"pageNumber" : 1,
"pageSize" : 5,
"sort" : {
"properties" : [ "properties", "properties" ],
"direction" : "ASC"
}
},
"totalElements" : 0
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlPageHvlBpmnProcessInstanceModel
Up
post /runtime/set-variable/by-execution-id/{executionId}/by-variable-name/{variableName}
Sets execution variable. (setVariable)
Path parameters
executionId (required)
Path Parameter —
variableName (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /runtime/start/by-process-defitinion-id/{processDefinitionId}
Start process instance by process definition id. (startProcessInstanceById)
Path parameters
processDefinitionId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"description" : "description",
"referenceType" : "referenceType",
"processDefinitionName" : "processDefinitionName",
"referenceId" : "referenceId",
"processDefinitionKey" : "processDefinitionKey",
"activityId" : "activityId",
"startUserId" : "startUserId",
"deploymentId" : "deploymentId",
"rootProcessInstanceId" : "rootProcessInstanceId",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : "id",
"localizedDescription" : "localizedDescription",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"localizedName" : "localizedName",
"businessStatus" : "businessStatus",
"parentId" : "parentId",
"suspended" : true,
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"callbackId" : "callbackId",
"superExecutionId" : "superExecutionId",
"tenantId" : "tenantId",
"name" : "name",
"businessKey" : "businessKey",
"ended" : true,
"processVariables" : {
"key" : { }
},
"processDefinitionVersion" : 0,
"callbackType" : "callbackType"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlBpmnProcessInstanceModel
Up
post /runtime/start/by-process-defitinion-key/{processDefinitionKey}
Start process instance by process definition key. (startProcessInstanceByKey1)
Path parameters
processDefinitionKey (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"description" : "description",
"referenceType" : "referenceType",
"processDefinitionName" : "processDefinitionName",
"referenceId" : "referenceId",
"processDefinitionKey" : "processDefinitionKey",
"activityId" : "activityId",
"startUserId" : "startUserId",
"deploymentId" : "deploymentId",
"rootProcessInstanceId" : "rootProcessInstanceId",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : "id",
"localizedDescription" : "localizedDescription",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"localizedName" : "localizedName",
"businessStatus" : "businessStatus",
"parentId" : "parentId",
"suspended" : true,
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"callbackId" : "callbackId",
"superExecutionId" : "superExecutionId",
"tenantId" : "tenantId",
"name" : "name",
"businessKey" : "businessKey",
"ended" : true,
"processVariables" : {
"key" : { }
},
"processDefinitionVersion" : 0,
"callbackType" : "callbackType"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlBpmnProcessInstanceModel
Up
post /scheduler/finish/by-business-key-list
Finishs scheduler job. (finishScheduler)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
get /scheduler/restart/{processInstanceId}
Restarts async scheduler job. (restartScheduler)
Path parameters
processInstanceId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"description" : "description",
"referenceType" : "referenceType",
"processDefinitionName" : "processDefinitionName",
"referenceId" : "referenceId",
"processDefinitionKey" : "processDefinitionKey",
"activityId" : "activityId",
"startUserId" : "startUserId",
"deploymentId" : "deploymentId",
"rootProcessInstanceId" : "rootProcessInstanceId",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : "id",
"localizedDescription" : "localizedDescription",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"localizedName" : "localizedName",
"businessStatus" : "businessStatus",
"parentId" : "parentId",
"suspended" : true,
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"callbackId" : "callbackId",
"superExecutionId" : "superExecutionId",
"tenantId" : "tenantId",
"name" : "name",
"businessKey" : "businessKey",
"ended" : true,
"processVariables" : {
"key" : { }
},
"processDefinitionVersion" : 0,
"callbackType" : "callbackType"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlBpmnProcessInstanceModel
Up
post /scheduler/start/async/{overrideJob}
Starts async scheduler job. (startAsyncScheduler)
Path parameters
overrideJob (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"description" : "description",
"referenceType" : "referenceType",
"processDefinitionName" : "processDefinitionName",
"referenceId" : "referenceId",
"processDefinitionKey" : "processDefinitionKey",
"activityId" : "activityId",
"startUserId" : "startUserId",
"deploymentId" : "deploymentId",
"rootProcessInstanceId" : "rootProcessInstanceId",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : "id",
"localizedDescription" : "localizedDescription",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"localizedName" : "localizedName",
"businessStatus" : "businessStatus",
"parentId" : "parentId",
"suspended" : true,
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"callbackId" : "callbackId",
"superExecutionId" : "superExecutionId",
"tenantId" : "tenantId",
"name" : "name",
"businessKey" : "businessKey",
"ended" : true,
"processVariables" : {
"key" : { }
},
"processDefinitionVersion" : 0,
"callbackType" : "callbackType"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlBpmnProcessInstanceModel
Up
post /scheduler/start/sync/{overrideJob}
Starts sync scheduler job. (startSyncScheduler)
Path parameters
overrideJob (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"description" : "description",
"referenceType" : "referenceType",
"processDefinitionName" : "processDefinitionName",
"referenceId" : "referenceId",
"processDefinitionKey" : "processDefinitionKey",
"activityId" : "activityId",
"startUserId" : "startUserId",
"deploymentId" : "deploymentId",
"rootProcessInstanceId" : "rootProcessInstanceId",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : "id",
"localizedDescription" : "localizedDescription",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"localizedName" : "localizedName",
"businessStatus" : "businessStatus",
"parentId" : "parentId",
"suspended" : true,
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"callbackId" : "callbackId",
"superExecutionId" : "superExecutionId",
"tenantId" : "tenantId",
"name" : "name",
"businessKey" : "businessKey",
"ended" : true,
"processVariables" : {
"key" : { }
},
"processDefinitionVersion" : 0,
"callbackType" : "callbackType"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlBpmnProcessInstanceModel
Up
get /task/{id}/claim/{assignee}
Claims the task. (claim)
Path parameters
id (required)
Path Parameter —
assignee (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Completes the task. (complete)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
get /task/confirm/{id}
Confirms the task. (confirmTask)
Path parameters
id (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Gets the task by id. (getById)
Path parameters
id (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlBpmnTaskModel
Up
get /task/variable/{taskId}/{variableName}
Gets the task variable. (getVariable1)
Path parameters
taskId (required)
Path Parameter —
variableName (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseObject
Up
get /task/variables/{taskId}
Gets the task variables. (getVariables)
Path parameters
taskId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"key" : { }
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseMapStringObject
Up
post /task/active-user/page
Queries active user tasks as paginated according to criteria in query model (queryActiveUserTaskPage)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"data" : [ {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
}, {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
} ],
"totalPages" : 6,
"pageable" : {
"pageNumber" : 1,
"pageSize" : 5,
"sort" : {
"properties" : [ "properties", "properties" ],
"direction" : "ASC"
}
},
"totalElements" : 0
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlPageHvlBpmnTaskModel
Query list. (queryList)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : [ {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
}, {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseListHvlBpmnTaskModel
Query page. (queryPage)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"data" : [ {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
}, {
"parentTaskId" : "parentTaskId",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"taskLocalVariables" : {
"key" : { }
},
"description" : "description",
"taskDefinitionId" : "taskDefinitionId",
"processDefinitionKey" : "processDefinitionKey",
"delegationState" : "PENDING",
"scopeType" : "scopeType",
"approvable" : true,
"id" : "id",
"localizedDescription" : "localizedDescription",
"key" : "key",
"caseVariables" : {
"key" : { }
},
"owner" : "owner",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"scopeId" : "scopeId",
"localizedName" : "localizedName",
"formKey" : "formKey",
"priority" : 5,
"identityLinks" : [ {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
}, {
"processInstanceId" : "processInstanceId",
"scopeId" : "scopeId",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"scopeType" : "scopeType",
"groupId" : "groupId",
"type" : "type",
"userId" : "userId",
"taskId" : "taskId"
} ],
"parentId" : "parentId",
"suspended" : true,
"claimTime" : "2000-01-23T04:56:07.000+00:00",
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"executionId" : "executionId",
"taskDefinitionKey" : "taskDefinitionKey",
"subScopeId" : "subScopeId",
"scopeDefinitionId" : "scopeDefinitionId",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"tenantId" : "tenantId",
"assignee" : "assignee",
"category" : "category",
"processVariables" : {
"key" : { }
}
} ],
"totalPages" : 6,
"pageable" : {
"pageNumber" : 1,
"pageSize" : 5,
"sort" : {
"properties" : [ "properties", "properties" ],
"direction" : "ASC"
}
},
"totalElements" : 0
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlPageHvlBpmnTaskModel
Rejects the task. (rejectTask)
Path parameters
id (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
get /task/{id}/unclaim
Unclaims the task. (unclaim)
Path parameters
id (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /transactional/complete-rollback/business-key/{businessKey}
Completes distributed transaction rollback step. (completeRollback)
Path parameters
businessKey (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /transactional/complete-step/business-key/{businessKey}
Completes distributed transaction step. (completeStep)
Path parameters
businessKey (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Up
post /transactional/start/by-process-defitinion-key/{processDefinitionKey}
Start process instance which includes distributed transaction sub activity by process definition key. (startProcessInstanceByKey)
Path parameters
processDefinitionKey (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"description" : "description",
"referenceType" : "referenceType",
"processDefinitionName" : "processDefinitionName",
"referenceId" : "referenceId",
"processDefinitionKey" : "processDefinitionKey",
"activityId" : "activityId",
"startUserId" : "startUserId",
"deploymentId" : "deploymentId",
"rootProcessInstanceId" : "rootProcessInstanceId",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"id" : "id",
"localizedDescription" : "localizedDescription",
"processInstanceId" : "processInstanceId",
"processDefinitionId" : "processDefinitionId",
"localizedName" : "localizedName",
"businessStatus" : "businessStatus",
"parentId" : "parentId",
"suspended" : true,
"propagatedStageInstanceId" : "propagatedStageInstanceId",
"callbackId" : "callbackId",
"superExecutionId" : "superExecutionId",
"tenantId" : "tenantId",
"name" : "name",
"businessKey" : "businessKey",
"ended" : true,
"processVariables" : {
"key" : { }
},
"processDefinitionVersion" : 0,
"callbackType" : "callbackType"
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlBpmnProcessInstanceModel
Up
post /transactional/start-rollback/business-key/{businessKey}
Starts distributed transaction rollback step. (startRollback)
Path parameters
businessKey (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
[ Jump to Methods ]
Table of Contents
HvlBpmnActivateProcessDefinitionModelHvlBpmnCompleteTaskModelHvlBpmnProcessDefinitionModelHvlBpmnProcessDefinitionQueryModelHvlBpmnProcessInstanceModelHvlBpmnProcessInstanceQueryModelHvlBpmnSchedulerModelHvlBpmnStartProcessInstanceModelHvlBpmnSuspendProcessDefinitionModelHvlBpmnTaskModelHvlBpmnTaskQueryModelHvlBpmnVariableValueQueryModelHvlErrorDetailHvlPageHvlBpmnProcessDefinitionModelHvlPageHvlBpmnProcessInstanceModelHvlPageHvlBpmnTaskModelHvlPageableHvlResponseBooleanHvlResponseByte[]HvlResponseHvlBpmnProcessInstanceModelHvlResponseHvlBpmnTaskModelHvlResponseHvlPageHvlBpmnProcessDefinitionModelHvlResponseHvlPageHvlBpmnProcessInstanceModelHvlResponseHvlPageHvlBpmnTaskModelHvlResponseListHvlBpmnProcessDefinitionModelHvlResponseListHvlBpmnProcessInstanceModelHvlResponseListHvlBpmnTaskModelHvlResponseMapStringObjectHvlResponseObjectHvlResponseVoidHvlSortIdentityLinkInforepository_deployXml_bodyrepository_deployXmls_body
id (optional)
key (optional)
tenantId (optional)
activationDate (optional)
activateProcessInstances (optional)
taskId (optional)
local (optional)
processVariables (optional)
transientProcessVariables (optional)
id (optional)
key (optional)
tenantId (optional)
category (optional)
name (optional)
description (optional)
version (optional)
deploymentId (optional)
suspended (optional)
pageable (optional)
filters (optional)
id (optional)
idList (optional)
category (optional)
categoryLike (optional)
categoryNotEquals (optional)
name (optional)
nameLike (optional)
nameLikeIgnoreCase (optional)
deploymentId (optional)
deploymentIdList (optional)
parentDeploymentId (optional)
key (optional)
keyLike (optional)
version (optional)
versionGreaterThan (optional)
versionGreaterThanOrEquals (optional)
versionLowerThan (optional)
versionLowerThanOrEquals (optional)
latestVersion (optional)
resourceName (optional)
resourceNameLike (optional)
startableByUserId (optional)
startableByGroupIdList (optional)
suspended (optional)
active (optional)
tenantId (optional)
tenantIdLike (optional)
withoutTenantId (optional)
engineVersion (optional)
messageEventSubscriptionName (optional)
locale (optional)
withLocalizationFallback (optional)
id (optional)
activityId (optional)
processInstanceId (optional)
parentId (optional)
superExecutionId (optional)
rootProcessInstanceId (optional)
tenantId (optional)
name (optional)
description (optional)
referenceId (optional)
referenceType (optional)
propagatedStageInstanceId (optional)
processDefinitionId (optional)
processDefinitionName (optional)
processDefinitionKey (optional)
processDefinitionVersion (optional)
deploymentId (optional)
businessKey (optional)
businessStatus (optional)
localizedName (optional)
localizedDescription (optional)
startTime (optional)
startUserId (optional)
callbackId (optional)
callbackType (optional)
processVariables (optional)
suspended (optional)
ended (optional)
pageable (optional)
filters (optional)
processDefinitionKey (optional)
processDefinitionKeyList (optional)
processDefinitionId (optional)
processDefinitionCategory (optional)
processDefinitionName (optional)
processDefinitionEngineVersion (optional)
processDefinitionVersion (optional)
processInstanceId (optional)
processInstanceBusinessKey (optional)
variableValueEqualsIgnoreCaseList (optional)
variableValueNotEqualsIgnoreCaseList (optional)
variableValueLikeList (optional)
variableValueLikeIgnoreCaseList (optional)
locale (optional)
withLocalizationFallback (optional)
startedBefore (optional)
startedAfter (optional)
startedBy (optional)
processInstanceIdSet (optional)
processInstanceBusinessKeyLike (optional)
processInstanceBusinessStatus (optional)
processInstanceBusinessStatusLike (optional)
processInstanceTenantId (optional)
processInstanceTenantIdLike (optional)
processInstanceWithoutTenantId (optional)
processDefinitionIdSet (optional)
deploymentId (optional)
deploymentIdList (optional)
superProcessInstanceId (optional)
subProcessInstanceId (optional)
excludeSubprocesses (optional)
activeActivityId (optional)
activeActivityIdSet (optional)
involvedUser (optional)
involvedGroup (optional)
involvedGroupSet (optional)
identityLinkType (optional)
suspended (optional)
active (optional)
processInstanceName (optional)
processInstanceNameLike (optional)
processInstanceNameLikeIgnoreCase (optional)
processInstanceCallbackId (optional)
processInstanceCallbackType (optional)
processInstanceReferenceId (optional)
processInstanceReferenceType (optional)
includeProcessVariables (optional)
withJobException (optional)
businessKey
periodType
ISO_8601
CRON
period
singleExecution (optional)
url
eventTopic
payload (optional)
businessKey (optional)
tenantId (optional)
variables (optional)
id (optional)
key (optional)
tenantId (optional)
suspensionDate (optional)
suspendProcessInstances (optional)
id (optional)
name (optional)
processInstanceId (optional)
parentId (optional)
key (optional)
formKey (optional)
executionId (optional)
taskDefinitionId (optional)
processDefinitionId (optional)
processDefinitionKey (optional)
owner (optional)
assignee (optional)
description (optional)
createTime (optional)
dueDate (optional)
priority (optional)
category (optional)
delegationState (optional)
PENDING
RESOLVED
claimTime (optional)
tenantId (optional)
scopeId (optional)
subScopeId (optional)
scopeType (optional)
scopeDefinitionId (optional)
taskDefinitionKey (optional)
propagatedStageInstanceId (optional)
localizedName (optional)
localizedDescription (optional)
approvable (optional)
taskLocalVariables (optional)
processVariables (optional)
caseVariables (optional)
suspended (optional)
parentTaskId (optional)
identityLinks (optional)
pageable (optional)
filters (optional)
processDefinitionKey (optional)
processDefinitionKeyList (optional)
processDefinitionId (optional)
processDefinitionCategory (optional)
processDefinitionName (optional)
processDefinitionEngineVersion (optional)
processDefinitionVersion (optional)
processInstanceId (optional)
processInstanceBusinessKey (optional)
variableValueEqualsIgnoreCaseList (optional)
variableValueNotEqualsIgnoreCaseList (optional)
variableValueLikeList (optional)
variableValueLikeIgnoreCaseList (optional)
locale (optional)
withLocalizationFallback (optional)
startedBefore (optional)
startedAfter (optional)
startedBy (optional)
taskDelegationState (optional)
PENDING
RESOLVED
userIdForCandidateAndAssignee (optional)
excludeSubtasks (optional)
suspended (optional)
active (optional)
taskId (optional)
taskName (optional)
taskNameInList (optional)
taskNameInIgnoreCaseList (optional)
taskNameLike (optional)
taskNameLikeIgnoreCase (optional)
taskDescription (optional)
taskDescriptionLike (optional)
taskDescriptionLikeIgnoreCase (optional)
taskPriority (optional)
taskMinPriority (optional)
taskMaxPriority (optional)
taskAssignee (optional)
taskAssigneeLike (optional)
taskAssigneeLikeIgnoreCase (optional)
taskUnassigned (optional)
taskAssigned (optional)
taskAssigneeIdList (optional)
taskOwner (optional)
taskOwnerLike (optional)
taskOwnerLikeIgnoreCase (optional)
taskCandidateUser (optional)
taskInvolvedUser (optional)
taskInvolvedGroupList (optional)
ignoreAssigneeValue (optional)
taskCandidateGroup (optional)
taskCandidateGroupInList (optional)
taskTenantId (optional)
taskTenantIdLike (optional)
taskWithoutTenantId (optional)
processInstanceIdInList (optional)
withoutProcessInstanceId (optional)
processInstanceBusinessKeyLike (optional)
processInstanceBusinessKeyLikeIgnoreCase (optional)
executionId (optional)
planItemInstanceId (optional)
scopeId (optional)
subScopeId (optional)
scopeType (optional)
scopeDefinitionId (optional)
propagatedStageInstanceId (optional)
processInstanceIdWithChildren (optional)
taskCreatedOn (optional)
taskCreatedBefore (optional)
taskCreatedAfter (optional)
taskCategory (optional)
taskWithFormKey (optional)
taskFormKey (optional)
taskDefinitionKey (optional)
taskDefinitionKeyLike (optional)
taskDefinitionKeyList (optional)
taskDueDate (optional)
taskDueBefore (optional)
taskDueAfter (optional)
withoutTaskDueDate (optional)
processDefinitionKeyLike (optional)
processDefinitionKeyLikeIgnoreCase (optional)
processDefinitionKeyInList (optional)
taskDefinitionId (optional)
processDefinitionNameLike (optional)
processCategoryInList (optional)
processCategoryNotInList (optional)
deploymentId (optional)
deploymentIdInList (optional)
withoutScopeId (optional)
taskVariableValueEqualsIgnoreCaseList (optional)
taskVariableValueNotEqualsIgnoreCaseList (optional)
taskVariableValueLikeList (optional)
taskVariableValueLikeIgnoreCaseList (optional)
taskVariableExistsList (optional)
taskVariableNotExistsList (optional)
processVariableValueEqualsIgnoreCaseList (optional)
processVariableValueNotEqualsIgnoreCaseList (optional)
processVariableValueLikeList (optional)
processVariableValueLikeIgnoreCaseList (optional)
processVariableExistsList (optional)
processVariableNotExistsList (optional)
includeTaskLocalVariables (optional)
includeProcessVariables (optional)
includeIdentityLinks (optional)
name (optional)
value (optional)
uuid (optional)
errorClassName (optional)
errorCode (optional)
errorDetail (optional)
errorMessage (optional)
service (optional)
time (optional)
errorArguments (optional)
totalElements (optional)
totalPages (optional)
pageable (optional)
data (optional)
totalElements (optional)
totalPages (optional)
pageable (optional)
data (optional)
totalElements (optional)
totalPages (optional)
pageable (optional)
data (optional)
pageNumber (optional)
pageSize (optional)
sort (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
direction (optional)
ASC
DESC
UNSORTED
properties (optional)
type (optional)
scopeId (optional)
groupId (optional)
processInstanceId (optional)
taskId (optional)
subScopeId (optional)
scopeType (optional)
scopeDefinitionId (optional)
userId (optional)