Update Work Item

API Type

REST

HTTP Method

POST

Description

Updates a manual work item or automatic work item.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/UpdateWorkItem/[workItemID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/UpdateWorkItem/[workItemID]

Request Parameters

Request Body Properties

JavaScript Code Example

$("#btnUpdateWorkItem").click(function () {
  
  var JSONObject = { attributes: [{ Name: "NAME", Value: "nishant" }]};
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                UpdateWorkItem/3D1F3E6003E4487ABA8E2ADB22A85CC2",
    data: JSON.stringify(JSONObject)
  });
  
});

Java Code Example

public String UpdateWorkItem() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        UpdateWorkItem/3D1F3E6003E4487ABA8E2ADB22A85CC2";

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

  JSONArray postArray = new JSONArray();
  String[] Name = { "NAME" };
  String[] Value = { "Rollback Session Demo New" };
  
    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);
    }

    JSONObject postData = new JSONObject();
    postData.put("attributes", postArray);
    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string UpdateWorkItem()
  {
    string URL = "https://mydomain:9011/AgilePointServer/Workflow/
                         UpdateWorkItem/3D1F3E6003E4487ABA8E2ADB22A85CC2";

    string jh = "{
      \"attributes\":[{\"Name\":\"NAME\",
      \"Value\":\"Rollback Session Demo New\"}]}";

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

    return ops.POSTMethod(URL, jh);
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher