Check Out Process Definition

API Type

REST

HTTP Method

POST

Description

This method is used to manage process definition versioning by setting the process definition status to CheckedOut based on a given process definition ID. Only process definitions with the status of Released can transition into the CheckedOut status.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

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

Request Parameters

Name	Description
processTemplateID	Definition: The unique identifier for the process definition to be checked out for modification. Type string Allowed Values: A valid process template ID

JavaScript Code Example

$("#btnCheckoutProcDef").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                CheckoutProcDef/C769BA234EFD421B8B95A525B972E511",
  });
  
});

Java Code Example

public String CheckoutProcDef(String processTemplateID) {

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

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

  JSONObject postData = new JSONObject();

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

C# Code Example

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

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

    return ops.POSTMethod(URI);

  }

Output

The process definition, in XML format, that has been checked out.

JSON Response Body Example

  "<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"no\"?>
  \u000d\u000a<?wfmc-xpdl xmlns=\"http:\/\/www.wfmc.org\/2002\/XPDL1.0\" 
                          xmlns:xpdl=\"http:\/\/www.wfmc.org\/2002\/XPDL1.0\" 
                          xsi:schemaLocation=\"http:\/\/www.wfmc.org\/2002\/XPDL1.0\"?>
  \u000d\u000a<!--Process Definition, Copyright 2003-2004 
  Ascentn Corporation, All Rights Reserved.-->\u000d\u000a
  <ProcessDefinition>...<\/ProcessDefinition>"

Supported Versions

AgilePoint BPMS v5.0 R2 and higher