Get Process Instance

API Type

REST

HTTP Method

GET

Description

Retrieves basic information about a specified process instance.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

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

JavaScript Code Example

$("#btnGetProcInst").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                GetProcInst/0FD3088F40B640D4AFE41AEEBDAE914B",
    type: "GET"
  });

});

Java Code Example

public String GetProcessInstance(String processInstanceID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetProcInst/"
                       + processInstanceID;

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetProcessInstance()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         GetProcInst/8252EAE9EFF445C5B395DA70363E8232";

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

    return ops.GetData(URI);
  }

Output

WFBaseProcessInstance object that contains basic information about a process instance. It returns null if the process instance ID does not exist.

JSON Response Body Example

{
  "GetProcInstResult": {
  "ApplName": "MyApplication",
  "CompletedDate": "\/Date(928149600000+0000)\/",
  "DefID": "258220E3849F4D04853F7B591B9C385E",
  "DefName": "BudgetRequestProcess",
  "DueDate": "\/Date(1390002900000+0000)\/",
  "LastModifiedBy": "",
  "LastModifiedDate": "\/Date(1389398111977+0000)\/",
  "LastRunningEndTime": "\/Date(928149600000+0000)\/",
  "LastRunningStartTime": "\/Date(1394129551350+0000)\/",
  "LastSwapDate": "\/Date(928149600000+0000)\/",
  "ProcInitiator": "demo3\\administrator",
  "ProcInitiatorLoc": "?",
  "ProcInstID": "B7F0ACFA610349B4BF10A4DAB8E93458",
  "ProcInstName": "BudgetRequestProcess-B7F0ACFA610349B4BF10A4DAB8E93458",
  "ProcessInitiator": "demo3\\administrator",
  "ProcessInitiatorLocation": "?",
  "SourceProcInstID": "",
  "StartedDate": "\/Date(1389398112007+0000)\/",
  "Status": "Running",
  "SuperProcInstID": "",
  "TargetProcInstID": "",
  "Version": "2.03",
  "WorkObjectID": "4B7A98C9374C4480A26D06DC67379FE3",
  "WorkObjectInfo": ""
  }
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher