Sign in
Process Definition

Get

Retrieves the latest version of the process definition for tenant according to the ProcessDefinition interface in the engine.

get/process-definition/key/{key}/tenant-id/{tenant-id}

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/process-definition/key/{key}/tenant-id/{tenant-id}
  • Auth: HTTP basic

Path parameters

keystring required

The key of the process definition (the latest version thereof) to be retrieved.

tenant-idstring required

The id of the tenant the process definition belongs to.

Response

Request successful.

idstring nullable

The id of the process definition

keystring nullable

The key of the process definition, i.e., the id of the BPMN 2.0 XML process definition.

categorystring nullable

The category of the process definition.

descriptionstring nullable

The description of the process definition.

namestring nullable

The name of the process definition.

versioninteger nullable

The version of the process definition that the engine assigned to it.

resourcestring nullable

The file name of the process definition.

deploymentIdstring nullable

The deployment id of the process definition.

diagramstring nullable

The file name of the process definition diagram, if it exists.

suspendedboolean nullable

A flag indicating whether the definition is suspended or not.

tenantIdstring nullable

The tenant id of the process definition.

versionTagstring nullable

The version tag of the process definition.

historyTimeToLiveinteger nullable

History time to live value of the process definition. Is used within History cleanup.

startableInTasklistboolean nullable

A flag indicating whether the process definition is startable in Tasklist or not.

Changes

No recorded changes to this operation across all 1 revision of this API.