Check Out Process Definition

API Type

REST

HTTP Method

POST

Description

This method is used to manage process model (process definition) versioning by setting the process model status to CheckedOut based on a given process model ID.

Good to Know

  • Only process models with the Released status can transition into the CheckedOut status.
  • 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/CheckoutProcDef/[processTemplateID]

URL Format (OnDemand)

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

Request Parameters

NameDescription

processTemplateID
Description:
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 URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        CheckoutProcDef/C769BA234EFD421B8B95A525B972E511";

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

  JSONObject postData = new JSONObject();

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

C# Code Example

public string CheckoutProcDef()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/
                         CheckoutProcDef/C769BA234EFD421B8B95A525B972E511";

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

    return ops.POSTMethod(URI);

  }

cURL Code Example

Note: The authorization code is an example. You must generate your own authorization code in base64 encoded format with the syntax Domain\Username:Password. 
curl --header "Content-Type: application/json" 
                         --header "Authorization:Basic QVAtNDI0XEFkbWluOnBhc3M=" 
                         --request POST --data 
                         {\"PROCESSTEMPLATEID\":\"827228D244B4F4D91177678EEC9B226D\"}
                         https://mydomain:9011/AgilePointServer/Workflow/
                         CheckoutProcDef/827228D244B4F4D91177678EEC9B226D

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