Create Process Definition

API Type

REST

HTTP Method

POST

Description

Adds a new process model (process definition) to AgilePoint Server.

Good to Know

  • To call this method, the API account user must have the access right, Add a Process Model.
  • The input parameter is a process model XML that is parsed to create a process model.
  • If the process model count exceeds, the license limit for allowed process models and creation of process model fails.

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

Name Description
None Not Applicable

Request Body Properties

Name Description

xml
Function:
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
Accepted 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: 'https://mydomain:9011/AgilePointServer/Workflow/CreateProcDef',
    data: JSON.stringify(JSONData)
  });
});

Java Code Example

public String CreateProcDef() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/CreateProcDef";

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

  JSONObject postData = new JSONObject();
  
    postData.put("xml", "<process template XML string>");

    return ops.POSTMethod(URI, postData.toString());
  return "";
}

C# Code Example

public string CreateProcDef()
  {
    string  URL= "https://mydomain:9011/AgilePointServer/Workflow/CreateProcDef";
           
    string jsonRequestData = "{
      \"xml\": \"" + '<process template XML string>' + "\"}";  

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

    return ops.POSTMethod(URL, jsonRequestData);
  }

Output

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

JSON Response Body Example

"String content"

Supported Versions

AgilePoint v5.0 R2 and higher

Code Examples in the AgilePoint NX Documentation

The AgilePoint NX Product Documentation is intended as a basic reference to help you understand how to complete basic coding tasks, such as make API or JavaScript method calls. Code examples that show specific use cases, the solutions to specific business problems, or detailed implementation scenarios are outside the scope of the AgilePoint NX Product Documentation. For specific and/or advanced types of examples that may better meet your requirements, AgilePoint provides several resources:

  • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
  • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
  • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.