Get Delegations | OBSS Apps Documentation

GET /rest/delegation/1.0/api/delegation

Returns paginated delegation records as JSON that meet all the given parameters and the authenticated user has permission to view.

Request

XML

<jira_url>/rest/delegation/1.0/api/category

The request takes all parameters from the query parameters.

Parameters

Expand parameters...

Parameter	Description	Location	Required	Value Samples
startAt	The index of the first record to return in the paginated response. Used to skip a certain number of records. Default Value: 0	Query Parameter	No	0 50
maxResults	The maximum number of records to return per page. Default Value: 100 Max Value: 100	Query Parameter	No	50 100
includeExpired	When set to true, expired delegations will be included in the results. Default Value: false	Query Parameter	No	true false
delegator	Filters the results to delegations where the specified user is the delegator.	Query Parameter	No	user1 user2
delegate	Filters the results to delegations where the specified user is a delegate.	Query Parameter	No	user1 user2
notes	Filters the results to delegations whose notes field contains the specified text.	Query Parameter	No	holiday

Examples

Expand examples...

XML

https://192.168.0.1/rest/delegation/1.0/api/delegation?startAt=0&maxResults=50&includeExpired=true&delegator=admin&delegate=user
https://192.168.0.1/rest/delegation/1.0/api/delegation?startAt=0&delegate=user&notes=holiday

Responses

Expand responses...

200 - Success

Success

HTTP 200

Returns the delegation records matching the given parameters as JSON.

{ "total": 2, "startAt": 0, "pageSize": 100, "values": [ { "delegationId": 103, "version": 1, "active": true, "delegator": "user", "delegates": [ "user" ], "categoryIds": [], "startDate": "2024-12-19T21:00Z", "endDate": "2024-12-20T20:59Z" }, { "delegationId": 107, "version": 1, "active": true, "delegator": "admin", "delegates": [ "user" ], "categoryIds": [], "startDate": "2024-12-18T21:00Z", "endDate": "2024-12-25T21:00Z" } ] }