Get Process Definition XML

API Type

REST

HTTP Method

GET

Description

Retrieves a process definition in XML format.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/GetProcDefXml/[processTemplateID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetProcDefXml/[processTemplateID]

Request Parameters

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

JavaScript Code Example

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

});

Java Code Example

public String GetProcDefXml(String processTemplateID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetProcDefXml/"
                       + processTemplateID;

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

  return ops.GETMethod(URI);
}

C# Code Example

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

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

    return ops.GetData(URI);
  }

Output

string that contains XML format of the process definition.

JSON Response Body Example

{
  "GetProcDefXmlResult": 
  "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"no\"?>
  <ProcessDefinition>...<\/ ProcessDefinition>"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher