Update Work Item

API Type

REST

HTTP Method

POST

Description

Updates the properties for a human task (manual work item) or a system activity (automatic work item).

Good to Know

  • Lets you update only the properties: Task Name, Original User ID, ClientData, Pool ID, Pool Info, Status, User ID, Resolve Participant, Priority, or Due Date.

    If you try to update any other property, it throws an exception.

  • To call this method, the API account user must have the access right, Create a Task.

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

Name Description

workItemID
Function:
An ID that represents a work item (task).
Type
string
Accepted Values:
A valid, unique 32-byte work item (task) ID.

Request Body Properties

Name Description

attributes
Function:
A NameValue array that contains the attributes that needs to be updated in the work item.
Type
NameValue
Accepted Values:

For a manual work item, the following attributes can be updated:

  • NAME
  • ORIGINAL_USER_ID
  • CLIENT_DATA, POOL_ID
  • POOL_INFO
  • STATUS
  • USER_ID
  • PRIORITY
  • DUE_DATE

For an automatic work item, the following attributes can be updated:

  • DUE_DATE
  • STATUS - if the value is Canceled, Completed, Overdue, Running, or Waiting.

JavaScript Code Example

$("#btnUpdateWorkItem").click(function () {
  
  var JSONObject = { attributes: [{ Name: "NAME", Value: "nishant" }]};
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                UpdateWorkItem/3D1F3E6003E4487ABA8E2ADB22A85CC2",
    dataType: "text",
    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);
  }

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\":\"NAME\",
                         \"Value\":\"Rollback Session Demo New\"}]} 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         UpdateWorkItem/827128D244B4F4D9117760CA3A2EC9FE

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.