GET /rest/delegation/1.0/api/delegation/getDelegates
Returns a JSON that shows the delegates of the given delegator in the given category.
Request
The request takes all parameters as query parameters.
<jira_url>/rest/delegation/1.0/api/delegation/getDelegates?delegator=<delegator>&category=<category>&datetime=<datetime>
Parameters
Expand parameters...
Parameter | Description | Location | Required | Value Samples |
|---|
| delegator | Jira username of the user whose delegates are to be queried. To query delegations of other users, the authenticated user must have View All permission. See DEL v1.5 - Permissions | Query Parameter | Yes | user1 |
| category | In which category the delegates will be searched. The value can be either general or the name of one of the categories created from the Delegation Categories page. See DEL v1.5 - Delegation Categories | Query Parameter | Yes | |
| datetime | The date for which delegates are queried. Valid format is yyyy-MM-dd HH:mm:ss. The given date will be evaluated according to the timezone of the Jira server. If no date is given, the current time of the Jira server will be used. | Query Parameter |
| 2021-08-27 16:30:00 |
Examples
Expand examples...
https://192.168.0.1/rest/delegation/1.0/api/delegation/getDelegates?delegator=user1&category=general&datetime=2021-05-10 12:45:00
https://192.168.0.1/rest/delegation/1.0/api/delegation/getDelegates?delegator=user2&category=expense
Responses
Expand responses...
Success
HTTP 200
Returns delegates of the delegator as JSON.
{
"delegator":"user1",
"asOf":"2021-08-27 05:45:36 +0000",
"category":"Expense",
"delegates":[
"user2",
"user3"
]
}
Invalid Parameter
HTTP 400
When one of the required parameters is missing or one of the supplied parameter values is invalid.
{
"status":400,
"message":"category is required.",
"timestamp":1630043290559,
"errors":{
"category":"category is required."
}
}
Missing Permission
HTTP 403
When the querying user does not have the necessary permissions.
{
"status":403,
"message":"You do not have permission to view delegations.",
"timestamp":1630044510592
}
{
"status":403,
"message":"You do not have permission to query delegations of other users.",
"timestamp":1630044510592
}
Not Found
HTTP 404
When one of the supplied parameter values is not found.
{
"status":404,
"message":"Category with name \"test\" could not be found.",
"timestamp":1630043572503
}
