Get Delegations

API Type

REST

HTTP Method

POST

Description

Retrieves a list of delegation objects that match the specified parameters. You can leave the parameters null to indicate any.

URL Format (OnPremises, Private Cloud)

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

URL Format (OnDemand)

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

Request Parameters

NameDescription
NoneNot Applicable

Request Body Properties

NameDescription

FromUser
Function:
Specifies a user from whom to delegate tasks.
Type
string
Accepted Values:
A valid user name.

ToUser
Function:
Specifies the user who will receive the delegated tasks.
Type
string
Accepted Values:
A valid user name.

Status
Function:
The status of the associated item.
Type
string
Accepted Values:
A valid status.

JavaScript Code Example

$("#btnGetDelegations").click(function () {
  var JSONObject = {
    FromUser: "mydomain\\brian.lucas",
    ToUser: "mydomain\\lilly.allen",
    Status: "Active"
  };
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Admin/GetDelegations",
    data: JSON.stringify(JSONObject)
  });
});

Java Code Example

public String GetDelegations() {

  String URI = "https://mydomain:9011/AgilePointServer/Admin/GetDelegations";

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

  JSONObject postData = new JSONObject();
  
    postData.put("FromUser", "mydomain\\liy.allen");
    postData.put("ToUser", "mydomain\\bob.hope");
    postData.put("Status", "Created");

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

C# Code Example

public string GetDelegations()
  {
    string URI = "https://mydomain:9011/AgilePointServer/Admin/GetDelegations";

    string jsonRequestData = "{
      \"FromUser\":\"" + "MYDOMAIN\\administrator" + "\",
      \"ToUser\":\"" + "MYDOMAIN\\peter.parker" + "\",
      \"Status\":\"" + "Active" + "\"}";

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

    return ops.POSTMethod(URI, jsonRequestData);
  }

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 {\"FromUser\":\"mydomain\\brian.lucas\",
                         \"Status\":\"Cancelled\",
                         \"ToUser\":\"mydomain\\brian.lucas\"} 
                         https://mydomain:9011/AgilePointServer/Admin/GetDelegations

Output

An array of WFDelegation objects.

JSON Response Body Example

[{
  "CancelledBy": "",
  "CancelledDate": "\/Date(928149600000+0000)\/",
  "CreatedBy": "mydomain\\brian.lucas",
  "CreatedDate": "\/Date(1394154711507+0000)\/",
  "DelegationID": "77F9A9946CF74545B4C8A27956CDA036",
  "Description": "Rest Test",
  "EndDate": "\/Date(28799000+0000)\/",
  "FromUser": "mydomain\\brian.lucas",
  "LastUpdatedBy": "mydomain\\administrator",
  "LastUpdatedDate": "\/Date(1394154884247+0000)\/",
  "ProcDefIDS": "",
  "RecWeekdaysString": "",
  "StartDate": "\/Date(-57600000+0000)\/",
  "Status": "Active",
  "ToUser": "mydomain\\lilly.allen"
}]

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.