{"id":263,"date":"2014-12-04T00:15:41","date_gmt":"2014-12-04T00:15:41","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/visualstudioalm\/2014\/12\/04\/getting-started-with-cloud-based-load-test-rest-apis\/"},"modified":"2022-05-26T01:50:08","modified_gmt":"2022-05-26T09:50:08","slug":"getting-started-with-cloud-based-load-test-rest-apis","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/devops\/getting-started-with-cloud-based-load-test-rest-apis\/","title":{"rendered":"Getting started with Cloud-based Load Test REST APIs"},"content":{"rendered":"

REST API\u2019s are pretty cool, enabling you to do things like write your own custom reports, write your own interfaces and of course integrating load tests into your build.\u00a0<\/p>\n

Looking at the sample<\/a> referenced with our REST API documentation<\/a>; at 400 lines to demonstrate 4 API\u2019s I must admit I found it pretty daunting so I thought I would see if I could simplify that somewhat.<\/p>\n

Just like the documentation indicates: the first place you want to start is to enable alternate credentials<\/a>.\u00a0 This is done by opening your user profile from Visual Studio Online.\u00a0<\/p>\n

\"image\"<\/p>\n

And enabling alternative credentials.<\/p>\n

\"image\"<\/p>\n

\u00a0<\/p>\n

At this point we are ready to start writing a sample!<\/p>\n

Since the goal of this demo is to keep it simple I decided to use ASP.NET and let it handle all the Async goo.\u00a0<\/p>\n

\u00a0<\/p>\n

\"image\"\"image\"<\/p>\n

To do this all you need to do is set the property Async=\u201dTrue\u201d on the page(see below).\u00a0\u00a0<\/p>\n

While on the page I also tossed on a Textbox to display the result of the REST calls.<\/p>\n

\"image\"<\/p>\n

Here is the markup for that page:<\/p>\n

\n <\/font><\/span><\/font>\n<\/p>\n

\n<\/blockquote>\n

\n> <\/font><%<\/font><\/span><\/font>@<\/font><\/span> <\/span>Page<\/font><\/span> <\/span>Language<\/font><\/span>=”C#”<\/font><\/span> <\/span>AutoEventWireup<\/font><\/span>=”true”<\/font><\/span> <\/span><\/font>async<\/font><\/span>=”true”<\/font><\/span><\/font> <\/span>CodeBehind<\/font><\/span>=”simple.aspx.cs”<\/font><\/span> <\/span>Inherits<\/font><\/span>=”ssimple.simple”<\/font><\/span> <\/span>%><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font>\u00a0<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font><\/span><\/font>DOCTYPE<\/font><\/span> <\/span>html<\/font><\/span><\/font>><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font>\u00a0<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font><<\/font><\/span><\/font>html<\/font><\/span> <\/span>xmlns<\/font><\/span><\/font>=”http:\/\/www.w3.org\/1999\/xhtml”><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font><<\/font><\/span><\/font>head<\/font><\/span> <\/span>runat<\/font><\/span><\/font>=”server”><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0 <\/font><\/span><\/span><\/font><<\/font><\/span>title<\/font><\/span>><\/<\/font><\/span>title<\/font><\/span><\/font>><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font><\/<\/font><\/span><\/font>head<\/font><\/span><\/font>><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font><<\/font><\/span><\/font>body<\/font><\/span><\/font>><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0 <\/font><\/span><\/span><\/font><<\/font><\/span>form<\/font><\/span> <\/span>id<\/font><\/span>=”form1″<\/font><\/span> <\/span>runat<\/font><\/span><\/font>=”server”><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0 <\/font><\/span><\/span><\/font><<\/font><\/span>div<\/font><\/span><\/font>><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span><\/span><\/font><<\/font><\/span>asp<\/font><\/span>:<\/font><\/span>TextBox<\/font><\/span> <\/span>ID<\/font><\/span>=”TextBox1″<\/font><\/span> <\/span>runat<\/font><\/span>=”server”<\/font><\/span> <\/span>TextMode<\/font><\/span>=”MultiLine”><\/<\/font><\/span>asp<\/font><\/span>:<\/font><\/span>TextBox<\/font><\/span><\/font>><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0 <\/font><\/span><\/span><\/font><\/<\/font><\/span>div<\/font><\/span><\/font>><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0 <\/font><\/span><\/span><\/font><\/<\/font><\/span>form<\/font><\/span><\/font>><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font><\/<\/font><\/span><\/font>body<\/font><\/span><\/font>><\/font><\/span><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font><\/<\/font><\/span><\/font>html<\/font><\/span><\/font>><\/font><\/span><\/span>\n> <\/p>\n

\u00a0<\/p>\n

To make the code easier to read and access the functionality needed; bring in the following four namespaces and corresponding references:<\/p>\n

\n<\/blockquote>\n

\n> <\/font>using<\/font><\/span><\/font> System.Globalization;<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font>using<\/font><\/span><\/font> System.Web.Configuration;<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font>using<\/font><\/span><\/font> System.Net.Http;<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font>using<\/font><\/span><\/font> System.Net.Http.Headers;<\/font><\/span>\n> <\/p>\n

At this point I am ready to call my REST API: **\/TESTDROPS.\u00a0 **<\/p>\n

**An important note: **You need to use the **VSCLT **URI for Cloud-based load test REST API\u2019s So the entire URL would look like:<\/p>\n

\n

https:\/\/.vsclt<\/font>.visualstudio.com\/_apis\/clt\/testdrops”<\/strong><\/p>\n<\/blockquote>\n

While the REST API only takes one line of code (HttpClient.GetStringAsync\u2026); a couple of lines of code are required to setup up the connection.<\/p>\n

Since we are letting ASP.NET handle the Async handling you need to set this property in the event handler.<\/p>\n

\u00a0<\/p>\n

\n<\/blockquote>\n

\n> <\/font>protected<\/font><\/span><\/font> <\/span>async<\/strong><\/font><\/span> <\/span>void<\/font><\/span> Page_Load(<\/span>object<\/font><\/span> sender, <\/span>EventArgs<\/font><\/span><\/font> e)<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span><\/font>{<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> <\/font>\u00a0<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span><\/span><\/font>HttpClient<\/font><\/span> client = <\/span>new<\/font><\/span> <\/span>HttpClient<\/font><\/span><\/font>();<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span><\/span>\/\/setup the client connection<\/font><\/span><\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span><\/span><\/font>var<\/font><\/span> vsoAccountUsername = <\/span>WebConfigurationManager<\/font><\/span>.AppSettings[<\/span>“VSOnlineAccountUsername”<\/font><\/span><\/font>];<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span><\/span>\/\/ var vsoAccountUsername = “Chass@outlook.com”;<\/font><\/span><\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span><\/span><\/font>var<\/font><\/span> vsoAccountPassword = <\/span>WebConfigurationManager<\/font><\/span>.AppSettings[<\/span>“VSOnlineAccountPassword”<\/font><\/span><\/font>];<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span>client.DefaultRequestHeaders.Authorization = <\/font><\/span><\/font>new<\/font><\/span> <\/span>AuthenticationHeaderValue<\/font><\/span>(<\/span>“Basic”<\/font><\/span><\/font>,<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span><\/span><\/font>Convert<\/font><\/span>.ToBase64String(System.Text.<\/span>Encoding<\/font><\/span>.ASCII.GetBytes(<\/span>string<\/font><\/span>.Format(<\/span>CultureInfo<\/font><\/span>.InvariantCulture, <\/span>“{0}:{1}”<\/font><\/span><\/font>, vsoAccountUsername, vsoAccountPassword))));<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span>TextBox1.Text = <\/font><\/span><\/font>await<\/font><\/span> client.GetStringAsync(<\/span>“https:\/\/aidemo.vsclt.visualstudio.com\/_apis\/clt\/testdrops”<\/font><\/span><\/font>);<\/font><\/span>\n> <\/p>\n

\n<\/blockquote>\n

\n> \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/font><\/span><\/font>}<\/font><\/span>\n> <\/p>\n

\u00a0<\/p>\n

If you are getting an HTTP 401 error when running this sample more than likely your account doesn\u2019t have a Visual Studio Ultimate Subscription associated with it or you haven\u2019t enabled alternate credentials.<\/p>\n

For those of you a little more old school here is a console application version:\u00a0<\/p>\n

\u00a0<\/p>\n

\n

public static async void GetTestRuns()
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 try
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 var elsAccountUrl = new Uri(ConfigurationManager.AppSettings[“ElsOnlineAccountUrl”]);
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 var vsoAccountUsername = ConfigurationManager.AppSettings[“VSOnlineAccountUsername”];
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 var vsoAccountPassword = ConfigurationManager.AppSettings[“VSOnlineAccountPassword”];<\/font><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 using (var client = new HttpClient())
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 client.DefaultRequestHeaders.Accept.Add(
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 new MediaTypeWithQualityHeaderValue(“application\/json”));<\/font><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(“Basic”,
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Convert.ToBase64String(
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 System.Text.Encoding.ASCII.GetBytes(
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 string.Format(“{0}:{1}”, vsoAccountUsername, vsoAccountPassword))));<\/font><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 using (HttpResponseMessage response = client.GetAsync(elsAccountUrl+”\/_apis\/clt\/testruns”).Result)
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 response.EnsureSuccessStatusCode();
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 string responseBody = await response.Content.ReadAsStringAsync();
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Console.WriteLine(responseBody);
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 catch (Exception ex)
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Console.WriteLine(ex.ToString());
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }<\/font><\/p>\n

\u00a0<\/p>\n<\/blockquote>\n

\u00a0<\/p>\n

\u00a0<\/p>\n

If you haven\u2019t played with App.Config files, here is an example:<\/p>\n

\n


\u00a0\u00a0\u00a0
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0
\u00a0\u00a0\u00a0 <\/startup>
\u00a0\u00a0\u00a0
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 [https:\/\/<\/font>{account}.<\/font>vsclt.visualstudio.com”][7] \/><\/font><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0
\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0
\u00a0\u00a0\u00a0 <\/appSettings>
<\/configuration><\/font><\/p>\n<\/blockquote>\n

\u00a0<\/p>\n

To make it has easy as possible, I have also attached a zip file of the web project:<\/p>\n

2451.ssimple.zip<\/a><\/p>\n

http:\/\/blogs.msdn.com\/cfs-file.ashx\/__key\/communityserver-blogs-components-weblogfiles\/00-00-00-45-92-chass\/2451.ssimple.zip<\/a><\/p>\n

\u00a0<\/p>\n

In case you are wondering what the return looks like I would recommend just running the URL: https:\/\/{youraccount}.vsclt.visualstudio.com\/_apis\/clt\/testdrops<\/a><\/p>\n

Here is a screenshot of the web application as well<\/p>\n

\"image\"<\/p>\n

\u00a0<\/p>\n

\u00a0<\/p>\n

\u00a0<\/p>\n

SEO Tagging: \u201cworlds simplest REST API Sample\u201d<\/p>\n","protected":false},"excerpt":{"rendered":"

REST API\u2019s are pretty cool, enabling you to do things like write your own custom reports, write your own interfaces and of course integrating load tests into your build.\u00a0 Looking at the sample referenced with our REST API documentation; at 400 lines to demonstrate 4 API\u2019s I must admit I found it pretty daunting so […]<\/p>\n","protected":false},"author":63,"featured_media":45953,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1,252],"tags":[],"class_list":["post-263","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-devops","category-testing"],"acf":[],"blog_post_summary":"

REST API\u2019s are pretty cool, enabling you to do things like write your own custom reports, write your own interfaces and of course integrating load tests into your build.\u00a0 Looking at the sample referenced with our REST API documentation; at 400 lines to demonstrate 4 API\u2019s I must admit I found it pretty daunting so […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/posts\/263","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/users\/63"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/comments?post=263"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/posts\/263\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/media\/45953"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/media?parent=263"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/categories?post=263"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/devops\/wp-json\/wp\/v2\/tags?post=263"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}