SpiraPlan: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/history/{history_change_set_id}


Retrieves the details of a specific change made

Includes the field-level details of each change

How to Execute

To access this REST web service, you need to use the following URL (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):


Request Parameters

Name Description
project_id The id of the project
history_change_set_id The id of the change

Request Body

Return Data

The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.

Property Description
HistoryChangeSetId The ID of the change set
ProjectId The ID of the project
UserId The ID of the user that made the change
UserFullName The full name of the user that made the change
ArtifactId The ID of the artifact being changed
ArtifactName The name of the artifact being changed
ArtifactTypeId The id of the type of artifact
ArtifactTypeName The name of the type of artifact
ChangeDate The date/time of the change
ChangeTypeId The id of the type of change Modified = 1, Deleted = 2, Added = 3, Purged = 4, Rollback = 5, Undelete = 6, Imported = 7, Exported = 8, Deleted_Parent = 9, Added_Parent = 10, Purged_Parent = 11, Undelete_Parent = 12
ChangeTypeName The name of the type of change
SignedId Whether this change was signed by an electronic signature NotSigned = 1, Valid = 2, Invalid = 3
Changes The collection of field changes in this set