Get Activity Instance Status

API Type

REST

HTTP Method

GET

Description

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

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

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

Java Code Example

public String GetActivityInstStatus(String procInstID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetActivityInstStatus/"
                       + procInstID;

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
           
  }

Output

An array of KeyValue objects that holds pairs of activity definition names and statuses. The statuses can be Passed, Active, Pending, Activated, Canceled, or null.

JSON Response Body Example

{
  "GetActivityInstStatusResult": [
  {
    "Key": "Start",
    "Value": "Passed"
  },
  {
    "Key": "Stop",
    "Value": "Passed"
  }
]}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher