Restore Process Instance

API Type

REST

HTTP Method

POST

Description

Restores a process instance and associated data from the ArchiveDatabase to the AgilePoint Server. The process instance records are written to the AgilePoint Database deleted from the AgilePoint Archive Database.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

JavaScript Code Example

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

  });

});

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);
  }

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher