Assign Work Item

API Type

REST

HTTP Method

POST

Description

Assigns a work item to a user, which often means claiming a work item for oneself. This is often used with task pools where work items are created, and then multiple users are notified, but the work item is not immediately assigned to a user. A user then claims the work item, or his manager assigns it to him. The user must have privileges to claim or assign the work item.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
workItemID	Definition: An ID that represents a work item (task). Type string Allowed Values: A valid, unique 32-byte work item (task) ID.

Request Body Properties

Name	Description
clientData	Definition: Specifies the client data, which identifies a client for AgilePoint Server. Type string Allowed 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 workItemId, String clientData) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/AssignWorkItem/"
                       + workItemId;

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

  JSONObject postData = new JSONObject();
  try {
    postData.put("clientData", clientData);
    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
  return "";
}

C# Code Example

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

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

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

    return ops.POSTMethod(URI, jsonRequestData);
  }

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": "demo3\\administrator",
  "SentDate": "\/Date(1394147826010+0000)\/",
  "SourceWorkItemID": "",
  "Status": "Sent",	
  "UserID": "",
  "WorkItemID": "2AA1E203047B41F29E3E29F62D00903B",
  "WorkObjectID": "",
  "WorkObjectInfo": ""
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher