Sign in

v1

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

Create Issue Relationship

Use this API to create a relationship between an issue and related records.

post/v1/issuelink/issue/{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 Issue API.

Request body

linkTypeLabel'is related to' required

The label of the relationship.

relatedEntityType'Control' | 'Evidence' | 'Initiative' | 'Issue' | 'Risk' | 'assessment' | 'assets' | 'entities' | 'policies' | 'procedures' | 'processing-activities' | 'standards' | 'vendors' required

The entity type of the related record.

relatedEntityIdstring uuid required

The unique identifier of the related record.

Example request

{
  "linkTypeLabel": "is related to",
  "relatedEntityType": "Risk",
  "relatedEntityId": "ab129a431-3d3d-4352-9daf-71f6ea2b3d70"
}

Response

Successfully linked the Issue to the provided entity.

linkIdstring uuid required

The unique identifier of the relationship link.

linkTypestring required

The type of relationship between the related records.

Example response

{
  "linkId": "ab129a431-3d3d-4352-9daf-71f6ea2b3d70",
  "linkType": "issue-related",
  "entity1": {
    "id": "ab129a431-3d3d-4352-9daf-71f6ea2b3d70",
    "name": "Test risk"
  },
  "entity2": {
    "id": "ab129a431-3d3d-4352-9daf-71f6ea2b3d70",
    "name": "Test risk"
  }
}