Archive Process Instance

API Type

REST

HTTP Method

POST

Description

Archives a process instance based on a specified process instance identifier by moving the set of process instance records from the current AgilePoint Database into the AgilePoint Archive Database. The process instance records and all of the associated data are then deleted from the AgilePoint Database. The process instance to be archived must be completed or canceled.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

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

JavaScript Code Example

$("#btnArchiveProcInst").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                        ArchiveProcInst/0008D8ACD70B4D38955F0777C5433963"      
  });

});

Java Code Example

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

  JSONObject postData = new JSONObject();

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

C# Code Example

public string ArchiveProcInst()
  {
    string URL = "https://mydomain:9011/AgilePointServer/Workflow/
                         ArchiveProcInst/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