Get Locale

API Type

REST

HTTP Method

GET

Description

Retrieves the default locale for the AgilePoint Server.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Admin/GetLocale

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Admin/GetLocale

Request Parameters

Name	Description
None	Not Applicable

JavaScript Code Example

$("#btnGetLocale").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/GetLocale",
    type: "GET"
  });
  
});

Java Code Example

public String GetLocale() {

  String URI = "http://mydomain:9011/AgilePointServer/Admin/GetLocale";

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

  return ops.GETMethod(URI);
}

C# Code Example

public string GetLocale()
  {
    string URI = "http://mydomain:9011/AgilePointServer/Admin/GetLocale";

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

    return ops.GetData(URI);
  }

Output

Locale abbreviation—for example, en-US.

JSON Response Body Example

{
  "GetLocaleResult": "en-US"
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher