Get list of issues
Get list of issues, based on different criteria to filter out the results. Results will be provided on pagination basis.
Query parameters
-
page
integer(int32) The
page
define the current page number. It should be positive integer number and should start with minimum value 1.Minimum value is
1
. -
size
integer(int32) The
size
define number of records on each page. It should be positive integer number between 1 to 10000.Minimum value is
1
, maximum value is10000
. -
sort
array[string] The
sort
parameter accepts an array of strings, allowing for multiple sorting criteria. By default, sorting order is ascending. -
name
string The
name
parameter is an optional filter that allows you to narrow down the results based on specific name content. -
subject
string Filter Issues which contains provided subject. If null, not consider this as filter criteria.
-
status
string Filter Issues based on the status from
IN_PROGRESS
,LATE
,COMPLETE
andOPEN
. -
periodId
string Filter Issues based on the periodId. If not provided, considered all periods issues. You can look for ACTIVE periods under
Periods api
section. -
priority
string Filter Issues based on the priority If not provided, considered all priority issues. You can pass the values from ENUM:
High
,Medium
,Low
andUnspecified
. -
entityId
string Filter Issues based on the entityId. If not provided, all issues considered.
-
highPriority
string If passed as
true
then only high priority issues considered.
curl \
--request GET 'http://close-service:8082/cs-close-api/issues'
{
"result": [
{
"id": 158,
"late": true,
"name": null,
"year": "2020",
"logSid": 802,
"status": {
"id": "IN_PROGRESS",
"name": "In progress"
},
"taskId": null,
"subject": "15453 Close Issue AP",
"periodId": 70,
"priority": "Medium",
"taskName": null,
"periodName": "Jun",
"actionPlanId": null,
"inboxReceiver": {
"name": "Dan Longley",
"type": "U",
"email": "dalongley@DanDaMan.com",
"queueId": null
},
"taskReference": "USR05272020091821426497"
}
],
"metadata": {
"totalElements": 42,
"totalPages": 42,
"first": true,
"last": true,
"empty": true,
"numberOfElements": 42,
"size": 42,
"sorted": true
}
}