Get Process Instance Attributes

API Type

REST

HTTP Method

GET

Description

Retrieves multiple attributes of a process instance.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

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

Attributes

Name	Description
DefID	The ID of the process definition.
DefName	The name of the process definition.
ProcInstName	The name of the process instance.
Status	The current status of the process instance.
SuperProcInstID	The parent process instance ID.
workObjectID	The ID of the work object.
StartDate	The date and time when the process instance was started.
DueDate	The date that the process instance is expected to be complete
LastModifiedDate	The date and time that the last modification was made to the process instance.

JavaScript Code Example

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

Java Code Example

public String GetProcessInstanceAttributes(String processInstanceID) {

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

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
  }

Output

Array of NameValue objects that holds the values of all the requested attributes.

JSON Response Body Example

{
  "GetProcInstAttrsResult": [
  {
    "Name": "SourceProcInstID",
    "Value": ""
  },
  {
    "Name": "TargetProcInstID",
    "Value": ""
  },
  ...
  {
    "Name": "WorkObjectInfo",
    "Value": ""
  }
]}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher