Issue
Issue is used to document and manage issues that occur with the products you manufacture and sell. In the UI, you can log issues at Issues > Issues > Issues > New.
Use the issue record to create new issues and expose them to REST web services.
To learn more, see Logging Issues.
This record:
-
is not a subrecord
-
has no subrecords
There are no prerequisites for using this record through REST web services.
The REST API Browser includes information about the field names and field types of the issue record, and about the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s issue reference page.
For information about using the REST API Browser, see The REST API Browser.
Record ID
The record ID for an issue REST record is issue.
Code Sample
The following samples show common use cases for issue.
Creating an Issue
POST https:// {{REST_SERVICES}} /services/rest/record/v1/issue
Body: { "duplicateStatus": "F", "emailAssignee": false, "isOwner": true, "isShowstopper": false, "issueAbstract": "Issue abstract 1701112365", "issueNumber": "issue_1701112365", "issueStatus": { "id": "1", "refName": "Submitted" }, "issueTags": { "count": 0, "hasMore": false, "items": [], "offset": 0, "totalResults": 0 }, "issueType": { "id": "1", "refName": "Problem" }, "mediaItem": { "count": 0, "hasMore": false, "items": [], "offset": 0, "totalResults": 0 }, "priority": { "id": "1", "refName": "P1" }, "product": { "id": "103" }, "relatedIssues": { "items": [ ], "totalResults": 0 }, "reportedBy": { "id": "-5", "refName": "Mark Wheel" }, "reproduce": { "id": "1", "refName": "Test Environment" }, "severity": { "id": "1", "refName": "S1 - Blocking" }, "source": { "id": "1", "refName": "Internal" }, "statusType": "OPEN", "targetVersion": { "items": [], "totalResults": 0 }, "trackCode": { "id": "1", "refName": "Never" }
}'
Retrieving an Issue
GET
https:// {{REST_SERVICES}} /services/rest/record/v1/issue
Updating an issue
PATCH https:// {{REST_SERVICES}} /services/rest/record/v1/issue/{{ISSUE_NUMBER}}
Body:
{ "duplicateStatus": "F", "emailAssignee": false, "isOwner": true, "isShowstopper": false, "issueAbstract": "Issue abstract 1701112438", "issueNumber": "issue_1701112438", "issueStatus": { "id": "1", "refName": "Submitted" }, "issueTags": { "count": 0, "hasMore": false, "items": [], "offset": 0, "totalResults": 0 }, "issueType": { "id": "1", "refName": "Problem" }, "mediaItem": { "count": 0, "hasMore": false, "items": [], "offset": 0, "totalResults": 0 }, "priority": { "id": "1", "refName": "P1" }, "product": { "id": "103" }, "relatedIssues": { "items": [ { "issuenumber": "303", "issuestatus": "Submitted", "relationship": { "id": "M3", "refName": "Blocks" } } ], "totalResults": 1 }, "reportedBy": { "id": "-5", "refName": "Mark Wheel" }, "reproduce": { "id": "1", "refName": "Test Environment" }, "severity": { "id": "1", "refName": "S1 - Blocking" }, "source": { "id": "1", "refName": "Internal" }, "statusType": "OPEN", "targetVersion": { "items": [], "totalResults": 0 }, "trackCode": { "id": "1", "refName": "Never" }
}'