Work Item Relation Types - List

參考

Service:: Work Item Tracking

API Version:: 7.1-preview.2

取得工作專案關聯類型。

GET https://dev.azure.com/{organization}/_apis/wit/workitemrelationtypes?api-version=7.1-preview.2

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
api-version	query	True	string	要使用的 API 版本。這應該設定為 '7.1-preview.2' 以使用此版本的 API。

回應

名稱	類型	Description
200 OK	WorkItemRelationType[]	成功的作業

安全性

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

名稱	Description
vso.work	授與讀取工作專案、查詢、面板、區域和反復專案路徑，以及其他工作專案追蹤相關中繼資料的能力。也授與執行查詢、搜尋工作專案，以及透過服務勾點接收工作專案事件通知的能力。

範例

Get the work item relation types

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/wit/workitemrelationtypes?api-version=7.1-preview.2

Sample Response

Status code:: 200

{
  "count": 18,
  "value": [
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": true,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": true,
        "topology": "dependency",
        "isForward": true,
        "oppositeEndReferenceName": "Microsoft.VSTS.Common.Affects-Reverse"
      },
      "referenceName": "Microsoft.VSTS.Common.Affects-Forward",
      "name": "Affects",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/Microsoft.VSTS.Common.Affects-Forward"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": true,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": true,
        "topology": "dependency",
        "isForward": false,
        "oppositeEndReferenceName": "Microsoft.VSTS.Common.Affects-Forward"
      },
      "referenceName": "Microsoft.VSTS.Common.Affects-Reverse",
      "name": "Affected By",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/Microsoft.VSTS.Common.Affects-Reverse"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": true,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": true,
        "topology": "dependency",
        "isForward": true,
        "oppositeEndReferenceName": "Microsoft.VSTS.TestCase.SharedParameterReferencedBy-Reverse"
      },
      "referenceName": "Microsoft.VSTS.TestCase.SharedParameterReferencedBy-Forward",
      "name": "Referenced By",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/Microsoft.VSTS.TestCase.SharedParameterReferencedBy-Forward"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": true,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": true,
        "topology": "dependency",
        "isForward": false,
        "oppositeEndReferenceName": "Microsoft.VSTS.TestCase.SharedParameterReferencedBy-Forward"
      },
      "referenceName": "Microsoft.VSTS.TestCase.SharedParameterReferencedBy-Reverse",
      "name": "References",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/Microsoft.VSTS.TestCase.SharedParameterReferencedBy-Reverse"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": true,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": true,
        "topology": "dependency",
        "isForward": true,
        "oppositeEndReferenceName": "Microsoft.VSTS.Common.TestedBy-Reverse"
      },
      "referenceName": "Microsoft.VSTS.Common.TestedBy-Forward",
      "name": "Tested By",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/Microsoft.VSTS.Common.TestedBy-Forward"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": true,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": true,
        "topology": "dependency",
        "isForward": false,
        "oppositeEndReferenceName": "Microsoft.VSTS.Common.TestedBy-Forward"
      },
      "referenceName": "Microsoft.VSTS.Common.TestedBy-Reverse",
      "name": "Tests",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/Microsoft.VSTS.Common.TestedBy-Reverse"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": true,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": true,
        "topology": "dependency",
        "isForward": true,
        "oppositeEndReferenceName": "Microsoft.VSTS.TestCase.SharedStepReferencedBy-Reverse"
      },
      "referenceName": "Microsoft.VSTS.TestCase.SharedStepReferencedBy-Forward",
      "name": "Test Case",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/Microsoft.VSTS.TestCase.SharedStepReferencedBy-Forward"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": true,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": true,
        "topology": "dependency",
        "isForward": false,
        "oppositeEndReferenceName": "Microsoft.VSTS.TestCase.SharedStepReferencedBy-Forward"
      },
      "referenceName": "Microsoft.VSTS.TestCase.SharedStepReferencedBy-Reverse",
      "name": "Shared Steps",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/Microsoft.VSTS.TestCase.SharedStepReferencedBy-Reverse"
    },
    {
      "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"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": false,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": false,
        "topology": "tree",
        "isForward": false,
        "oppositeEndReferenceName": "System.LinkTypes.Duplicate-Forward"
      },
      "referenceName": "System.LinkTypes.Duplicate-Reverse",
      "name": "Duplicate Of",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/System.LinkTypes.Duplicate-Reverse"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": false,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": true,
        "topology": "dependency",
        "isForward": true,
        "oppositeEndReferenceName": "System.LinkTypes.Dependency-Reverse"
      },
      "referenceName": "System.LinkTypes.Dependency-Forward",
      "name": "Successor",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/System.LinkTypes.Dependency-Forward"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": false,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": true,
        "topology": "dependency",
        "isForward": false,
        "oppositeEndReferenceName": "System.LinkTypes.Dependency-Forward"
      },
      "referenceName": "System.LinkTypes.Dependency-Reverse",
      "name": "Predecessor",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/System.LinkTypes.Dependency-Reverse"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": false,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": false,
        "topology": "tree",
        "isForward": true,
        "oppositeEndReferenceName": "System.LinkTypes.Hierarchy-Reverse"
      },
      "referenceName": "System.LinkTypes.Hierarchy-Forward",
      "name": "Child",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/System.LinkTypes.Hierarchy-Forward"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": false,
        "enabled": true,
        "acyclic": true,
        "directional": true,
        "singleTarget": false,
        "topology": "tree",
        "isForward": false,
        "oppositeEndReferenceName": "System.LinkTypes.Hierarchy-Forward"
      },
      "referenceName": "System.LinkTypes.Hierarchy-Reverse",
      "name": "Parent",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/System.LinkTypes.Hierarchy-Reverse"
    },
    {
      "attributes": {
        "usage": "workItemLink",
        "editable": false,
        "enabled": true,
        "acyclic": false,
        "directional": false,
        "singleTarget": true,
        "topology": "network"
      },
      "referenceName": "System.LinkTypes.Related",
      "name": "Related",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/System.LinkTypes.Related"
    },
    {
      "attributes": {
        "usage": "resourceLink",
        "editable": false,
        "enabled": true
      },
      "referenceName": "AttachedFile",
      "name": "Attached File",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/AttachedFile"
    },
    {
      "attributes": {
        "usage": "resourceLink",
        "editable": false,
        "enabled": true
      },
      "referenceName": "Hyperlink",
      "name": "Hyperlink",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/Hyperlink"
    },
    {
      "attributes": {
        "usage": "resourceLink",
        "editable": false,
        "enabled": true
      },
      "referenceName": "ArtifactLink",
      "name": "Artifact Link",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemRelationTypes/ArtifactLink"
    }
  ]
}

定義

名稱	Description
ReferenceLinks	表示 REST 參考連結集合的類別。
WorkItemRelationType	表示工作專案類型關聯類型。

ReferenceLinks

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

WorkItemRelationType

表示工作專案類型關聯類型。

名稱	類型	Description
_links	ReferenceLinks	連結相關 REST 資源的參考。
attributes	object	關聯型別屬性的集合。
name	string	名稱。
referenceName	string	參照名稱。
url	string

共用方式為