REST Clients

Last Update: 9/26/2016

This API is in private preview and subject to change.

A REST client simplifies calling Visual Studio Team Services REST APIs from your client-side (JavaScript/TypeScript) extension code.

Get started

To get started with calling client methods from your extension, see how to call a REST API. In general, the steps are:

  1. Construct or acquire an instance of a client
  2. Call the method on the client instance, passing any necessary parameters
  3. Wait for the response
    • All REST client methods are non-blocking and return a Promise object. A promise represents a future return value (or exception). Typically you will call then() on the returned object, passing a function that you want to have called when the response is received.

Available clients