Resources

You can access various resources in TargetProcess REST API.

Entity

Entity represents TargetProcess objects such as User Story, Bug, Task, Project, Iteration etc. It contains Fields, Nested entities and Collections of Nested entities. Here is an example of simplified entity structure for User Story:

Entity always has an Id field.

To retrieve a single Entity use format

http://localhost/targetprocess/api/v1/{Entities}/[id]

For example, to retrieve a Bug with Id = 84 send the following request

http://localhost/targetprocess/api/v1/Bugs/84

Collection

Collection represents a set of Entities of the same type. It can be a list of User Stories, Bugs, Tasks or any other objects.

<UserStories Next="http://localhost/TargetProcess/api/v1/UserStories/?take=25&amp;skip=25">
	<UserStory Id="196" Name="Set Due Date">
		<!-- ... -->
	</UserStory>
	<UserStory Id="192" Name="Make Task Important">
		<!-- ... -->
	</UserStory>
</UserStories>	

To retrieve a collection of all Entities use format

http://localhost/targetprocess/api/v1/{Entities}/

For example, this request retrieves all Bugs

http://localhost/targetprocess/api/v1/Bugs/

To retrieve a collection of Entities for a specific Context use Acid

http://localhost/targetprocess/api/v1/Bugs/?acid=E1D0F26614C81DD3A6B077E0B4C05138

Inner Collections

You can retrieve inner collections for entity. For example, User Story contains a collection of Bugs. In this case you can retrieve them:

http://localhost/api/v1/UserStories/34256/Bugs

REST API Chapters

1. Getting Started
2. Concepts
1. Resources and collections
2. Context
3. Authentication
4. Response: Formats, Paging, Filters, Partial Get
5. Create, update and delete operations
6. Restful Storage
3. FAQ
4. Reference

Overview

1. Resources
   • Entity
   • Collection
   • Inner Collections