Update Process Instance

API Type

REST

HTTP Method

POST

Description

Updates attributes of a workflow process instance. The attributes that can be updated are listed in the attribute table.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/UpdateProcInst/[processInstanceID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/UpdateProcInst/[processInstanceID]

Request Parameters

Request Body Properties

Attributes

JavaScript Code Example

$("#btnUpdateProcInst").click(function () {
  var JSONObject = { attributes: [{ Name: "PROCINSTNAME", Value: "test123" }]};
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                UpdateProcInst/F05A692BBC514477BECA6586EFF90101",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public String UpdateProcInst() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        UpdateProcInst/F05A692BBC514477BECA6586EFF90101";

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

  JSONObject postMainData = new JSONObject();

  JSONArray postArray = new JSONArray();

  
    String[] Name = { "PROC_INST_NAME" };
    String[] Value = { "Process Map Approval" };
    for (int i = 0; i < Name.length; i++) {
      JSONObject nameValuePair = new JSONObject();
      nameValuePair.put("Name", Name[i]);
      nameValuePair.put("Value", Value[i]);

      postArray.put(nameValuePair);
    }

    postMainData.put("attributes", postArray);
    return ops.POSTMethod(URI, postMainData.toString());
  return "";
}

C# Code Example

public string UpdateProcInst()
  {
    string jsonRequestData = "{
      \"attributes\":[{
      \"Name\":\"PROCINSTNAME\",
      \"Value\":\"test123\"}]}";

    string URI = "https://mydomain:9011//AgilePointServer/Workflow/
                  UpdateProcInst/F05A692BBC514477BECA6586EFF90101";

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

    return ops.POSTMethod(URI, jsonRequestData);
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher