Azure-devops-docs: List of available REST clients

Created on 13 Apr 2018  Â·  6Comments  Â·  Source: MicrosoftDocs/azure-devops-docs

When I click to get the 'full list of available REST clients and their references here', I get sent to https://docs.microsoft.com/en-us/vsts/extend/reference/client/core-sdk?view=vsts. Is this the right page? I'm not sure where to go to get specific clients I need to call.

In the example provided, the link for the 'Work Item Tracking Client' has a hyperlink to https://www.visualstudio.com/en-us/docs/integrate/extensions/reference/client/api/tfs/workitemtracking/restclient/workitemtrackinghttpclient2_2
But this just redirects to the same list, https://docs.microsoft.com/en-us/vsts/extend/reference/client/core-sdk?view=vsts

Where can I go to get reference on the names of the clients to call in VSS.require(), and then the methods they make available?


Document Details

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

All 6 comments

Thanks a lot

Thanks, that's great, appreciate it. Looks like they won't work for me. I'm calling the graph API (https://docs.microsoft.com/en-us/rest/api/vsts/graph/groups/get) to get security groups, which it looks like the rest clients don't support (https://web.archive.org/web/20161204031624/https://www.visualstudio.com/en-us/docs/integrate/extensions/reference/client/api/tfs/core/restclient/corehttpclient2_2)

Well, I was digging in MS repositories on GitHub and here is what I've found:
https://github.com/Microsoft/vss-web-extension-sdk/blob/master/typings/vss.d.ts
This file describes all RestClients for VSS. Just search for VSS/Graph/RestClient. The module declaration contains all method declarations as well. You'll find getGroup(groupDescriptor: string): IPromise<Contracts.GraphGroup>; - I think that's what you were looking for.

Moreover I think this file contains all modules declarations, so other RestClients should be there also. I wonder if that's documented somewhere...

Why have the dead links not been fixed yet?

I've updated the list of rest clients to go here:
https://docs.microsoft.com/en-us/vsts/extend/reference/client/rest-clients?view=vsts

And the work item tracking client to go here:
https://docs.microsoft.com/en-us/vsts/extend/reference/client/api/tfs/workitemtracking/restclient/workitemtrackinghttpclient2_2?view=vsts

This change should go live in ~10 minutes, thanks everyone for the contributions!

Was this page helpful?
0 / 5 - 0 ratings