Simple history

Simple History API works with the following resources:

Resource

Meta information

Endpoints

Task

link

/api/v1/Tasks/[id]/History
/api/v1/TaskSimpleHistories
/api/v2/TaskSimpleHistories

Bug

link

/api/v1/Bugs/[id]/History
/api/v1/BugSimpleHistories
/api/v2/BugSimpleHistories

User Story

link

/api/v1/UserStories/[id]/History
/api/v1/UserStorySimpleHistories
/api/v2/UserStorySimpleHistories

Feature

link

/api/v1/Features/[id]/History
/api/v1/FeatureSimpleHistories
/api/v2/FeatureSimpleHistories

Epic

link

/api/v1/Epics/[id]/History
/api/v1/EpicSimpleHistories
/api/v2/EpicSimpleHistories

Impediment

link

/api/v1/Impediments/[id]/History
/api/v1/ImpedimentSimpleHistories
/api/v2/ImpedimentSimpleHistories

Request

link

/api/v1/Requests/[id]/History
/api/v1/RequestSimpleHistories
/api/v2/RequestSimpleHistories

Portfolio Epic

link

/api/v1/PortfolioEpics/[id]/History
/api/v1/PortfolioEpicSimpleHistories
/api/v2/PortfolioEpicSimpleHistories

As you can see from meta information, simple history record has only the following fields:

  • Date of modification
  • Who has made the modification
  • Entity state of this item for that moment
  • Effort of this item for that moment
  • Release of this item for that moment
  • Iteration of this item for that moment
  • Link the the original item (and its current fields)

More fields are available in Full history .

A new Simple History record is generated when Entity Sate, Effort, Release or Iteration field was changed.

🚧

By looking at one particular Simple History record it's not possible to determine which exact field was changed. In order to understand what field was changed you have to compare this History record with the older History records of the same Entity or to use full history.

Here is an example of one UserStorySimpleHistory record in XML format.

<UserStorySimpleHistory ResourceType="UserStorySimpleHistory" Id="89">
<Date>2016-02-25T00:00:00</Date>
<Effort>0.0000</Effort>
<EffortCompleted>0.0000</EffortCompleted>
<EffortToDo>0.0000</EffortToDo>
<Project ResourceType="Project" Id="2" Name="Reporting WebApp"/>
<EntityState ResourceType="EntityState" Id="78" Name="">
<NumericPriority nil="true"/>
</EntityState>
<Modifier ResourceType="GeneralUser" Id="2">
<FirstName>Target</FirstName>
<LastName>Process</LastName>
<Login>System</Login>
</Modifier>
<UserStory ResourceType="UserStory" Id="139" Name="Advanced REST API"/>
<Release nil="true"/>
<Iteration nil="true"/>
</UserStorySimpleHistory>