Get Process Instance Attribute

API Type

REST

HTTP Method

GET

Description

Retrieves a single attribute for a specified process instance.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/GetProcInstAttr/[processInstanceID]/[attributeName]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetProcInstAttr/[processInstanceID]/[attributeName]

Request Parameters

Name	Description
processInstanceID	Definition: Specifies the unique ID of a process instance. Type string Allowed Values: A valid process instance ID
attributeName	Definition: The name of the process instance attribute you want. Type string Allowed Values: 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.

Name

Description

processInstanceID

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

attributeName

Definition:

The name of the process instance attribute you want.

Type

string

Allowed Values:

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

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

Java Code Example

public String GetProcessInstanceAttribute(String processInstanceID,
  String attributeName) {

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

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
  }

Output

Returns the KeyValue for the attribute associated with the process instance as a name-value" pair.

JSON Response Body Example

{
  "GetProcInstAttrResult":
  {
    "Name":"DueDate",
    "Value":"1\/17\/2014 3:55:00 PM"
  }
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher