Restore Process Instance by ID

API Type

REST

HTTP Method

POST

Description

Restores a process instance and associated data from the archive database to AgilePoint Server.

Good to Know

  • The process instance records are written to the AgilePoint database, but also retained in the AgilePoint archive database.
  • To call this method, the API account user must have the access right, Archive and restore process(es).

URL Format (OnPremises, PrivateCloud)

https://[domain]:[port]/AgilePointServer/Workflow/RestoreProcInst/[procInstID]

URL Format (OnDemand)

https://[domain]:[port]/AgilePointService/Workflow/RestoreProcInst/[procInstID]

Request Parameters

Name Description

procInstID
Function:
Specifies the unique ID of a process instance.
Type
string
Accepted Values:
A valid process instance ID

JavaScript Code Example

$("#btnRestoreProcInst").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                        RestoreProcInst/0008D8ACD70B4D38955F0777C5433963",
    dataType: "text"
  });

});

Java Code Example

public void RestoreProcInst(){
  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                       RestoreProcInst/0008D8ACD70B4D38955F0777C5433963";
		
  HTTPOperations ops = new HTTPOperations(domain, userName, 
                       password, appID, locale);

  JSONObject postData = new JSONObject();

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

C# Code Example

public string RestoreProcInst()
  {
    string URL = "https://mydomain:9011/AgilePointServer/Workflow/
                  RestoreProcInst/0008D8ACD70B4D38955F0777C5433963";

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

    return ops.POSTMethod(URL);
  }

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/
                         RestoreProcInst/827228D244B4F4D9117767BD4C6892FE

Output

None.

JSON Response Body Example

The response body is empty.

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.