Activate Work Item

API Type

REST

HTTP Method

POST

Description

Activates a work item.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/ActivateWorkItem/[workItemID]/[activate]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/ActivateWorkItem/[workItemID]/[activate]

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.
activate	Definition: Activates or inactivate a work item. Type bool Allowed Values: True - Activates the work item. False - Inactivates the work item.

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

$("#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 workItemId, String clientData,
  boolean activate) {

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

  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 ActivateWorkItem()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         ActivateWorkItem/E48644178C514A95AB457F00A35F1550/True";
    string jsonRequestData = "{\"clientData\":\"" + "" + "\"}";

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

Supported Versions

AgilePoint BPMS v5.0 R2 and higher