You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#customer intent: As a team member with organizational responsibilities, I want to understand the link types available in Azure DevOps and Azure Boards.
13
14
---
14
15
15
16
# Reference guide for link types
@@ -18,7 +19,7 @@ ms.date: 11/15/2023
18
19
19
20
<aid="link-type-guidance"></a>
20
21
21
-
You can use different link types to manage the various relationships between work items and other artifacts, like builds, commits, pull requests, and more. In this article, we describe the following link types.
22
+
You can use different link types to manage the various relationships between work items and other artifacts, like builds, commits, and pull requests. This article describes the following link types.
22
23
23
24
::: moniker range="azure-devops"
24
25
@@ -43,17 +44,15 @@ A specific field maintains a count of links for the first three link types, such
43
44
44
45
::: moniker-end
45
46
46
-
47
-
48
-
Link types are subject to certain restrictions based on their topology. Use the guidance provided in the following tables to choose which link type to use based on the types of queries and reports you want to create. To learn more about the different topologies, see [Link type topologies and restrictions](/previous-versions/azure/devops/reference/xml/link-type-element-reference#topology).
47
+
Link types are subject to restrictions based on their topology. Use the guidance provided in the following tables to choose which link type to use based on the types of queries and reports you want to create. To learn more about the different topologies, see [Link type topologies and restrictions](/previous-versions/azure/devops/reference/xml/link-type-element-reference#topology).
49
48
50
49
## Work link type
51
50
52
51
Work link types are system-defined, process-defined, or user-defined (custom). The links listed in the following table are system-defined.
53
52
54
53
Each work link type defines the link labels, topology type, and restrictions that are used when links between work items are constructed. For example, the parent-child link type defines two labels: Parent and Child. The link type also supports a hierarchical or tree topology, and prevents circular references from being created between work items.
55
54
56
-

55
+
:::image type="content" source="media/link-type-reference/linkscontrol-work-item-link-types.png" alt-text="Diagram is a conceptual image of a Work item link type.":::
57
56
58
57
A work item's *Related Link Count* corresponds to the sum of all links defined with a work link type.
59
58
@@ -77,8 +76,8 @@ The following table describes the work item link types you can specify to scope
77
76
---
78
77
:::row:::
79
78
:::column span="1":::
80
-
**Affects-Affected by** (CMMI only) 
81
-

79
+
**Affects-Affected by** (CMMI only) :::image type="content" source="media/link-work-items-support-traceability/affects-cmmi.png" alt-text="Diagram is a conceptual image of Affects link type.":::
80
+
:::image type="content" source="media/link-work-items-support-traceability/affected-by-cmmi.png" alt-text="Diagram is a conceptual image of Affected by link type.":::
82
81
:::column-end:::
83
82
:::column span="3":::
84
83
Microsoft.VSTS.Common.Affects-Forward
@@ -90,7 +89,8 @@ The following table describes the work item link types you can specify to scope
90
89
91
90
Use this directional link to create links between any set of work items, but not ones that would create closed loops. Typically used to track change requests made to requirements.
92
91
93
-
Restrictions and recommendations:
92
+
Restrictions and recommendations:
93
+
94
94
- You can link a change request to only one requirement using Affects. You can link requirements to as many child change requests as needed using Affected by.
95
95
- Only use Affects-Affected by links to link work items in the same project. We recommend this action if you plan to use Excel to modify or update work item data.
96
96
@@ -99,8 +99,8 @@ The following table describes the work item link types you can specify to scope
99
99
:::row:::
100
100
:::column span="1":::
101
101
**Child-Parent**
102
-

103
-

102
+
:::image type="content" source="media/link-work-items-support-traceability/child-tree-forward.png" alt-text="Diagram is a conceptual image of a Child link type.":::
103
+
:::image type="content" source="media/link-work-items-support-traceability/parent-tree-reverse.png" alt-text="Diagram is a conceptual image of a Parent link type.":::
104
104
:::column-end:::
105
105
:::column span="3":::
106
106
System.LinkTypes.Hierarchy-Forward
@@ -118,17 +118,18 @@ The following table describes the work item link types you can specify to scope
118
118
- Link tasks to PBIs, user stories, or requirements. Supports Backlog Overview, Stories Overview, and Requirements Overview reports.
119
119
120
120
Restrictions and recommendations:
121
+
121
122
- Use Excel to bulk edit both work items and parent-child links. See [Bulk add or modify work items with Excel](../backlogs/office/bulk-add-modify-work-items-excel.md).
122
123
- A work item can have only one Parent. A parent work item can have many children.
123
-
- Only use parent-child links to link work items in the same project. This action is recommended if you plan to use Excel to modify or update work item data.
124
+
- Only use parent-child links to link work items in the same project. We recommend this action if you plan to use Excel to modify or update work item data.
124
125
125
126
:::column-end:::
126
127
:::row-end:::
127
128
:::row:::
128
129
:::column span="1":::
129
130
**Duplicate-Duplicate of**
130
-

131
-

131
+
:::image type="content" source="media/link-work-items-support-traceability/duplicate-tree-forward.png" alt-text="Diagram is a conceptual image of Duplicate of tree forward.":::
132
+
:::image type="content" source="media/link-work-items-support-traceability/duplicate-of-tree-reverse.png" alt-text="Diagram is a conceptual image of Duplicate of tree reverse.":::
132
133
:::column-end:::
133
134
:::column span="3":::
134
135
System.LinkTypes.Duplicate-Forward
@@ -141,16 +142,17 @@ The following table describes the work item link types you can specify to scope
141
142
Use this directional link to create one-to-many relationships between a single parent to one or more child items. Use to track tasks, bugs, or other work items that are duplicates of one another.
142
143
143
144
Restrictions and recommendations:
145
+
144
146
- A work item can have only one Duplicate.
145
-
- Only use Duplicate or Duplicate Of links to link work items in the same project. This action is recommended if you plan to use Excel to modify or update work item data.
147
+
- Only use Duplicate or Duplicate Of links to link work items in the same project. We recommend this action if you plan to use Excel to modify or update work item data.
146
148
147
149
:::column-end:::
148
150
:::row-end:::
149
151
:::row:::
150
152
:::column span="1":::
151
153
**Referenced By-References**
152
-

153
-

154
+
:::image type="content" source="media/link-work-items-support-traceability/tested-by-dependency-forward.png" alt-text="Diagram is a conceptual image of Tested by link type.":::
155
+
:::image type="content" source="media/link-work-items-support-traceability/tests-dependency-reverse.png" alt-text="Diagram is a conceptual image of Tests link type.":::
154
156
:::column-end:::
155
157
:::column span="3":::
156
158
Microsoft.VSTS.TestCase.
@@ -167,15 +169,16 @@ The following table describes the work item link types you can specify to scope
167
169
:::row:::
168
170
:::column span="1":::
169
171
**Related**
170
-

172
+
:::image type="content" source="media/link-work-items-support-traceability/related-network.png" alt-text="Diagram is a conceptual image of Related link type.":::
171
173
:::column-end:::
172
174
:::column span="3":::
173
175
System.LinkTypes.Related
174
176
Topology type: Network
175
177
Link category: System-defined
176
178
:::column-end:::
177
179
:::column span="3":::
178
-
Use this nondirectional link to create links between any set of work items. Use to link work items that are at the same level, such as two user stories that define features that overlap one another. The Related link type creates simple relationships with few restrictions.
180
+
Use this nondirectional link to create links between any set of work items. Use to link work items that are at the same level, such as two user stories that define features that overlap one another. The Related link type creates simple relationships with few restrictions.
181
+
179
182
- Relate work items that are at the same level, such as two user stories that define features that overlap one another.
180
183
- Link work items that are defined in different projects and managed by different teams.
181
184
- Find and view work items and their related work items in a two-tiered view.
@@ -186,8 +189,8 @@ The following table describes the work item link types you can specify to scope
186
189
:::row:::
187
190
:::column span="1":::
188
191
**Successor-Predecessor**
189
-

190
-

192
+
:::image type="content" source="media/link-work-items-support-traceability/successor-dependency-forward.png" alt-text="Diagram is a conceptual image of Successor dependency, forward.":::
193
+
:::image type="content" source="media/link-work-items-support-traceability/predecessor-dependency-reverse.png" alt-text="Diagram is a conceptual image of Predecessor dependency, reverse.":::
191
194
:::column-end:::
192
195
:::column span="3":::
193
196
System.LinkTypes.Dependency
@@ -204,17 +207,19 @@ The following table describes the work item link types you can specify to scope
204
207
- Supports one-to-many relationships.
205
208
- Find and view predecessor work items and their successor work items in a two-tiered, direct links query view.
206
209
207
-
Restrictions and recommendations:
210
+
Restrictions and recommendations:
211
+
208
212
- An error appears when you attempt to create links that define circular relationships.
209
213
- Create predecessor-successor links only to work items that are within the same project.
210
-
You can create predecessor-successor links between work items that are defined in different projects. But, if you export a query to Excel, only those work items defined for the project for which the query is defined get imported.
214
+
You can create predecessor-successor links between work items that are defined in different projects. But, if you export a query to Excel, only those work items defined for the project for which the query is defined get imported.
215
+
211
216
:::column-end:::
212
217
:::row-end:::
213
218
:::row:::
214
219
:::column span="1":::
215
220
**Tested by-Tests**
216
-

217
-

221
+
:::image type="content" source="media/link-work-items-support-traceability/tested-by-dependency-forward.png" alt-text="Diagram is a conceptual image of Tested by link type.":::
222
+
:::image type="content" source="media/link-work-items-support-traceability/tests-dependency-reverse.png" alt-text="Diagram is a conceptual image of Tests link type.":::
218
223
:::column-end:::
219
224
:::column span="3":::
220
225
Microsoft.VSTS.Common.TestedBy-Forward
@@ -231,8 +236,8 @@ The following table describes the work item link types you can specify to scope
231
236
:::row:::
232
237
:::column span="1":::
233
238
**Test Case-Shared Steps**
234
-

235
-

239
+
:::image type="content" source="media/link-work-items-support-traceability/tested-by-dependency-forward.png" alt-text="Diagram is a conceptual image of Tested by link type.":::
240
+
:::image type="content" source="media/link-work-items-support-traceability/tests-dependency-reverse.png" alt-text="Diagram is a conceptual image of Tests link type.":::
236
241
:::column-end:::
237
242
:::column span="3":::
238
243
Microsoft.VSTS.TestCase.
@@ -253,8 +258,7 @@ The following table describes the work item link types you can specify to scope
253
258
254
259
A hyperlink can link a work item to any URL. The *Hyperlink Count* tracks the number of hyperlinks to a work item.
255
260
256
-
> [!div class="mx-imgBorder"]
257
-
> 
261
+
:::image type="content" source="media/link-type-reference/hyperlink.png" alt-text="Diagram is a conceptual image of a Hyperlink.":::
258
262
259
263
:::row:::
260
264
:::column span="1":::
@@ -291,7 +295,7 @@ A hyperlink can link a work item to any URL. The *Hyperlink Count* tracks the nu
291
295
External link types are system-defined link types that support linking work items to other objects stored within Azure DevOps as shown in the following image. A work item's *External Link Count* corresponds to the sum of all links defined with an external link type.
292
296
293
297
> [!div class="mx-imgBorder"]
294
-
> 
298
+
> :::image type="content" source="media/link-type-reference/linkscontrol-external-link-types.png" alt-text="Diagram is a conceptual image of External link type.":::
295
299
296
300
> [!NOTE]
297
301
> You can only use an external link type to link to an Azure DevOps object. To link work items to other objects outside of Azure DevOps, use a [hyperlink](#hyperlink).
@@ -541,7 +545,7 @@ GitHub link types are system-defined and support linking work items to GitHub ob
541
545
::: moniker range=">= azure-devops-2020"
542
546
543
547
> [!div class="mx-imgBorder"]
544
-
> 
548
+
> :::image type="content" source="media/link-type-reference/linkscontrol-github-link-types.png" alt-text="Diagram is a conceptual image of GitHub link type.":::
545
549
546
550
::: moniker-end
547
551
@@ -628,8 +632,8 @@ A work item's [*Remote Link Count*](linking-attachments.md#remote-link-count) co
628
632
:::column span="":::
629
633
**Consumes From-Produced For**
630
634
(Dependency topology)
631
-

632
-

635
+
:::image type="content" source="media/link-work-items-support-traceability/affected-by-cmmi.png" alt-text="Diagram is a conceptual image of Consumes From topology.":::
636
+
:::image type="content" source="media/link-work-items-support-traceability/affects-cmmi.png" alt-text="Diagram is a conceptual image of Produced For topology.":::
633
637
:::column-end:::
634
638
:::column span="":::
635
639
System.LinkTypes.Remote.Dependency-Forward
@@ -644,7 +648,7 @@ A work item's [*Remote Link Count*](linking-attachments.md#remote-link-count) co
644
648
:::row:::
645
649
:::column span="":::
646
650
**Remote Related**
647
-

651
+
:::image type="content" source="media/link-work-items-support-traceability/related-network.png" alt-text="Diagram is a conceptual image of Remote Related topology.":::
648
652
:::column-end:::
649
653
:::column span="":::
650
654
System.LinkTypes.Remote.Related
@@ -821,7 +825,7 @@ The following table provides descriptions for each of the link type attributes r
821
825
Names, `name`
822
826
:::column-end:::
823
827
:::column span="2":::
824
-
Specifies the friendly name assigned to the link type(s). Directional links are defined in pairs, therefore include a forward and reverse name.
828
+
Specifies the friendly name assigned to the link types. Directional links are defined in pairs, therefore include a forward and reverse name.
0 commit comments