Work Item Relation Types - Get
Gets the work item relation type definition.
GET https://dev.azure.com/{organization}/_apis/wit/workitemrelationtypes/{relation}?api-version=7.1
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
relation
|
path | True |
string |
The relation name |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.1' to use this version of the api. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
successful operation |
Security
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
Name | Description |
---|---|
vso.work | Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks. |
Examples
Get the work item relation type
Sample request
GET https://dev.azure.com/fabrikam/_apis/wit/workitemrelationtypes/{relation}?api-version=7.1
Sample response
{
"attributes": {
"usage": "workItemLink",
"editable": false,
"enabled": true,
"acyclic": true,
"directional": true,
"singleTarget": false,
"topology": "tree",
"isForward": true,
"oppositeEndReferenceName": "System.LinkTypes.Duplicate-Reverse"
},
"referenceName": "System.LinkTypes.Duplicate-Forward",
"name": "Duplicate",
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/System.LinkTypes.Duplicate-Forward"
}
Definitions
Name | Description |
---|---|
Reference |
The class to represent a collection of REST reference links. |
Work |
Represents the work item type relation type. |
ReferenceLinks
The class to represent a collection of REST reference links.
Name | Type | Description |
---|---|---|
links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |
WorkItemRelationType
Represents the work item type relation type.
Name | Type | Description |
---|---|---|
_links |
Link references to related REST resources. |
|
attributes |
object |
The collection of relation type attributes. |
name |
string |
The name. |
referenceName |
string |
The reference name. |
url |
string |