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

Request Body Properties

JavaScript Code Example

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

Java Code Example

public String UpdateProcDef() {
  String URI = "https://mydomain:9011/AgilePointServer/Workflow/UpdateProcDef";

  HTTPOperations ops = new HTTPOperations(domain, userName, 
                       password, appID, locale);

  JSONObject postData = new JSONObject();
  postData.append("xml", "<process template XML string>");

  return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string UpdateProcDef() 
  {

    string jsonRequestData = "{
      \"xml\": \"" + '<process template XML string>' + "\"}";

    string URL = "https://mydomain:9011/AgilePointServer/Workflow/UpdateProcDef";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.POSTMethod(URL, jsonRequestData);

  }

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