Release Process Definition

API Type

REST

HTTP Method

POST

Description

Releases the process model (process definition) with the specified process model ID from AgilePoint Server.

Good to Know

URL Format (OnPremises, PrivateCloud)

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

URL Format (OnDemand)

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

Request Parameters

Name Description

processTemplateID

Function:
The unique identifier for the process definition to be checked out for modification.
Type
string
Accepted Values:
A valid process template ID

JavaScript Code Example

$("#btnReleaseProcDef").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                      ReleaseProcDef/C769BA234EFD421B8B95A525B972E511",
    dataType: "text"
  });
});

Java Code Example

public String ReleaseProcDef() {

  String URI = "https://mydomain:9011/AgilePointServer/Workflow/
                        ReleaseProcDef/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 ReleaseProcDef()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Workflow/
                         ReleaseProcDef/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\":\"827028D244B4F4D9117757492322F5E6\"} 
                         https://mydomain:9011/AgilePointServer/Workflow/
                         ReleaseProcDef/827028D244B4F4D9117757492322F5E6

Output

None.

JSON Response Body Example

The response body is empty.

Supported Versions

AgilePoint v5.0 R2 and higher