Activate Work Item (Task)
API Type
REST
HTTP Method
POST
Description
Activates a human task (manual work item) and updates the activated date of the task.
Good to Know
- This API can be called only by the task owner or AgilePoint System Account.
URL Format (OnPremises, Private Cloud)
https://[domain]:[port]/AgilePointServer/Workflow/ActivateWorkItem/[workItemID]/[activate]
URL Format (OnDemand)
https://[domain]:[port]/AgilePointService/Workflow/ActivateWorkItem/[workItemID]/[activate]
Request Parameters
Request Body Properties
Name | Description |
---|---|
clientData |
|
JavaScript Code Example
$("#btnActivateWorkItem").click(function () {
var JSONObject = {
clientData: ""
};
$.ajax({
url: "https://mydomain:9011/AgilePointServer/
Workflow/ActivateWorkItem/CFF4B6D3DBF546A2B0423AD413A94420/True",
data: JSON.stringify(JSONObject)
});
});
Java Code Example
public String ActivateWorkItem() {
String URI = "https://mydomain:9011/AgilePointServer/Workflow/
ActivateWorkItem/CFF4B6D3DBF546A2B0423AD413A94420/true";
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 ActivateWorkItem()
{
string URI = "https://mydomain:9011/AgilePointServer/Workflow/
ActivateWorkItem/CFF4B6D3DBF546A2B0423AD413A94420/True";
string jsonRequestData = "{\"clientData\":\"" + "" + "\"}";
HTTPOperations ops = new HTTPOperations(domain, this.userName,
password, appID, locale);
return ops.POSTMethod(URI, jsonRequestData);
}
cURL Code Example
curl --header "Content-Type: application/json"
--header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M="
--request POST --data {\"clientData\":\"\"}
https://mydomain:9011/AgilePointServer/Workflow/
ActivateWorkItem/827128D244B4F4D9117761512B78D158/true
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": "A5CA2ADC2BAF4064ABC1EF3E63760093",
"EventName": "ActivateWorkItem",
"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=\"ID\" value=\"True\" \/>
<param name=\"WorkItemID\"
value=\"2AA1E203047B41F29E3E29F62D00903B\" \/>
<\/WFEvent>",
"ParentProcInstID": "",
"ProcDefID": "",
"ProcInstID": "B7F0ACFA610349B4BF10A4DAB8E93458",
"ProcInstName": "",
"Sender": "mydomain\\administrator",
"SentDate": "\/Date(1394147396783+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.