Update Process Definition

API Type

REST

HTTP Method

POST

Description

Updates a process definition without using version control. This method is intended for minor changes only, such as typographical errors. Warning: Changes made using this method circumvent version control, meaning changes are not tracked, and versions cannot be managed. Do not use this call for making any major changes to the process definition.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
xml	Definition: Specifies a process definition in XML format. To generate the process definition file in XML format, in AgilePoint Envision, click File > Export & Import > Save As Deploying File(xml). You can also download the process definition XML from AgilePoint Enterprise Manager. Type string Allowed Values: A string that contains process definition in XML format.

JavaScript Code Example

$("#btnUpdateProcDef").click(function () {
  
  var JSONData = { xml: '<process template XML string>' }; 
 
  $.ajax({
    url: 'http://mydomain:9011/AgilePointServer/Workflow/UpdateProcDef',
    data: JSON.stringify(JSONData)
  });
});

Output

Returns the unique identifier for the process definition that is updated.

JSON Response Body Example

"String content"

Supported Versions

AgilePoint BPMS v5.0 R2 and higher