Feature/git issue 4049 process instance api enhancement

engine-rest/engine-rest-openapi/src/main/templates/models/org/camunda/bpm/engine/rest/dto/runtime/ProcessInstanceDto.ftl

@@ -12,6 +12,14 @@
         type = "string"
         desc = "The id of the process definition that this process instance belongs to." />
 
+   <#-- 
+    GIT Issue : https://github.com/camunda/camunda-bpm-platform/issues/4049 
+    -->    
+    <@lib.property
+        name = "definitionKey"
+        type = "string"
+        desc = "The key of the process definition that this process instance belongs to." />
+
     <@lib.property
         name = "businessKey"
         type = "string"
@@ -40,4 +48,4 @@
         desc = "The tenant id of the process instance." />
 
 </@lib.dto>
-</#macro>
+</#macro>

engine-rest/engine-rest-openapi/src/main/templates/paths/process-instance/get.ftl

@@ -34,6 +34,7 @@
                            "links": [],
                            "id": "anId",
                            "definitionId": "aProcDefId",
+                           "definitionKey": "aProcDefKey",
                            "businessKey": "aKey",
                            "caseInstanceId": "aCaseInstanceId",
                            "ended": false,
@@ -53,4 +54,4 @@
   }
 }
 
-</#macro>
+</#macro>

engine-rest/engine-rest-openapi/src/main/templates/paths/process-instance/post.ftl

@@ -60,6 +60,7 @@
                            "links": [],
                            "id": "anId",
                            "definitionId": "aProcessDefinitionId",
+                           "definitionKey": "aProcessDefinitionKey",
                            "businessKey": "aKey",
                            "caseInstanceId": "aCaseInstanceId",
                            "ended": false,
@@ -80,4 +81,4 @@
   }
 }
 
-</#macro>
+</#macro>

engine-rest/engine-rest-openapi/src/main/templates/paths/process-instance/{id}/get.ftl

@@ -28,6 +28,7 @@
                        "value": {
                          "id":"aProcessInstanceId",
                          "definitionId":"aProcDefId",
+                         "definitionKey":"aProcDefKey",
                          "businessKey":"aKey",
                          "caseInstanceId":"aCaseInstanceId",
                          "ended":false,
@@ -45,4 +46,4 @@
 
   }
 }
-</#macro>
+</#macro>

engine-rest/engine-rest/src/main/java/org/camunda/bpm/engine/rest/dto/runtime/ProcessInstanceDto.java

@@ -28,13 +28,18 @@ public class ProcessInstanceDto extends LinkableDto {
   private boolean ended;
   private boolean suspended;
   private String tenantId;
+  /**
+   * GIT Issue : https://github.com/camunda/camunda-bpm-platform/issues/4049
+   */
+  private String definitionKey;
 
   public ProcessInstanceDto() {
   }
 
   public ProcessInstanceDto(ProcessInstance instance) {
     this.id = instance.getId();
     this.definitionId = instance.getProcessDefinitionId();
+    this.definitionKey = instance.getProcessDefinitionKey();
     this.businessKey = instance.getBusinessKey();
     this.caseInstanceId = instance.getCaseInstanceId();
     this.ended = instance.isEnded();
@@ -49,6 +54,14 @@ public String getId() {
   public String getDefinitionId() {
     return definitionId;
   }
+
+ /**
+ * @return the definitionKey
+ * GIT Issue : https://github.com/camunda/camunda-bpm-platform/issues/4049
+ */
+  public String getDefinitionKey() {
+	return definitionKey;
+  }
 
   public String getBusinessKey() {
     return businessKey;

engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/ProcessInstanceRestServiceInteractionTest.java

@@ -1083,6 +1083,7 @@ public void testGetSingleInstance() {
       .body("id", Matchers.equalTo(MockProvider.EXAMPLE_PROCESS_INSTANCE_ID))
       .body("ended", Matchers.equalTo(MockProvider.EXAMPLE_PROCESS_INSTANCE_IS_ENDED))
       .body("definitionId", Matchers.equalTo(MockProvider.EXAMPLE_PROCESS_DEFINITION_ID))
+      .body("definitionKey", Matchers.equalTo(MockProvider.EXAMPLE_PROCESS_DEFINITION_KEY))
       .body("businessKey", Matchers.equalTo(MockProvider.EXAMPLE_PROCESS_INSTANCE_BUSINESS_KEY))
       .body("suspended", Matchers.equalTo(MockProvider.EXAMPLE_PROCESS_INSTANCE_IS_SUSPENDED))
       .body("tenantId", Matchers.equalTo(MockProvider.EXAMPLE_TENANT_ID))

engine/src/main/java/org/camunda/bpm/engine/impl/persistence/entity/ExecutionEntity.java

@@ -1935,4 +1935,25 @@ public ProcessEngine getProcessEngine() {
   public String getProcessDefinitionTenantId() {
     return getProcessDefinition().getTenantId();
   }
+
+  /**
+   * reference to a process definition entity within Execution Entity
+   * 
+   * GIT Issue : https://github.com/camunda/camunda-bpm-platform/issues/4049
+   */
+
+  protected transient ProcessDefinitionEntity processDefinitionKey;
+
+  /**
+   * persisted reference to the process definition.
+   *
+   * @see #getProcessDefinitionKey()
+   * 
+   * GIT Issue : https://github.com/camunda/camunda-bpm-platform/issues/4049
+   */
+
+  @Override
+  public String getProcessDefinitionKey() {
+		return getProcessDefinition().getKey();
+	}
 }

engine/src/main/java/org/camunda/bpm/engine/impl/persistence/entity/ProcessInstanceWithVariablesImpl.java

@@ -86,4 +86,14 @@ public String getProcessInstanceId() {
   public String getTenantId() {
     return executionEntity.getTenantId();
   }
+  /**
+   * The Key of the process definition of the process instance.
+   * 
+   * GIT Issue : https://github.com/camunda/camunda-bpm-platform/issues/4049
+   */
+
+  @Override
+  public String getProcessDefinitionKey() {
+		return executionEntity.getProcessDefinitionKey();
+  }
 }

engine/src/main/java/org/camunda/bpm/engine/runtime/ProcessInstance.java

@@ -32,6 +32,13 @@ public interface ProcessInstance extends Execution {
    */
   String getProcessDefinitionId();
 
+   /**
+   * The Key of the process definition of the process instance.
+   * 
+   * GIT Issue : https://github.com/camunda/camunda-bpm-platform/issues/4049
+   */
+  String getProcessDefinitionKey();
+
   /**
    * The business key of this process instance.
    */

engine/src/main/resources/org/camunda/bpm/engine/impl/mapping/entity/Execution.xml

@@ -155,8 +155,22 @@
     <result property="cachedEntityState" column="CACHED_ENT_STATE_" jdbcType="INTEGER"/>
     <result property="sequenceCounter" column="SEQUENCE_COUNTER_" jdbcType="BIGINT"/>
     <result property="tenantId" column="TENANT_ID_" jdbcType="VARCHAR"/>
+    <result property="tenantId" column="TENANT_ID_" jdbcType="VARCHAR"/>
+
+    <!-- Added the association relationship between Process Instance and Process Definition
+         GIT Issue : https://github.com/camunda/camunda-bpm-platform/issues/4049  -->
+    <association property="processDefinitionKey" resultMap="definitionResult"/>
   </resultMap>
 
+  <!-- Added the resultMap id="definitionResult" to accomodate returning Process definition Key for Process Instance GET and POST API Calls
+       as per GIT Issue : https://github.com/camunda/camunda-bpm-platform/issues/4049 
+       Averted updates to selectExecutionsByQueryCriteriaSql, as this select query is also being used by other API's-->
+
+  <resultMap id="definitionResult" type="org.camunda.bpm.engine.impl.persistence.entity.ProcessDefinitionEntity">
+     <id property="id" column="ID_" jdbcType="VARCHAR" />
+    <result property="key" column="KEY_"/>
+  </resultMap>
+
   <resultMap type="org.camunda.bpm.engine.impl.util.ImmutablePair" id="deploymentIdMapping">
     <id property="left" column="DEPLOYMENT_ID_" jdbcType="VARCHAR" />
     <id property="right" column="ID_" jdbcType="VARCHAR" />