TargetProcess REST API examples

readme.rst

Documentation

• http://dev.targetprocess.com/rest/index
• http://dev.targetprocess.com/rest/getting_started
• http://md5.tpondemand.com/api/v1/index/meta

Company wide current TeamIterations including all stories with the amount of tasks

https://hostname.com/targetprocess/api/v1/TeamIterations/?include=[Team,Name,UserStories,Bugs,Velocity]&append=[Tasks-Count]&IsCurrent=1

Complex example

https://hostname.com/targetprocess/api/v1/TeamIterations/?include=[Project,Team,Name,UserStories[Id,Effort,Name],Bugs,Velocity]&append=[Tasks-Count]&IsCurrent=1

UserStories for the Searchperience Team grouped by TeamIterations

https://hostname.com/targetprocess/api/v1/Teams/4089/TeamIterations?include=[Name,UserStories] https://hostname.com/targetprocess/api/v1/Teams/4089/TeamIterations?include=[Team,Name,UserStories,Bugs,Velocity] https://hostname.com/targetprocess/api/v1/Teams/4089/TeamIterations?include=[Team,Name,UserStories[Id,Effort,Name],Bugs,Velocity] https://hostname.com/targetprocess/api/v1/Teams/4089/TeamIterations?include=[Team,Name,UserStories,Bugs,Velocity]&append=[Tasks-Count,UserStories-Count,Bugs-Count]

Getting the Next Sprint backlog

https://hostname.de/targetprocess/api/v1/Teams/4089/TeamIterations?include=[Name,UserStories[Id,Name,Effort,EffortToDo,EffortCompleted,Project[Abbreviation]]],Bugs,Velocity]&where=EndDate%20gt%20'2014-01-20'&take=2

Improved version "use valid date for 'EndDate' & 'StartDate'"

https://hostname.de/targetprocess/api/v1/Teams/4089/TeamIterations?where=EndDate%20gt%20'2014-01-20'%20and%20StartDate%20gt%20'2014-01-20'&orderby=StartDate&take=1&include=[Name,UserStories[Id,Name,Effort,EffortToDo,EffortCompleted,Project[Abbreviation]]]