Merge Process Instances

API Type

REST

HTTP Method

POST

Description

Merges 2 or more process instances into one process instance.

These process instances should be based on the same process definition.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/MergeProcInsts

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/MergeProcInsts

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
instruction	Definition: Specifies the instructions for merging two process instances. Type WFProcessMergingInstruction Allowed Values: A WFProcessMergingInstruction object.

JavaScript Code Example

$("#btnMergeProcInsts").click(function () {
                 
  var JSONObject =  {
    MergedProcessInstance:{
    CustomAttributes:[{
    Name:"/pd:myFields/pd:username",
    Value:"Administrator"
    },
    {
    Name:"/pd:myFields/pd:dept",
    Value:"IT Admin"
    } 
    ],
    ProcessInstanceID:"008493358D1A419EA7094B7A3A58929D",
    ProcessInstanceName:"ProcessMapApproval-008493358D1A419EA7094B7A3A58929D",
    WorkObjectID:"00777ED0FE3E4AB49C44E7E5EDAA9656",
    WorkObjectInfo:"00777ED0FE3E4AB49C44E7E5EDAA9656t"
    },
    MergingProcessInstanceIDs:["060404057EC543A48C16FEC3F7FF8374","061761ADBEA2450A8F70538C495D9773"]
    };                 
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/MergeProcInsts",
    data: JSON.stringify(JSONObject),
                      
});

});

Output

The process instance ID of the merged process instance.

JSON Response Body Example

"String content"

Supported Versions

AgilePoint BPMS v5.0 R2 and higher