Work Item Relation Types - List

Ruft die Arbeitselementbeziehungstypen ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
path True

string

Der Name der Azure DevOps-Organisation.

api-version
query True

string

Version der zu verwendenden API. Diese sollte auf 6.0 festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name Typ Beschreibung
200 OK

WorkItemRelationType[]

Erfolgreicher Vorgang

Sicherheit

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 Beschreibung
vso.work Ermöglicht das Lesen von Arbeitselementen, Abfragen, Boards, Bereichs- und Iterationspfaden und anderen Metadaten zur Nachverfolgung von Arbeitselementen. Bietet außerdem die Möglichkeit, Abfragen auszuführen, Arbeitselemente zu durchsuchen und Benachrichtigungen über Arbeitselementereignisse über Diensthooks zu erhalten.

Beispiele

Get the work item relation types

Sample Request

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

Sample Response

{
  "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"
    }
  ]
}

Definitionen

Name Beschreibung
ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

WorkItemRelationType

Stellt den Beziehungstyp des Arbeitselementtyps dar.

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

WorkItemRelationType

Stellt den Beziehungstyp des Arbeitselementtyps dar.

Name Typ Beschreibung
_links

ReferenceLinks

Links zu verwandten REST-Ressourcen.

attributes

object

Die Auflistung von Attributen vom Beziehungstyp.

name

string

Der Name.

referenceName

string

Der Verweisname.

url

string