Back to QMetry All Products Help Page
API for Issues
- Mrunalini Potnis
- 1 Get List of Issues
- 2 Get Issue list along with Custom Fields (Only for projects that are not integrated wtih Jira)
- 3 Create Issue
- 4 Update Issue
- 5 Delete Issue
- 6 Get List of Issues for a Requirement
- 7 Get List of Available Issues to Link During Execution (Deprecated)
- 8 Link Requirements to Issue
- 9 Unlink Requirements from Issues
- 10 Fetch Executions for Issue
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 | |
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 | |
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