Global Discovery Service Sample (C#)

This sample shows how to access the Discovery Service using the OData V4 RESTful API.

How to run this sample

This sample is available on Github at

What this sample does

This sample returns the available Common Data Service instances for a given user credential.

How this sample works

This sample will use credential information in the App.config file, but will not use the URL configured in the connection string. Instead, it will just use the user credentials and the client ID.


This sample uses a HttpClient to authenticate using ADAL and call the Discovery Service to return information about available instances the user can connect to.

The sample depends on the GetInstances method and the Instance class below:

/// <summary>
/// Uses the global discovery service to return environment instances
/// </summary>
/// <param name="username">The user name</param>
/// <param name="password">The password</param>
/// <returns>A list of Instances</returns>
static List<Instance> GetInstances(string username, string password)

    string GlobalDiscoUrl = "";
    HttpClient client = new HttpClient();
    client.DefaultRequestHeaders.Authorization = 
        new AuthenticationHeaderValue("Bearer", GetAccessToken(username, password, 
        new Uri("")));
    client.Timeout = new TimeSpan(0, 2, 0);
    client.BaseAddress = new Uri(GlobalDiscoUrl);

    HttpResponseMessage response = 
        client.GetAsync("api/discovery/v2.0/Instances", HttpCompletionOption.ResponseHeadersRead).Result;

    if (response.IsSuccessStatusCode)
        //Get the response content and parse it.
        string result = response.Content.ReadAsStringAsync().Result;
        JObject body = JObject.Parse(result);
        JArray values = (JArray)body.GetValue("value");

        if (!values.HasValues)
            return new List<Instance>();

        return JsonConvert.DeserializeObject<List<Instance>>(values.ToString());
        throw new Exception(response.ReasonPhrase);
/// <summary>
  /// Object returned from the Discovery Service.
  /// </summary>
  class Instance
    public string Id { get; set; }
    public string UniqueName { get; set; }
    public string UrlName { get; set; }
    public string FriendlyName { get; set; }
    public int State { get; set; }
    public string Version { get; set; }
    public string Url { get; set; }
    public string ApiUrl { get; set; }
    public DateTime LastUpdated { get; set; }