Uncheckout Process Definition

API Type

REST

HTTP Method

POST

Description

Undoes a check-out for a process definition. This method returns the status of a process definition from CheckedOut to Released without making changes to the process definition, or changing the version number.

URL Format (On Premises)

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

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/UnCheckOutProcDef/[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

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

Java Code Example

public String UncheckoutProcDef(String processTemplateID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/UncheckoutProcDef/"
                       + 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 UnCheckOutProc()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Workflow/
                         UncheckoutProcDef/6E1259372F89448CA220718128ECB018";

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

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

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint BPMS v5.0 R2 and higher