Get Activity Instance

API Type

REST

HTTP Method

GET

Description

Retrieves basic information for a specified activity instance.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/GetActivityInst/[activityInstanceID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetActivityInst/[activityInstanceID]

Request Parameters

Name	Description
activityInstanceID	Definition: The unique ID for an activity instance. Type string Allowed Values: A valid activity instance ID.

JavaScript Code Example

$("#btnGetActivityInst").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                GetActivityInst/00005B6533CB4362A55A624C54293CD3",
    type: "GET"
  });
  
});

Java Code Example

public String GetActivityInst(String activityInstanceID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetActivityInst/"
                       + activityInstanceID;

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetActivityInst()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         GetActivityInst/2CA7408CB9FA444A90BEE3E826A83593";

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

    return ops.GetData(URI);
  }

Output

WFBaseActivityInstance object.

JSON Response Body Example

{
  "GetActivityInstResult":
  {
    "CompletedDate": "\/Date(1385676516483+0000)\/",
    "DisplayName": "AgilePart.16",
    "DueDate": "\/Date(1385677080000+0000)\/",
    "ID": "0F6B47906A0C4B469AC9CB9A7F2FF831",
    "InStack": true,
    "Name": "AgilePart.16",
    "Pending": false,
    "Session": 1,
    "StartedDate": "\/Date(1385676514640+0000)\/",
    "TokenPos":
    {
      "Value": 0
    },
    "Tokens": 0
  }
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher