REST API Reference
Reference contains all resources with fields descriptions.
Culture
Selected in application culture.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | The culture name in the format [languagecode2]-[country/regioncode2], where [languagecode2] is a lowercase two-letter code derived from ISO 639-1 and [country/regioncode2] is an uppercase two-letter code derived from ISO 3166. For example, en-US |
| DecimalSeparator | Decimal separator for the culture |
| ShortDateFormat | Short date format for the culture |
| LongDateFormat | Long date format for the culture |
| TimePattern | Time format for the culture according to http://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.71).aspx |
Process
Set of practices that can be applied to a project. It is possible to create custom processes with defined set of Practice.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Process name. For example: Simplified |
| Description | Brief description of the process |
| EntityStates | Entity States for the process |
EntityType
Represents entity type. For example: Bug, TestCase, Project.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Name of entity type. For example: Bug, TestCase, Project. |
Priority
Priority of User Story, Bug or Feature
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Priority name. For example: Must Have |
| Importance | Priority importance. Minimal value is of highest importance. |
| IsDefault | Determines whether priority is default |
| EntityType | Type of entity to which priority belongs |
Severity
Severity (measure of injuriousness) of the bug. For example, Blocking, Critical, Small.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Severity name. For example: Blocking |
| Importance | Defines severity importance. Minimal value is of highest importance |
| IsDefault | Indicates wheather severity is default |
EntityState
State of entity. For example, bug has four states by default: Open, Fixed, Invalid and Done.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Name of the state. For example, Open or Done |
| IsInitial | Defines if the state is initial. Only one initial state is allowed |
| IsFinal | Defines if the state is final. Only one final state is allowed |
| EntityType | Entity type to which entity state belongs (Bug, Project, etc) |
| Process | Process to which entity state belongs |
General
Base entity for Assignable, Build, Impediment, Iteration, Program, Project, Release, Test Case, Test Plan, Bug, Feature, Request, Task, Test Plan Run, User Story
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
Assignable
Base entity for User Story, Task, Bug, Test Plan Run, Feature, Request.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who owns the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Effort | Total effort of the assignable. Read-only field |
| EffortCompleted | Effort spent on the assignment. Read-only calculated field |
| EffortToDo | Effort required to complete the assignment. Read-only calculated field |
| TimeSpent | Total time spent on the assignment. Read-only calculated field |
| TimeRemain | Total time remaining to complete the assignment for the Role. Read-only calculated field |
| EntityType | Type of entity. For exapmle Bug, Feature, Task, etc. |
| AssignedUser | User to whom entity is assigned |
| Release | Assignable entity may be assigned to Release or may be in project Backlog (Release is not defined in this case) |
| Iteration | Assignable entity may be assigned to Iteration |
| Priority | Priority of assignable. For example, User Story can have Must Have or Nice To Have priority |
| EntityState | State of assignable. For example, User Story can be in Open or Done state |
| Assignments | People assigned to entity |
| Impediments | Blocking reason which does not allow further work on assignable entity |
| Times | Collection of posted time entries to assignable entity |
| RoleEfforts | Collection of efforts for all roles |
GeneralUser
Base entity for User and Requester.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| FirstName | First Name |
| LastName | Last Name |
| Login | Login |
| CreateDate | Creation date of user |
| ModifyDate | Last modification date of user |
| IsActive | Determines whether user is active in the system |
| IsAdministrator | Determines whether user is administrator |
| Generals | Generals |
| Assignable | All entitiest assigned to this user |
| Comments | Collection of user comments |
| Revisions | Collection of user revisions |
| Assignments | Collection of user assignments |
User
Represents User of the system.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| WeeklyAvailableHours | Weekly available hours |
| CurrentAllocation | Current allocation |
| CurrentAvailableHours | Current available hours |
| AvailableFrom | Available from |
| AvailableFutureAllocation | Available future allocation |
| AvailableFutureHours | Available future hours |
| IsObserver | Is observer |
| Times | Times |
| Impediments | Impediments |
| CustomActivities | Custom activities |
Project
Core entity which contains releases, feature, user stories, bugs, etc.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| IsActive | Defines whether project is active |
| IsProduct | Defines whether project is a product |
| Generals | Collection of general entities |
| Program | Program associated with the project |
| Features | Collection of project features |
| Releases | Collection of project releases |
| Iterations | Collection of project iterations |
| UserStories | Collection of project user stories |
| Tasks | Collection of project tasks |
| Bugs | Collection of project bugs |
| TestCases | Collection of project test cases |
| TestPlans | Collection of project test plans |
| Builds | Collection of project builds |
| Times | Collection of times posted to the project |
| Revisions | Collection of project revisions |
| CustomActivities | Collection of project custom activities |
| Company | Project company |
GET http://{targetprocess}/api/v1/Projects/248/
{
"Id": 248,
"Name": "Project Name",
"Description": "Project Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Project Tags",
"Owner": {
"Id": 65
},
"Project": {
"Id": 299,
"Name": "Project #299"
},
"Comments": [
{
"Id": 144
},
{
"Id": 195
}
],
"Attachments": [
{
"Id": 215,
"Name": "Picture.png"
},
{
"Id": 242,
"Name": "Error.png"
}
],
"IsActive": null,
"IsProduct": null,
"Generals": [
{
"Id": 30,
"Name": "General #30"
},
{
"Id": 218,
"Name": "General #218"
}
],
"Program": {
"Id": 215,
"Name": "Program #215"
},
"Features": [
{
"Id": 37,
"Name": "Feature #37"
},
{
"Id": 271,
"Name": "Feature #271"
}
],
"Releases": [
{
"Id": 56,
"Name": "Release #56"
},
{
"Id": 143,
"Name": "Release #143"
}
],
"Iterations": [
{
"Id": 162,
"Name": "Iteration #162"
},
{
"Id": 97,
"Name": "Iteration #97"
}
],
"UserStories": [
{
"Id": 201,
"Name": "UserStory #201"
},
{
"Id": 140,
"Name": "UserStory #140"
}
],
"Tasks": [
{
"Id": 250,
"Name": "Task #250"
},
{
"Id": 242,
"Name": "Task #242"
}
],
"Bugs": [
{
"Id": 238,
"Name": "Bug #238"
},
{
"Id": 229,
"Name": "Bug #229"
}
],
"TestCases": [
{
"Id": 281,
"Name": "TestCase #281"
},
{
"Id": 88,
"Name": "TestCase #88"
}
],
"TestPlans": [
{
"Id": 156,
"Name": "TestPlan #156"
},
{
"Id": 199,
"Name": "TestPlan #199"
}
],
"Builds": [
{
"Id": 99,
"Name": "Build #99"
},
{
"Id": 86,
"Name": "Build #86"
}
],
"Times": [
{
"Id": 246
},
{
"Id": 66
}
],
"Revisions": [
{
"Id": 56
},
{
"Id": 20
}
],
"CustomActivities": [
{
"Id": 187,
"Name": "CustomActivity #187"
},
{
"Id": 207,
"Name": "CustomActivity #207"
}
],
"Company": {
"Id": 189,
"Name": "Company #189"
},
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<Project Id="248" Name="Project Name">
<Description>Project Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Project Tags</Tags>
<Owner Id="65" />
<Project Id="299" Name="Project #299" />
<Comments>
<Comment Id="144" />
<Comment Id="195" />
</Comments>
<Attachments>
<Attachment Id="215" Name="Picture.png" />
<Attachment Id="242" Name="Error.png" />
</Attachments>
<IsActive />
<IsProduct />
<Generals>
<General Id="30" Name="General #30" />
<General Id="218" Name="General #218" />
</Generals>
<Program Id="215" Name="Program #215" />
<Features>
<Feature Id="37" Name="Feature #37" />
<Feature Id="271" Name="Feature #271" />
</Features>
<Releases>
<Release Id="56" Name="Release #56" />
<Release Id="143" Name="Release #143" />
</Releases>
<Iterations>
<Iteration Id="162" Name="Iteration #162" />
<Iteration Id="97" Name="Iteration #97" />
</Iterations>
<UserStories>
<UserStory Id="201" Name="UserStory #201" />
<UserStory Id="140" Name="UserStory #140" />
</UserStories>
<Tasks>
<Task Id="250" Name="Task #250" />
<Task Id="242" Name="Task #242" />
</Tasks>
<Bugs>
<Bug Id="238" Name="Bug #238" />
<Bug Id="229" Name="Bug #229" />
</Bugs>
<TestCases>
<TestCase Id="281" Name="TestCase #281" />
<TestCase Id="88" Name="TestCase #88" />
</TestCases>
<TestPlans>
<TestPlan Id="156" Name="TestPlan #156" />
<TestPlan Id="199" Name="TestPlan #199" />
</TestPlans>
<Builds>
<Build Id="99" Name="Build #99" />
<Build Id="86" Name="Build #86" />
</Builds>
<Times>
<Time Id="246" />
<Time Id="66" />
</Times>
<Revisions>
<Revision Id="56" />
<Revision Id="20" />
</Revisions>
<CustomActivities>
<CustomActivity Id="187" Name="CustomActivity #187" />
<CustomActivity Id="207" Name="CustomActivity #207" />
</CustomActivities>
<Company Id="189" Name="Company #189" />
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Project>
GET http://{targetprocess}/api/v1/Projects/
[
{
"Id": 248,
"Name": "Project Name",
"Description": "Project Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Project Tags",
"Owner": {
"Id": 65
},
"Project": {
"Id": 299,
"Name": "Project #299"
},
"Comments": [
{
"Id": 144
},
{
"Id": 195
}
],
"Attachments": [
{
"Id": 215,
"Name": "Picture.png"
},
{
"Id": 242,
"Name": "Error.png"
}
],
"IsActive": null,
"IsProduct": null,
"Generals": [
{
"Id": 30,
"Name": "General #30"
},
{
"Id": 218,
"Name": "General #218"
}
],
"Program": {
"Id": 215,
"Name": "Program #215"
},
"Features": [
{
"Id": 37,
"Name": "Feature #37"
},
{
"Id": 271,
"Name": "Feature #271"
}
],
"Releases": [
{
"Id": 56,
"Name": "Release #56"
},
{
"Id": 143,
"Name": "Release #143"
}
],
"Iterations": [
{
"Id": 162,
"Name": "Iteration #162"
},
{
"Id": 97,
"Name": "Iteration #97"
}
],
"UserStories": [
{
"Id": 201,
"Name": "UserStory #201"
},
{
"Id": 140,
"Name": "UserStory #140"
}
],
"Tasks": [
{
"Id": 250,
"Name": "Task #250"
},
{
"Id": 242,
"Name": "Task #242"
}
],
"Bugs": [
{
"Id": 238,
"Name": "Bug #238"
},
{
"Id": 229,
"Name": "Bug #229"
}
],
"TestCases": [
{
"Id": 281,
"Name": "TestCase #281"
},
{
"Id": 88,
"Name": "TestCase #88"
}
],
"TestPlans": [
{
"Id": 156,
"Name": "TestPlan #156"
},
{
"Id": 199,
"Name": "TestPlan #199"
}
],
"Builds": [
{
"Id": 99,
"Name": "Build #99"
},
{
"Id": 86,
"Name": "Build #86"
}
],
"Times": [
{
"Id": 246
},
{
"Id": 66
}
],
"Revisions": [
{
"Id": 56
},
{
"Id": 20
}
],
"CustomActivities": [
{
"Id": 187,
"Name": "CustomActivity #187"
},
{
"Id": 207,
"Name": "CustomActivity #207"
}
],
"Company": {
"Id": 189,
"Name": "Company #189"
},
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 278,
"Name": "Project Name",
"Description": "Project Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Project Tags",
"Owner": {
"Id": 66
},
"Project": {
"Id": 278,
"Name": "Project #278"
},
"Comments": [
{
"Id": 19
},
{
"Id": 270
}
],
"Attachments": [
{
"Id": 203,
"Name": "Picture.png"
},
{
"Id": 28,
"Name": "Error.png"
}
],
"IsActive": null,
"IsProduct": null,
"Generals": [
{
"Id": 44,
"Name": "General #44"
},
{
"Id": 32,
"Name": "General #32"
}
],
"Program": {
"Id": 182,
"Name": "Program #182"
},
"Features": [
{
"Id": 285,
"Name": "Feature #285"
},
{
"Id": 147,
"Name": "Feature #147"
}
],
"Releases": [
{
"Id": 44,
"Name": "Release #44"
},
{
"Id": 203,
"Name": "Release #203"
}
],
"Iterations": [
{
"Id": 170,
"Name": "Iteration #170"
},
{
"Id": 67,
"Name": "Iteration #67"
}
],
"UserStories": [
{
"Id": 185,
"Name": "UserStory #185"
},
{
"Id": 1,
"Name": "UserStory #1"
}
],
"Tasks": [
{
"Id": 108,
"Name": "Task #108"
},
{
"Id": 255,
"Name": "Task #255"
}
],
"Bugs": [
{
"Id": 18,
"Name": "Bug #18"
},
{
"Id": 84,
"Name": "Bug #84"
}
],
"TestCases": [
{
"Id": 211,
"Name": "TestCase #211"
},
{
"Id": 287,
"Name": "TestCase #287"
}
],
"TestPlans": [
{
"Id": 296,
"Name": "TestPlan #296"
},
{
"Id": 116,
"Name": "TestPlan #116"
}
],
"Builds": [
{
"Id": 156,
"Name": "Build #156"
},
{
"Id": 84,
"Name": "Build #84"
}
],
"Times": [
{
"Id": 151
},
{
"Id": 159
}
],
"Revisions": [
{
"Id": 17
},
{
"Id": 84
}
],
"CustomActivities": [
{
"Id": 148,
"Name": "CustomActivity #148"
},
{
"Id": 253,
"Name": "CustomActivity #253"
}
],
"Company": {
"Id": 183,
"Name": "Company #183"
},
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<Project Id="248" Name="Project Name">
<Description>Project Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Project Tags</Tags>
<Owner Id="65" />
<Project Id="299" Name="Project #299" />
<Comments>
<Comment Id="144" />
<Comment Id="195" />
</Comments>
<Attachments>
<Attachment Id="215" Name="Picture.png" />
<Attachment Id="242" Name="Error.png" />
</Attachments>
<IsActive />
<IsProduct />
<Generals>
<General Id="30" Name="General #30" />
<General Id="218" Name="General #218" />
</Generals>
<Program Id="215" Name="Program #215" />
<Features>
<Feature Id="37" Name="Feature #37" />
<Feature Id="271" Name="Feature #271" />
</Features>
<Releases>
<Release Id="56" Name="Release #56" />
<Release Id="143" Name="Release #143" />
</Releases>
<Iterations>
<Iteration Id="162" Name="Iteration #162" />
<Iteration Id="97" Name="Iteration #97" />
</Iterations>
<UserStories>
<UserStory Id="201" Name="UserStory #201" />
<UserStory Id="140" Name="UserStory #140" />
</UserStories>
<Tasks>
<Task Id="250" Name="Task #250" />
<Task Id="242" Name="Task #242" />
</Tasks>
<Bugs>
<Bug Id="238" Name="Bug #238" />
<Bug Id="229" Name="Bug #229" />
</Bugs>
<TestCases>
<TestCase Id="281" Name="TestCase #281" />
<TestCase Id="88" Name="TestCase #88" />
</TestCases>
<TestPlans>
<TestPlan Id="156" Name="TestPlan #156" />
<TestPlan Id="199" Name="TestPlan #199" />
</TestPlans>
<Builds>
<Build Id="99" Name="Build #99" />
<Build Id="86" Name="Build #86" />
</Builds>
<Times>
<Time Id="246" />
<Time Id="66" />
</Times>
<Revisions>
<Revision Id="56" />
<Revision Id="20" />
</Revisions>
<CustomActivities>
<CustomActivity Id="187" Name="CustomActivity #187" />
<CustomActivity Id="207" Name="CustomActivity #207" />
</CustomActivities>
<Company Id="189" Name="Company #189" />
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Project>
<Project Id="278" Name="Project Name">
<Description>Project Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Project Tags</Tags>
<Owner Id="66" />
<Project Id="278" Name="Project #278" />
<Comments>
<Comment Id="19" />
<Comment Id="270" />
</Comments>
<Attachments>
<Attachment Id="203" Name="Picture.png" />
<Attachment Id="28" Name="Error.png" />
</Attachments>
<IsActive />
<IsProduct />
<Generals>
<General Id="44" Name="General #44" />
<General Id="32" Name="General #32" />
</Generals>
<Program Id="182" Name="Program #182" />
<Features>
<Feature Id="285" Name="Feature #285" />
<Feature Id="147" Name="Feature #147" />
</Features>
<Releases>
<Release Id="44" Name="Release #44" />
<Release Id="203" Name="Release #203" />
</Releases>
<Iterations>
<Iteration Id="170" Name="Iteration #170" />
<Iteration Id="67" Name="Iteration #67" />
</Iterations>
<UserStories>
<UserStory Id="185" Name="UserStory #185" />
<UserStory Id="1" Name="UserStory #1" />
</UserStories>
<Tasks>
<Task Id="108" Name="Task #108" />
<Task Id="255" Name="Task #255" />
</Tasks>
<Bugs>
<Bug Id="18" Name="Bug #18" />
<Bug Id="84" Name="Bug #84" />
</Bugs>
<TestCases>
<TestCase Id="211" Name="TestCase #211" />
<TestCase Id="287" Name="TestCase #287" />
</TestCases>
<TestPlans>
<TestPlan Id="296" Name="TestPlan #296" />
<TestPlan Id="116" Name="TestPlan #116" />
</TestPlans>
<Builds>
<Build Id="156" Name="Build #156" />
<Build Id="84" Name="Build #84" />
</Builds>
<Times>
<Time Id="151" />
<Time Id="159" />
</Times>
<Revisions>
<Revision Id="17" />
<Revision Id="84" />
</Revisions>
<CustomActivities>
<CustomActivity Id="148" Name="CustomActivity #148" />
<CustomActivity Id="253" Name="CustomActivity #253" />
</CustomActivities>
<Company Id="183" Name="Company #183" />
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Project>
</Items>
Program
Container for projects
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Projects | Collection of projects |
GET http://{targetprocess}/api/v1/Programs/31/
{
"Id": 31,
"Name": "Program Name",
"Description": "Program Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Program Tags",
"Owner": {
"Id": 222
},
"Project": {
"Id": 120,
"Name": "Project #120"
},
"Comments": [
{
"Id": 280
},
{
"Id": 39
}
],
"Attachments": [
{
"Id": 209,
"Name": "Picture.png"
},
{
"Id": 184,
"Name": "Error.png"
}
],
"Projects": [
{
"Id": 249,
"Name": "Project #249"
},
{
"Id": 205,
"Name": "Project #205"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<Program Id="31" Name="Program Name">
<Description>Program Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Program Tags</Tags>
<Owner Id="222" />
<Project Id="120" Name="Project #120" />
<Comments>
<Comment Id="280" />
<Comment Id="39" />
</Comments>
<Attachments>
<Attachment Id="209" Name="Picture.png" />
<Attachment Id="184" Name="Error.png" />
</Attachments>
<Projects>
<Project Id="249" Name="Project #249" />
<Project Id="205" Name="Project #205" />
</Projects>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Program>
GET http://{targetprocess}/api/v1/Programs/
[
{
"Id": 31,
"Name": "Program Name",
"Description": "Program Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Program Tags",
"Owner": {
"Id": 222
},
"Project": {
"Id": 120,
"Name": "Project #120"
},
"Comments": [
{
"Id": 280
},
{
"Id": 39
}
],
"Attachments": [
{
"Id": 209,
"Name": "Picture.png"
},
{
"Id": 184,
"Name": "Error.png"
}
],
"Projects": [
{
"Id": 249,
"Name": "Project #249"
},
{
"Id": 205,
"Name": "Project #205"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 170,
"Name": "Program Name",
"Description": "Program Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Program Tags",
"Owner": {
"Id": 51
},
"Project": {
"Id": 55,
"Name": "Project #55"
},
"Comments": [
{
"Id": 182
},
{
"Id": 75
}
],
"Attachments": [
{
"Id": 299,
"Name": "Picture.png"
},
{
"Id": 170,
"Name": "Error.png"
}
],
"Projects": [
{
"Id": 19,
"Name": "Project #19"
},
{
"Id": 79,
"Name": "Project #79"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<Program Id="31" Name="Program Name">
<Description>Program Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Program Tags</Tags>
<Owner Id="222" />
<Project Id="120" Name="Project #120" />
<Comments>
<Comment Id="280" />
<Comment Id="39" />
</Comments>
<Attachments>
<Attachment Id="209" Name="Picture.png" />
<Attachment Id="184" Name="Error.png" />
</Attachments>
<Projects>
<Project Id="249" Name="Project #249" />
<Project Id="205" Name="Project #205" />
</Projects>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Program>
<Program Id="170" Name="Program Name">
<Description>Program Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Program Tags</Tags>
<Owner Id="51" />
<Project Id="55" Name="Project #55" />
<Comments>
<Comment Id="182" />
<Comment Id="75" />
</Comments>
<Attachments>
<Attachment Id="299" Name="Picture.png" />
<Attachment Id="170" Name="Error.png" />
</Attachments>
<Projects>
<Project Id="19" Name="Project #19" />
<Project Id="79" Name="Project #79" />
</Projects>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Program>
</Items>
Release
Time-boxed entity that can contain several iterations and at the end of which there is some shippable output.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Iterations | Collection of iterations inside release |
| Assignables | Collection of entities it containes |
| Features | Collection of features it containes |
| UserStories | Collection of user stories it containes |
| Tasks | Collection of tasks it containes |
| Bugs | Collection of bugs containes |
| TestPlanRuns | Collection of test plan runs it containes |
| Requests | Collection of releases it containes |
| Builds | Collection of builds it containes |
GET http://{targetprocess}/api/v1/Releases/252/
{
"Id": 252,
"Name": "Release Name",
"Description": "Release Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Release Tags",
"Owner": {
"Id": 170
},
"Project": {
"Id": 193,
"Name": "Project #193"
},
"Comments": [
{
"Id": 154
},
{
"Id": 291
}
],
"Attachments": [
{
"Id": 23,
"Name": "Picture.png"
},
{
"Id": 153,
"Name": "Error.png"
}
],
"Iterations": [
{
"Id": 46,
"Name": "Iteration #46"
},
{
"Id": 244,
"Name": "Iteration #244"
}
],
"Assignables": [
{
"Id": 192,
"Name": "Assignable #192"
},
{
"Id": 172,
"Name": "Assignable #172"
}
],
"Features": [
{
"Id": 165,
"Name": "Feature #165"
},
{
"Id": 201,
"Name": "Feature #201"
}
],
"UserStories": [
{
"Id": 298,
"Name": "UserStory #298"
},
{
"Id": 90,
"Name": "UserStory #90"
}
],
"Tasks": [
{
"Id": 19,
"Name": "Task #19"
},
{
"Id": 139,
"Name": "Task #139"
}
],
"Bugs": [
{
"Id": 144,
"Name": "Bug #144"
},
{
"Id": 64,
"Name": "Bug #64"
}
],
"TestPlanRuns": [
{
"Id": 21,
"Name": "TestPlanRun #21"
},
{
"Id": 69,
"Name": "TestPlanRun #69"
}
],
"Requests": [
{
"Id": 45,
"Name": "Request 1"
},
{
"Id": 134,
"Name": "Request 2"
}
],
"Builds": [
{
"Id": 135,
"Name": "Build #135"
},
{
"Id": 5,
"Name": "Build #5"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<Release Id="252" Name="Release Name">
<Description>Release Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Release Tags</Tags>
<Owner Id="170" />
<Project Id="193" Name="Project #193" />
<Comments>
<Comment Id="154" />
<Comment Id="291" />
</Comments>
<Attachments>
<Attachment Id="23" Name="Picture.png" />
<Attachment Id="153" Name="Error.png" />
</Attachments>
<Iterations>
<Iteration Id="46" Name="Iteration #46" />
<Iteration Id="244" Name="Iteration #244" />
</Iterations>
<Assignables>
<Assignable Id="192" Name="Assignable #192" />
<Assignable Id="172" Name="Assignable #172" />
</Assignables>
<Features>
<Feature Id="165" Name="Feature #165" />
<Feature Id="201" Name="Feature #201" />
</Features>
<UserStories>
<UserStory Id="298" Name="UserStory #298" />
<UserStory Id="90" Name="UserStory #90" />
</UserStories>
<Tasks>
<Task Id="19" Name="Task #19" />
<Task Id="139" Name="Task #139" />
</Tasks>
<Bugs>
<Bug Id="144" Name="Bug #144" />
<Bug Id="64" Name="Bug #64" />
</Bugs>
<TestPlanRuns>
<TestPlanRun Id="21" Name="TestPlanRun #21" />
<TestPlanRun Id="69" Name="TestPlanRun #69" />
</TestPlanRuns>
<Requests>
<Request Id="45" Name="Request 1" />
<Request Id="134" Name="Request 2" />
</Requests>
<Builds>
<Build Id="135" Name="Build #135" />
<Build Id="5" Name="Build #5" />
</Builds>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Release>
GET http://{targetprocess}/api/v1/Releases/
[
{
"Id": 252,
"Name": "Release Name",
"Description": "Release Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Release Tags",
"Owner": {
"Id": 170
},
"Project": {
"Id": 193,
"Name": "Project #193"
},
"Comments": [
{
"Id": 154
},
{
"Id": 291
}
],
"Attachments": [
{
"Id": 23,
"Name": "Picture.png"
},
{
"Id": 153,
"Name": "Error.png"
}
],
"Iterations": [
{
"Id": 46,
"Name": "Iteration #46"
},
{
"Id": 244,
"Name": "Iteration #244"
}
],
"Assignables": [
{
"Id": 192,
"Name": "Assignable #192"
},
{
"Id": 172,
"Name": "Assignable #172"
}
],
"Features": [
{
"Id": 165,
"Name": "Feature #165"
},
{
"Id": 201,
"Name": "Feature #201"
}
],
"UserStories": [
{
"Id": 298,
"Name": "UserStory #298"
},
{
"Id": 90,
"Name": "UserStory #90"
}
],
"Tasks": [
{
"Id": 19,
"Name": "Task #19"
},
{
"Id": 139,
"Name": "Task #139"
}
],
"Bugs": [
{
"Id": 144,
"Name": "Bug #144"
},
{
"Id": 64,
"Name": "Bug #64"
}
],
"TestPlanRuns": [
{
"Id": 21,
"Name": "TestPlanRun #21"
},
{
"Id": 69,
"Name": "TestPlanRun #69"
}
],
"Requests": [
{
"Id": 45,
"Name": "Request 1"
},
{
"Id": 134,
"Name": "Request 2"
}
],
"Builds": [
{
"Id": 135,
"Name": "Build #135"
},
{
"Id": 5,
"Name": "Build #5"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 116,
"Name": "Release Name",
"Description": "Release Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Release Tags",
"Owner": {
"Id": 244
},
"Project": {
"Id": 60,
"Name": "Project #60"
},
"Comments": [
{
"Id": 274
},
{
"Id": 8
}
],
"Attachments": [
{
"Id": 152,
"Name": "Picture.png"
},
{
"Id": 288,
"Name": "Error.png"
}
],
"Iterations": [
{
"Id": 298,
"Name": "Iteration #298"
},
{
"Id": 5,
"Name": "Iteration #5"
}
],
"Assignables": [
{
"Id": 196,
"Name": "Assignable #196"
},
{
"Id": 83,
"Name": "Assignable #83"
}
],
"Features": [
{
"Id": 290,
"Name": "Feature #290"
},
{
"Id": 176,
"Name": "Feature #176"
}
],
"UserStories": [
{
"Id": 231,
"Name": "UserStory #231"
},
{
"Id": 97,
"Name": "UserStory #97"
}
],
"Tasks": [
{
"Id": 126,
"Name": "Task #126"
},
{
"Id": 292,
"Name": "Task #292"
}
],
"Bugs": [
{
"Id": 265,
"Name": "Bug #265"
},
{
"Id": 291,
"Name": "Bug #291"
}
],
"TestPlanRuns": [
{
"Id": 76,
"Name": "TestPlanRun #76"
},
{
"Id": 39,
"Name": "TestPlanRun #39"
}
],
"Requests": [
{
"Id": 269,
"Name": "Request 1"
},
{
"Id": 53,
"Name": "Request 2"
}
],
"Builds": [
{
"Id": 264,
"Name": "Build #264"
},
{
"Id": 163,
"Name": "Build #163"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<Release Id="252" Name="Release Name">
<Description>Release Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Release Tags</Tags>
<Owner Id="170" />
<Project Id="193" Name="Project #193" />
<Comments>
<Comment Id="154" />
<Comment Id="291" />
</Comments>
<Attachments>
<Attachment Id="23" Name="Picture.png" />
<Attachment Id="153" Name="Error.png" />
</Attachments>
<Iterations>
<Iteration Id="46" Name="Iteration #46" />
<Iteration Id="244" Name="Iteration #244" />
</Iterations>
<Assignables>
<Assignable Id="192" Name="Assignable #192" />
<Assignable Id="172" Name="Assignable #172" />
</Assignables>
<Features>
<Feature Id="165" Name="Feature #165" />
<Feature Id="201" Name="Feature #201" />
</Features>
<UserStories>
<UserStory Id="298" Name="UserStory #298" />
<UserStory Id="90" Name="UserStory #90" />
</UserStories>
<Tasks>
<Task Id="19" Name="Task #19" />
<Task Id="139" Name="Task #139" />
</Tasks>
<Bugs>
<Bug Id="144" Name="Bug #144" />
<Bug Id="64" Name="Bug #64" />
</Bugs>
<TestPlanRuns>
<TestPlanRun Id="21" Name="TestPlanRun #21" />
<TestPlanRun Id="69" Name="TestPlanRun #69" />
</TestPlanRuns>
<Requests>
<Request Id="45" Name="Request 1" />
<Request Id="134" Name="Request 2" />
</Requests>
<Builds>
<Build Id="135" Name="Build #135" />
<Build Id="5" Name="Build #5" />
</Builds>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Release>
<Release Id="116" Name="Release Name">
<Description>Release Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Release Tags</Tags>
<Owner Id="244" />
<Project Id="60" Name="Project #60" />
<Comments>
<Comment Id="274" />
<Comment Id="8" />
</Comments>
<Attachments>
<Attachment Id="152" Name="Picture.png" />
<Attachment Id="288" Name="Error.png" />
</Attachments>
<Iterations>
<Iteration Id="298" Name="Iteration #298" />
<Iteration Id="5" Name="Iteration #5" />
</Iterations>
<Assignables>
<Assignable Id="196" Name="Assignable #196" />
<Assignable Id="83" Name="Assignable #83" />
</Assignables>
<Features>
<Feature Id="290" Name="Feature #290" />
<Feature Id="176" Name="Feature #176" />
</Features>
<UserStories>
<UserStory Id="231" Name="UserStory #231" />
<UserStory Id="97" Name="UserStory #97" />
</UserStories>
<Tasks>
<Task Id="126" Name="Task #126" />
<Task Id="292" Name="Task #292" />
</Tasks>
<Bugs>
<Bug Id="265" Name="Bug #265" />
<Bug Id="291" Name="Bug #291" />
</Bugs>
<TestPlanRuns>
<TestPlanRun Id="76" Name="TestPlanRun #76" />
<TestPlanRun Id="39" Name="TestPlanRun #39" />
</TestPlanRuns>
<Requests>
<Request Id="269" Name="Request 1" />
<Request Id="53" Name="Request 2" />
</Requests>
<Builds>
<Build Id="264" Name="Build #264" />
<Build Id="163" Name="Build #163" />
</Builds>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Release>
</Items>
Iteration
Time-boxed entity. In its period development team implements and delivers a set of functionality.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Velocity | Iteration Velocity measures how much work the whole team can perform during the iteration |
| Duration | Iteration duration in weeks |
| Release | Release to which this iteration belongs |
| Assignables | Collection of assignables contained in the iteration |
| UserStories | Collection of user stories contained in the iteration |
| Tasks | Collection of tasks contained in the iteration |
| Bugs | Collection of bugs contained in the iteration |
| TestPlanRuns | Collection of test plan runs contained in the iteration |
| Requests | Collection of iteration requests |
| Builds | Collection of iteration builds |
GET http://{targetprocess}/api/v1/Iterations/235/
{
"Id": 235,
"Name": "Iteration Name",
"Description": "Iteration Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Iteration Tags",
"Owner": {
"Id": 154
},
"Project": {
"Id": 105,
"Name": "Project #105"
},
"Comments": [
{
"Id": 297
},
{
"Id": 10
}
],
"Attachments": [
{
"Id": 207,
"Name": "Picture.png"
},
{
"Id": 36,
"Name": "Error.png"
}
],
"Velocity": 5.8,
"Duration": 148,
"Release": {
"Id": 174,
"Name": "Release #174"
},
"Assignables": [
{
"Id": 78,
"Name": "Assignable #78"
},
{
"Id": 93,
"Name": "Assignable #93"
}
],
"UserStories": [
{
"Id": 72,
"Name": "UserStory #72"
},
{
"Id": 235,
"Name": "UserStory #235"
}
],
"Tasks": [
{
"Id": 39,
"Name": "Task #39"
},
{
"Id": 183,
"Name": "Task #183"
}
],
"Bugs": [
{
"Id": 167,
"Name": "Bug #167"
},
{
"Id": 196,
"Name": "Bug #196"
}
],
"TestPlanRuns": [
{
"Id": 102,
"Name": "TestPlanRun #102"
},
{
"Id": 6,
"Name": "TestPlanRun #6"
}
],
"Requests": [
{
"Id": 29,
"Name": "Request 1"
},
{
"Id": 263,
"Name": "Request 2"
}
],
"Builds": [
{
"Id": 213,
"Name": "Build #213"
},
{
"Id": 267,
"Name": "Build #267"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<Iteration Id="235" Name="Iteration Name">
<Description>Iteration Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Iteration Tags</Tags>
<Owner Id="154" />
<Project Id="105" Name="Project #105" />
<Comments>
<Comment Id="297" />
<Comment Id="10" />
</Comments>
<Attachments>
<Attachment Id="207" Name="Picture.png" />
<Attachment Id="36" Name="Error.png" />
</Attachments>
<Velocity>5.8</Velocity>
<Duration>148</Duration>
<Release Id="174" Name="Release #174" />
<Assignables>
<Assignable Id="78" Name="Assignable #78" />
<Assignable Id="93" Name="Assignable #93" />
</Assignables>
<UserStories>
<UserStory Id="72" Name="UserStory #72" />
<UserStory Id="235" Name="UserStory #235" />
</UserStories>
<Tasks>
<Task Id="39" Name="Task #39" />
<Task Id="183" Name="Task #183" />
</Tasks>
<Bugs>
<Bug Id="167" Name="Bug #167" />
<Bug Id="196" Name="Bug #196" />
</Bugs>
<TestPlanRuns>
<TestPlanRun Id="102" Name="TestPlanRun #102" />
<TestPlanRun Id="6" Name="TestPlanRun #6" />
</TestPlanRuns>
<Requests>
<Request Id="29" Name="Request 1" />
<Request Id="263" Name="Request 2" />
</Requests>
<Builds>
<Build Id="213" Name="Build #213" />
<Build Id="267" Name="Build #267" />
</Builds>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Iteration>
GET http://{targetprocess}/api/v1/Iterations/
[
{
"Id": 235,
"Name": "Iteration Name",
"Description": "Iteration Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Iteration Tags",
"Owner": {
"Id": 154
},
"Project": {
"Id": 105,
"Name": "Project #105"
},
"Comments": [
{
"Id": 297
},
{
"Id": 10
}
],
"Attachments": [
{
"Id": 207,
"Name": "Picture.png"
},
{
"Id": 36,
"Name": "Error.png"
}
],
"Velocity": 5.8,
"Duration": 148,
"Release": {
"Id": 174,
"Name": "Release #174"
},
"Assignables": [
{
"Id": 78,
"Name": "Assignable #78"
},
{
"Id": 93,
"Name": "Assignable #93"
}
],
"UserStories": [
{
"Id": 72,
"Name": "UserStory #72"
},
{
"Id": 235,
"Name": "UserStory #235"
}
],
"Tasks": [
{
"Id": 39,
"Name": "Task #39"
},
{
"Id": 183,
"Name": "Task #183"
}
],
"Bugs": [
{
"Id": 167,
"Name": "Bug #167"
},
{
"Id": 196,
"Name": "Bug #196"
}
],
"TestPlanRuns": [
{
"Id": 102,
"Name": "TestPlanRun #102"
},
{
"Id": 6,
"Name": "TestPlanRun #6"
}
],
"Requests": [
{
"Id": 29,
"Name": "Request 1"
},
{
"Id": 263,
"Name": "Request 2"
}
],
"Builds": [
{
"Id": 213,
"Name": "Build #213"
},
{
"Id": 267,
"Name": "Build #267"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 195,
"Name": "Iteration Name",
"Description": "Iteration Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Iteration Tags",
"Owner": {
"Id": 76
},
"Project": {
"Id": 79,
"Name": "Project #79"
},
"Comments": [
{
"Id": 142
},
{
"Id": 58
}
],
"Attachments": [
{
"Id": 266,
"Name": "Picture.png"
},
{
"Id": 147,
"Name": "Error.png"
}
],
"Velocity": 19.1,
"Duration": 95,
"Release": {
"Id": 110,
"Name": "Release #110"
},
"Assignables": [
{
"Id": 73,
"Name": "Assignable #73"
},
{
"Id": 298,
"Name": "Assignable #298"
}
],
"UserStories": [
{
"Id": 183,
"Name": "UserStory #183"
},
{
"Id": 0,
"Name": "UserStory #0"
}
],
"Tasks": [
{
"Id": 295,
"Name": "Task #295"
},
{
"Id": 288,
"Name": "Task #288"
}
],
"Bugs": [
{
"Id": 47,
"Name": "Bug #47"
},
{
"Id": 231,
"Name": "Bug #231"
}
],
"TestPlanRuns": [
{
"Id": 27,
"Name": "TestPlanRun #27"
},
{
"Id": 57,
"Name": "TestPlanRun #57"
}
],
"Requests": [
{
"Id": 18,
"Name": "Request 1"
},
{
"Id": 33,
"Name": "Request 2"
}
],
"Builds": [
{
"Id": 219,
"Name": "Build #219"
},
{
"Id": 30,
"Name": "Build #30"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<Iteration Id="235" Name="Iteration Name">
<Description>Iteration Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Iteration Tags</Tags>
<Owner Id="154" />
<Project Id="105" Name="Project #105" />
<Comments>
<Comment Id="297" />
<Comment Id="10" />
</Comments>
<Attachments>
<Attachment Id="207" Name="Picture.png" />
<Attachment Id="36" Name="Error.png" />
</Attachments>
<Velocity>5.8</Velocity>
<Duration>148</Duration>
<Release Id="174" Name="Release #174" />
<Assignables>
<Assignable Id="78" Name="Assignable #78" />
<Assignable Id="93" Name="Assignable #93" />
</Assignables>
<UserStories>
<UserStory Id="72" Name="UserStory #72" />
<UserStory Id="235" Name="UserStory #235" />
</UserStories>
<Tasks>
<Task Id="39" Name="Task #39" />
<Task Id="183" Name="Task #183" />
</Tasks>
<Bugs>
<Bug Id="167" Name="Bug #167" />
<Bug Id="196" Name="Bug #196" />
</Bugs>
<TestPlanRuns>
<TestPlanRun Id="102" Name="TestPlanRun #102" />
<TestPlanRun Id="6" Name="TestPlanRun #6" />
</TestPlanRuns>
<Requests>
<Request Id="29" Name="Request 1" />
<Request Id="263" Name="Request 2" />
</Requests>
<Builds>
<Build Id="213" Name="Build #213" />
<Build Id="267" Name="Build #267" />
</Builds>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Iteration>
<Iteration Id="195" Name="Iteration Name">
<Description>Iteration Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Iteration Tags</Tags>
<Owner Id="76" />
<Project Id="79" Name="Project #79" />
<Comments>
<Comment Id="142" />
<Comment Id="58" />
</Comments>
<Attachments>
<Attachment Id="266" Name="Picture.png" />
<Attachment Id="147" Name="Error.png" />
</Attachments>
<Velocity>19.1</Velocity>
<Duration>95</Duration>
<Release Id="110" Name="Release #110" />
<Assignables>
<Assignable Id="73" Name="Assignable #73" />
<Assignable Id="298" Name="Assignable #298" />
</Assignables>
<UserStories>
<UserStory Id="183" Name="UserStory #183" />
<UserStory Id="0" Name="UserStory #0" />
</UserStories>
<Tasks>
<Task Id="295" Name="Task #295" />
<Task Id="288" Name="Task #288" />
</Tasks>
<Bugs>
<Bug Id="47" Name="Bug #47" />
<Bug Id="231" Name="Bug #231" />
</Bugs>
<TestPlanRuns>
<TestPlanRun Id="27" Name="TestPlanRun #27" />
<TestPlanRun Id="57" Name="TestPlanRun #57" />
</TestPlanRuns>
<Requests>
<Request Id="18" Name="Request 1" />
<Request Id="33" Name="Request 2" />
</Requests>
<Builds>
<Build Id="219" Name="Build #219" />
<Build Id="30" Name="Build #30" />
</Builds>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Iteration>
</Items>
Feature
High level requirement which can contain user stories
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Effort | Total effort of the assignable. Read-only field |
| EffortCompleted | Effort spent on the assignment. Read-only calculated field |
| EffortToDo | Effort required to complete the assignment. Read-only calculated field |
| TimeSpent | Total time spent on the assignment. Read-only calculated field |
| TimeRemain | Total time remaining to complete the assignment for the Role. Read-only calculated field |
| EntityType | Type of entity. For exapmle Bug, Feature, Task, etc. |
| AssignedUser | User to whom entity is assigned |
| Release | Assignable entity may be assigned to Release or may be in project Backlog (Release is not defined in this case) |
| Iteration | Assignable entity may be assigned to Iteration |
| Priority | Priority of assignable. For example, User Story can have Must Have or Nice To Have priority |
| EntityState | State of assignable. For example, User Story can be in Open or Done state |
| Assignments | People assigned to entity |
| Impediments | Blocking reason which does not allow further work on assignable entity |
| Times | Collection of posted time entries to assignable entity |
| RoleEfforts | Collection of efforts for all roles |
| InitialEstimate | Initially estimated effort |
| UserStories | Collection of user stories it containes |
| Requests | Requests |
GET http://{targetprocess}/api/v1/Features/251/
{
"Id": 251,
"Name": "Feature Name",
"Description": "Feature Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Feature Tags",
"Owner": {
"Id": 192
},
"Project": {
"Id": 171,
"Name": "Project #171"
},
"Comments": [
{
"Id": 72
},
{
"Id": 251
}
],
"Attachments": [
{
"Id": 257,
"Name": "Picture.png"
},
{
"Id": 134,
"Name": "Error.png"
}
],
"Effort": 27.2,
"EffortCompleted": 24.0,
"EffortToDo": 13.8,
"TimeSpent": 10.2,
"TimeRemain": 23.3,
"EntityType": {
"Id": 128,
"Name": "EntityType #128"
},
"AssignedUser": [
{
"Id": 194
},
{
"Id": 299
}
],
"Release": {
"Id": 182,
"Name": "Release #182"
},
"Iteration": {
"Id": 26,
"Name": "Iteration #26"
},
"Priority": {
"Id": 187,
"Name": "Priority #187"
},
"EntityState": {
"Id": 297,
"Name": "EntityState #297"
},
"Assignments": [
{
"Id": 261
},
{
"Id": 161
}
],
"Impediments": [
{
"Id": 41,
"Name": "Impediment #41"
},
{
"Id": 0,
"Name": "Impediment #0"
}
],
"Times": [
{
"Id": 167
},
{
"Id": 201
}
],
"RoleEfforts": [
{
"Id": 113
},
{
"Id": 259
}
],
"InitialEstimate": 9.7,
"UserStories": [
{
"Id": 235,
"Name": "UserStory #235"
},
{
"Id": 155,
"Name": "UserStory #155"
}
],
"Requests": [
{
"Id": 248,
"Name": "Request 1"
},
{
"Id": 162,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<Feature Id="251" Name="Feature Name">
<Description>Feature Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Feature Tags</Tags>
<Owner Id="192" />
<Project Id="171" Name="Project #171" />
<Comments>
<Comment Id="72" />
<Comment Id="251" />
</Comments>
<Attachments>
<Attachment Id="257" Name="Picture.png" />
<Attachment Id="134" Name="Error.png" />
</Attachments>
<Effort>27.2</Effort>
<EffortCompleted>24</EffortCompleted>
<EffortToDo>13.8</EffortToDo>
<TimeSpent>10.2</TimeSpent>
<TimeRemain>23.3</TimeRemain>
<EntityType Id="128" Name="EntityType #128" />
<AssignedUser>
<GeneralUser Id="194" />
<GeneralUser Id="299" />
</AssignedUser>
<Release Id="182" Name="Release #182" />
<Iteration Id="26" Name="Iteration #26" />
<Priority Id="187" Name="Priority #187" />
<EntityState Id="297" Name="EntityState #297" />
<Assignments>
<Assignment Id="261" />
<Assignment Id="161" />
</Assignments>
<Impediments>
<Impediment Id="41" Name="Impediment #41" />
<Impediment Id="0" Name="Impediment #0" />
</Impediments>
<Times>
<Time Id="167" />
<Time Id="201" />
</Times>
<RoleEfforts>
<RoleEffort Id="113" />
<RoleEffort Id="259" />
</RoleEfforts>
<InitialEstimate>9.7</InitialEstimate>
<UserStories>
<UserStory Id="235" Name="UserStory #235" />
<UserStory Id="155" Name="UserStory #155" />
</UserStories>
<Requests>
<Request Id="248" Name="Request 1" />
<Request Id="162" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Feature>
GET http://{targetprocess}/api/v1/Features/
[
{
"Id": 251,
"Name": "Feature Name",
"Description": "Feature Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Feature Tags",
"Owner": {
"Id": 192
},
"Project": {
"Id": 171,
"Name": "Project #171"
},
"Comments": [
{
"Id": 72
},
{
"Id": 251
}
],
"Attachments": [
{
"Id": 257,
"Name": "Picture.png"
},
{
"Id": 134,
"Name": "Error.png"
}
],
"Effort": 27.2,
"EffortCompleted": 24.0,
"EffortToDo": 13.8,
"TimeSpent": 10.2,
"TimeRemain": 23.3,
"EntityType": {
"Id": 128,
"Name": "EntityType #128"
},
"AssignedUser": [
{
"Id": 194
},
{
"Id": 299
}
],
"Release": {
"Id": 182,
"Name": "Release #182"
},
"Iteration": {
"Id": 26,
"Name": "Iteration #26"
},
"Priority": {
"Id": 187,
"Name": "Priority #187"
},
"EntityState": {
"Id": 297,
"Name": "EntityState #297"
},
"Assignments": [
{
"Id": 261
},
{
"Id": 161
}
],
"Impediments": [
{
"Id": 41,
"Name": "Impediment #41"
},
{
"Id": 0,
"Name": "Impediment #0"
}
],
"Times": [
{
"Id": 167
},
{
"Id": 201
}
],
"RoleEfforts": [
{
"Id": 113
},
{
"Id": 259
}
],
"InitialEstimate": 9.7,
"UserStories": [
{
"Id": 235,
"Name": "UserStory #235"
},
{
"Id": 155,
"Name": "UserStory #155"
}
],
"Requests": [
{
"Id": 248,
"Name": "Request 1"
},
{
"Id": 162,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 156,
"Name": "Feature Name",
"Description": "Feature Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Feature Tags",
"Owner": {
"Id": 48
},
"Project": {
"Id": 190,
"Name": "Project #190"
},
"Comments": [
{
"Id": 165
},
{
"Id": 94
}
],
"Attachments": [
{
"Id": 74,
"Name": "Picture.png"
},
{
"Id": 240,
"Name": "Error.png"
}
],
"Effort": 13.8,
"EffortCompleted": 27.6,
"EffortToDo": 10.1,
"TimeSpent": 5.7,
"TimeRemain": 4.5,
"EntityType": {
"Id": 198,
"Name": "EntityType #198"
},
"AssignedUser": [
{
"Id": 61
},
{
"Id": 160
}
],
"Release": {
"Id": 152,
"Name": "Release #152"
},
"Iteration": {
"Id": 231,
"Name": "Iteration #231"
},
"Priority": {
"Id": 144,
"Name": "Priority #144"
},
"EntityState": {
"Id": 30,
"Name": "EntityState #30"
},
"Assignments": [
{
"Id": 131
},
{
"Id": 35
}
],
"Impediments": [
{
"Id": 257,
"Name": "Impediment #257"
},
{
"Id": 168,
"Name": "Impediment #168"
}
],
"Times": [
{
"Id": 210
},
{
"Id": 192
}
],
"RoleEfforts": [
{
"Id": 4
},
{
"Id": 170
}
],
"InitialEstimate": 13.7,
"UserStories": [
{
"Id": 298,
"Name": "UserStory #298"
},
{
"Id": 36,
"Name": "UserStory #36"
}
],
"Requests": [
{
"Id": 36,
"Name": "Request 1"
},
{
"Id": 84,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<Feature Id="251" Name="Feature Name">
<Description>Feature Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Feature Tags</Tags>
<Owner Id="192" />
<Project Id="171" Name="Project #171" />
<Comments>
<Comment Id="72" />
<Comment Id="251" />
</Comments>
<Attachments>
<Attachment Id="257" Name="Picture.png" />
<Attachment Id="134" Name="Error.png" />
</Attachments>
<Effort>27.2</Effort>
<EffortCompleted>24</EffortCompleted>
<EffortToDo>13.8</EffortToDo>
<TimeSpent>10.2</TimeSpent>
<TimeRemain>23.3</TimeRemain>
<EntityType Id="128" Name="EntityType #128" />
<AssignedUser>
<GeneralUser Id="194" />
<GeneralUser Id="299" />
</AssignedUser>
<Release Id="182" Name="Release #182" />
<Iteration Id="26" Name="Iteration #26" />
<Priority Id="187" Name="Priority #187" />
<EntityState Id="297" Name="EntityState #297" />
<Assignments>
<Assignment Id="261" />
<Assignment Id="161" />
</Assignments>
<Impediments>
<Impediment Id="41" Name="Impediment #41" />
<Impediment Id="0" Name="Impediment #0" />
</Impediments>
<Times>
<Time Id="167" />
<Time Id="201" />
</Times>
<RoleEfforts>
<RoleEffort Id="113" />
<RoleEffort Id="259" />
</RoleEfforts>
<InitialEstimate>9.7</InitialEstimate>
<UserStories>
<UserStory Id="235" Name="UserStory #235" />
<UserStory Id="155" Name="UserStory #155" />
</UserStories>
<Requests>
<Request Id="248" Name="Request 1" />
<Request Id="162" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Feature>
<Feature Id="156" Name="Feature Name">
<Description>Feature Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Feature Tags</Tags>
<Owner Id="48" />
<Project Id="190" Name="Project #190" />
<Comments>
<Comment Id="165" />
<Comment Id="94" />
</Comments>
<Attachments>
<Attachment Id="74" Name="Picture.png" />
<Attachment Id="240" Name="Error.png" />
</Attachments>
<Effort>13.8</Effort>
<EffortCompleted>27.6</EffortCompleted>
<EffortToDo>10.1</EffortToDo>
<TimeSpent>5.7</TimeSpent>
<TimeRemain>4.5</TimeRemain>
<EntityType Id="198" Name="EntityType #198" />
<AssignedUser>
<GeneralUser Id="61" />
<GeneralUser Id="160" />
</AssignedUser>
<Release Id="152" Name="Release #152" />
<Iteration Id="231" Name="Iteration #231" />
<Priority Id="144" Name="Priority #144" />
<EntityState Id="30" Name="EntityState #30" />
<Assignments>
<Assignment Id="131" />
<Assignment Id="35" />
</Assignments>
<Impediments>
<Impediment Id="257" Name="Impediment #257" />
<Impediment Id="168" Name="Impediment #168" />
</Impediments>
<Times>
<Time Id="210" />
<Time Id="192" />
</Times>
<RoleEfforts>
<RoleEffort Id="4" />
<RoleEffort Id="170" />
</RoleEfforts>
<InitialEstimate>13.7</InitialEstimate>
<UserStories>
<UserStory Id="298" Name="UserStory #298" />
<UserStory Id="36" Name="UserStory #36" />
</UserStories>
<Requests>
<Request Id="36" Name="Request 1" />
<Request Id="84" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Feature>
</Items>
UserStory
User story
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Effort | Total effort of the assignable. Read-only field |
| EffortCompleted | Effort spent on the assignment. Read-only calculated field |
| EffortToDo | Effort required to complete the assignment. Read-only calculated field |
| TimeSpent | Total time spent on the assignment. Read-only calculated field |
| TimeRemain | Total time remaining to complete the assignment for the Role. Read-only calculated field |
| EntityType | Type of entity. For exapmle Bug, Feature, Task, etc. |
| AssignedUser | User to whom entity is assigned |
| Release | Assignable entity may be assigned to Release or may be in project Backlog (Release is not defined in this case) |
| Iteration | Assignable entity may be assigned to Iteration |
| Priority | Priority of assignable. For example, User Story can have Must Have or Nice To Have priority |
| EntityState | State of assignable. For example, User Story can be in Open or Done state |
| Assignments | People assigned to entity |
| Impediments | Blocking reason which does not allow further work on assignable entity |
| Times | Collection of posted time entries to assignable entity |
| RoleEfforts | Collection of efforts for all roles |
| InitialEstimate | Initially estimated user story effort |
| Feature | Feature to which this user story belongs |
| Tasks | Collection of tasks contained in the user story |
| Bugs | Collection of bugs contained in the user story |
| TestCases | Collection of test cases contained in the user story |
| Requests | Requests |
GET http://{targetprocess}/api/v1/UserStories/189/
{
"Id": 189,
"Name": "UserStory Name",
"Description": "UserStory Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "UserStory Tags",
"Owner": {
"Id": 239
},
"Project": {
"Id": 76,
"Name": "Project #76"
},
"Comments": [
{
"Id": 79
},
{
"Id": 3
}
],
"Attachments": [
{
"Id": 133,
"Name": "Picture.png"
},
{
"Id": 88,
"Name": "Error.png"
}
],
"Effort": 25.1,
"EffortCompleted": 24.6,
"EffortToDo": 15.9,
"TimeSpent": 28.5,
"TimeRemain": 6.0,
"EntityType": {
"Id": 283,
"Name": "EntityType #283"
},
"AssignedUser": [
{
"Id": 255
},
{
"Id": 268
}
],
"Release": {
"Id": 140,
"Name": "Release #140"
},
"Iteration": {
"Id": 253,
"Name": "Iteration #253"
},
"Priority": {
"Id": 106,
"Name": "Priority #106"
},
"EntityState": {
"Id": 165,
"Name": "EntityState #165"
},
"Assignments": [
{
"Id": 91
},
{
"Id": 125
}
],
"Impediments": [
{
"Id": 117,
"Name": "Impediment #117"
},
{
"Id": 126,
"Name": "Impediment #126"
}
],
"Times": [
{
"Id": 198
},
{
"Id": 180
}
],
"RoleEfforts": [
{
"Id": 279
},
{
"Id": 273
}
],
"InitialEstimate": 8.9,
"Feature": {
"Id": 204,
"Name": "Feature #204"
},
"Tasks": [
{
"Id": 102,
"Name": "Task #102"
},
{
"Id": 140,
"Name": "Task #140"
}
],
"Bugs": [
{
"Id": 239,
"Name": "Bug #239"
},
{
"Id": 65,
"Name": "Bug #65"
}
],
"TestCases": [
{
"Id": 272,
"Name": "TestCase #272"
},
{
"Id": 155,
"Name": "TestCase #155"
}
],
"Requests": [
{
"Id": 258,
"Name": "Request 1"
},
{
"Id": 284,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<UserStory Id="189" Name="UserStory Name">
<Description>UserStory Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>UserStory Tags</Tags>
<Owner Id="239" />
<Project Id="76" Name="Project #76" />
<Comments>
<Comment Id="79" />
<Comment Id="3" />
</Comments>
<Attachments>
<Attachment Id="133" Name="Picture.png" />
<Attachment Id="88" Name="Error.png" />
</Attachments>
<Effort>25.1</Effort>
<EffortCompleted>24.6</EffortCompleted>
<EffortToDo>15.9</EffortToDo>
<TimeSpent>28.5</TimeSpent>
<TimeRemain>6</TimeRemain>
<EntityType Id="283" Name="EntityType #283" />
<AssignedUser>
<GeneralUser Id="255" />
<GeneralUser Id="268" />
</AssignedUser>
<Release Id="140" Name="Release #140" />
<Iteration Id="253" Name="Iteration #253" />
<Priority Id="106" Name="Priority #106" />
<EntityState Id="165" Name="EntityState #165" />
<Assignments>
<Assignment Id="91" />
<Assignment Id="125" />
</Assignments>
<Impediments>
<Impediment Id="117" Name="Impediment #117" />
<Impediment Id="126" Name="Impediment #126" />
</Impediments>
<Times>
<Time Id="198" />
<Time Id="180" />
</Times>
<RoleEfforts>
<RoleEffort Id="279" />
<RoleEffort Id="273" />
</RoleEfforts>
<InitialEstimate>8.9</InitialEstimate>
<Feature Id="204" Name="Feature #204" />
<Tasks>
<Task Id="102" Name="Task #102" />
<Task Id="140" Name="Task #140" />
</Tasks>
<Bugs>
<Bug Id="239" Name="Bug #239" />
<Bug Id="65" Name="Bug #65" />
</Bugs>
<TestCases>
<TestCase Id="272" Name="TestCase #272" />
<TestCase Id="155" Name="TestCase #155" />
</TestCases>
<Requests>
<Request Id="258" Name="Request 1" />
<Request Id="284" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</UserStory>
GET http://{targetprocess}/api/v1/UserStories/
[
{
"Id": 189,
"Name": "UserStory Name",
"Description": "UserStory Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "UserStory Tags",
"Owner": {
"Id": 239
},
"Project": {
"Id": 76,
"Name": "Project #76"
},
"Comments": [
{
"Id": 79
},
{
"Id": 3
}
],
"Attachments": [
{
"Id": 133,
"Name": "Picture.png"
},
{
"Id": 88,
"Name": "Error.png"
}
],
"Effort": 25.1,
"EffortCompleted": 24.6,
"EffortToDo": 15.9,
"TimeSpent": 28.5,
"TimeRemain": 6.0,
"EntityType": {
"Id": 283,
"Name": "EntityType #283"
},
"AssignedUser": [
{
"Id": 255
},
{
"Id": 268
}
],
"Release": {
"Id": 140,
"Name": "Release #140"
},
"Iteration": {
"Id": 253,
"Name": "Iteration #253"
},
"Priority": {
"Id": 106,
"Name": "Priority #106"
},
"EntityState": {
"Id": 165,
"Name": "EntityState #165"
},
"Assignments": [
{
"Id": 91
},
{
"Id": 125
}
],
"Impediments": [
{
"Id": 117,
"Name": "Impediment #117"
},
{
"Id": 126,
"Name": "Impediment #126"
}
],
"Times": [
{
"Id": 198
},
{
"Id": 180
}
],
"RoleEfforts": [
{
"Id": 279
},
{
"Id": 273
}
],
"InitialEstimate": 8.9,
"Feature": {
"Id": 204,
"Name": "Feature #204"
},
"Tasks": [
{
"Id": 102,
"Name": "Task #102"
},
{
"Id": 140,
"Name": "Task #140"
}
],
"Bugs": [
{
"Id": 239,
"Name": "Bug #239"
},
{
"Id": 65,
"Name": "Bug #65"
}
],
"TestCases": [
{
"Id": 272,
"Name": "TestCase #272"
},
{
"Id": 155,
"Name": "TestCase #155"
}
],
"Requests": [
{
"Id": 258,
"Name": "Request 1"
},
{
"Id": 284,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 81,
"Name": "UserStory Name",
"Description": "UserStory Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "UserStory Tags",
"Owner": {
"Id": 149
},
"Project": {
"Id": 98,
"Name": "Project #98"
},
"Comments": [
{
"Id": 56
},
{
"Id": 78
}
],
"Attachments": [
{
"Id": 184,
"Name": "Picture.png"
},
{
"Id": 176,
"Name": "Error.png"
}
],
"Effort": 27.2,
"EffortCompleted": 10.8,
"EffortToDo": 22.7,
"TimeSpent": 23.6,
"TimeRemain": 3.5,
"EntityType": {
"Id": 30,
"Name": "EntityType #30"
},
"AssignedUser": [
{
"Id": 184
},
{
"Id": 191
}
],
"Release": {
"Id": 171,
"Name": "Release #171"
},
"Iteration": {
"Id": 244,
"Name": "Iteration #244"
},
"Priority": {
"Id": 259,
"Name": "Priority #259"
},
"EntityState": {
"Id": 71,
"Name": "EntityState #71"
},
"Assignments": [
{
"Id": 113
},
{
"Id": 177
}
],
"Impediments": [
{
"Id": 199,
"Name": "Impediment #199"
},
{
"Id": 24,
"Name": "Impediment #24"
}
],
"Times": [
{
"Id": 159
},
{
"Id": 298
}
],
"RoleEfforts": [
{
"Id": 47
},
{
"Id": 144
}
],
"InitialEstimate": 1.9,
"Feature": {
"Id": 45,
"Name": "Feature #45"
},
"Tasks": [
{
"Id": 295,
"Name": "Task #295"
},
{
"Id": 10,
"Name": "Task #10"
}
],
"Bugs": [
{
"Id": 99,
"Name": "Bug #99"
},
{
"Id": 10,
"Name": "Bug #10"
}
],
"TestCases": [
{
"Id": 155,
"Name": "TestCase #155"
},
{
"Id": 172,
"Name": "TestCase #172"
}
],
"Requests": [
{
"Id": 257,
"Name": "Request 1"
},
{
"Id": 67,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<UserStory Id="189" Name="UserStory Name">
<Description>UserStory Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>UserStory Tags</Tags>
<Owner Id="239" />
<Project Id="76" Name="Project #76" />
<Comments>
<Comment Id="79" />
<Comment Id="3" />
</Comments>
<Attachments>
<Attachment Id="133" Name="Picture.png" />
<Attachment Id="88" Name="Error.png" />
</Attachments>
<Effort>25.1</Effort>
<EffortCompleted>24.6</EffortCompleted>
<EffortToDo>15.9</EffortToDo>
<TimeSpent>28.5</TimeSpent>
<TimeRemain>6</TimeRemain>
<EntityType Id="283" Name="EntityType #283" />
<AssignedUser>
<GeneralUser Id="255" />
<GeneralUser Id="268" />
</AssignedUser>
<Release Id="140" Name="Release #140" />
<Iteration Id="253" Name="Iteration #253" />
<Priority Id="106" Name="Priority #106" />
<EntityState Id="165" Name="EntityState #165" />
<Assignments>
<Assignment Id="91" />
<Assignment Id="125" />
</Assignments>
<Impediments>
<Impediment Id="117" Name="Impediment #117" />
<Impediment Id="126" Name="Impediment #126" />
</Impediments>
<Times>
<Time Id="198" />
<Time Id="180" />
</Times>
<RoleEfforts>
<RoleEffort Id="279" />
<RoleEffort Id="273" />
</RoleEfforts>
<InitialEstimate>8.9</InitialEstimate>
<Feature Id="204" Name="Feature #204" />
<Tasks>
<Task Id="102" Name="Task #102" />
<Task Id="140" Name="Task #140" />
</Tasks>
<Bugs>
<Bug Id="239" Name="Bug #239" />
<Bug Id="65" Name="Bug #65" />
</Bugs>
<TestCases>
<TestCase Id="272" Name="TestCase #272" />
<TestCase Id="155" Name="TestCase #155" />
</TestCases>
<Requests>
<Request Id="258" Name="Request 1" />
<Request Id="284" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</UserStory>
<UserStory Id="81" Name="UserStory Name">
<Description>UserStory Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>UserStory Tags</Tags>
<Owner Id="149" />
<Project Id="98" Name="Project #98" />
<Comments>
<Comment Id="56" />
<Comment Id="78" />
</Comments>
<Attachments>
<Attachment Id="184" Name="Picture.png" />
<Attachment Id="176" Name="Error.png" />
</Attachments>
<Effort>27.2</Effort>
<EffortCompleted>10.8</EffortCompleted>
<EffortToDo>22.7</EffortToDo>
<TimeSpent>23.6</TimeSpent>
<TimeRemain>3.5</TimeRemain>
<EntityType Id="30" Name="EntityType #30" />
<AssignedUser>
<GeneralUser Id="184" />
<GeneralUser Id="191" />
</AssignedUser>
<Release Id="171" Name="Release #171" />
<Iteration Id="244" Name="Iteration #244" />
<Priority Id="259" Name="Priority #259" />
<EntityState Id="71" Name="EntityState #71" />
<Assignments>
<Assignment Id="113" />
<Assignment Id="177" />
</Assignments>
<Impediments>
<Impediment Id="199" Name="Impediment #199" />
<Impediment Id="24" Name="Impediment #24" />
</Impediments>
<Times>
<Time Id="159" />
<Time Id="298" />
</Times>
<RoleEfforts>
<RoleEffort Id="47" />
<RoleEffort Id="144" />
</RoleEfforts>
<InitialEstimate>1.9</InitialEstimate>
<Feature Id="45" Name="Feature #45" />
<Tasks>
<Task Id="295" Name="Task #295" />
<Task Id="10" Name="Task #10" />
</Tasks>
<Bugs>
<Bug Id="99" Name="Bug #99" />
<Bug Id="10" Name="Bug #10" />
</Bugs>
<TestCases>
<TestCase Id="155" Name="TestCase #155" />
<TestCase Id="172" Name="TestCase #172" />
</TestCases>
<Requests>
<Request Id="257" Name="Request 1" />
<Request Id="67" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</UserStory>
</Items>
Task
Small requirement that a user story contains
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Effort | Total effort of the assignable. Read-only field |
| EffortCompleted | Effort spent on the assignment. Read-only calculated field |
| EffortToDo | Effort required to complete the assignment. Read-only calculated field |
| TimeSpent | Total time spent on the assignment. Read-only calculated field |
| TimeRemain | Total time remaining to complete the assignment for the Role. Read-only calculated field |
| EntityType | Type of entity. For exapmle Bug, Feature, Task, etc. |
| AssignedUser | User to whom entity is assigned |
| Release | Assignable entity may be assigned to Release or may be in project Backlog (Release is not defined in this case) |
| Iteration | Assignable entity may be assigned to Iteration |
| Priority | Priority of assignable. For example, User Story can have Must Have or Nice To Have priority |
| EntityState | State of assignable. For example, User Story can be in Open or Done state |
| Assignments | People assigned to entity |
| Impediments | Blocking reason which does not allow further work on assignable entity |
| Times | Collection of posted time entries to assignable entity |
| RoleEfforts | Collection of efforts for all roles |
| UserStory | User story to which this task belongs |
| Requests | Requests |
GET http://{targetprocess}/api/v1/Tasks/34/
{
"Id": 34,
"Name": "Task Name",
"Description": "Task Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Task Tags",
"Owner": {
"Id": 47
},
"Project": {
"Id": 232,
"Name": "Project #232"
},
"Comments": [
{
"Id": 249
},
{
"Id": 226
}
],
"Attachments": [
{
"Id": 72,
"Name": "Picture.png"
},
{
"Id": 52,
"Name": "Error.png"
}
],
"Effort": 3.7,
"EffortCompleted": 5.3,
"EffortToDo": 17.3,
"TimeSpent": 21.8,
"TimeRemain": 24.8,
"EntityType": {
"Id": 68,
"Name": "EntityType #68"
},
"AssignedUser": [
{
"Id": 120
},
{
"Id": 13
}
],
"Release": {
"Id": 84,
"Name": "Release #84"
},
"Iteration": {
"Id": 145,
"Name": "Iteration #145"
},
"Priority": {
"Id": 107,
"Name": "Priority #107"
},
"EntityState": {
"Id": 182,
"Name": "EntityState #182"
},
"Assignments": [
{
"Id": 124
},
{
"Id": 238
}
],
"Impediments": [
{
"Id": 57,
"Name": "Impediment #57"
},
{
"Id": 30,
"Name": "Impediment #30"
}
],
"Times": [
{
"Id": 40
},
{
"Id": 157
}
],
"RoleEfforts": [
{
"Id": 226
},
{
"Id": 112
}
],
"UserStory": {
"Id": 216,
"Name": "UserStory #216"
},
"Requests": [
{
"Id": 137,
"Name": "Request 1"
},
{
"Id": 25,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<Task Id="34" Name="Task Name">
<Description>Task Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Task Tags</Tags>
<Owner Id="47" />
<Project Id="232" Name="Project #232" />
<Comments>
<Comment Id="249" />
<Comment Id="226" />
</Comments>
<Attachments>
<Attachment Id="72" Name="Picture.png" />
<Attachment Id="52" Name="Error.png" />
</Attachments>
<Effort>3.7</Effort>
<EffortCompleted>5.3</EffortCompleted>
<EffortToDo>17.3</EffortToDo>
<TimeSpent>21.8</TimeSpent>
<TimeRemain>24.8</TimeRemain>
<EntityType Id="68" Name="EntityType #68" />
<AssignedUser>
<GeneralUser Id="120" />
<GeneralUser Id="13" />
</AssignedUser>
<Release Id="84" Name="Release #84" />
<Iteration Id="145" Name="Iteration #145" />
<Priority Id="107" Name="Priority #107" />
<EntityState Id="182" Name="EntityState #182" />
<Assignments>
<Assignment Id="124" />
<Assignment Id="238" />
</Assignments>
<Impediments>
<Impediment Id="57" Name="Impediment #57" />
<Impediment Id="30" Name="Impediment #30" />
</Impediments>
<Times>
<Time Id="40" />
<Time Id="157" />
</Times>
<RoleEfforts>
<RoleEffort Id="226" />
<RoleEffort Id="112" />
</RoleEfforts>
<UserStory Id="216" Name="UserStory #216" />
<Requests>
<Request Id="137" Name="Request 1" />
<Request Id="25" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Task>
GET http://{targetprocess}/api/v1/Tasks/
[
{
"Id": 34,
"Name": "Task Name",
"Description": "Task Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Task Tags",
"Owner": {
"Id": 47
},
"Project": {
"Id": 232,
"Name": "Project #232"
},
"Comments": [
{
"Id": 249
},
{
"Id": 226
}
],
"Attachments": [
{
"Id": 72,
"Name": "Picture.png"
},
{
"Id": 52,
"Name": "Error.png"
}
],
"Effort": 3.7,
"EffortCompleted": 5.3,
"EffortToDo": 17.3,
"TimeSpent": 21.8,
"TimeRemain": 24.8,
"EntityType": {
"Id": 68,
"Name": "EntityType #68"
},
"AssignedUser": [
{
"Id": 120
},
{
"Id": 13
}
],
"Release": {
"Id": 84,
"Name": "Release #84"
},
"Iteration": {
"Id": 145,
"Name": "Iteration #145"
},
"Priority": {
"Id": 107,
"Name": "Priority #107"
},
"EntityState": {
"Id": 182,
"Name": "EntityState #182"
},
"Assignments": [
{
"Id": 124
},
{
"Id": 238
}
],
"Impediments": [
{
"Id": 57,
"Name": "Impediment #57"
},
{
"Id": 30,
"Name": "Impediment #30"
}
],
"Times": [
{
"Id": 40
},
{
"Id": 157
}
],
"RoleEfforts": [
{
"Id": 226
},
{
"Id": 112
}
],
"UserStory": {
"Id": 216,
"Name": "UserStory #216"
},
"Requests": [
{
"Id": 137,
"Name": "Request 1"
},
{
"Id": 25,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 175,
"Name": "Task Name",
"Description": "Task Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Task Tags",
"Owner": {
"Id": 12
},
"Project": {
"Id": 233,
"Name": "Project #233"
},
"Comments": [
{
"Id": 103
},
{
"Id": 209
}
],
"Attachments": [
{
"Id": 212,
"Name": "Picture.png"
},
{
"Id": 139,
"Name": "Error.png"
}
],
"Effort": 16.3,
"EffortCompleted": 25.1,
"EffortToDo": 12.6,
"TimeSpent": 27.1,
"TimeRemain": 12.2,
"EntityType": {
"Id": 244,
"Name": "EntityType #244"
},
"AssignedUser": [
{
"Id": 174
},
{
"Id": 225
}
],
"Release": {
"Id": 70,
"Name": "Release #70"
},
"Iteration": {
"Id": 277,
"Name": "Iteration #277"
},
"Priority": {
"Id": 175,
"Name": "Priority #175"
},
"EntityState": {
"Id": 297,
"Name": "EntityState #297"
},
"Assignments": [
{
"Id": 15
},
{
"Id": 164
}
],
"Impediments": [
{
"Id": 48,
"Name": "Impediment #48"
},
{
"Id": 289,
"Name": "Impediment #289"
}
],
"Times": [
{
"Id": 132
},
{
"Id": 129
}
],
"RoleEfforts": [
{
"Id": 277
},
{
"Id": 16
}
],
"UserStory": {
"Id": 192,
"Name": "UserStory #192"
},
"Requests": [
{
"Id": 92,
"Name": "Request 1"
},
{
"Id": 299,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<Task Id="34" Name="Task Name">
<Description>Task Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Task Tags</Tags>
<Owner Id="47" />
<Project Id="232" Name="Project #232" />
<Comments>
<Comment Id="249" />
<Comment Id="226" />
</Comments>
<Attachments>
<Attachment Id="72" Name="Picture.png" />
<Attachment Id="52" Name="Error.png" />
</Attachments>
<Effort>3.7</Effort>
<EffortCompleted>5.3</EffortCompleted>
<EffortToDo>17.3</EffortToDo>
<TimeSpent>21.8</TimeSpent>
<TimeRemain>24.8</TimeRemain>
<EntityType Id="68" Name="EntityType #68" />
<AssignedUser>
<GeneralUser Id="120" />
<GeneralUser Id="13" />
</AssignedUser>
<Release Id="84" Name="Release #84" />
<Iteration Id="145" Name="Iteration #145" />
<Priority Id="107" Name="Priority #107" />
<EntityState Id="182" Name="EntityState #182" />
<Assignments>
<Assignment Id="124" />
<Assignment Id="238" />
</Assignments>
<Impediments>
<Impediment Id="57" Name="Impediment #57" />
<Impediment Id="30" Name="Impediment #30" />
</Impediments>
<Times>
<Time Id="40" />
<Time Id="157" />
</Times>
<RoleEfforts>
<RoleEffort Id="226" />
<RoleEffort Id="112" />
</RoleEfforts>
<UserStory Id="216" Name="UserStory #216" />
<Requests>
<Request Id="137" Name="Request 1" />
<Request Id="25" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Task>
<Task Id="175" Name="Task Name">
<Description>Task Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Task Tags</Tags>
<Owner Id="12" />
<Project Id="233" Name="Project #233" />
<Comments>
<Comment Id="103" />
<Comment Id="209" />
</Comments>
<Attachments>
<Attachment Id="212" Name="Picture.png" />
<Attachment Id="139" Name="Error.png" />
</Attachments>
<Effort>16.3</Effort>
<EffortCompleted>25.1</EffortCompleted>
<EffortToDo>12.6</EffortToDo>
<TimeSpent>27.1</TimeSpent>
<TimeRemain>12.2</TimeRemain>
<EntityType Id="244" Name="EntityType #244" />
<AssignedUser>
<GeneralUser Id="174" />
<GeneralUser Id="225" />
</AssignedUser>
<Release Id="70" Name="Release #70" />
<Iteration Id="277" Name="Iteration #277" />
<Priority Id="175" Name="Priority #175" />
<EntityState Id="297" Name="EntityState #297" />
<Assignments>
<Assignment Id="15" />
<Assignment Id="164" />
</Assignments>
<Impediments>
<Impediment Id="48" Name="Impediment #48" />
<Impediment Id="289" Name="Impediment #289" />
</Impediments>
<Times>
<Time Id="132" />
<Time Id="129" />
</Times>
<RoleEfforts>
<RoleEffort Id="277" />
<RoleEffort Id="16" />
</RoleEfforts>
<UserStory Id="192" Name="UserStory #192" />
<Requests>
<Request Id="92" Name="Request 1" />
<Request Id="299" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Task>
</Items>
Bug
Bug or defect (error, flaw, mistake, failure, or fault in a computer program)
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Effort | Total effort of the assignable. Read-only field |
| EffortCompleted | Effort spent on the assignment. Read-only calculated field |
| EffortToDo | Effort required to complete the assignment. Read-only calculated field |
| TimeSpent | Total time spent on the assignment. Read-only calculated field |
| TimeRemain | Total time remaining to complete the assignment for the Role. Read-only calculated field |
| EntityType | Type of entity. For exapmle Bug, Feature, Task, etc. |
| AssignedUser | User to whom entity is assigned |
| Release | Assignable entity may be assigned to Release or may be in project Backlog (Release is not defined in this case) |
| Iteration | Assignable entity may be assigned to Iteration |
| Priority | Priority of assignable. For example, User Story can have Must Have or Nice To Have priority |
| EntityState | State of assignable. For example, User Story can be in Open or Done state |
| Assignments | People assigned to entity |
| Impediments | Blocking reason which does not allow further work on assignable entity |
| Times | Collection of posted time entries to assignable entity |
| RoleEfforts | Collection of efforts for all roles |
| Build | Build to which this bug belongs |
| UserStory | User story to which this bug belongs |
| Severity | Bug severity |
| Requests | Requests |
GET http://{targetprocess}/api/v1/Bugs/259/
{
"Id": 259,
"Name": "Bug Name",
"Description": "Bug Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Bug Tags",
"Owner": {
"Id": 136
},
"Project": {
"Id": 200,
"Name": "Project #200"
},
"Comments": [
{
"Id": 28
},
{
"Id": 297
}
],
"Attachments": [
{
"Id": 206,
"Name": "Picture.png"
},
{
"Id": 15,
"Name": "Error.png"
}
],
"Effort": 26.4,
"EffortCompleted": 21.0,
"EffortToDo": 10.1,
"TimeSpent": 24.4,
"TimeRemain": 28.1,
"EntityType": {
"Id": 155,
"Name": "EntityType #155"
},
"AssignedUser": [
{
"Id": 55
},
{
"Id": 153
}
],
"Release": {
"Id": 115,
"Name": "Release #115"
},
"Iteration": {
"Id": 113,
"Name": "Iteration #113"
},
"Priority": {
"Id": 156,
"Name": "Priority #156"
},
"EntityState": {
"Id": 115,
"Name": "EntityState #115"
},
"Assignments": [
{
"Id": 87
},
{
"Id": 249
}
],
"Impediments": [
{
"Id": 237,
"Name": "Impediment #237"
},
{
"Id": 218,
"Name": "Impediment #218"
}
],
"Times": [
{
"Id": 121
},
{
"Id": 160
}
],
"RoleEfforts": [
{
"Id": 127
},
{
"Id": 22
}
],
"Build": {
"Id": 100,
"Name": "Build #100"
},
"UserStory": {
"Id": 274,
"Name": "UserStory #274"
},
"Severity": {
"Id": 232,
"Name": "Severity #232"
},
"Requests": [
{
"Id": 195,
"Name": "Request 1"
},
{
"Id": 247,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<Bug Id="259" Name="Bug Name">
<Description>Bug Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Bug Tags</Tags>
<Owner Id="136" />
<Project Id="200" Name="Project #200" />
<Comments>
<Comment Id="28" />
<Comment Id="297" />
</Comments>
<Attachments>
<Attachment Id="206" Name="Picture.png" />
<Attachment Id="15" Name="Error.png" />
</Attachments>
<Effort>26.4</Effort>
<EffortCompleted>21</EffortCompleted>
<EffortToDo>10.1</EffortToDo>
<TimeSpent>24.4</TimeSpent>
<TimeRemain>28.1</TimeRemain>
<EntityType Id="155" Name="EntityType #155" />
<AssignedUser>
<GeneralUser Id="55" />
<GeneralUser Id="153" />
</AssignedUser>
<Release Id="115" Name="Release #115" />
<Iteration Id="113" Name="Iteration #113" />
<Priority Id="156" Name="Priority #156" />
<EntityState Id="115" Name="EntityState #115" />
<Assignments>
<Assignment Id="87" />
<Assignment Id="249" />
</Assignments>
<Impediments>
<Impediment Id="237" Name="Impediment #237" />
<Impediment Id="218" Name="Impediment #218" />
</Impediments>
<Times>
<Time Id="121" />
<Time Id="160" />
</Times>
<RoleEfforts>
<RoleEffort Id="127" />
<RoleEffort Id="22" />
</RoleEfforts>
<Build Id="100" Name="Build #100" />
<UserStory Id="274" Name="UserStory #274" />
<Severity Id="232" Name="Severity #232" />
<Requests>
<Request Id="195" Name="Request 1" />
<Request Id="247" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Bug>
GET http://{targetprocess}/api/v1/Bugs/
[
{
"Id": 259,
"Name": "Bug Name",
"Description": "Bug Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Bug Tags",
"Owner": {
"Id": 136
},
"Project": {
"Id": 200,
"Name": "Project #200"
},
"Comments": [
{
"Id": 28
},
{
"Id": 297
}
],
"Attachments": [
{
"Id": 206,
"Name": "Picture.png"
},
{
"Id": 15,
"Name": "Error.png"
}
],
"Effort": 26.4,
"EffortCompleted": 21.0,
"EffortToDo": 10.1,
"TimeSpent": 24.4,
"TimeRemain": 28.1,
"EntityType": {
"Id": 155,
"Name": "EntityType #155"
},
"AssignedUser": [
{
"Id": 55
},
{
"Id": 153
}
],
"Release": {
"Id": 115,
"Name": "Release #115"
},
"Iteration": {
"Id": 113,
"Name": "Iteration #113"
},
"Priority": {
"Id": 156,
"Name": "Priority #156"
},
"EntityState": {
"Id": 115,
"Name": "EntityState #115"
},
"Assignments": [
{
"Id": 87
},
{
"Id": 249
}
],
"Impediments": [
{
"Id": 237,
"Name": "Impediment #237"
},
{
"Id": 218,
"Name": "Impediment #218"
}
],
"Times": [
{
"Id": 121
},
{
"Id": 160
}
],
"RoleEfforts": [
{
"Id": 127
},
{
"Id": 22
}
],
"Build": {
"Id": 100,
"Name": "Build #100"
},
"UserStory": {
"Id": 274,
"Name": "UserStory #274"
},
"Severity": {
"Id": 232,
"Name": "Severity #232"
},
"Requests": [
{
"Id": 195,
"Name": "Request 1"
},
{
"Id": 247,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 71,
"Name": "Bug Name",
"Description": "Bug Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Bug Tags",
"Owner": {
"Id": 251
},
"Project": {
"Id": 167,
"Name": "Project #167"
},
"Comments": [
{
"Id": 135
},
{
"Id": 222
}
],
"Attachments": [
{
"Id": 216,
"Name": "Picture.png"
},
{
"Id": 176,
"Name": "Error.png"
}
],
"Effort": 1.8,
"EffortCompleted": 5.4,
"EffortToDo": 1.2,
"TimeSpent": 26.5,
"TimeRemain": 19.6,
"EntityType": {
"Id": 70,
"Name": "EntityType #70"
},
"AssignedUser": [
{
"Id": 182
},
{
"Id": 192
}
],
"Release": {
"Id": 234,
"Name": "Release #234"
},
"Iteration": {
"Id": 279,
"Name": "Iteration #279"
},
"Priority": {
"Id": 13,
"Name": "Priority #13"
},
"EntityState": {
"Id": 163,
"Name": "EntityState #163"
},
"Assignments": [
{
"Id": 160
},
{
"Id": 77
}
],
"Impediments": [
{
"Id": 5,
"Name": "Impediment #5"
},
{
"Id": 50,
"Name": "Impediment #50"
}
],
"Times": [
{
"Id": 22
},
{
"Id": 217
}
],
"RoleEfforts": [
{
"Id": 78
},
{
"Id": 167
}
],
"Build": {
"Id": 170,
"Name": "Build #170"
},
"UserStory": {
"Id": 184,
"Name": "UserStory #184"
},
"Severity": {
"Id": 215,
"Name": "Severity #215"
},
"Requests": [
{
"Id": 289,
"Name": "Request 1"
},
{
"Id": 277,
"Name": "Request 2"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<Bug Id="259" Name="Bug Name">
<Description>Bug Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Bug Tags</Tags>
<Owner Id="136" />
<Project Id="200" Name="Project #200" />
<Comments>
<Comment Id="28" />
<Comment Id="297" />
</Comments>
<Attachments>
<Attachment Id="206" Name="Picture.png" />
<Attachment Id="15" Name="Error.png" />
</Attachments>
<Effort>26.4</Effort>
<EffortCompleted>21</EffortCompleted>
<EffortToDo>10.1</EffortToDo>
<TimeSpent>24.4</TimeSpent>
<TimeRemain>28.1</TimeRemain>
<EntityType Id="155" Name="EntityType #155" />
<AssignedUser>
<GeneralUser Id="55" />
<GeneralUser Id="153" />
</AssignedUser>
<Release Id="115" Name="Release #115" />
<Iteration Id="113" Name="Iteration #113" />
<Priority Id="156" Name="Priority #156" />
<EntityState Id="115" Name="EntityState #115" />
<Assignments>
<Assignment Id="87" />
<Assignment Id="249" />
</Assignments>
<Impediments>
<Impediment Id="237" Name="Impediment #237" />
<Impediment Id="218" Name="Impediment #218" />
</Impediments>
<Times>
<Time Id="121" />
<Time Id="160" />
</Times>
<RoleEfforts>
<RoleEffort Id="127" />
<RoleEffort Id="22" />
</RoleEfforts>
<Build Id="100" Name="Build #100" />
<UserStory Id="274" Name="UserStory #274" />
<Severity Id="232" Name="Severity #232" />
<Requests>
<Request Id="195" Name="Request 1" />
<Request Id="247" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Bug>
<Bug Id="71" Name="Bug Name">
<Description>Bug Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Bug Tags</Tags>
<Owner Id="251" />
<Project Id="167" Name="Project #167" />
<Comments>
<Comment Id="135" />
<Comment Id="222" />
</Comments>
<Attachments>
<Attachment Id="216" Name="Picture.png" />
<Attachment Id="176" Name="Error.png" />
</Attachments>
<Effort>1.8</Effort>
<EffortCompleted>5.4</EffortCompleted>
<EffortToDo>1.2</EffortToDo>
<TimeSpent>26.5</TimeSpent>
<TimeRemain>19.6</TimeRemain>
<EntityType Id="70" Name="EntityType #70" />
<AssignedUser>
<GeneralUser Id="182" />
<GeneralUser Id="192" />
</AssignedUser>
<Release Id="234" Name="Release #234" />
<Iteration Id="279" Name="Iteration #279" />
<Priority Id="13" Name="Priority #13" />
<EntityState Id="163" Name="EntityState #163" />
<Assignments>
<Assignment Id="160" />
<Assignment Id="77" />
</Assignments>
<Impediments>
<Impediment Id="5" Name="Impediment #5" />
<Impediment Id="50" Name="Impediment #50" />
</Impediments>
<Times>
<Time Id="22" />
<Time Id="217" />
</Times>
<RoleEfforts>
<RoleEffort Id="78" />
<RoleEffort Id="167" />
</RoleEfforts>
<Build Id="170" Name="Build #170" />
<UserStory Id="184" Name="UserStory #184" />
<Severity Id="215" Name="Severity #215" />
<Requests>
<Request Id="289" Name="Request 1" />
<Request Id="277" Name="Request 2" />
</Requests>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Bug>
</Items>
TestCase
Set of steps to determine whether specified case works correctly in the system.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Steps | Steps that should be executed to test functionality |
| Success | Expected results |
| LastStatus | Defines whether test case passed or failed last time. True - passed, False - failed |
| LastFailureComment | Comment that describes failure if it occured last time |
| LastRunDate | Date when test case was run last time |
| UserStory | User story to which this test case belongs |
GET http://{targetprocess}/api/v1/TestCases/205/
{
"Id": 205,
"Name": "TestCase Name",
"Description": "TestCase Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "TestCase Tags",
"Owner": {
"Id": 297
},
"Project": {
"Id": 210,
"Name": "Project #210"
},
"Comments": [
{
"Id": 204
},
{
"Id": 187
}
],
"Attachments": [
{
"Id": 17,
"Name": "Picture.png"
},
{
"Id": 192,
"Name": "Error.png"
}
],
"Steps": "TestCase Steps",
"Success": "TestCase Success",
"LastStatus": null,
"LastFailureComment": "TestCase LastFailureComment",
"LastRunDate": "\/Date(1300658400000+0200)\/",
"UserStory": {
"Id": 196,
"Name": "UserStory #196"
},
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<TestCase Id="205" Name="TestCase Name">
<Description>TestCase Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>TestCase Tags</Tags>
<Owner Id="297" />
<Project Id="210" Name="Project #210" />
<Comments>
<Comment Id="204" />
<Comment Id="187" />
</Comments>
<Attachments>
<Attachment Id="17" Name="Picture.png" />
<Attachment Id="192" Name="Error.png" />
</Attachments>
<Steps>TestCase Steps</Steps>
<Success>TestCase Success</Success>
<LastStatus />
<LastFailureComment>TestCase LastFailureComment</LastFailureComment>
<LastRunDate>2011-03-21T00:00:00+02:00</LastRunDate>
<UserStory Id="196" Name="UserStory #196" />
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</TestCase>
GET http://{targetprocess}/api/v1/TestCases/
[
{
"Id": 205,
"Name": "TestCase Name",
"Description": "TestCase Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "TestCase Tags",
"Owner": {
"Id": 297
},
"Project": {
"Id": 210,
"Name": "Project #210"
},
"Comments": [
{
"Id": 204
},
{
"Id": 187
}
],
"Attachments": [
{
"Id": 17,
"Name": "Picture.png"
},
{
"Id": 192,
"Name": "Error.png"
}
],
"Steps": "TestCase Steps",
"Success": "TestCase Success",
"LastStatus": null,
"LastFailureComment": "TestCase LastFailureComment",
"LastRunDate": "\/Date(1300658400000+0200)\/",
"UserStory": {
"Id": 196,
"Name": "UserStory #196"
},
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 279,
"Name": "TestCase Name",
"Description": "TestCase Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "TestCase Tags",
"Owner": {
"Id": 96
},
"Project": {
"Id": 32,
"Name": "Project #32"
},
"Comments": [
{
"Id": 237
},
{
"Id": 271
}
],
"Attachments": [
{
"Id": 22,
"Name": "Picture.png"
},
{
"Id": 50,
"Name": "Error.png"
}
],
"Steps": "TestCase Steps",
"Success": "TestCase Success",
"LastStatus": null,
"LastFailureComment": "TestCase LastFailureComment",
"LastRunDate": "\/Date(1300658400000+0200)\/",
"UserStory": {
"Id": 277,
"Name": "UserStory #277"
},
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<TestCase Id="205" Name="TestCase Name">
<Description>TestCase Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>TestCase Tags</Tags>
<Owner Id="297" />
<Project Id="210" Name="Project #210" />
<Comments>
<Comment Id="204" />
<Comment Id="187" />
</Comments>
<Attachments>
<Attachment Id="17" Name="Picture.png" />
<Attachment Id="192" Name="Error.png" />
</Attachments>
<Steps>TestCase Steps</Steps>
<Success>TestCase Success</Success>
<LastStatus />
<LastFailureComment>TestCase LastFailureComment</LastFailureComment>
<LastRunDate>2011-03-21T00:00:00+02:00</LastRunDate>
<UserStory Id="196" Name="UserStory #196" />
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</TestCase>
<TestCase Id="279" Name="TestCase Name">
<Description>TestCase Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>TestCase Tags</Tags>
<Owner Id="96" />
<Project Id="32" Name="Project #32" />
<Comments>
<Comment Id="237" />
<Comment Id="271" />
</Comments>
<Attachments>
<Attachment Id="22" Name="Picture.png" />
<Attachment Id="50" Name="Error.png" />
</Attachments>
<Steps>TestCase Steps</Steps>
<Success>TestCase Success</Success>
<LastStatus />
<LastFailureComment>TestCase LastFailureComment</LastFailureComment>
<LastRunDate>2011-03-21T00:00:00+02:00</LastRunDate>
<UserStory Id="277" Name="UserStory #277" />
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</TestCase>
</Items>
TestCaseRun
Test case run
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Executed | Executed |
| Passed | Passed |
| Comment | Comment |
| RunDate | Run date |
TestPlan
Test plan
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| InitialEstimate | Initial estimate |
GET http://{targetprocess}/api/v1/TestPlans/235/
{
"Id": 235,
"Name": "TestPlan Name",
"Description": "TestPlan Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "TestPlan Tags",
"Owner": {
"Id": 87
},
"Project": {
"Id": 120,
"Name": "Project #120"
},
"Comments": [
{
"Id": 261
},
{
"Id": 69
}
],
"Attachments": [
{
"Id": 35,
"Name": "Picture.png"
},
{
"Id": 169,
"Name": "Error.png"
}
],
"InitialEstimate": 6.5,
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<TestPlan Id="235" Name="TestPlan Name">
<Description>TestPlan Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>TestPlan Tags</Tags>
<Owner Id="87" />
<Project Id="120" Name="Project #120" />
<Comments>
<Comment Id="261" />
<Comment Id="69" />
</Comments>
<Attachments>
<Attachment Id="35" Name="Picture.png" />
<Attachment Id="169" Name="Error.png" />
</Attachments>
<InitialEstimate>6.5</InitialEstimate>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</TestPlan>
GET http://{targetprocess}/api/v1/TestPlans/
[
{
"Id": 235,
"Name": "TestPlan Name",
"Description": "TestPlan Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "TestPlan Tags",
"Owner": {
"Id": 87
},
"Project": {
"Id": 120,
"Name": "Project #120"
},
"Comments": [
{
"Id": 261
},
{
"Id": 69
}
],
"Attachments": [
{
"Id": 35,
"Name": "Picture.png"
},
{
"Id": 169,
"Name": "Error.png"
}
],
"InitialEstimate": 6.5,
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 201,
"Name": "TestPlan Name",
"Description": "TestPlan Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "TestPlan Tags",
"Owner": {
"Id": 144
},
"Project": {
"Id": 217,
"Name": "Project #217"
},
"Comments": [
{
"Id": 144
},
{
"Id": 48
}
],
"Attachments": [
{
"Id": 6,
"Name": "Picture.png"
},
{
"Id": 134,
"Name": "Error.png"
}
],
"InitialEstimate": 13.9,
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<TestPlan Id="235" Name="TestPlan Name">
<Description>TestPlan Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>TestPlan Tags</Tags>
<Owner Id="87" />
<Project Id="120" Name="Project #120" />
<Comments>
<Comment Id="261" />
<Comment Id="69" />
</Comments>
<Attachments>
<Attachment Id="35" Name="Picture.png" />
<Attachment Id="169" Name="Error.png" />
</Attachments>
<InitialEstimate>6.5</InitialEstimate>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</TestPlan>
<TestPlan Id="201" Name="TestPlan Name">
<Description>TestPlan Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>TestPlan Tags</Tags>
<Owner Id="144" />
<Project Id="217" Name="Project #217" />
<Comments>
<Comment Id="144" />
<Comment Id="48" />
</Comments>
<Attachments>
<Attachment Id="6" Name="Picture.png" />
<Attachment Id="134" Name="Error.png" />
</Attachments>
<InitialEstimate>13.9</InitialEstimate>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</TestPlan>
</Items>
TestPlanRun
Test plan run
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Effort | Total effort of the assignable. Read-only field |
| EffortCompleted | Effort spent on the assignment. Read-only calculated field |
| EffortToDo | Effort required to complete the assignment. Read-only calculated field |
| TimeSpent | Total time spent on the assignment. Read-only calculated field |
| TimeRemain | Total time remaining to complete the assignment for the Role. Read-only calculated field |
| EntityType | Type of entity. For exapmle Bug, Feature, Task, etc. |
| AssignedUser | User to whom entity is assigned |
| Release | Assignable entity may be assigned to Release or may be in project Backlog (Release is not defined in this case) |
| Iteration | Assignable entity may be assigned to Iteration |
| Priority | Priority of assignable. For example, User Story can have Must Have or Nice To Have priority |
| EntityState | State of assignable. For example, User Story can be in Open or Done state |
| Assignments | People assigned to entity |
| Impediments | Blocking reason which does not allow further work on assignable entity |
| Times | Collection of posted time entries to assignable entity |
| RoleEfforts | Collection of efforts for all roles |
| PassedCount | Count of passed test cases |
| FailedCount | Count of passed test cases |
| NotRunCount | Count of not runned test cases |
GET http://{targetprocess}/api/v1/TestPlanRuns/22/
{
"Id": 22,
"Name": "TestPlanRun Name",
"Description": "TestPlanRun Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "TestPlanRun Tags",
"Owner": {
"Id": 287
},
"Project": {
"Id": 290,
"Name": "Project #290"
},
"Comments": [
{
"Id": 73
},
{
"Id": 271
}
],
"Attachments": [
{
"Id": 288,
"Name": "Picture.png"
},
{
"Id": 46,
"Name": "Error.png"
}
],
"Effort": 26.2,
"EffortCompleted": 12.1,
"EffortToDo": 26.6,
"TimeSpent": 18.0,
"TimeRemain": 28.0,
"EntityType": {
"Id": 272,
"Name": "EntityType #272"
},
"AssignedUser": [
{
"Id": 112
},
{
"Id": 50
}
],
"Release": {
"Id": 195,
"Name": "Release #195"
},
"Iteration": {
"Id": 27,
"Name": "Iteration #27"
},
"Priority": {
"Id": 189,
"Name": "Priority #189"
},
"EntityState": {
"Id": 235,
"Name": "EntityState #235"
},
"Assignments": [
{
"Id": 96
},
{
"Id": 94
}
],
"Impediments": [
{
"Id": 28,
"Name": "Impediment #28"
},
{
"Id": 208,
"Name": "Impediment #208"
}
],
"Times": [
{
"Id": 170
},
{
"Id": 127
}
],
"RoleEfforts": [
{
"Id": 145
},
{
"Id": 2
}
],
"PassedCount": 43,
"FailedCount": 100,
"NotRunCount": 48,
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<TestPlanRun Id="22" Name="TestPlanRun Name">
<Description>TestPlanRun Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>TestPlanRun Tags</Tags>
<Owner Id="287" />
<Project Id="290" Name="Project #290" />
<Comments>
<Comment Id="73" />
<Comment Id="271" />
</Comments>
<Attachments>
<Attachment Id="288" Name="Picture.png" />
<Attachment Id="46" Name="Error.png" />
</Attachments>
<Effort>26.2</Effort>
<EffortCompleted>12.1</EffortCompleted>
<EffortToDo>26.6</EffortToDo>
<TimeSpent>18</TimeSpent>
<TimeRemain>28</TimeRemain>
<EntityType Id="272" Name="EntityType #272" />
<AssignedUser>
<GeneralUser Id="112" />
<GeneralUser Id="50" />
</AssignedUser>
<Release Id="195" Name="Release #195" />
<Iteration Id="27" Name="Iteration #27" />
<Priority Id="189" Name="Priority #189" />
<EntityState Id="235" Name="EntityState #235" />
<Assignments>
<Assignment Id="96" />
<Assignment Id="94" />
</Assignments>
<Impediments>
<Impediment Id="28" Name="Impediment #28" />
<Impediment Id="208" Name="Impediment #208" />
</Impediments>
<Times>
<Time Id="170" />
<Time Id="127" />
</Times>
<RoleEfforts>
<RoleEffort Id="145" />
<RoleEffort Id="2" />
</RoleEfforts>
<PassedCount>43</PassedCount>
<FailedCount>100</FailedCount>
<NotRunCount>48</NotRunCount>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</TestPlanRun>
GET http://{targetprocess}/api/v1/TestPlanRuns/
[
{
"Id": 22,
"Name": "TestPlanRun Name",
"Description": "TestPlanRun Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "TestPlanRun Tags",
"Owner": {
"Id": 287
},
"Project": {
"Id": 290,
"Name": "Project #290"
},
"Comments": [
{
"Id": 73
},
{
"Id": 271
}
],
"Attachments": [
{
"Id": 288,
"Name": "Picture.png"
},
{
"Id": 46,
"Name": "Error.png"
}
],
"Effort": 26.2,
"EffortCompleted": 12.1,
"EffortToDo": 26.6,
"TimeSpent": 18.0,
"TimeRemain": 28.0,
"EntityType": {
"Id": 272,
"Name": "EntityType #272"
},
"AssignedUser": [
{
"Id": 112
},
{
"Id": 50
}
],
"Release": {
"Id": 195,
"Name": "Release #195"
},
"Iteration": {
"Id": 27,
"Name": "Iteration #27"
},
"Priority": {
"Id": 189,
"Name": "Priority #189"
},
"EntityState": {
"Id": 235,
"Name": "EntityState #235"
},
"Assignments": [
{
"Id": 96
},
{
"Id": 94
}
],
"Impediments": [
{
"Id": 28,
"Name": "Impediment #28"
},
{
"Id": 208,
"Name": "Impediment #208"
}
],
"Times": [
{
"Id": 170
},
{
"Id": 127
}
],
"RoleEfforts": [
{
"Id": 145
},
{
"Id": 2
}
],
"PassedCount": 43,
"FailedCount": 100,
"NotRunCount": 48,
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 148,
"Name": "TestPlanRun Name",
"Description": "TestPlanRun Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "TestPlanRun Tags",
"Owner": {
"Id": 273
},
"Project": {
"Id": 261,
"Name": "Project #261"
},
"Comments": [
{
"Id": 192
},
{
"Id": 214
}
],
"Attachments": [
{
"Id": 284,
"Name": "Picture.png"
},
{
"Id": 31,
"Name": "Error.png"
}
],
"Effort": 27.7,
"EffortCompleted": 0.6,
"EffortToDo": 24.6,
"TimeSpent": 4.1,
"TimeRemain": 15.8,
"EntityType": {
"Id": 140,
"Name": "EntityType #140"
},
"AssignedUser": [
{
"Id": 102
},
{
"Id": 154
}
],
"Release": {
"Id": 188,
"Name": "Release #188"
},
"Iteration": {
"Id": 93,
"Name": "Iteration #93"
},
"Priority": {
"Id": 88,
"Name": "Priority #88"
},
"EntityState": {
"Id": 94,
"Name": "EntityState #94"
},
"Assignments": [
{
"Id": 22
},
{
"Id": 116
}
],
"Impediments": [
{
"Id": 159,
"Name": "Impediment #159"
},
{
"Id": 71,
"Name": "Impediment #71"
}
],
"Times": [
{
"Id": 37
},
{
"Id": 45
}
],
"RoleEfforts": [
{
"Id": 293
},
{
"Id": 79
}
],
"PassedCount": 120,
"FailedCount": 245,
"NotRunCount": 126,
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<TestPlanRun Id="22" Name="TestPlanRun Name">
<Description>TestPlanRun Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>TestPlanRun Tags</Tags>
<Owner Id="287" />
<Project Id="290" Name="Project #290" />
<Comments>
<Comment Id="73" />
<Comment Id="271" />
</Comments>
<Attachments>
<Attachment Id="288" Name="Picture.png" />
<Attachment Id="46" Name="Error.png" />
</Attachments>
<Effort>26.2</Effort>
<EffortCompleted>12.1</EffortCompleted>
<EffortToDo>26.6</EffortToDo>
<TimeSpent>18</TimeSpent>
<TimeRemain>28</TimeRemain>
<EntityType Id="272" Name="EntityType #272" />
<AssignedUser>
<GeneralUser Id="112" />
<GeneralUser Id="50" />
</AssignedUser>
<Release Id="195" Name="Release #195" />
<Iteration Id="27" Name="Iteration #27" />
<Priority Id="189" Name="Priority #189" />
<EntityState Id="235" Name="EntityState #235" />
<Assignments>
<Assignment Id="96" />
<Assignment Id="94" />
</Assignments>
<Impediments>
<Impediment Id="28" Name="Impediment #28" />
<Impediment Id="208" Name="Impediment #208" />
</Impediments>
<Times>
<Time Id="170" />
<Time Id="127" />
</Times>
<RoleEfforts>
<RoleEffort Id="145" />
<RoleEffort Id="2" />
</RoleEfforts>
<PassedCount>43</PassedCount>
<FailedCount>100</FailedCount>
<NotRunCount>48</NotRunCount>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</TestPlanRun>
<TestPlanRun Id="148" Name="TestPlanRun Name">
<Description>TestPlanRun Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>TestPlanRun Tags</Tags>
<Owner Id="273" />
<Project Id="261" Name="Project #261" />
<Comments>
<Comment Id="192" />
<Comment Id="214" />
</Comments>
<Attachments>
<Attachment Id="284" Name="Picture.png" />
<Attachment Id="31" Name="Error.png" />
</Attachments>
<Effort>27.7</Effort>
<EffortCompleted>0.6</EffortCompleted>
<EffortToDo>24.6</EffortToDo>
<TimeSpent>4.1</TimeSpent>
<TimeRemain>15.8</TimeRemain>
<EntityType Id="140" Name="EntityType #140" />
<AssignedUser>
<GeneralUser Id="102" />
<GeneralUser Id="154" />
</AssignedUser>
<Release Id="188" Name="Release #188" />
<Iteration Id="93" Name="Iteration #93" />
<Priority Id="88" Name="Priority #88" />
<EntityState Id="94" Name="EntityState #94" />
<Assignments>
<Assignment Id="22" />
<Assignment Id="116" />
</Assignments>
<Impediments>
<Impediment Id="159" Name="Impediment #159" />
<Impediment Id="71" Name="Impediment #71" />
</Impediments>
<Times>
<Time Id="37" />
<Time Id="45" />
</Times>
<RoleEfforts>
<RoleEffort Id="293" />
<RoleEffort Id="79" />
</RoleEfforts>
<PassedCount>120</PassedCount>
<FailedCount>245</FailedCount>
<NotRunCount>126</NotRunCount>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</TestPlanRun>
</Items>
Time
Time
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Description | Description |
| Spent | Spent |
| Remain | Remain |
| IsEstimation | Is estimation |
| Date | Date |
| CreateDate | Create date |
| Project | Project |
| UserStory | User story |
| Task | Task |
| Bug | Bug |
| User | User |
| Assignable | Assignable |
| Role | Role |
| CustomActivity | Custom activity |
Revision
Revision
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Description | Description |
| CommitDate | Commit date |
| AssignableName | Assignable name |
| Project | Project |
| RevisionFiles | Revision files |
| Author | Author |
RevisionFile
Revision file
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| FileName | File name |
| Revision | Revision |
CustomActivity
Custom activity
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Name |
| Created | Created |
| Estimate | Estimate |
| Project | Project |
| User | User |
| Times | Times |
Request
Request can be idea, issue or question from customer or application user
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| Effort | Total effort of the assignable. Read-only field |
| EffortCompleted | Effort spent on the assignment. Read-only calculated field |
| EffortToDo | Effort required to complete the assignment. Read-only calculated field |
| TimeSpent | Total time spent on the assignment. Read-only calculated field |
| TimeRemain | Total time remaining to complete the assignment for the Role. Read-only calculated field |
| EntityType | Type of entity. For exapmle Bug, Feature, Task, etc. |
| AssignedUser | User to whom entity is assigned |
| Release | Assignable entity may be assigned to Release or may be in project Backlog (Release is not defined in this case) |
| Iteration | Assignable entity may be assigned to Iteration |
| Priority | Priority of assignable. For example, User Story can have Must Have or Nice To Have priority |
| EntityState | State of assignable. For example, User Story can be in Open or Done state |
| Assignments | People assigned to entity |
| Impediments | Blocking reason which does not allow further work on assignable entity |
| Times | Collection of posted time entries to assignable entity |
| RoleEfforts | Collection of efforts for all roles |
| SourceType | Source of request. Can be Email, Phone, External, Internal |
| IsReplied | Determines whether request is replied |
| RequestType | Type of request |
| Features | Features |
| Tasks | Tasks |
| UserStories | User stories |
| Bugs | Bugs |
GET http://{targetprocess}/api/v1/Requests/285/
{
"Id": 285,
"Name": "Request Name",
"Description": "Request Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Request Tags",
"Owner": {
"Id": 3
},
"Project": {
"Id": 161,
"Name": "Project #161"
},
"Comments": [
{
"Id": 72
},
{
"Id": 118
}
],
"Attachments": [
{
"Id": 207,
"Name": "Picture.png"
},
{
"Id": 19,
"Name": "Error.png"
}
],
"Effort": 8.0,
"EffortCompleted": 19.7,
"EffortToDo": 6.6,
"TimeSpent": 16.3,
"TimeRemain": 5.0,
"EntityType": {
"Id": 183,
"Name": "EntityType #183"
},
"AssignedUser": [
{
"Id": 288
},
{
"Id": 55
}
],
"Release": {
"Id": 236,
"Name": "Release #236"
},
"Iteration": {
"Id": 188,
"Name": "Iteration #188"
},
"Priority": {
"Id": 106,
"Name": "Priority #106"
},
"EntityState": {
"Id": 15,
"Name": "EntityState #15"
},
"Assignments": [
{
"Id": 238
},
{
"Id": 51
}
],
"Impediments": [
{
"Id": 213,
"Name": "Impediment #213"
},
{
"Id": 248,
"Name": "Impediment #248"
}
],
"Times": [
{
"Id": 78
},
{
"Id": 232
}
],
"RoleEfforts": [
{
"Id": 288
},
{
"Id": 202
}
],
"SourceType": 224,
"IsReplied": null,
"RequestType": {
"Id": 147,
"Name": "RequestType #147"
},
"Features": [
{
"Id": 220,
"Name": "Feature #220"
},
{
"Id": 204,
"Name": "Feature #204"
}
],
"Tasks": [
{
"Id": 211,
"Name": "Task #211"
},
{
"Id": 32,
"Name": "Task #32"
}
],
"UserStories": [
{
"Id": 179,
"Name": "UserStory #179"
},
{
"Id": 260,
"Name": "UserStory #260"
}
],
"Bugs": [
{
"Id": 37,
"Name": "Bug #37"
},
{
"Id": 296,
"Name": "Bug #296"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<Request Id="285" Name="Request Name">
<Description>Request Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Request Tags</Tags>
<Owner Id="3" />
<Project Id="161" Name="Project #161" />
<Comments>
<Comment Id="72" />
<Comment Id="118" />
</Comments>
<Attachments>
<Attachment Id="207" Name="Picture.png" />
<Attachment Id="19" Name="Error.png" />
</Attachments>
<Effort>8</Effort>
<EffortCompleted>19.7</EffortCompleted>
<EffortToDo>6.6</EffortToDo>
<TimeSpent>16.3</TimeSpent>
<TimeRemain>5</TimeRemain>
<EntityType Id="183" Name="EntityType #183" />
<AssignedUser>
<GeneralUser Id="288" />
<GeneralUser Id="55" />
</AssignedUser>
<Release Id="236" Name="Release #236" />
<Iteration Id="188" Name="Iteration #188" />
<Priority Id="106" Name="Priority #106" />
<EntityState Id="15" Name="EntityState #15" />
<Assignments>
<Assignment Id="238" />
<Assignment Id="51" />
</Assignments>
<Impediments>
<Impediment Id="213" Name="Impediment #213" />
<Impediment Id="248" Name="Impediment #248" />
</Impediments>
<Times>
<Time Id="78" />
<Time Id="232" />
</Times>
<RoleEfforts>
<RoleEffort Id="288" />
<RoleEffort Id="202" />
</RoleEfforts>
<SourceType>224</SourceType>
<IsReplied />
<RequestType Id="147">
<Name>RequestType #147</Name>
</RequestType>
<Features>
<Feature Id="220" Name="Feature #220" />
<Feature Id="204" Name="Feature #204" />
</Features>
<Tasks>
<Task Id="211" Name="Task #211" />
<Task Id="32" Name="Task #32" />
</Tasks>
<UserStories>
<UserStory Id="179" Name="UserStory #179" />
<UserStory Id="260" Name="UserStory #260" />
</UserStories>
<Bugs>
<Bug Id="37" Name="Bug #37" />
<Bug Id="296" Name="Bug #296" />
</Bugs>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Request>
GET http://{targetprocess}/api/v1/Requests/
[
{
"Id": 285,
"Name": "Request Name",
"Description": "Request Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Request Tags",
"Owner": {
"Id": 3
},
"Project": {
"Id": 161,
"Name": "Project #161"
},
"Comments": [
{
"Id": 72
},
{
"Id": 118
}
],
"Attachments": [
{
"Id": 207,
"Name": "Picture.png"
},
{
"Id": 19,
"Name": "Error.png"
}
],
"Effort": 8.0,
"EffortCompleted": 19.7,
"EffortToDo": 6.6,
"TimeSpent": 16.3,
"TimeRemain": 5.0,
"EntityType": {
"Id": 183,
"Name": "EntityType #183"
},
"AssignedUser": [
{
"Id": 288
},
{
"Id": 55
}
],
"Release": {
"Id": 236,
"Name": "Release #236"
},
"Iteration": {
"Id": 188,
"Name": "Iteration #188"
},
"Priority": {
"Id": 106,
"Name": "Priority #106"
},
"EntityState": {
"Id": 15,
"Name": "EntityState #15"
},
"Assignments": [
{
"Id": 238
},
{
"Id": 51
}
],
"Impediments": [
{
"Id": 213,
"Name": "Impediment #213"
},
{
"Id": 248,
"Name": "Impediment #248"
}
],
"Times": [
{
"Id": 78
},
{
"Id": 232
}
],
"RoleEfforts": [
{
"Id": 288
},
{
"Id": 202
}
],
"SourceType": 224,
"IsReplied": null,
"RequestType": {
"Id": 147,
"Name": "RequestType #147"
},
"Features": [
{
"Id": 220,
"Name": "Feature #220"
},
{
"Id": 204,
"Name": "Feature #204"
}
],
"Tasks": [
{
"Id": 211,
"Name": "Task #211"
},
{
"Id": 32,
"Name": "Task #32"
}
],
"UserStories": [
{
"Id": 179,
"Name": "UserStory #179"
},
{
"Id": 260,
"Name": "UserStory #260"
}
],
"Bugs": [
{
"Id": 37,
"Name": "Bug #37"
},
{
"Id": 296,
"Name": "Bug #296"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 67,
"Name": "Request Name",
"Description": "Request Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Request Tags",
"Owner": {
"Id": 283
},
"Project": {
"Id": 247,
"Name": "Project #247"
},
"Comments": [
{
"Id": 169
},
{
"Id": 13
}
],
"Attachments": [
{
"Id": 190,
"Name": "Picture.png"
},
{
"Id": 28,
"Name": "Error.png"
}
],
"Effort": 15.8,
"EffortCompleted": 6.5,
"EffortToDo": 27.5,
"TimeSpent": 8.2,
"TimeRemain": 28.2,
"EntityType": {
"Id": 109,
"Name": "EntityType #109"
},
"AssignedUser": [
{
"Id": 105
},
{
"Id": 273
}
],
"Release": {
"Id": 105,
"Name": "Release #105"
},
"Iteration": {
"Id": 6,
"Name": "Iteration #6"
},
"Priority": {
"Id": 75,
"Name": "Priority #75"
},
"EntityState": {
"Id": 72,
"Name": "EntityState #72"
},
"Assignments": [
{
"Id": 54
},
{
"Id": 83
}
],
"Impediments": [
{
"Id": 140,
"Name": "Impediment #140"
},
{
"Id": 129,
"Name": "Impediment #129"
}
],
"Times": [
{
"Id": 4
},
{
"Id": 94
}
],
"RoleEfforts": [
{
"Id": 232
},
{
"Id": 277
}
],
"SourceType": 161,
"IsReplied": null,
"RequestType": {
"Id": 252,
"Name": "RequestType #252"
},
"Features": [
{
"Id": 18,
"Name": "Feature #18"
},
{
"Id": 4,
"Name": "Feature #4"
}
],
"Tasks": [
{
"Id": 27,
"Name": "Task #27"
},
{
"Id": 17,
"Name": "Task #17"
}
],
"UserStories": [
{
"Id": 239,
"Name": "UserStory #239"
},
{
"Id": 120,
"Name": "UserStory #120"
}
],
"Bugs": [
{
"Id": 122,
"Name": "Bug #122"
},
{
"Id": 67,
"Name": "Bug #67"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<Request Id="285" Name="Request Name">
<Description>Request Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Request Tags</Tags>
<Owner Id="3" />
<Project Id="161" Name="Project #161" />
<Comments>
<Comment Id="72" />
<Comment Id="118" />
</Comments>
<Attachments>
<Attachment Id="207" Name="Picture.png" />
<Attachment Id="19" Name="Error.png" />
</Attachments>
<Effort>8</Effort>
<EffortCompleted>19.7</EffortCompleted>
<EffortToDo>6.6</EffortToDo>
<TimeSpent>16.3</TimeSpent>
<TimeRemain>5</TimeRemain>
<EntityType Id="183" Name="EntityType #183" />
<AssignedUser>
<GeneralUser Id="288" />
<GeneralUser Id="55" />
</AssignedUser>
<Release Id="236" Name="Release #236" />
<Iteration Id="188" Name="Iteration #188" />
<Priority Id="106" Name="Priority #106" />
<EntityState Id="15" Name="EntityState #15" />
<Assignments>
<Assignment Id="238" />
<Assignment Id="51" />
</Assignments>
<Impediments>
<Impediment Id="213" Name="Impediment #213" />
<Impediment Id="248" Name="Impediment #248" />
</Impediments>
<Times>
<Time Id="78" />
<Time Id="232" />
</Times>
<RoleEfforts>
<RoleEffort Id="288" />
<RoleEffort Id="202" />
</RoleEfforts>
<SourceType>224</SourceType>
<IsReplied />
<RequestType Id="147">
<Name>RequestType #147</Name>
</RequestType>
<Features>
<Feature Id="220" Name="Feature #220" />
<Feature Id="204" Name="Feature #204" />
</Features>
<Tasks>
<Task Id="211" Name="Task #211" />
<Task Id="32" Name="Task #32" />
</Tasks>
<UserStories>
<UserStory Id="179" Name="UserStory #179" />
<UserStory Id="260" Name="UserStory #260" />
</UserStories>
<Bugs>
<Bug Id="37" Name="Bug #37" />
<Bug Id="296" Name="Bug #296" />
</Bugs>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Request>
<Request Id="67" Name="Request Name">
<Description>Request Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Request Tags</Tags>
<Owner Id="283" />
<Project Id="247" Name="Project #247" />
<Comments>
<Comment Id="169" />
<Comment Id="13" />
</Comments>
<Attachments>
<Attachment Id="190" Name="Picture.png" />
<Attachment Id="28" Name="Error.png" />
</Attachments>
<Effort>15.8</Effort>
<EffortCompleted>6.5</EffortCompleted>
<EffortToDo>27.5</EffortToDo>
<TimeSpent>8.2</TimeSpent>
<TimeRemain>28.2</TimeRemain>
<EntityType Id="109" Name="EntityType #109" />
<AssignedUser>
<GeneralUser Id="105" />
<GeneralUser Id="273" />
</AssignedUser>
<Release Id="105" Name="Release #105" />
<Iteration Id="6" Name="Iteration #6" />
<Priority Id="75" Name="Priority #75" />
<EntityState Id="72" Name="EntityState #72" />
<Assignments>
<Assignment Id="54" />
<Assignment Id="83" />
</Assignments>
<Impediments>
<Impediment Id="140" Name="Impediment #140" />
<Impediment Id="129" Name="Impediment #129" />
</Impediments>
<Times>
<Time Id="4" />
<Time Id="94" />
</Times>
<RoleEfforts>
<RoleEffort Id="232" />
<RoleEffort Id="277" />
</RoleEfforts>
<SourceType>161</SourceType>
<IsReplied />
<RequestType Id="252">
<Name>RequestType #252</Name>
</RequestType>
<Features>
<Feature Id="18" Name="Feature #18" />
<Feature Id="4" Name="Feature #4" />
</Features>
<Tasks>
<Task Id="27" Name="Task #27" />
<Task Id="17" Name="Task #17" />
</Tasks>
<UserStories>
<UserStory Id="239" Name="UserStory #239" />
<UserStory Id="120" Name="UserStory #120" />
</UserStories>
<Bugs>
<Bug Id="122" Name="Bug #122" />
<Bug Id="67" Name="Bug #67" />
</Bugs>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Request>
</Items>
RequestType
Type of request
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Name of type |
| Requests | Requests |
Build
Build in specific project
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| BuildDate | Date of the build |
| Release | Release to which this build belongs |
| Iteration | Iteration to which this build belongs |
| Bugs | Collection of bugs found in build |
GET http://{targetprocess}/api/v1/Builds/68/
{
"Id": 68,
"Name": "Build Name",
"Description": "Build Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Build Tags",
"Owner": {
"Id": 38
},
"Project": {
"Id": 22,
"Name": "Project #22"
},
"Comments": [
{
"Id": 220
},
{
"Id": 220
}
],
"Attachments": [
{
"Id": 166,
"Name": "Picture.png"
},
{
"Id": 13,
"Name": "Error.png"
}
],
"BuildDate": "\/Date(1300658400000+0200)\/",
"Release": {
"Id": 119,
"Name": "Release #119"
},
"Iteration": {
"Id": 241,
"Name": "Iteration #241"
},
"Bugs": [
{
"Id": 38,
"Name": "Bug #38"
},
{
"Id": 115,
"Name": "Bug #115"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<Build Id="68" Name="Build Name">
<Description>Build Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Build Tags</Tags>
<Owner Id="38" />
<Project Id="22" Name="Project #22" />
<Comments>
<Comment Id="220" />
<Comment Id="220" />
</Comments>
<Attachments>
<Attachment Id="166" Name="Picture.png" />
<Attachment Id="13" Name="Error.png" />
</Attachments>
<BuildDate>2011-03-21T00:00:00+02:00</BuildDate>
<Release Id="119" Name="Release #119" />
<Iteration Id="241" Name="Iteration #241" />
<Bugs>
<Bug Id="38" Name="Bug #38" />
<Bug Id="115" Name="Bug #115" />
</Bugs>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Build>
GET http://{targetprocess}/api/v1/Builds/
[
{
"Id": 68,
"Name": "Build Name",
"Description": "Build Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Build Tags",
"Owner": {
"Id": 38
},
"Project": {
"Id": 22,
"Name": "Project #22"
},
"Comments": [
{
"Id": 220
},
{
"Id": 220
}
],
"Attachments": [
{
"Id": 166,
"Name": "Picture.png"
},
{
"Id": 13,
"Name": "Error.png"
}
],
"BuildDate": "\/Date(1300658400000+0200)\/",
"Release": {
"Id": 119,
"Name": "Release #119"
},
"Iteration": {
"Id": 241,
"Name": "Iteration #241"
},
"Bugs": [
{
"Id": 38,
"Name": "Bug #38"
},
{
"Id": 115,
"Name": "Bug #115"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 230,
"Name": "Build Name",
"Description": "Build Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Build Tags",
"Owner": {
"Id": 106
},
"Project": {
"Id": 25,
"Name": "Project #25"
},
"Comments": [
{
"Id": 104
},
{
"Id": 188
}
],
"Attachments": [
{
"Id": 282,
"Name": "Picture.png"
},
{
"Id": 212,
"Name": "Error.png"
}
],
"BuildDate": "\/Date(1300658400000+0200)\/",
"Release": {
"Id": 226,
"Name": "Release #226"
},
"Iteration": {
"Id": 153,
"Name": "Iteration #153"
},
"Bugs": [
{
"Id": 242,
"Name": "Bug #242"
},
{
"Id": 74,
"Name": "Bug #74"
}
],
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<Build Id="68" Name="Build Name">
<Description>Build Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Build Tags</Tags>
<Owner Id="38" />
<Project Id="22" Name="Project #22" />
<Comments>
<Comment Id="220" />
<Comment Id="220" />
</Comments>
<Attachments>
<Attachment Id="166" Name="Picture.png" />
<Attachment Id="13" Name="Error.png" />
</Attachments>
<BuildDate>2011-03-21T00:00:00+02:00</BuildDate>
<Release Id="119" Name="Release #119" />
<Iteration Id="241" Name="Iteration #241" />
<Bugs>
<Bug Id="38" Name="Bug #38" />
<Bug Id="115" Name="Bug #115" />
</Bugs>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Build>
<Build Id="230" Name="Build Name">
<Description>Build Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Build Tags</Tags>
<Owner Id="106" />
<Project Id="25" Name="Project #25" />
<Comments>
<Comment Id="104" />
<Comment Id="188" />
</Comments>
<Attachments>
<Attachment Id="282" Name="Picture.png" />
<Attachment Id="212" Name="Error.png" />
</Attachments>
<BuildDate>2011-03-21T00:00:00+02:00</BuildDate>
<Release Id="226" Name="Release #226" />
<Iteration Id="153" Name="Iteration #153" />
<Bugs>
<Bug Id="242" Name="Bug #242" />
<Bug Id="74" Name="Bug #74" />
</Bugs>
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Build>
</Items>
Comment
Comment
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Description | Description |
| CreateDate | Create date |
| General | General |
| Owner | Owner |
Assignment
Assignment
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Assignable | Assignable |
| GeneralUser | General user |
| Role | Role |
Impediment
Blocking reason for feature implementation or other obstacles in project.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Entity name or title |
| Description | Entity description |
| StartDate | Start Date for time-boxed entities such as Iteration, Project, Release |
| EndDate | End Date for time-boxed entities such as Iteration, Project, Release |
| CreateDate | Date of entity creation |
| ModifyDate | Last time entity was modified |
| LastCommentDate | Last comment date |
| Tags | Comma separated list tags |
| Owner | Person who ownes the entity |
| Project | Project to which entity belongs |
| Comments | Collection of comments for entity |
| Attachments | Attachments |
| IsPrivate | Determines whether impediment is private |
| Assignable | Assignable entity to which impediment belongs |
| EntityState | Entity state of impediment |
| Priority | Impediment priority |
| Responsible | Person responsible for impediment resolution |
GET http://{targetprocess}/api/v1/Impediments/80/
{
"Id": 80,
"Name": "Impediment Name",
"Description": "Impediment Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Impediment Tags",
"Owner": {
"Id": 213
},
"Project": {
"Id": 166,
"Name": "Project #166"
},
"Comments": [
{
"Id": 205
},
{
"Id": 47
}
],
"Attachments": [
{
"Id": 270,
"Name": "Picture.png"
},
{
"Id": 54,
"Name": "Error.png"
}
],
"IsPrivate": null,
"Assignable": {
"Id": 264,
"Name": "Assignable #264"
},
"EntityState": {
"Id": 169,
"Name": "EntityState #169"
},
"Priority": {
"Id": 284,
"Name": "Priority #284"
},
"Responsible": {
"Id": 150
},
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
<Impediment Id="80" Name="Impediment Name">
<Description>Impediment Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Impediment Tags</Tags>
<Owner Id="213" />
<Project Id="166" Name="Project #166" />
<Comments>
<Comment Id="205" />
<Comment Id="47" />
</Comments>
<Attachments>
<Attachment Id="270" Name="Picture.png" />
<Attachment Id="54" Name="Error.png" />
</Attachments>
<IsPrivate />
<Assignable Id="264" Name="Assignable #264" />
<EntityState Id="169" Name="EntityState #169" />
<Priority Id="284" Name="Priority #284" />
<Responsible Id="150" />
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Impediment>
GET http://{targetprocess}/api/v1/Impediments/
[
{
"Id": 80,
"Name": "Impediment Name",
"Description": "Impediment Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Impediment Tags",
"Owner": {
"Id": 213
},
"Project": {
"Id": 166,
"Name": "Project #166"
},
"Comments": [
{
"Id": 205
},
{
"Id": 47
}
],
"Attachments": [
{
"Id": 270,
"Name": "Picture.png"
},
{
"Id": 54,
"Name": "Error.png"
}
],
"IsPrivate": null,
"Assignable": {
"Id": 264,
"Name": "Assignable #264"
},
"EntityState": {
"Id": 169,
"Name": "EntityState #169"
},
"Priority": {
"Id": 284,
"Name": "Priority #284"
},
"Responsible": {
"Id": 150
},
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
},
{
"Id": 37,
"Name": "Impediment Name",
"Description": "Impediment Description",
"StartDate": "\/Date(1300658400000+0200)\/",
"EndDate": "\/Date(1300658400000+0200)\/",
"CreateDate": "\/Date(1300658400000+0200)\/",
"ModifyDate": "\/Date(1300658400000+0200)\/",
"LastCommentDate": "\/Date(1300658400000+0200)\/",
"Tags": "Impediment Tags",
"Owner": {
"Id": 237
},
"Project": {
"Id": 36,
"Name": "Project #36"
},
"Comments": [
{
"Id": 49
},
{
"Id": 134
}
],
"Attachments": [
{
"Id": 163,
"Name": "Picture.png"
},
{
"Id": 274,
"Name": "Error.png"
}
],
"IsPrivate": null,
"Assignable": {
"Id": 116,
"Name": "Assignable #116"
},
"EntityState": {
"Id": 185,
"Name": "EntityState #185"
},
"Priority": {
"Id": 153,
"Name": "Priority #153"
},
"Responsible": {
"Id": 194
},
"CustomFields": [
{
"Name": "Integer Value",
"Value": 13
}
]
}
]
<Items>
<Impediment Id="80" Name="Impediment Name">
<Description>Impediment Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Impediment Tags</Tags>
<Owner Id="213" />
<Project Id="166" Name="Project #166" />
<Comments>
<Comment Id="205" />
<Comment Id="47" />
</Comments>
<Attachments>
<Attachment Id="270" Name="Picture.png" />
<Attachment Id="54" Name="Error.png" />
</Attachments>
<IsPrivate />
<Assignable Id="264" Name="Assignable #264" />
<EntityState Id="169" Name="EntityState #169" />
<Priority Id="284" Name="Priority #284" />
<Responsible Id="150" />
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Impediment>
<Impediment Id="37" Name="Impediment Name">
<Description>Impediment Description</Description>
<StartDate>2011-03-21T00:00:00+02:00</StartDate>
<EndDate>2011-03-21T00:00:00+02:00</EndDate>
<CreateDate>2011-03-21T00:00:00+02:00</CreateDate>
<ModifyDate>2011-03-21T00:00:00+02:00</ModifyDate>
<LastCommentDate>2011-03-21T00:00:00+02:00</LastCommentDate>
<Tags>Impediment Tags</Tags>
<Owner Id="237" />
<Project Id="36" Name="Project #36" />
<Comments>
<Comment Id="49" />
<Comment Id="134" />
</Comments>
<Attachments>
<Attachment Id="163" Name="Picture.png" />
<Attachment Id="274" Name="Error.png" />
</Attachments>
<IsPrivate />
<Assignable Id="116" Name="Assignable #116" />
<EntityState Id="185" Name="EntityState #185" />
<Priority Id="153" Name="Priority #153" />
<Responsible Id="194" />
<CustomFields>
<Field Name="Integer Value">
<Value>13</Value>
</Field>
</CustomFields>
</Impediment>
</Items>
Company
Company
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Name |
| Url | Url |
| Description | Description |
| Projects | Projects |
RoleEffort
Role effort
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| InitialEstimate | Initial estimate |
| Effort | Effort |
| EffortCompleted | Effort completed |
| EffortToDo | Effort to do |
| TimeSpent | Time spent |
| TimeRemain | Time remain |
| Assignable | Assignable |
| Role | Role |
Attachment
Attachment
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Name |
| Description | Description |
| Date | Date |
| Owner | Owner |
| General | General |
Context
Information of context.
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Acid | Application context Id. Unique value for set of projects |
| Culture | Current culture in application |
| SelectedProjects | Collection of selectrd projects in the context |
| Processes | Collection of selected processes in the context |
ProcessInfo
Information about Process
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Name of the process |
| Terms | Collection of terms of the process |
| CustomFields | Collection of custom fields information of the process |
| Practices | Collection of practices of the process |
Term
User-defined term of a proces
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Name of the term |
| Value | User-defined value |
CustomFieldInfo
Information about custom field in the process
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| EntityKind | Entity kind to which custom field is defined |
| Name | Name of the custom field |
| Type | Type of the custom field value. For example, DropDown or Text |
| Required | Determines whether custom field is required |
| Listed | Determines whether custom field is shown in lists |
Practice
Practice of the process
Properties
| Name | Description |
|---|---|
| Id | Id of entity |
| Name | Name of the practice |
