Assign Work Item (Task)

API Type

REST

HTTP Method

POST

Description

Assigns a human task (manual work item) to a user, which often means claiming a task for oneself.

Good to Know

  • This is often used with task pools where tasks are created, and then multiple users are notified, but the task is not immediately assigned to a user. A user then claims the task, or his manager assigns it to him.
  • The user must have access rights to claim or assign the task.

URL Format (OnPremises, Private Cloud)

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

URL Format (OnDemand)

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

Request Parameters

NameDescription

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

NameDescription

clientData
Function:
Specifies the client data, which identifies a client for AgilePoint Server.
Type
string
Accepted Values:
A string that contains the client data.

If this value is null, the system will keep existing client data. Otherwise the relevant data is overwritten.

JavaScript Code Example

$("#btnAssignWorkItem").click(function () {

  var JSONObject = { clientData: null };

  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                AssignWorkItem/D4751D6380F141A4AC89AF6820B988D5",
    data: JSON.stringify(JSONObject)
  });

});

Java Code Example

public String AssignWorkItem() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        AssignWorkItem/D4751D6380F141A4AC89AF6820B988D5";

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

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

C# Code Example

public string AssignWorkItem()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/
                         AssignWorkItem/D4751D6380F141A4AC89AF6820B988D5";

    string jsonRequestData = "{\"clientData\":\"" + null + "\"}";

    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 {\"clientData\":\"\"} 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         AssignWorkItem/827128D244B4F4D9117761512B78D158

Output

WFEvent class that represents the workflow event instance that is created when the task is assigned.

JSON Response Body Example

{
  "ActivityInstID": "0DB05C1A1BAB445895CCF46E096AECDD",
  "AutoStart": true,
  "CustomAttributes": null,
  "Diagnostic": true,
  "EndDate": "\/Date(928149600000+0000)\/",
  "Entries": 1,
  "Error": null,
  "EventID": "25B6221C3F06459A803382485CEE0101",
  "EventName": "AssignWorkItem",
  "HighPriority": true,
  "ParamsXml": "<?xml version=\"1.0\" encoding=\"utf-8\"?>
                <WFEvent>
                  <param name=\"ProcInstID\" 
                            value=\"B7F0ACFA610349B4BF10A4DAB8E93458\" \/>
                  <param name=\"ActivityInstID\" 
                            value=\"0DB05C1A1BAB445895CCF46E096AECDD\" \/>
                  <param name=\"HighPriority\" value=\"True\" \/>
                  <param name=\"WorkItemID\" 
                            value=\"2AA1E203047B41F29E3E29F62D00903B\" \/>
                <\/WFEvent>",
  "ParentProcInstID": "",
  "ProcDefID": "",
  "ProcInstID": "B7F0ACFA610349B4BF10A4DAB8E93458",
  "ProcInstName": "",
  "Sender": "mydomain\\administrator",
  "SentDate": "\/Date(1394147826010+0000)\/",
  "SourceWorkItemID": "",
  "Status": "Sent",	
  "UserID": "",
  "WorkItemID": "2AA1E203047B41F29E3E29F62D00903B",
  "WorkObjectID": "",
  "WorkObjectInfo": ""
}

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.