Resume Process Instance

API Type

REST

HTTP Method

POST

Description

Resumes a process instance with the specified process instance ID.

Good to Know

  • To call this method, the API account user must have the access right, Suspend and Resume a Process.
  • Only suspended process instances can be resumed. If a parent process instance is resumed, any suspended child process instances are resumed as well.

URL Format (OnPremises, Private Cloud)

https://[domain]:[port]/AgilePointServer/Workflow/ResumeProcInst/[processInstanceID]

URL Format (OnDemand)

https://[domain]:[port]/AgilePointService/Workflow/ResumeProcInst/[processInstanceID]

Request Parameters

NameDescription

processInstanceID
Description:
Specifies the unique ID of a process instance.
Type
string
Allowed Values:
A valid process instance ID

JavaScript Code Example

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

  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                ResumeProcInst/248685A175F54C12A9A80353798B4508",
  });

});

Java Code Example

public String ResumeProcInst() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        ResumeProcInst/248685A175F54C12A9A80353798B4508";

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

  JSONObject postData = new JSONObject();

  return ops.POSTMethod(URI, postData.toString());
}

C# Code Example

public string ResumeProcInst()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/
                         ResumeProcInst/248685A175F54C12A9A80353798B4508";

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

    return ops.POSTMethod(URI, "");
  }

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 {\"PROCINSTID\":\"827228D244B4F4D9117767BD4C6892FE\"} 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         ResumeProcInst/827228D244B4F4D9117767BD4C6892FE

Output

A WFEvent object that provides status of the request.

JSON Response Body Example

{
  "ActivityInstID": "",
  "AutoStart": true,
  "CustomAttributes": null,
  "Diagnostic": true,
  "EndDate": "\/Date(928149600000+0000)\/",
  "Entries": 1,
  "Error": null,
  "EventID": "8834D110BBAA4857AD572F25B0CC291C",
  "EventName": "ResumeProcessInstance",
  "HighPriority": true,
  "ParamsXml": "<?xml version=\"1.0\" encoding=\"utf-8\"?>
                <WFEvent>
                  <param name=\"ProcInstID\" 
                            value=\"00131C75A35046A89E32B64C4649E075\" \/>
                  <param name=\"HighPriority\" value=\"True\" \/>
                <\/WFEvent>",
  "ParentProcInstID": "",
  "ProcDefID": "",
  "ProcInstID": "00131C75A35046A89E32B64C4649E075",
  "ProcInstName": "",
  "Sender": "mydomain\\administrator",
  "SentDate": "\/Date(1394143777121+0000)\/",
  "SourceWorkItemID": "",
  "Status": "Sent",	
  "UserID": "",
  "WorkItemID": "",
  "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.