Azure DevOps REST API - Work Item Relation Type URL Format Is Not Explicit

[jack-toussaint]

Please add examples for all of the Work Item Relation types. The ArtifactLink relation type for linking pull requests requires the url to be formatted in a specific way. I couldn't find that format anywhere in the documentation. I had to create a work item and manually link the PR. Then used the API to pull the metadata for that work item. That allowed me to inspect the ArtifactLink object and get the proper format, vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}.

I searched online for "vstfs:///Git/PullRequestId" and found it tucked away in the Pull Requests page, https://learn.microsoft.com/en-us/rest/api/azure/devops/git/pull-requests/get-pull-requests?view=azure-devops-rest-7.1&tabs=HTTP.

Please provide examples for all of the Work Item Relation Types or come up with another solution for improving this documentation.

---

Document Details

⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.

• ID: db41f842-3e23-d6dc-5caf-de87516b051d
• Version Independent ID: a063d33b-7a9b-7ad1-f77d-bee88cfc429c
• Content: Work Items - Update - REST API (Azure DevOps Work Item Tracking)
• Content Source: docs-ref-autogen/7.1/wit/Work-Items/Update.yml
• Service: azure-devops
• Sub-service: azure-devops-ref
• GitHub Login: @wnjenkin
• Microsoft Alias: whjenkin