Archive Process Instance by ID
API Type
REST
HTTP Method
POST
Description
Archives a process instance based on the specified process instance identifier by moving the set of process instance records from the workflow database to the archive database.
Good to Know
- The process instance records and all of the associated data are deleted from the AgilePoint database.
- The process instance to be archived must be in Completed or Cancelled status.
- If you archive a process instance, and find that the same process instance was archived, it first deletes the old instance record from the archive database before archiving.
- To call this method, the API account user must have the access right, Archive and restore process(es).
URL Format (OnPremises, Private Cloud)
https://[domain]:[port]/AgilePointServer/Workflow/ArchiveProcInst/[procInstID]
URL Format (OnDemand)
https://[domain]:[port]/AgilePointService/Workflow/ArchiveProcInst/[procInstID]
Request Parameters
Name | Description |
---|---|
procInstID |
|
JavaScript Code Example
$("#btnArchiveProcInst").click(function () {
$.ajax({
url: "https://mydomain:9011/AgilePointServer/Workflow/
ArchiveProcInst/0008D8ACD70B4D38955F0777C5433963",
dataType: "text"
});
});
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);
}
cURL Code Example
curl --header "Content-Type: application/json"
--header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M="
--request POST
--data {\"PROCINSTID\":\"827028D244B4F4D911775FD417AEC1BE\"}
https://mydomain:9011/AgilePointServer/Workflow/
ArchiveProcInst/827028D244B4F4D911775FD417AEC1BE
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.