Hvl Bpmn Admin Server

Havelsan bpmn admin services info
More information: https://www.havelsan.com.tr
Contact Info: BIT_JAVA_ALTYAPI_YAZILIM_MIM_TK@havelsan.com.tr
Version: 3.1.0-SNAPSHOT
Apache License Version 2.0
https://www.apache.org/licenses/LICENSE-2.0

Access

Methods

[ Jump to Models ]

Table of Contents

BpmnAdminRepositoryAPI

BpmnDisplayJsonClientResourceAPI

BpmnHistoricProcessInstanceAPI

BpmnProcessAPI

BpmnProcessCommentAPI

BpmnProcessDocumentationAPI

BpmnProcessDocumentationAttachmentAPI

BpmnProcessInstanceAPI

BpmnSchedulerAdminPublicAPI

BpmnAdminRepositoryAPI

Up
post /admin/repository/activate
Activate process definition by key (activateProcessDefinition)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseListHvlBpmnProcessDefinitionModel

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

BpmnDisplayJsonClientResourceAPI

Up
get /display/process-instances/debugger/{processInstanceId}/model-json
Gets debugger model json (getDebuggerModelJSON)

Path parameters

processInstanceId (required)
Path Parameter

Return type

JsonNode

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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

JsonNode

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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

JsonNode

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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

JsonNode

Example data

Content-Type: application/json
{ }

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK JsonNode

BpmnHistoricProcessInstanceAPI

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 Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlBpmnAdminProcessInstanceModel_WithHistory

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithHistory

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithHistory

BpmnProcessAPI

Up
delete /process/delete/{id}
Removes object according to provided parameter (delete1)

Path parameters

id (required)
Path Parameter — format: int64

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /process/deploy/{processId}
Deploy process (deployProcess)

Path parameters

processId (required)
Path Parameter — format: int64

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body long (required)
Body Parameter

Return type

array[byte[]]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseLong

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseLong

Up
get /process/namespaces
Gets namespace list (getNamespaceList)

Return type

HvlResponseListString

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListString

Up
get /process/{id}
Gets process by id (getProcessById)

Path parameters

id (required)
Path Parameter — format: int64

Return type

HvlResponseHvlBpmnProcessModel

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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseHvlBpmnProcessModel

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 Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseListLong

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Form parameters

zipFile (optional)
Form Parameter — format: binary

Return type

HvlResponseListHvlBpmnProcessModel

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlBpmnProcessModel

Up
post /process/import
Imports a bpmn xml (importProcess)

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

xmlFile (optional)
Form Parameter — format: binary

Return type

HvlResponseHvlProcessDefinitionImportResultModel

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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseBoolean

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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseListString

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListString

Up
post /process/list
Queries processes according to criteria in query model (queryList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlBpmnProcessQueryModel (required)
Body Parameter

Return type

HvlResponseListHvlBpmnProcessModel

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlBpmnProcessModel

Up
post /process/page
Queries processes as paginated according to criteria in query model (queryPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlBpmnProcessQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlBpmnProcessModel

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlBpmnProcessModel

Up
post /process/save
Adds provided object (save)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlBpmnProcessModel (required)
Body Parameter

Query parameters

sourceProcessId (optional)
Query Parameter — format: int64

Return type

HvlResponseLong

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Form parameters

all (required)
Form Parameter
empty (required)
Form Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /process/update
Edits object associated provided object (update)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlBpmnProcessModel (required)
Body Parameter

Query parameters

newVersion (required)
Query Parameter

Return type

HvlResponseLong

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Form parameters

upgradedProcessDefinitionXmlFile (optional)
Form Parameter — format: binary

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

BpmnProcessCommentAPI

Up
delete /process/comments/{uuid}
Deletes process comment by uuid (deleteByUuid)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseHvlBpmnProcessCommentModel

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlBpmnProcessCommentModel

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlBpmnProcessCommentModel

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /process/comments
Updates process comment (update1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

BpmnProcessDocumentationAPI

Up
get /process/doc/generate-documentation/{processId}
Generates process documentation (generateDocumentation)

Path parameters

processId (required)
Path Parameter — format: int64

Return type

HvlResponseString

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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseString

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseString

BpmnProcessDocumentationAttachmentAPI

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 Content-Type request header:

Form parameters

file (optional)
Form Parameter — format: binary

Return type

HvlResponseLong

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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type 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 Accept request header; the media type will be conveyed by the Content-Type 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

HvlResponseListProjectedProcessDocAttachmentModel

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListProjectedProcessDocAttachmentModel

BpmnProcessInstanceAPI

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 Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlBpmnProcessInstanceLogModel

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlBpmnAdminProcessInstanceModel_WithActive

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithActive

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body HvlBpmnTaskQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlBpmnTaskModel

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlBpmnTaskModel

BpmnSchedulerAdminPublicAPI

Up
post /scheduler/finish/by-business-key-list
Finishs scheduler job. (finishScheduler)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /scheduler/restart/{processInstanceId}
Restarts async scheduler job. (restartScheduler)

Path parameters

processInstanceId (required)
Path Parameter

Return type

HvlResponseHvlBpmnProcessInstanceModel

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body HvlBpmnSchedulerModel (required)
Body Parameter

Return type

HvlResponseHvlBpmnProcessInstanceModel

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 Accept request header; the media type will be conveyed by the Content-Type 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 Content-Type request header:

Request body

body HvlBpmnSchedulerModel (required)
Body Parameter

Return type

HvlResponseHvlBpmnProcessInstanceModel

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlBpmnProcessInstanceModel

Models

[ Jump to Methods ]

Table of Contents

  1. HvlBpmnActivateProcessDefinitionModel
  2. HvlBpmnActivityInstanceModel_WithActive
  3. HvlBpmnActivityInstanceModel_WithHistory
  4. HvlBpmnAdminProcessInstanceModel_WithActive
  5. HvlBpmnAdminProcessInstanceModel_WithHistory
  6. HvlBpmnAdminProcessInstanceQueryModel_WithActive
  7. HvlBpmnAdminProcessInstanceQueryModel_WithHistory
  8. HvlBpmnDeleteProcessInstanceModel
  9. HvlBpmnEventLogQueryModel
  10. HvlBpmnProcessCommentModel
  11. HvlBpmnProcessCommentQueryModel
  12. HvlBpmnProcessDefinitionModel
  13. HvlBpmnProcessDetailModel
  14. HvlBpmnProcessInstanceLogModel
  15. HvlBpmnProcessInstanceModel
  16. HvlBpmnProcessModel
  17. HvlBpmnProcessQueryModel
  18. HvlBpmnSchedulerModel
  19. HvlBpmnSuspendProcessDefinitionModel
  20. HvlBpmnTaskModel
  21. HvlBpmnTaskQueryModel
  22. HvlBpmnVariableValueQueryModel
  23. HvlErrorDetail
  24. HvlErrorDetail_WithActive
  25. HvlErrorDetail_WithHistory
  26. HvlPageHvlBpmnAdminProcessInstanceModel_WithActive
  27. HvlPageHvlBpmnAdminProcessInstanceModel_WithHistory
  28. HvlPageHvlBpmnProcessCommentModel
  29. HvlPageHvlBpmnProcessInstanceLogModel
  30. HvlPageHvlBpmnProcessModel
  31. HvlPageHvlBpmnTaskModel
  32. HvlPageable
  33. HvlPageable_WithActive
  34. HvlPageable_WithHistory
  35. HvlProcessDefinitionImportResultModel
  36. HvlResponseBoolean
  37. HvlResponseHvlBpmnProcessCommentModel
  38. HvlResponseHvlBpmnProcessInstanceModel
  39. HvlResponseHvlBpmnProcessModel
  40. HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithActive
  41. HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithHistory
  42. HvlResponseHvlPageHvlBpmnProcessCommentModel
  43. HvlResponseHvlPageHvlBpmnProcessInstanceLogModel
  44. HvlResponseHvlPageHvlBpmnProcessModel
  45. HvlResponseHvlPageHvlBpmnTaskModel
  46. HvlResponseHvlProcessDefinitionImportResultModel
  47. HvlResponseListHvlBpmnAdminProcessInstanceModel_WithActive
  48. HvlResponseListHvlBpmnAdminProcessInstanceModel_WithHistory
  49. HvlResponseListHvlBpmnProcessCommentModel
  50. HvlResponseListHvlBpmnProcessDefinitionModel
  51. HvlResponseListHvlBpmnProcessModel
  52. HvlResponseListLong
  53. HvlResponseListProjectedProcessDocAttachmentModel
  54. HvlResponseListString
  55. HvlResponseLong
  56. HvlResponseString
  57. HvlResponseVoid
  58. HvlSort
  59. HvlSort_WithActive
  60. HvlSort_WithHistory
  61. IdentityLinkInfo
  62. JsonNode
  63. MultiValueMapStringString
  64. ProjectedProcessDocAttachmentModel
  65. add_processId_body
  66. import_all_body
  67. process_import_body
  68. upgradeversion_processDefinitionKey_body

HvlBpmnActivateProcessDefinitionModel Up

id (optional)
key (optional)
tenantId (optional)
activationDate (optional)
Date format: date-time
activateProcessInstances (optional)

HvlBpmnActivityInstanceModel_WithActive Up

activityId (optional)
activityName (optional)
activityType (optional)
processDefinitionId (optional)
taskId (optional)
executionId (optional)
assignee (optional)
startTime (optional)
endTime (optional)
tenantId (optional)

HvlBpmnActivityInstanceModel_WithHistory Up

activityId (optional)
activityName (optional)
activityType (optional)
processDefinitionId (optional)
taskId (optional)
executionId (optional)
assignee (optional)
startTime (optional)
endTime (optional)
tenantId (optional)

HvlBpmnAdminProcessInstanceModel_WithActive Up

processInstanceId (optional)
processDefinitionKey (optional)
name (optional)
businessKey (optional)
active (optional)
processVersion (optional)
Long format: int64
startTime (optional)
Date format: date-time
activityInstanceModelList (optional)
processVariables (optional)

HvlBpmnAdminProcessInstanceModel_WithHistory Up

processInstanceId (optional)
processDefinitionKey (optional)
name (optional)
businessKey (optional)
processVersion (optional)
Long format: int64
deleteReason (optional)
endTime (optional)
Date format: date-time
startTime (optional)
Date format: date-time
activityInstanceModelList (optional)
processVariables (optional)

HvlBpmnAdminProcessInstanceQueryModel_WithActive Up

pageable (optional)
filters (optional)
namespace (optional)
key (optional)
processVersion (optional)
Long format: int64
businessKey (optional)
definitionId (optional)
finished (optional)

HvlBpmnAdminProcessInstanceQueryModel_WithHistory Up

pageable (optional)
filters (optional)
namespace (optional)
key (optional)
processVersion (optional)
Long format: int64
businessKey (optional)
definitionId (optional)
finished (optional)

HvlBpmnDeleteProcessInstanceModel Up

processInstanceId
deleteReason (optional)

HvlBpmnEventLogQueryModel Up

pageable (optional)
filters (optional)
processInstanceId (optional)
username (optional)
applicationName (optional)
eventType (optional)
source (optional)
message (optional)
queryStartDate (optional)
Date format: date-time
queryEndDate (optional)
Date format: date-time
customAttribute (optional)
customAttributeList (optional)

HvlBpmnProcessCommentModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
businessKey
commentText
commentBy (optional)
commnentDate (optional)
Date format: date-time
editDate (optional)
Date format: date-time

HvlBpmnProcessCommentQueryModel Up

pageable (optional)
filters (optional)
idAndEq (optional)
array[Long] format: int64
businessKeyAndEq
commentByAndEq (optional)
commnentDateAndEq (optional)
array[Date] format: date-time

HvlBpmnProcessDefinitionModel Up

id (optional)
key (optional)
tenantId (optional)
category (optional)
name (optional)
description (optional)
version (optional)
Integer format: int32
deploymentId (optional)
suspended (optional)

HvlBpmnProcessDetailModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
thumbnail (optional)
array[byte[]] format: byte
sourceJson (optional)
array[byte[]] format: byte

HvlBpmnProcessInstanceLogModel Up

eventDate (optional)
Date format: date-time
message (optional)

HvlBpmnProcessInstanceModel Up

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)
Integer format: int32
deploymentId (optional)
businessKey (optional)
businessStatus (optional)
localizedName (optional)
localizedDescription (optional)
startTime (optional)
Date format: date-time
startUserId (optional)
callbackId (optional)
callbackType (optional)
processVariables (optional)
suspended (optional)
ended (optional)

HvlBpmnProcessModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
key
description (optional)
namespace (optional)
status (optional)
Enum:
DRAFT
DEPLOYED
lockedByProfile (optional)
detail (optional)
code (optional)
processVersion (optional)
Long format: int64
deployedFlowableVersion (optional)
Long format: int64
deployedProcessVersion (optional)
Long format: int64
deployedDefinitionId (optional)
suspended (optional)
systemProcess (optional)
type (optional)
Enum:
STANDART
SCHEDULER_JOB

HvlBpmnProcessQueryModel Up

pageable (optional)
filters (optional)
idList (optional)
array[Long] format: int64
key (optional)
name (optional)
status (optional)
Enum:
DRAFT
DEPLOYED
namespace (optional)
processVersion (optional)
Long format: int64
flowableVersion (optional)
Long format: int64
latestVersion (optional)
emptyCategory (optional)
suspended (optional)
type (optional)
Enum:
STANDART
SCHEDULER_JOB

HvlBpmnSchedulerModel Up

businessKey
periodType
Enum:
ISO_8601
CRON
period
singleExecution (optional)
url
eventTopic
payload (optional)

HvlBpmnSuspendProcessDefinitionModel Up

id (optional)
key (optional)
tenantId (optional)
suspensionDate (optional)
Date format: date-time
suspendProcessInstances (optional)

HvlBpmnTaskModel Up

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)
Date format: date-time
dueDate (optional)
Date format: date-time
priority (optional)
Integer format: int32
category (optional)
delegationState (optional)
Enum:
PENDING
RESOLVED
claimTime (optional)
Date format: date-time
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)

HvlBpmnTaskQueryModel Up

pageable (optional)
filters (optional)
processDefinitionKey (optional)
processDefinitionKeyList (optional)
processDefinitionId (optional)
processDefinitionCategory (optional)
processDefinitionName (optional)
processDefinitionEngineVersion (optional)
processDefinitionVersion (optional)
Integer format: int32
processInstanceId (optional)
processInstanceBusinessKey (optional)
variableValueEqualsIgnoreCaseList (optional)
variableValueNotEqualsIgnoreCaseList (optional)
variableValueLikeList (optional)
variableValueLikeIgnoreCaseList (optional)
locale (optional)
withLocalizationFallback (optional)
startedBefore (optional)
Date format: date-time
startedAfter (optional)
Date format: date-time
startedBy (optional)
taskDelegationState (optional)
Enum:
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)
Integer format: int32
taskMinPriority (optional)
Integer format: int32
taskMaxPriority (optional)
Integer format: int32
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)
Date format: date-time
taskCreatedBefore (optional)
Date format: date-time
taskCreatedAfter (optional)
Date format: date-time
taskCategory (optional)
taskWithFormKey (optional)
taskFormKey (optional)
taskDefinitionKey (optional)
taskDefinitionKeyLike (optional)
taskDefinitionKeyList (optional)
taskDueDate (optional)
Date format: date-time
taskDueBefore (optional)
Date format: date-time
taskDueAfter (optional)
Date format: date-time
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)

HvlBpmnVariableValueQueryModel Up

name (optional)
value (optional)

HvlErrorDetail Up

uuid (optional)
errorClassName (optional)
errorCode (optional)
errorDetail (optional)
errorMessage (optional)
service (optional)
time (optional)
Date format: date-time
errorArguments (optional)

HvlErrorDetail_WithActive Up

uuid (optional)
errorClassName (optional)
errorCode (optional)
errorDetail (optional)
errorMessage (optional)
service (optional)
time (optional)
Date format: date-time
errorArguments (optional)

HvlErrorDetail_WithHistory Up

uuid (optional)
errorClassName (optional)
errorCode (optional)
errorDetail (optional)
errorMessage (optional)
service (optional)
time (optional)
Date format: date-time
errorArguments (optional)

HvlPageHvlBpmnAdminProcessInstanceModel_WithActive Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlBpmnAdminProcessInstanceModel_WithHistory Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlBpmnProcessCommentModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlBpmnProcessInstanceLogModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlBpmnProcessModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlBpmnTaskModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageable Up

pageNumber (optional)
Integer format: int32
pageSize (optional)
Integer format: int32
sort (optional)

HvlPageable_WithActive Up

pageNumber (optional)
Integer format: int32
pageSize (optional)
Integer format: int32
sort (optional)

HvlPageable_WithHistory Up

pageNumber (optional)
Integer format: int32
pageSize (optional)
Integer format: int32
sort (optional)

HvlProcessDefinitionImportResultModel Up

exist (optional)
processDefinitionKey (optional)
processDefinitionId (optional)
Long format: int64

HvlResponseBoolean Up

body (optional)
errorDetail (optional)

HvlResponseHvlBpmnProcessCommentModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlBpmnProcessInstanceModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlBpmnProcessModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithActive Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlBpmnAdminProcessInstanceModel_WithHistory Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlBpmnProcessCommentModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlBpmnProcessInstanceLogModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlBpmnProcessModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlBpmnTaskModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlProcessDefinitionImportResultModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlBpmnAdminProcessInstanceModel_WithActive Up

body (optional)
errorDetail (optional)

HvlResponseListHvlBpmnAdminProcessInstanceModel_WithHistory Up

body (optional)
errorDetail (optional)

HvlResponseListHvlBpmnProcessCommentModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlBpmnProcessDefinitionModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlBpmnProcessModel Up

body (optional)
errorDetail (optional)

HvlResponseListLong Up

body (optional)
array[Long] format: int64
errorDetail (optional)

HvlResponseListProjectedProcessDocAttachmentModel Up

body (optional)
errorDetail (optional)

HvlResponseListString Up

body (optional)
errorDetail (optional)

HvlResponseLong Up

body (optional)
Long format: int64
errorDetail (optional)

HvlResponseString Up

body (optional)
errorDetail (optional)

HvlResponseVoid Up

body (optional)
errorDetail (optional)

HvlSort Up

direction (optional)
Enum:
ASC
DESC
UNSORTED
properties (optional)

HvlSort_WithActive Up

direction (optional)
Enum:
ASC
DESC
UNSORTED
properties (optional)

HvlSort_WithHistory Up

direction (optional)
Enum:
ASC
DESC
UNSORTED
properties (optional)

IdentityLinkInfo Up

type (optional)
scopeId (optional)
groupId (optional)
processInstanceId (optional)
taskId (optional)
subScopeId (optional)
scopeType (optional)
scopeDefinitionId (optional)
userId (optional)

JsonNode Up

MultiValueMapStringString Up

ProjectedProcessDocAttachmentModel Up

businessKey (optional)
uuid (optional)
filename (optional)
processVersion (optional)
Long format: int64

add_processId_body Up

file
byte[] format: binary

import_all_body Up

zipFile
byte[] format: binary

process_import_body Up

xmlFile
byte[] format: binary

upgradeversion_processDefinitionKey_body Up

upgradedProcessDefinitionXmlFile
byte[] format: binary