Check In Process Definition

API Type

REST

HTTP Method

POST

Description

Checks in the process model (process definition) with an XML deployment file.

Good to Know

A new version of the process model is created with the status Created.
To call this method, the API account user must have the access right, Checkin and Checkout a Process Model.

URL Format (OnPremises, Private Cloud)

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

URL Format (OnDemand)

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

Request Parameters

Name	Description
None	Not Applicable

Request Body Properties

Name	Description
xml	Description: 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 URI = "https://mydomain:9011/AgilePointServer/Workflow/CheckinProcDef";

  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 CheckinProcDef()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/CheckinProcDef";

    string jsonRequestData = "{\"xml\":" + '<process template XML string>' + "}";

    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 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.