Create Process Definition

API Type

REST

HTTP Method

POST

Description

Adds a new process definition to the AgilePoint Server.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/CreateProcDef

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/CreateProcDef

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
xml	Definition: Specifies a process definition in XML format. To generate the process definition file in XML format, in AgilePoint Envision, click File > Export & Import > Save As Deploying File(xml). You can also download the process definition XML from AgilePoint Enterprise Manager. Type string Allowed Values: A string that contains process definition in XML format.

JavaScript Code Example

$("#btnCreateProcDef").click(function () {
  
  var JSONData = { xml: '<process template XML string>' }; 
 
  $.ajax({
    url: 'http://mydomain:9011/AgilePointServer/Workflow/CreateProcDef',
    data: JSON.stringify(JSONData)
  });
});

Output

Unique ID of the process definition, which the AgilePoint system generates.

JSON Response Body Example

"String content"

Supported Versions

AgilePoint BPMS v5.0 R2 and higher