Get Events By Process Instance ID

API Type

REST

HTTP Method

GET

Description

Retrieves all the events that have occurred for a specified process instance.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

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

Java Code Example

public String GetEventsByProcessInstanceID(String processInstanceID) {

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

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
  }

Output

An array of WFEvent objects.

JSON Response Body Example

{
  "GetEventsByProcInstIDResult": [{
  "ActivityInstID": "A27AD9FE81164DBDB09E9E7CEDCD0930",
  "AutoStart": true,
  "CustomAttributes": null,
  "Diagnostic": true,
  "EndDate": "\/Date(1390001063407+0000)\/",
  "Entries": 0,
  "Error": "",
  "EventID": "4858621DD6584477A663A665D03A7181",
  "EventName": "CompleteWorkItem",
  "HighPriority": false,
  "ParamsXml": "<?xml version=\"1.0\" encoding=\"utf-8\"?>
                <WFEvent>
                  <param name=\"ProcInstID\" 
                          value=\"B7F0ACFA610349B4BF10A4DAB8E93458\" \/>
                  <param name=\"ActivityInstID\" 
                          value=\"A27AD9FE81164DBDB09E9E7CEDCD0930\" \/>
                  <param name=\"WorkItemID\" 
                          value=\"9FA1E98B85264545A62384A57D24FFF4\" \/>
                <\/WFEvent>",
  "ParentProcInstID": "",
  "ProcDefID": "",
  "ProcInstID": "B7F0ACFA610349B4BF10A4DAB8E93458",
  "ProcInstName": "",
  "Sender": "demo3\\administrator",
  "SentDate": "\/Date(1390001063287+0000)\/",
  "SourceWorkItemID": "",
  "Status": "Processed",
  "UserID": "",
  "WorkItemID": "9FA1E98B85264545A62384A57D24FFF4",
  "WorkObjectID": "",
  "WorkObjectInfo": ""
  }]
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher