Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Issues

Get Issue Relationships

Use this API to retrieve relationship details between an issue and related records.

get/v1/issuelinks/{issueId}

Path parameters

issueIdstring uuid required
Example:00000000-0000-0000-0000-000000000000

The unique identifier of the issue. This value is obtained using the Get List of Issues API.

Query parameters

pageinteger

Results page to be retrieved (0..N). Example- '?page=1

The page number of the results.

sizeinteger

Number of records per page (1..50). Example- '?size=20

The number of results per page.

sort'Id,asc' | 'Id,desc'

The sort criteria that dictates the order of the results.

Response

Relationship details fetched successfully

issueIdstring uuid

The unique identifier of the issue.

issueNamestring

The name that describes the issue.

relatedIdstring uuid

The unique identifier of the related record.

relatedNamestring

The name of the related record.

relatedTypestring

The entity type of the related record.

relationshipTypestring

The type of relationship between the related records.

relationshipLabelstring

The label that describes the relationship between the related records.

Example response

{
  "issueId": "ab129a431-3d3d-4352-9daf-71f6ea2b3d70",
  "issueName": "Security Issue",
  "relatedId": "ab129a431-3d3d-4352-9daf-71f6ea2b3d70",
  "relatedName": "Storage Asset",
  "relatedType": "assets",
  "relationshipType": "issue-related",
  "relationshipLabel": "is related to"
}