API for Issues
Get List of Issues
POST /rest/issues/list
Description
API to list issues
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| start | body | no | Start index of records | - | integer |
| limit | body | no | Number of records per page | - | integer |
| page | body | no | Page number to be displayed | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | List of issues shown successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Get Issue list along with Custom Fields (Only for projects that are not integrated wtih Jira)
POST /rest/issues/list/viewColumns
Description
Fetch specific data of Issues with custom fields.
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| start | body | no | Start index of records | - | integer |
| limit | body | no | Number of records per page | - | integer |
| page | body | no | Page number to be displayed | - | integer |
| viewId | body | yes | View ID of the user for that particular project and Issue module. View ID can be fetched from latestViews section of Getinfo API. | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Issue list fetched successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Create Issue
POST /rest/issues
Description
API to create internal Issue
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| sync_with | body | yes | igConfigurationID of Jira or 'internalTrackerId' if external Project isn't configured | - | integer |
| issueType | body | yes | Type Id of Issue | - | integer |
| issuePriority | body | yes | PriorityId of Issue | - | integer |
| issueOwner | body | no | OwnerId of Issue | - | integer |
| summary | body | yes | provide summary | - | string |
| component | body | no | LabelId of Issue | - | integer |
| release | body | no | Associated Release(s) Id | - | integer |
| affectedVersion | body | no | Release Id of Issue | - | integer |
| environment | body | no | Environment | - | string |
| description | body | no | Description | - | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Issue created successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Update Issue
PUT /rest/issues
Description
API to update internal Issue
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| sync_with | body | no | igConfigurationID of Jira or 'internalTrackerId' if external Project isn't configured | - | integer |
| issueType | body | no | Type Id of Issue | - | integer |
| issuePriority | body | no | PriorityId of Issue | - | integer |
| issueOwner | body | no | OwnerId of Issue | - | integer |
| summary | body | no | provide summary | - | string |
| component | body | no | LabelId of Issue | - | integer |
| release | body | no | Associated Release(s) Id | - | integer |
| affectedVersion | body | no | Release Id of Issue | - | integer |
| environment | body | no | Environment | - | string |
| description | body | no | Description | - | string |
| DefectId | body | yes | Id of Issue | - | integer |
| entityKey | body | yes | EntityKey of Issue | - | string |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Issue updated successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Delete Issue
POST /rest/issues/deleteEntity
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| entityIds | body | yes | Id of issues to delete | - | Array[integer] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Issues deleted successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Get List of Available Issues to Link During Execution (Deprecated)
POST /rest/issues/internallist
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| start | body | yes | start index of records | - | integer |
| limit | body | yes | number of records per page | - | integer |
| page | body | yes | page number to be displayed | - | integer |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | List of issues to link to execution successfully fetched | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Get List of Requirements linked to Issue
POST /rest/requirements/list/forIS
Request
Content-Type: application/json
Parameters
| Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| dfID | body | no | Id of issue | - | integer |
| start | body | no | Start index of records | - | integer |
| getLinked | body | no | True to get only those requirements that are linked with this Issue, false to get those requirements which are not linked with this Issue | - | boolean |
| limit | body | no | Number of records per page | - | integer |
| page | body | no | Page number to be displayed | - | integer |
| getColumns | body | no | True to get list of all available filters(System + UDF) in 'filterTemplate' field | - | boolean |
| udfFilter | body | no | Apply filter on user defined fields' values | - | Array[UdfFilter] |
| filter | body | no | System filters to be applied | - | Array[Filter] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirement list fetch successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Link Requirements to Issue
PUT /rest/issues/link/requirements
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| isID | body | yes | EntityKey of Issue | - | string |
| rqIDs | body | yes | ID of Requirements to link with the Issue | - | Array[integer] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Requirements successfully linked to issue | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Unlink Requirements from Issues
PUT /rest/issues/unlink/requirements
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
| isID | body | yes | EntityKey of Issue to unlink Requirements from | - | string |
| rqIDs | body | yes | Unique identifier of Requirements that are to be unlinked from Issue | - | Array[integer] |
Response
Content-Type: application/json
| Status Code | Reason | Response Model |
|---|---|---|
| 200 | Selected entities unlinked successfully | ResponseEntity |
| 400 | Invalid json object or mandatory fields missing | - |
| 401 | Unauthorised or session expired | - |
| 500 | Returned when server connection times out | - |
Definitions
ResponseEntity
| name | type | required | description | example |
|---|---|---|---|---|
| headers | object | optional | - | |
| body | object | optional | - | |
| statusCode | string | optional | - |
UdfFilter
| name | type | required | description | example |
|---|---|---|---|---|
| type | string | required | Type of Filter | |
| value | string | required | Value to search based on type of UDF | |
| udfmID | integer | required | Unique Identifier based on project-module-udf-user | |
| field | string | required | Name of User Defined Field |
Filter
| name | type | required | description | example |
|---|---|---|---|---|
| value | object | required | Value to search based on type of filter | |
| comparison | string | required | The comparision operator 'lt' or 'gt' for Date type filter | |
| type | string | required | Type of Filter | |
| field | string | required | Field name on which filter is to be applied |