Get collection of Tasks
More information
Options for working with inner collections
If you'd like to get an inner collection there is an option to either include it into the list of retrieved fields, or to query this collection directly:
- /api/v1/tasks?include=[Id,Name,Comments]&take=100&innertake=1000
- /api/v1/comments?where=(General.EntityType.Name eq 'Task')&include=[Id,Name,General]&take=1000
We recommend using the second approach.
-
get Tasks created last months:
/api/v1/tasks?where=(CreateDate gte '2017-01-01')and(CreateDate lte '2017-01-31')&take=1000 -
get Tasks closed last months:
/api/v1/tasks?where=(EndDate gte '2017-01-01')and(EndDate lte '2017-01-31')&take=1000 -
get Tasks in the current iteration:
/api/v1/tasks?where=(Iteration.IsCurrent eq 'true')&take=1000 -
get Tasks in the current release:
/api/v1/tasks?where=(Release.IsCurrent eq 'true')&take=1000 -
get Tasks created by user ID#1:
/api/v1/tasks?where=(Owner.Id eq 1)&include=[Id,Name,CreateDate,StartDate,EndDate,EntityState]&take=1000
using System;
using System.Net;
using System.Net.Http;
namespace REST.Test
{
class Program
{
static void Main(string[] args)
{
HttpClient client = new HttpClient();
client.BaseAddress = new Uri("https://restapi.tpondemand.com/api/v1/");
ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls;
//get 5 oldest Tasks which are not closed yet
string query = "tasks?where=(EntityState.IsFinal eq 'false')&take=5&orderby=CreateDate&include=[Id,Name,EntityState]";
//using a token generated at /api/v1/Authentication
query += "&token=Njo4OTIyQzkzN0M5NEY3NzNENDIyNTM2RDU3MTMwMTMwOA==";
Console.WriteLine("Pulling " + query);
HttpResponseMessage response = client.GetAsync(query).Result;
if (response.IsSuccessStatusCode)
{
Console.WriteLine(response.Content.ReadAsStringAsync().Result);
}
else
{
Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
}
}
}
}
using System;
using System.Net;
using System.Net.Http;
namespace REST.Test
{
class Program
{
static void Main(string[] args)
{
HttpClient client = new HttpClient();
client.BaseAddress = new Uri("https://restapi.tpondemand.com/api/v1/");
ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls;
//get Tasks closed last week
string lastMonday = DateTime.Now.AddDays(-(int)DateTime.Now.DayOfWeek - 6).ToString("yyyy-MM-dd");
string query = "tasks?where=(EndDate gte '" + lastMonday + "')&include=[Id,Name,EndDate,TimeSpent]&take=1000";
//using access token generated at Personal Details page (Access Tokens tab)
query += "&access_token=NjplaXdQeTJDOHVITFBta0QyME85QlhEOWpwTGdPM2V6VjIyelZlZ0NKWG1RPQ==";
Console.WriteLine("Pulling " + query);
HttpResponseMessage response = client.GetAsync(query).Result;
if (response.IsSuccessStatusCode)
{
Console.WriteLine(response.Content.ReadAsStringAsync().Result);
}
else
{
Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
}
}
}
}
using System;
using System.Net;
using System.Net.Http;
using System.Text;
namespace REST.Test
{
class Program
{
static void Main(string[] args)
{
HttpClient client = new HttpClient();
client.BaseAddress = new Uri("https://restapi.tpondemand.com/api/v1/");
ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls;
//get Tasks for project with ID#192
string query = "tasks?where=(Project.Id eq 192)&take=1000&include=[Id,Name,EntityState]";
//using basic authentication (here 'John' is login and '123' is password)
string authentication = Convert.ToBase64String(Encoding.ASCII.GetBytes("John:123"));
client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Basic", authentication);
Console.WriteLine("Pulling " + query);
HttpResponseMessage response = client.GetAsync(query).Result;
if (response.IsSuccessStatusCode)
{
Console.WriteLine(response.Content.ReadAsStringAsync().Result);
}
else
{
Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
}
}
}
}
using System;
using System.Net;
using System.Net.Http;
namespace REST.Test
{
class Program
{
static void Main(string[] args)
{
HttpClient client = new HttpClient();
client.BaseAddress = new Uri("https://restapi.tpondemand.com/api/v1/");
ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls;
//get Task ID#72
string query = "tasks/72?include=[Id,Name,EntityState]";
//using no authentication will result in 401 Unauthorized response
Console.WriteLine("Pulling " + query);
HttpResponseMessage response = client.GetAsync(query).Result;
if (response.IsSuccessStatusCode)
{
Console.WriteLine(response.Content.ReadAsStringAsync().Result);
}
else
{
Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
}
}
}
}