Get Activity Instances By Process Instance ID

API Type

REST

HTTP Method

GET

Description

Retrieves the status of all activity instances for a specified process instance.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetActivityInstsByPIID/[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

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

Java Code Example

public String GetActivityInstsByPIID(String processsInstanceID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetActivityInstsByPIID/"
                       + processsInstanceID;

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetActivityInstsByPIID()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         GetActivityInstsByPIID/A2D3DB711D0C4975942FFDA7EE923670";

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

    return ops.GetData(URI);
  }

Output

An array of WFBaseActivityInstance objects.

JSON Response Body Example

{
  "GetActivityInstsByPIIDResult": [
  {
    "CompletedDate": "\/Date(1385676471223+0000)\/",
    "DisplayName": "START",
    "DueDate": "\/Date(928149600000+0000)\/",
    "ID": "0D9835B27E1A483EA1517ACA1296EDAD",
    "InStack": true,
    "Name": "Start",
    "Pending": false,
    "Session": 1,
    "StartedDate": "\/Date(1385676471223+0000)\/",
    "TokenPos":
    {
      "Value": 0
    },
    "Tokens": 0
  }
  {
    "CompletedDate": "\/Date(1385676516500+0000)\/",
    "DisplayName": "STOP",
    "DueDate": "\/Date(1385676516493+0000)\/",
    "ID": "5062CC033DD340F2BD36FC1D2F7F2576",
    "InStack": true,
    "Name": "Stop",
    "Pending": false,
    "Session": 1,
    "StartedDate": "\/Date(1385676516493+0000)\/",
    "TokenPos":
    {
      "Value": 0
    },
    "Tokens": 0
  }
]}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher