How to specify the API version?





.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty{ height:90px;width:728px;box-sizing:border-box;
}







1















According to the Azure DevOps Services REST API Reference, the request URI has the following format:



https://{instance}[/{team-project}]/_apis[/{area}]/{resource}?api-version={version}


Regarding the api-version:




Every API request should include an api-version to avoid having your app or service break as APIs evolve.




I started using the .NET client libraries for Azure DevOps Services (and TFS) to manage dashboards programmatically.



I am able to connect to Azure DevOps using a Personal Access Token:



var credential = new VssBasicCredential(string.Empty, "PersonalAccessToken");

using (VssConnection connection = new VssConnection(new Uri("...."), credential))
using (var client = connection.GetClient<DashboardHttpClient>())
{
// ...
}


How can I specify the API version? Does it still make sense to do it, when using the .NET client libraries?










share|improve this question































    1















    According to the Azure DevOps Services REST API Reference, the request URI has the following format:



    https://{instance}[/{team-project}]/_apis[/{area}]/{resource}?api-version={version}


    Regarding the api-version:




    Every API request should include an api-version to avoid having your app or service break as APIs evolve.




    I started using the .NET client libraries for Azure DevOps Services (and TFS) to manage dashboards programmatically.



    I am able to connect to Azure DevOps using a Personal Access Token:



    var credential = new VssBasicCredential(string.Empty, "PersonalAccessToken");

    using (VssConnection connection = new VssConnection(new Uri("...."), credential))
    using (var client = connection.GetClient<DashboardHttpClient>())
    {
    // ...
    }


    How can I specify the API version? Does it still make sense to do it, when using the .NET client libraries?










    share|improve this question



























      1












      1








      1








      According to the Azure DevOps Services REST API Reference, the request URI has the following format:



      https://{instance}[/{team-project}]/_apis[/{area}]/{resource}?api-version={version}


      Regarding the api-version:




      Every API request should include an api-version to avoid having your app or service break as APIs evolve.




      I started using the .NET client libraries for Azure DevOps Services (and TFS) to manage dashboards programmatically.



      I am able to connect to Azure DevOps using a Personal Access Token:



      var credential = new VssBasicCredential(string.Empty, "PersonalAccessToken");

      using (VssConnection connection = new VssConnection(new Uri("...."), credential))
      using (var client = connection.GetClient<DashboardHttpClient>())
      {
      // ...
      }


      How can I specify the API version? Does it still make sense to do it, when using the .NET client libraries?










      share|improve this question
















      According to the Azure DevOps Services REST API Reference, the request URI has the following format:



      https://{instance}[/{team-project}]/_apis[/{area}]/{resource}?api-version={version}


      Regarding the api-version:




      Every API request should include an api-version to avoid having your app or service break as APIs evolve.




      I started using the .NET client libraries for Azure DevOps Services (and TFS) to manage dashboards programmatically.



      I am able to connect to Azure DevOps using a Personal Access Token:



      var credential = new VssBasicCredential(string.Empty, "PersonalAccessToken");

      using (VssConnection connection = new VssConnection(new Uri("...."), credential))
      using (var client = connection.GetClient<DashboardHttpClient>())
      {
      // ...
      }


      How can I specify the API version? Does it still make sense to do it, when using the .NET client libraries?







      c# rest azure azure-devops azure-devops-rest-api






      share|improve this question















      share|improve this question













      share|improve this question




      share|improve this question








      edited Nov 23 '18 at 14:20









      Stijn

      16.6k1083127




      16.6k1083127










      asked Nov 23 '18 at 14:19









      Rui JarimbaRui Jarimba

      7,25773461




      7,25773461
























          1 Answer
          1






          active

          oldest

          votes


















          1














          The API version is decided by the client libraries. You can confirm this by disassembling them (e.g. using ILSpy).



          For example, in the current stable release of Microsoft.TeamFoundationServer.Client, DashboardHttpClientBase has a CreateDashboardAsnc method that makes the following call:



          this.SendAsync<Dashboard>(..., new ApiResourceVersion("4.1-preview.2"), ...);





          share|improve this answer
























          • Cool stuff, thanks :-)

            – Rui Jarimba
            Nov 23 '18 at 15:37












          Your Answer






          StackExchange.ifUsing("editor", function () {
          StackExchange.using("externalEditor", function () {
          StackExchange.using("snippets", function () {
          StackExchange.snippets.init();
          });
          });
          }, "code-snippets");

          StackExchange.ready(function() {
          var channelOptions = {
          tags: "".split(" "),
          id: "1"
          };
          initTagRenderer("".split(" "), "".split(" "), channelOptions);

          StackExchange.using("externalEditor", function() {
          // Have to fire editor after snippets, if snippets enabled
          if (StackExchange.settings.snippets.snippetsEnabled) {
          StackExchange.using("snippets", function() {
          createEditor();
          });
          }
          else {
          createEditor();
          }
          });

          function createEditor() {
          StackExchange.prepareEditor({
          heartbeatType: 'answer',
          autoActivateHeartbeat: false,
          convertImagesToLinks: true,
          noModals: true,
          showLowRepImageUploadWarning: true,
          reputationToPostImages: 10,
          bindNavPrevention: true,
          postfix: "",
          imageUploader: {
          brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
          contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
          allowUrls: true
          },
          onDemand: true,
          discardSelector: ".discard-answer"
          ,immediatelyShowMarkdownHelp:true
          });


          }
          });














          draft saved

          draft discarded


















          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53448377%2fhow-to-specify-the-api-version%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown

























          1 Answer
          1






          active

          oldest

          votes








          1 Answer
          1






          active

          oldest

          votes









          active

          oldest

          votes






          active

          oldest

          votes









          1














          The API version is decided by the client libraries. You can confirm this by disassembling them (e.g. using ILSpy).



          For example, in the current stable release of Microsoft.TeamFoundationServer.Client, DashboardHttpClientBase has a CreateDashboardAsnc method that makes the following call:



          this.SendAsync<Dashboard>(..., new ApiResourceVersion("4.1-preview.2"), ...);





          share|improve this answer
























          • Cool stuff, thanks :-)

            – Rui Jarimba
            Nov 23 '18 at 15:37
















          1














          The API version is decided by the client libraries. You can confirm this by disassembling them (e.g. using ILSpy).



          For example, in the current stable release of Microsoft.TeamFoundationServer.Client, DashboardHttpClientBase has a CreateDashboardAsnc method that makes the following call:



          this.SendAsync<Dashboard>(..., new ApiResourceVersion("4.1-preview.2"), ...);





          share|improve this answer
























          • Cool stuff, thanks :-)

            – Rui Jarimba
            Nov 23 '18 at 15:37














          1












          1








          1







          The API version is decided by the client libraries. You can confirm this by disassembling them (e.g. using ILSpy).



          For example, in the current stable release of Microsoft.TeamFoundationServer.Client, DashboardHttpClientBase has a CreateDashboardAsnc method that makes the following call:



          this.SendAsync<Dashboard>(..., new ApiResourceVersion("4.1-preview.2"), ...);





          share|improve this answer













          The API version is decided by the client libraries. You can confirm this by disassembling them (e.g. using ILSpy).



          For example, in the current stable release of Microsoft.TeamFoundationServer.Client, DashboardHttpClientBase has a CreateDashboardAsnc method that makes the following call:



          this.SendAsync<Dashboard>(..., new ApiResourceVersion("4.1-preview.2"), ...);






          share|improve this answer












          share|improve this answer



          share|improve this answer










          answered Nov 23 '18 at 15:30









          StijnStijn

          16.6k1083127




          16.6k1083127













          • Cool stuff, thanks :-)

            – Rui Jarimba
            Nov 23 '18 at 15:37



















          • Cool stuff, thanks :-)

            – Rui Jarimba
            Nov 23 '18 at 15:37

















          Cool stuff, thanks :-)

          – Rui Jarimba
          Nov 23 '18 at 15:37





          Cool stuff, thanks :-)

          – Rui Jarimba
          Nov 23 '18 at 15:37




















          draft saved

          draft discarded




















































          Thanks for contributing an answer to Stack Overflow!


          • Please be sure to answer the question. Provide details and share your research!

          But avoid



          • Asking for help, clarification, or responding to other answers.

          • Making statements based on opinion; back them up with references or personal experience.


          To learn more, see our tips on writing great answers.




          draft saved


          draft discarded














          StackExchange.ready(
          function () {
          StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53448377%2fhow-to-specify-the-api-version%23new-answer', 'question_page');
          }
          );

          Post as a guest















          Required, but never shown





















































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown

































          Required, but never shown














          Required, but never shown












          Required, but never shown







          Required, but never shown







          這個網誌中的熱門文章

          Xamarin.form Move up view when keyboard appear

          Post-Redirect-Get with Spring WebFlux and Thymeleaf

          Anylogic : not able to use stopDelay()