Check In Process Definition

API Type

REST

HTTP Method

POST

Description

Checks in the process definition to the AgilePoint Server and returns the process definition identifier. This method accepts a string with the updated process definition in XML format.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

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

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

Java Code Example

public String CheckinProcDef(String processtemplateXML) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/CheckinProcDef";

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

  JSONObject postData = new JSONObject();
  try {
    postData.put("xml", processtemplateXML);

    return ops.POSTMethod(URI, postData.toString());
  } catch (JSONException e1) {
    e1.printStackTrace();
  }
    return "";
}

C# Code Example

public string CheckinProcDef(string procxml)
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/CheckinProcDef";

    string jsonRequestData = "{\"xml\":" + procxml + "}";

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

    return ops.PostXml(URI, jsonRequestData);
  }

Output

A new process definition ID.

JSON Response Body Example

{
  GetReleasedPIDResult: "String content"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher