Full history

Native entities

Resource

Meta information

Endpoints

Task

link

/api/v1/TaskHistories
/api/v2/TaskHistories
/api/history/v2/Task

Bug

link

/api/v1/BugHistories
/api/v2/BugHistories
/api/history/v2/Bug

User Story

link

/api/v1/UserStoryHistories
/api/v2/UserStoryHistories
/api/history/v2//UserStory

Feature

link

/api/v1/FeatureHistories
/api/v2/FeatureHistories
/api/history/v2/Feature

Epic

link

/api/v1/EpicHistories
/api/v2/EpicHistories
/api/history/v2/Epic

Impediment

link

/api/v1/ImpedimentHistories
/api/v2/ImpedimentHistories
/api/history/v2/Impediment

Request

link

/api/v1/RequestHistories
/api/v2/RequestHistories
/api/history/v2/Request

Portfolio Epic

link

/api/v1/PortfolioEpicHistories
/api/v2/PortfolioEpicHistories
/api/history/v2/PortfolioEpic

Release

link

/api/v1/ReleaseHistories
/api/v2/ReleaseHistories
/api/history/v2/Release

Build

link

/api/v1/BuildHistories
/api/v2/BuildHistories
/api/history/v2/Build

Iteration

link

/api/v1/IterationHistories
/api/v2/IterationHistories
/api/history/v2/Iteration

Program

link

/api/v1/ProgramHistories
/api/v2/ProgramHistories
/api/history/v2/Program

TeamIteration

link

/api/v1/TeamIterationHistories
/api/v2/TeamIterationHistories
/api/history/v2/TeamIteration

Time

link

/api/v1/TimeHistories
/api/v2/TimeHistories
/api/history/v2/Time

Unlike with Simple History, with full history you can determine what exactly was changed by looking at IsChanged[field name] fields.

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

<UserStoryHistory ResourceType="UserStoryHistory" Id="89">
<Date>2016-02-25T00:00:00</Date>
<DateTo>2016-02-25T00:00:00</DateTo>
<Modification>Add</Modification>
<InitialEstimate>0.0000</InitialEstimate>
<IsChangedInitialEstimate>true</IsChangedInitialEstimate>
<Effort>0.0000</Effort>
<IsChangedEffort>true</IsChangedEffort>
<EffortCompleted>0.0000</EffortCompleted>
<IsChangedEffortCompleted>true</IsChangedEffortCompleted>
<EffortToDo>0.0000</EffortToDo>
<IsChangedEffortToDo>true</IsChangedEffortToDo>
<TimeSpent>0.0000</TimeSpent>
<IsChangedTimeSpent>true</IsChangedTimeSpent>
<TimeRemain>0.0000</TimeRemain>
<IsChangedTimeRemain>true</IsChangedTimeRemain>
<PlannedStartDate nil="true"/>
<IsChangedPlannedStartDate>true</IsChangedPlannedStartDate>
<PlannedEndDate nil="true"/>
<IsChangedPlannedEndDate>true</IsChangedPlannedEndDate>
<Name>Advanced REST API</Name>
<IsChangedName>true</IsChangedName>
<Description nil="true"/>
<IsChangedDescription>true</IsChangedDescription>
<StartDate nil="true"/>
<IsChangedStartDate>true</IsChangedStartDate>
<EndDate nil="true"/>
<IsChangedEndDate>true</IsChangedEndDate>
<CreateDate>2016-02-25T00:00:00</CreateDate>
<IsChangedCreateDate>true</IsChangedCreateDate>
<ModifyDate>2016-02-25T00:00:00</ModifyDate>
<IsChangedModifyDate>true</IsChangedModifyDate>
<LastCommentDate nil="true"/>
<IsChangedLastCommentDate>true</IsChangedLastCommentDate>
<NumericPriority>43</NumericPriority>
<IsChangedNumericPriority>true</IsChangedNumericPriority>
<IsChangedProject>true</IsChangedProject>
<IsChangedFeature>true</IsChangedFeature>
<IsChangedRelease>true</IsChangedRelease>
<IsChangedIteration>true</IsChangedIteration>
<IsChangedTeam>true</IsChangedTeam>
<IsChangedTeamIteration>true</IsChangedTeamIteration>
<IsChangedPriority>true</IsChangedPriority>
<IsChangedEntityState>true</IsChangedEntityState>
<IsChangedEntityType>true</IsChangedEntityType>
<IsChangedLastEditor>true</IsChangedLastEditor>
<IsChangedOwner>true</IsChangedOwner>
<IsChangedLastCommentedUser>true</IsChangedLastCommentedUser>
<EntityType ResourceType="EntityType" Id="4" Name="UserStory"/>
<Project ResourceType="Project" Id="2" Name="Reporting WebApp"/>
<Feature nil="true"/>
<Release nil="true"/>
<Iteration nil="true"/>
<Team nil="true"/>
<TeamIteration nil="true"/>
<Priority ResourceType="Priority" Id="3" Name="Medium">
<Importance>3</Importance>
</Priority>
<EntityState ResourceType="EntityState" Id="78" Name="">
<NumericPriority nil="true"/>
</EntityState>
<LastEditor ResourceType="GeneralUser" Id="2">
<FirstName>Target</FirstName>
<LastName>Process</LastName>
<Login>System</Login>
</LastEditor>
<Owner ResourceType="GeneralUser" Id="2">
<FirstName>Target</FirstName>
<LastName>Process</LastName>
<Login>System</Login>
</Owner>
<LastCommentedUser nil="true"/>
<CurrentUserStory ResourceType="UserStory" Id="139" Name="Advanced REST API"/>
<Modifier ResourceType="GeneralUser" Id="2">
<FirstName>Target</FirstName>
<LastName>Process</LastName>
<Login>System</Login>
</Modifier>
<PreviousHistoryRecord nil="true"/>
</UserStoryHistory>

Extendable Domain entities

It is possible to get the history of any ExD entities (like Objectives, Key Results, Retrospectives, IterationGoal etc.) in the same way as for the native entities.

Here are few examples:

Risk History (/api/v1/RiskHistories) in XML format

<RiskHistory ResourceType="RiskHistory" Id="1">
<Name>The export licence may not be granted</Name>
<IsChangedName>true</IsChangedName>
<Description><p>Lorem ipsum dolor sit amet&#44; consectetur adipiscing elit. Maecenas vehicula fringilla nulla quis maximus. Cras quis dolor nisl. In quis sem ullamcorper&#44; pretium lorem vitae&#44; varius lorem. Integer enim nibh&#44; accumsan at nulla tincidunt&#44; semper pretium erat. Donec ornare&#44; tellus sed feugiat molestie&#44; purus enim sagittis enim&#44; vitae viverra ipsum quam sed est. Morbi a urna arcu. Proin bibendum&#44; nulla et sodales dictum&#44; tellus ante pulvinar ipsum&#44; a fringilla ante mi sit amet eros. Curabitur iaculis lorem velit&#44; luctus rhoncus quam volutpat eu. In tellus neque&#44; lacinia sit amet tellus facilisis&#44; semper imperdiet tellus. Nullam vel molestie neque. Nunc sagittis justo quis egestas auctor. Nulla egestas scelerisque mi&#44; eget vulputate neque congue in. Pellentesque non ultricies diam.</p></Description>
<IsChangedDescription>true</IsChangedDescription>
<StartDate>2021-03-07T04:28:19</StartDate>
<IsChangedStartDate>true</IsChangedStartDate>
<EndDate nil="true"/>
<IsChangedEndDate>true</IsChangedEndDate>
<CreateDate>2021-03-07T04:28:19</CreateDate>
<IsChangedCreateDate>true</IsChangedCreateDate>
<ModifyDate>2021-06-02T07:37:26</ModifyDate>
<IsChangedModifyDate>true</IsChangedModifyDate>
<LastCommentDate nil="true"/>
<IsChangedLastCommentDate>true</IsChangedLastCommentDate>
<IsChangedEntityType>true</IsChangedEntityType>
<IsChangedLastEditor>true</IsChangedLastEditor>
<IsChangedOwner>true</IsChangedOwner>
<IsChangedCreator>true</IsChangedCreator>
<IsChangedLastCommentedUser>true</IsChangedLastCommentedUser>
<IsChangedProject>true</IsChangedProject>
<Effort>0.0000</Effort>
<IsChangedEffort>true</IsChangedEffort>
<EffortCompleted>0.0000</EffortCompleted>
<IsChangedEffortCompleted>true</IsChangedEffortCompleted>
<EffortToDo>0.0000</EffortToDo>
<IsChangedEffortToDo>true</IsChangedEffortToDo>
<TimeSpent>0.0000</TimeSpent>
<IsChangedTimeSpent>true</IsChangedTimeSpent>
<TimeRemain>0.0000</TimeRemain>
<IsChangedTimeRemain>true</IsChangedTimeRemain>
<LastStateChangeDate>2021-03-07T04:28:19</LastStateChangeDate>
<IsChangedLastStateChangeDate>true</IsChangedLastStateChangeDate>
<PlannedStartDate nil="true"/>
<IsChangedPlannedStartDate>true</IsChangedPlannedStartDate>
<PlannedEndDate nil="true"/>
<IsChangedPlannedEndDate>true</IsChangedPlannedEndDate>
<IsChangedRelease>true</IsChangedRelease>
<IsChangedIteration>true</IsChangedIteration>
<IsChangedTeamIteration>true</IsChangedTeamIteration>
<IsChangedTeam>true</IsChangedTeam>
<IsChangedPriority>true</IsChangedPriority>
<IsChangedEntityState>true</IsChangedEntityState>
<Date>2021-07-03T04:03:44.057</Date>
<DateTo>2021-07-06T03:13:26.23</DateTo>
<Modification>Add</Modification>
<EntityType ResourceType="EntityType" Id="9015" Name="Risk"/>
<LastEditor ResourceType="GeneralUser" Id="3721">
<FirstName>Admin</FirstName>
<LastName>User</LastName>
<Login>admin</Login>
<FullName>Admin User</FullName>
</LastEditor>
<Owner ResourceType="GeneralUser" Id="43322">
<FirstName>Mary</FirstName>
<LastName>Berry</LastName>
<Login>login43322</Login>
<FullName>Mary Berry</FullName>
</Owner>
<Creator ResourceType="GeneralUser" Id="43322">
<FirstName>Mary</FirstName>
<LastName>Berry</LastName>
<Login>login43322</Login>
<FullName>Mary Berry</FullName>
</Creator>
<LastCommentedUser nil="true"/>
<Project nil="true"/>
<Release ResourceType="Release" Id="188278" Name="PI3 Core Banking"/>
<Iteration nil="true"/>
<TeamIteration nil="true"/>
<Team ResourceType="Team" Id="155989" Name="Banker’s Dozen">
<EmojiIcon>:spades:</EmojiIcon>
</Team>
<Priority ResourceType="Priority" Id="155" Name="Average">
<Importance>1</Importance>
</Priority>
<EntityState ResourceType="EntityState" Id="11190" Name="New">
<NumericPriority>1</NumericPriority>
</EntityState>
<CurrentRisk ResourceType="Risk" Id="188605" Name="The export licence may not be granted"/>
<Modifier ResourceType="GeneralUser" Id="3721">
<FirstName>Admin</FirstName>
<LastName>User</LastName>
<Login>admin</Login>
<FullName>Admin User</FullName>
</Modifier>
<PreviousHistoryRecord nil="true"/>
</RiskHistory>

Key Result history (/api/v1/KeyResultHistories) in XML format

<KeyResultHistory ResourceType="KeyResultHistory" Id="1">
<Name>Got into Leaders of the tools supporting SAFe</Name>
<IsChangedName>true</IsChangedName>
<Description nil="true"/>
<IsChangedDescription>true</IsChangedDescription>
<StartDate nil="true"/>
<IsChangedStartDate>true</IsChangedStartDate>
<EndDate nil="true"/>
<IsChangedEndDate>true</IsChangedEndDate>
<CreateDate>2021-06-09T11:08:32</CreateDate>
<IsChangedCreateDate>true</IsChangedCreateDate>
<ModifyDate>2021-06-18T15:40:23</ModifyDate>
<IsChangedModifyDate>true</IsChangedModifyDate>
<LastCommentDate nil="true"/>
<IsChangedLastCommentDate>true</IsChangedLastCommentDate>
<IsChangedEntityType>true</IsChangedEntityType>
<IsChangedLastEditor>true</IsChangedLastEditor>
<IsChangedOwner>true</IsChangedOwner>
<IsChangedCreator>true</IsChangedCreator>
<IsChangedLastCommentedUser>true</IsChangedLastCommentedUser>
<IsChangedProject>true</IsChangedProject>
<Effort>0.0000</Effort>
<IsChangedEffort>true</IsChangedEffort>
<EffortCompleted>0.0000</EffortCompleted>
<IsChangedEffortCompleted>true</IsChangedEffortCompleted>
<EffortToDo>0.0000</EffortToDo>
<IsChangedEffortToDo>true</IsChangedEffortToDo>
<TimeSpent>0.0000</TimeSpent>
<IsChangedTimeSpent>true</IsChangedTimeSpent>
<TimeRemain>0.0000</TimeRemain>
<IsChangedTimeRemain>true</IsChangedTimeRemain>
<LastStateChangeDate>2021-06-09T11:08:32</LastStateChangeDate>
<IsChangedLastStateChangeDate>true</IsChangedLastStateChangeDate>
<PlannedStartDate nil="true"/>
<IsChangedPlannedStartDate>true</IsChangedPlannedStartDate>
<PlannedEndDate nil="true"/>
<IsChangedPlannedEndDate>true</IsChangedPlannedEndDate>
<IsChangedRelease>true</IsChangedRelease>
<IsChangedIteration>true</IsChangedIteration>
<IsChangedTeamIteration>true</IsChangedTeamIteration>
<IsChangedTeam>true</IsChangedTeam>
<IsChangedPriority>true</IsChangedPriority>
<IsChangedEntityState>true</IsChangedEntityState>
<Date>2021-07-03T04:02:33.87</Date>
<DateTo>2022-04-25T22:51:35.06</DateTo>
<Modification>Add</Modification>
<IsChangedStrategicObjective>true</IsChangedStrategicObjective>
<IsChangedUltimateObjective>true</IsChangedUltimateObjective>
<IsChangedTacticalObjective>true</IsChangedTacticalObjective>
<EntityType ResourceType="EntityType" Id="9032" Name="KeyResult"/>
<LastEditor ResourceType="GeneralUser" Id="3721">
<FirstName>Admin</FirstName>
<LastName>User</LastName>
<Login>admin</Login>
<FullName>Admin User</FullName>
</LastEditor>
<Owner ResourceType="GeneralUser" Id="3721">
<FirstName>Admin</FirstName>
<LastName>User</LastName>
<Login>admin</Login>
<FullName>Admin User</FullName>
</Owner>
<Creator ResourceType="GeneralUser" Id="3721">
<FirstName>Admin</FirstName>
<LastName>User</LastName>
<Login>admin</Login>
<FullName>Admin User</FullName>
</Creator>
<LastCommentedUser nil="true"/>
<Project nil="true"/>
<Release nil="true"/>
<Iteration nil="true"/>
<TeamIteration nil="true"/>
<Team nil="true"/>
<Priority ResourceType="Priority" Id="181" Name="Average">
<Importance>1</Importance>
</Priority>
<EntityState ResourceType="EntityState" Id="11212" Name="Draft">
<NumericPriority>1</NumericPriority>
</EntityState>
<CurrentKeyResult ResourceType="KeyResult" Id="188874" Name="Got into Leaders of the tools supporting SAFe"/>
<Modifier ResourceType="GeneralUser" Id="3721">
<FirstName>Admin</FirstName>
<LastName>User</LastName>
<Login>admin</Login>
<FullName>Admin User</FullName>
</Modifier>
<PreviousHistoryRecord nil="true"/>
<StrategicObjective ResourceType="StrategicObjective" Id="188924" Name="Provide best support of SAFe"/>
<UltimateObjective nil="true"/>
<TacticalObjective nil="true"/>
</KeyResultHistory>