Hvl Bpmn Admin Server
Havelsan bpmn admin 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 /admin/repository/activate
Activate process definition by key (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
get /admin/repository/latest/by-key/{key}
Find latest process definition by key (findLatestProcessDefinitionByKey)
Path parameters
key (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" : [ {
"deploymentId" : "deploymentId",
"tenantId" : "tenantId",
"name" : "name",
"description" : "description",
"id" : "id",
"category" : "category",
"version" : 0,
"key" : "key",
"suspended" : true
}, {
"deploymentId" : "deploymentId",
"tenantId" : "tenantId",
"name" : "name",
"description" : "description",
"id" : "id",
"category" : "category",
"version" : 0,
"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
Up
post /admin/repository/suspend
Suspend process definition by key (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
get /display/process-instances/debugger/{processInstanceId}/model-json
Gets debugger model json (getDebuggerModelJSON)
Path parameters
processInstanceId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }
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
JsonNode
Up
get /display/process-instances/history/{processInstanceId}/model-json
Gets model history json (getModelHistoryJSON)
Path parameters
processInstanceId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }
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
JsonNode
Up
get /display/process-instances/{processInstanceId}/model-json
Gets model json (getModelJSON)
Path parameters
processInstanceId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }
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
JsonNode
Up
get /display/process-definitions/{processDefinitionId}/model-json
Gets model json for process definition (getModelJSONForProcessDefinition)
Path parameters
processDefinitionId (required)
Path Parameter —
Return type
Example data
Content-Type: application/json
{ }
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
JsonNode
Up
post /historic/process/instance/list
Queries process instances according to criteria in query model (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" : [ {
"processInstanceId" : "processInstanceId",
"name" : "name",
"businessKey" : "businessKey",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"processVersion" : 5,
"processVariables" : {
"key" : { }
},
"deleteReason" : "deleteReason",
"activityInstanceModelList" : [ {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
}, {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
} ],
"processDefinitionKey" : "processDefinitionKey"
}, {
"processInstanceId" : "processInstanceId",
"name" : "name",
"businessKey" : "businessKey",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"processVersion" : 5,
"processVariables" : {
"key" : { }
},
"deleteReason" : "deleteReason",
"activityInstanceModelList" : [ {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
}, {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
} ],
"processDefinitionKey" : "processDefinitionKey"
} ]
}
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
HvlResponseListHvlBpmnAdminProcessInstanceModel_WithHistory
Up
post /historic/process/instance/page
Queries process instances as paginated according to criteria in query model (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" : [ {
"processInstanceId" : "processInstanceId",
"name" : "name",
"businessKey" : "businessKey",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"processVersion" : 5,
"processVariables" : {
"key" : { }
},
"deleteReason" : "deleteReason",
"activityInstanceModelList" : [ {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
}, {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
} ],
"processDefinitionKey" : "processDefinitionKey"
}, {
"processInstanceId" : "processInstanceId",
"name" : "name",
"businessKey" : "businessKey",
"startTime" : "2000-01-23T04:56:07.000+00:00",
"endTime" : "2000-01-23T04:56:07.000+00:00",
"processVersion" : 5,
"processVariables" : {
"key" : { }
},
"deleteReason" : "deleteReason",
"activityInstanceModelList" : [ {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
}, {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
} ],
"processDefinitionKey" : "processDefinitionKey"
} ],
"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
HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithHistory
Up
delete /process/delete/{id}
Removes object according to provided parameter (delete1)
Path parameters
id (required)
Path Parameter — format: int64
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
put /process/deploy/{processId}
Deploy process (deployProcess)
Path parameters
processId (required)
Path Parameter — format: int64
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 /process/export/all
Exports all processes as zip file (exportAll)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
array[byte[]]
Example data
Content-Type: application/json
[ "", "" ]
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
Up
get /process/export/{processId}
Exports process as bpmn xml (exportProcess)
Path parameters
processId (required)
Path Parameter — format: int64
Return type
array[byte[]]
Example data
Content-Type: application/json
[ "", "" ]
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
Up
get /process/version/current/{processCode}
Gets current version of process (getCurrentVersion)
Path parameters
processCode (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" : 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
HvlResponseLong
Up
get /process/namespaces
Gets namespace list (getNamespaceList)
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" : [ "body", "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
HvlResponseListString
Gets process by id (getProcessById)
Path parameters
id (required)
Path Parameter — format: int64
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" : {
"updatedBy" : "updatedBy",
"lockedByProfile" : "lockedByProfile",
"code" : "code",
"description" : "description",
"deployedFlowableVersion" : 2,
"processVersion" : 3,
"type" : "STANDART",
"uuid" : "uuid",
"version" : 5,
"suspended" : true,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"deployedProcessVersion" : 4,
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"namespace" : "namespace",
"deployedDefinitionId" : "deployedDefinitionId",
"id" : 2,
"detail" : {
"thumbnail" : [ "", "" ],
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"updatedBy" : "updatedBy",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 9,
"uuid" : "uuid",
"version" : 7,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"sourceJson" : [ "", "" ]
},
"systemProcess" : true,
"key" : "key",
"status" : "DRAFT"
}
}
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
HvlResponseHvlBpmnProcessModel
Up
get /process/version/process/code/{processCode}/version/{processVersion}
Gets process by version (getProcessByVersion)
Path parameters
processCode (required)
Path Parameter —
processVersion (required)
Path Parameter — format: int64
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" : {
"updatedBy" : "updatedBy",
"lockedByProfile" : "lockedByProfile",
"code" : "code",
"description" : "description",
"deployedFlowableVersion" : 2,
"processVersion" : 3,
"type" : "STANDART",
"uuid" : "uuid",
"version" : 5,
"suspended" : true,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"deployedProcessVersion" : 4,
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"namespace" : "namespace",
"deployedDefinitionId" : "deployedDefinitionId",
"id" : 2,
"detail" : {
"thumbnail" : [ "", "" ],
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"updatedBy" : "updatedBy",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 9,
"uuid" : "uuid",
"version" : 7,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"sourceJson" : [ "", "" ]
},
"systemProcess" : true,
"key" : "key",
"status" : "DRAFT"
}
}
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
HvlResponseHvlBpmnProcessModel
Up
get /process/model/{modelId}
Gets process model node (getProcessModelNode)
Path parameters
modelId (required)
Path Parameter — format: int64
Return type
Object
Example data
Content-Type: application/json
{ }
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
Object
Up
get /process/version/list/process/code/{processCode}
Gets process version list (getProcessVersionList)
Path parameters
processCode (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" : [ 0, 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
HvlResponseListLong
Up
post /process/import/all
Imports all bpmn xml files from a zip file (importAll)
Consumes
This API call consumes the following media types via the request header:
Form parameters
zipFile (optional)
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" : [ {
"updatedBy" : "updatedBy",
"lockedByProfile" : "lockedByProfile",
"code" : "code",
"description" : "description",
"deployedFlowableVersion" : 2,
"processVersion" : 3,
"type" : "STANDART",
"uuid" : "uuid",
"version" : 5,
"suspended" : true,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"deployedProcessVersion" : 4,
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"namespace" : "namespace",
"deployedDefinitionId" : "deployedDefinitionId",
"id" : 2,
"detail" : {
"thumbnail" : [ "", "" ],
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"updatedBy" : "updatedBy",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 9,
"uuid" : "uuid",
"version" : 7,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"sourceJson" : [ "", "" ]
},
"systemProcess" : true,
"key" : "key",
"status" : "DRAFT"
}, {
"updatedBy" : "updatedBy",
"lockedByProfile" : "lockedByProfile",
"code" : "code",
"description" : "description",
"deployedFlowableVersion" : 2,
"processVersion" : 3,
"type" : "STANDART",
"uuid" : "uuid",
"version" : 5,
"suspended" : true,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"deployedProcessVersion" : 4,
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"namespace" : "namespace",
"deployedDefinitionId" : "deployedDefinitionId",
"id" : 2,
"detail" : {
"thumbnail" : [ "", "" ],
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"updatedBy" : "updatedBy",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 9,
"uuid" : "uuid",
"version" : 7,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"sourceJson" : [ "", "" ]
},
"systemProcess" : true,
"key" : "key",
"status" : "DRAFT"
} ]
}
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
HvlResponseListHvlBpmnProcessModel
Imports a bpmn xml (importProcess)
Consumes
This API call consumes the following media types via the request header:
Form parameters
xmlFile (optional)
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" : {
"exist" : true,
"processDefinitionId" : 0,
"processDefinitionKey" : "processDefinitionKey"
}
}
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
HvlResponseHvlProcessDefinitionImportResultModel
Up
get /process/lock/getLock/process/{id}
Check the process is locked (isLocked)
Path parameters
id (required)
Path Parameter — format: int64
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
Up
put /process/lock/process/{id}
Lock the process (lock)
Path parameters
id (required)
Path Parameter — format: int64
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 /process/list-category/by-name/{namespace}
Queries categories according to namespace (queryCategoryList)
Path parameters
namespace (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" : [ "body", "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
HvlResponseListString
Queries processes according to criteria in query model (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" : [ {
"updatedBy" : "updatedBy",
"lockedByProfile" : "lockedByProfile",
"code" : "code",
"description" : "description",
"deployedFlowableVersion" : 2,
"processVersion" : 3,
"type" : "STANDART",
"uuid" : "uuid",
"version" : 5,
"suspended" : true,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"deployedProcessVersion" : 4,
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"namespace" : "namespace",
"deployedDefinitionId" : "deployedDefinitionId",
"id" : 2,
"detail" : {
"thumbnail" : [ "", "" ],
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"updatedBy" : "updatedBy",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 9,
"uuid" : "uuid",
"version" : 7,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"sourceJson" : [ "", "" ]
},
"systemProcess" : true,
"key" : "key",
"status" : "DRAFT"
}, {
"updatedBy" : "updatedBy",
"lockedByProfile" : "lockedByProfile",
"code" : "code",
"description" : "description",
"deployedFlowableVersion" : 2,
"processVersion" : 3,
"type" : "STANDART",
"uuid" : "uuid",
"version" : 5,
"suspended" : true,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"deployedProcessVersion" : 4,
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"namespace" : "namespace",
"deployedDefinitionId" : "deployedDefinitionId",
"id" : 2,
"detail" : {
"thumbnail" : [ "", "" ],
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"updatedBy" : "updatedBy",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 9,
"uuid" : "uuid",
"version" : 7,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"sourceJson" : [ "", "" ]
},
"systemProcess" : true,
"key" : "key",
"status" : "DRAFT"
} ]
}
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
HvlResponseListHvlBpmnProcessModel
Queries processes as paginated according to criteria in query model (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" : [ {
"updatedBy" : "updatedBy",
"lockedByProfile" : "lockedByProfile",
"code" : "code",
"description" : "description",
"deployedFlowableVersion" : 2,
"processVersion" : 3,
"type" : "STANDART",
"uuid" : "uuid",
"version" : 5,
"suspended" : true,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"deployedProcessVersion" : 4,
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"namespace" : "namespace",
"deployedDefinitionId" : "deployedDefinitionId",
"id" : 2,
"detail" : {
"thumbnail" : [ "", "" ],
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"updatedBy" : "updatedBy",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 9,
"uuid" : "uuid",
"version" : 7,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"sourceJson" : [ "", "" ]
},
"systemProcess" : true,
"key" : "key",
"status" : "DRAFT"
}, {
"updatedBy" : "updatedBy",
"lockedByProfile" : "lockedByProfile",
"code" : "code",
"description" : "description",
"deployedFlowableVersion" : 2,
"processVersion" : 3,
"type" : "STANDART",
"uuid" : "uuid",
"version" : 5,
"suspended" : true,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"deployedProcessVersion" : 4,
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"name" : "name",
"namespace" : "namespace",
"deployedDefinitionId" : "deployedDefinitionId",
"id" : 2,
"detail" : {
"thumbnail" : [ "", "" ],
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"updatedBy" : "updatedBy",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 9,
"uuid" : "uuid",
"version" : 7,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"sourceJson" : [ "", "" ]
},
"systemProcess" : true,
"key" : "key",
"status" : "DRAFT"
} ],
"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
HvlResponseHvlPageHvlBpmnProcessModel
Adds provided object (save)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
sourceProcessId (optional)
Query Parameter — format: int64
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" : 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
HvlResponseLong
Up
post /process/model/{modelId}
Saves process model node (saveProcessModelNode)
Path parameters
modelId (required)
Path Parameter — format: int64
Consumes
This API call consumes the following media types via the request header:
application/x-www-form-urlencoded
Form parameters
all (required)
Form Parameter —
empty (required)
Form 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
put /process/lock/unlock/process/{id}
Unlock the process (unlock)
Path parameters
id (required)
Path Parameter — format: int64
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
Edits object associated provided object (update)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
newVersion (required)
Query 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" : 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
HvlResponseLong
Up
put /process/upgrade-version/{processDefinitionKey}
Upgrade existing process definition (upgradeVersion)
Path parameters
processDefinitionKey (required)
Path Parameter —
Consumes
This API call consumes the following media types via the request header:
Form parameters
upgradedProcessDefinitionXmlFile (optional)
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
delete /process/comments/{uuid}
Deletes process comment by uuid (deleteByUuid)
Path parameters
uuid (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 /process/comments/{uuid}
Gets process comment by uuid (getByUuid)
Path parameters
uuid (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" : {
"updatedBy" : "updatedBy",
"commnentDate" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"version" : 1,
"commentText" : "commentText",
"editDate" : "2000-01-23T04:56:07.000+00:00",
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"commentBy" : "commentBy",
"businessKey" : "businessKey",
"id" : 5
}
}
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
HvlResponseHvlBpmnProcessCommentModel
Up
post /process/comments/list
Queries process comments according to criteria in query model (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" : [ {
"updatedBy" : "updatedBy",
"commnentDate" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"version" : 1,
"commentText" : "commentText",
"editDate" : "2000-01-23T04:56:07.000+00:00",
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"commentBy" : "commentBy",
"businessKey" : "businessKey",
"id" : 5
}, {
"updatedBy" : "updatedBy",
"commnentDate" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"version" : 1,
"commentText" : "commentText",
"editDate" : "2000-01-23T04:56:07.000+00:00",
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"commentBy" : "commentBy",
"businessKey" : "businessKey",
"id" : 5
} ]
}
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
HvlResponseListHvlBpmnProcessCommentModel
Up
post /process/comments/page
Queries process comments as paginated according to criteria in query model (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" : [ {
"updatedBy" : "updatedBy",
"commnentDate" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"version" : 1,
"commentText" : "commentText",
"editDate" : "2000-01-23T04:56:07.000+00:00",
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"commentBy" : "commentBy",
"businessKey" : "businessKey",
"id" : 5
}, {
"updatedBy" : "updatedBy",
"commnentDate" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"version" : 1,
"commentText" : "commentText",
"editDate" : "2000-01-23T04:56:07.000+00:00",
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"commentBy" : "commentBy",
"businessKey" : "businessKey",
"id" : 5
} ],
"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
HvlResponseHvlPageHvlBpmnProcessCommentModel
Up
post /process/comments
Saves process comment (save1)
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
Updates process comment (update1)
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 /process/doc/generate-documentation/{processId}
Generates process documentation (generateDocumentation)
Path parameters
processId (required)
Path Parameter — format: int64
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" : "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
HvlResponseString
Up
get /process/doc/generate-documentation/force/{processId}
Forces process documentation generation (generateDocumentationForce)
Path parameters
processId (required)
Path Parameter — format: int64
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" : "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
HvlResponseString
Up
post /process/doc-attachment/add/{processId}
Saves process documentation attachment (addFileToDocumentation)
Path parameters
processId (required)
Path Parameter — format: int64
Consumes
This API call consumes the following media types via the request header:
Form parameters
file (optional)
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" : 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
HvlResponseLong
Up
delete /process/doc-attachment/delete/{uuid}/{processUuid}
Deletes process documentation attachment by uuid and process uuid (delete)
Path parameters
uuid (required)
Path Parameter —
processUuid (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 /process/doc-attachment/download/{uuid}
Downloads process documentation attachment by uuid (downloadAttachment)
Path parameters
uuid (required)
Path Parameter —
Return type
array[byte[]]
Example data
Content-Type: application/json
[ "", "" ]
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
Up
get /process/doc-attachment/list/{businessKey}
Queries process documentation attachment by business key (getDataListByBusinessKey)
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" : [ {
"filename" : "filename",
"businessKey" : "businessKey",
"processVersion" : 0,
"uuid" : "uuid"
}, {
"filename" : "filename",
"businessKey" : "businessKey",
"processVersion" : 0,
"uuid" : "uuid"
} ]
}
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
HvlResponseListProjectedProcessDocAttachmentModel
Up
post /process/instance/by-delete-process-instance-model
Deletes process instance with provided delete process instance model (deleteByDeleteProcessInstanceModel)
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 /process/instance/logs/page
Queries process instances logs as paginated according to criteria in query model (queryInstanceLogs)
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" : [ {
"message" : "message",
"eventDate" : "2000-01-23T04:56:07.000+00:00"
}, {
"message" : "message",
"eventDate" : "2000-01-23T04:56:07.000+00:00"
} ],
"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
HvlResponseHvlPageHvlBpmnProcessInstanceLogModel
Up
post /process/instance/list
Queries process instances according to criteria in query model (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" : [ {
"processInstanceId" : "processInstanceId",
"name" : "name",
"businessKey" : "businessKey",
"active" : true,
"startTime" : "2000-01-23T04:56:07.000+00:00",
"processVersion" : 5,
"processVariables" : {
"key" : { }
},
"activityInstanceModelList" : [ {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
}, {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
} ],
"processDefinitionKey" : "processDefinitionKey"
}, {
"processInstanceId" : "processInstanceId",
"name" : "name",
"businessKey" : "businessKey",
"active" : true,
"startTime" : "2000-01-23T04:56:07.000+00:00",
"processVersion" : 5,
"processVariables" : {
"key" : { }
},
"activityInstanceModelList" : [ {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
}, {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
} ],
"processDefinitionKey" : "processDefinitionKey"
} ]
}
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
HvlResponseListHvlBpmnAdminProcessInstanceModel_WithActive
Up
post /process/instance/page
Queries process instances as paginated according to criteria in query model (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" : [ {
"processInstanceId" : "processInstanceId",
"name" : "name",
"businessKey" : "businessKey",
"active" : true,
"startTime" : "2000-01-23T04:56:07.000+00:00",
"processVersion" : 5,
"processVariables" : {
"key" : { }
},
"activityInstanceModelList" : [ {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
}, {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
} ],
"processDefinitionKey" : "processDefinitionKey"
}, {
"processInstanceId" : "processInstanceId",
"name" : "name",
"businessKey" : "businessKey",
"active" : true,
"startTime" : "2000-01-23T04:56:07.000+00:00",
"processVersion" : 5,
"processVariables" : {
"key" : { }
},
"activityInstanceModelList" : [ {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
}, {
"activityId" : "activityId",
"processDefinitionId" : "processDefinitionId",
"executionId" : "executionId",
"activityName" : "activityName",
"tenantId" : "tenantId",
"startTime" : "startTime",
"assignee" : "assignee",
"endTime" : "endTime",
"activityType" : "activityType",
"taskId" : "taskId"
} ],
"processDefinitionKey" : "processDefinitionKey"
} ],
"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
HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithActive
Up
post /process/instance/task/page
Queries tasks by process instances as paginated according to criteria in query model (queryTaskPage)
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" : 1,
"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" : 1,
"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 /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
[ Jump to Methods ]
Table of Contents
HvlBpmnActivateProcessDefinitionModel
HvlBpmnActivityInstanceModel_WithActive
HvlBpmnActivityInstanceModel_WithHistory
HvlBpmnAdminProcessInstanceModel_WithActive
HvlBpmnAdminProcessInstanceModel_WithHistory
HvlBpmnAdminProcessInstanceQueryModel_WithActive
HvlBpmnAdminProcessInstanceQueryModel_WithHistory
HvlBpmnDeleteProcessInstanceModel
HvlBpmnEventLogQueryModel
HvlBpmnProcessCommentModel
HvlBpmnProcessCommentQueryModel
HvlBpmnProcessDefinitionModel
HvlBpmnProcessDetailModel
HvlBpmnProcessInstanceLogModel
HvlBpmnProcessInstanceModel
HvlBpmnProcessModel
HvlBpmnProcessQueryModel
HvlBpmnSchedulerModel
HvlBpmnSuspendProcessDefinitionModel
HvlBpmnTaskModel
HvlBpmnTaskQueryModel
HvlBpmnVariableValueQueryModel
HvlErrorDetail
HvlErrorDetail_WithActive
HvlErrorDetail_WithHistory
HvlPageHvlBpmnAdminProcessInstanceModel_WithActive
HvlPageHvlBpmnAdminProcessInstanceModel_WithHistory
HvlPageHvlBpmnProcessCommentModel
HvlPageHvlBpmnProcessInstanceLogModel
HvlPageHvlBpmnProcessModel
HvlPageHvlBpmnTaskModel
HvlPageable
HvlPageable_WithActive
HvlPageable_WithHistory
HvlProcessDefinitionImportResultModel
HvlResponseBoolean
HvlResponseHvlBpmnProcessCommentModel
HvlResponseHvlBpmnProcessInstanceModel
HvlResponseHvlBpmnProcessModel
HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithActive
HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithHistory
HvlResponseHvlPageHvlBpmnProcessCommentModel
HvlResponseHvlPageHvlBpmnProcessInstanceLogModel
HvlResponseHvlPageHvlBpmnProcessModel
HvlResponseHvlPageHvlBpmnTaskModel
HvlResponseHvlProcessDefinitionImportResultModel
HvlResponseListHvlBpmnAdminProcessInstanceModel_WithActive
HvlResponseListHvlBpmnAdminProcessInstanceModel_WithHistory
HvlResponseListHvlBpmnProcessCommentModel
HvlResponseListHvlBpmnProcessDefinitionModel
HvlResponseListHvlBpmnProcessModel
HvlResponseListLong
HvlResponseListProjectedProcessDocAttachmentModel
HvlResponseListString
HvlResponseLong
HvlResponseString
HvlResponseVoid
HvlSort
HvlSort_WithActive
HvlSort_WithHistory
IdentityLinkInfo
JsonNode
MultiValueMapStringString
ProjectedProcessDocAttachmentModel
add_processId_body
import_all_body
process_import_body
upgradeversion_processDefinitionKey_body
id (optional)
key (optional)
tenantId (optional)
activationDate (optional)
activateProcessInstances (optional)
activityId (optional)
activityName (optional)
activityType (optional)
processDefinitionId (optional)
taskId (optional)
executionId (optional)
assignee (optional)
startTime (optional)
endTime (optional)
tenantId (optional)
activityId (optional)
activityName (optional)
activityType (optional)
processDefinitionId (optional)
taskId (optional)
executionId (optional)
assignee (optional)
startTime (optional)
endTime (optional)
tenantId (optional)
processInstanceId (optional)
processDefinitionKey (optional)
name (optional)
businessKey (optional)
active (optional)
processVersion (optional)
startTime (optional)
activityInstanceModelList (optional)
processVariables (optional)
processInstanceId (optional)
processDefinitionKey (optional)
name (optional)
businessKey (optional)
processVersion (optional)
deleteReason (optional)
endTime (optional)
startTime (optional)
activityInstanceModelList (optional)
processVariables (optional)
pageable (optional)
filters (optional)
namespace (optional)
key (optional)
processVersion (optional)
businessKey (optional)
definitionId (optional)
finished (optional)
pageable (optional)
filters (optional)
namespace (optional)
key (optional)
processVersion (optional)
businessKey (optional)
definitionId (optional)
finished (optional)
processInstanceId
deleteReason (optional)
pageable (optional)
filters (optional)
processInstanceId (optional)
username (optional)
applicationName (optional)
eventType (optional)
source (optional)
message (optional)
queryStartDate (optional)
queryEndDate (optional)
customAttribute (optional)
customAttributeList (optional)
uuid
version (optional)
dateCreated (optional)
dateUpdated (optional)
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
id
businessKey
commentText
commentBy (optional)
commnentDate (optional)
editDate (optional)
pageable (optional)
filters (optional)
idAndEq (optional)
businessKeyAndEq
commentByAndEq (optional)
commnentDateAndEq (optional)
id (optional)
key (optional)
tenantId (optional)
category (optional)
name (optional)
description (optional)
version (optional)
deploymentId (optional)
suspended (optional)
uuid
version (optional)
dateCreated (optional)
dateUpdated (optional)
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
id
thumbnail (optional)
sourceJson (optional)
eventDate (optional)
message (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)
uuid
version (optional)
dateCreated (optional)
dateUpdated (optional)
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
id
name
key
description (optional)
namespace (optional)
status (optional)
DRAFT
DEPLOYED
lockedByProfile (optional)
detail (optional)
code (optional)
processVersion (optional)
deployedFlowableVersion (optional)
deployedProcessVersion (optional)
deployedDefinitionId (optional)
suspended (optional)
systemProcess (optional)
type (optional)
STANDART
SCHEDULER_JOB
pageable (optional)
filters (optional)
idList (optional)
key (optional)
name (optional)
status (optional)
DRAFT
DEPLOYED
namespace (optional)
processVersion (optional)
flowableVersion (optional)
latestVersion (optional)
emptyCategory (optional)
suspended (optional)
type (optional)
STANDART
SCHEDULER_JOB
businessKey
periodType
ISO_8601
CRON
period
singleExecution (optional)
url
eventTopic
payload (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)
uuid (optional)
errorClassName (optional)
errorCode (optional)
errorDetail (optional)
errorMessage (optional)
service (optional)
time (optional)
errorArguments (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)
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)
pageNumber (optional)
pageSize (optional)
sort (optional)
pageNumber (optional)
pageSize (optional)
sort (optional)
exist (optional)
processDefinitionKey (optional)
processDefinitionId (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)
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)
direction (optional)
ASC
DESC
UNSORTED
properties (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)
businessKey (optional)
uuid (optional)
filename (optional)
processVersion (optional)
upgradedProcessDefinitionXmlFile