Update Process Instance

API Type

REST

HTTP Method

POST

Description

Updates process attribute, such as process instance name, due date, work object info.

Good to Know

  • The process attributes that can be updated are listed in the attribute table.
  • To call this method, the API account user must have the access right, Initiate a Process.

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

Name Description

processInstanceID
Function:
Specifies the unique ID of a process instance.
Type
string
Accepted Values:
A valid process instance ID

Request Body Properties

Name Description

attributes
Function:
Name-value pairs associated with a custom ID.
Type
NameValue
Accepted Values:
A valid custom ID with an associated name.

Attributes

Name Description
ProcInstName The name of the process instance.
DueDate The date that the process instance is expected to be complete
workObjectID The ID of the work object.

JavaScript Code Example

$("#btnUpdateProcInst").click(function () {
  var JSONObject = { attributes: [{ Name: "PROCINSTNAME", Value: "test123" }]};
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                UpdateProcInst/F05A692BBC514477BECA6586EFF90101",
    dataType: "text",
    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);
  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password. 
curl --header "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST 
                         --data {\"attributes\":[{\"Name\":\"PROCINSTNAME\",
                         \"Value\":\"test123\"}]} 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         UpdateProcInst/827128D244B4F4D9117760CD00B194AA

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.