Get Process Definition Graphics

API Type

REST

HTTP Method

GET

Description

Retrieves graphical data for the process definition in XML format. The graphical representation of the process is XML-serialized by the class Graphic Image. The graphical data is used to display the process visually.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/GetProcDefGraphics/[processID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetProcDefGraphics/[processID]

Request Parameters

Name	Description
processID	Definition: The process definition ID for a released process definition. Type string Allowed Values: A valid process definition ID.

JavaScript Code Example

$("#btnGetProcDefGraphics").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                GetProcDefGraphics/FFF216089A274862BA56223B3E087A82",
    type: "GET"
  });
});

Java Code Example

public String GetProcDefGraphics(String processID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetProcDefGraphics/"
                       + processID;

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetProcDefGraphics()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         GetProcDefGraphics/6E1259372F89448CA220718128ECB018";

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

    return ops.GetData(URI);
  }

Output

Graphics object in XML format.

JSON Response Body Example

{
  "GetProcDefGraphicsResult":"<?xml version=\"1.0\" encoding=\"utf-8\"?>
  <Graphics>...<\/Graphics>"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher