See all operations
GET: projects/{project_id}/history/{history_change_set_id}
Description
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):
https://api.inflectra.com/spira/services/v6_0/RestService.svc/projects/{project_id}/history/{history_change_set_id}
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
|
|
Meaning
|
The meaning of the changed if it's a signed changeset
|
<RemoteHistoryChangeSet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<ArtifactId>0</ArtifactId>
<ArtifactName i:nil="true" />
<ArtifactTypeId>0</ArtifactTypeId>
<ArtifactTypeName i:nil="true" />
<ChangeDate>0001-01-01T00:00:00</ChangeDate>
<ChangeTypeId>0</ChangeTypeId>
<ChangeTypeName i:nil="true" />
<Changes i:nil="true" />
<HistoryChangeSetId>0</HistoryChangeSetId>
<Meaning i:nil="true" />
<ProjectId>0</ProjectId>
<SignedId>0</SignedId>
<UserFullName i:nil="true" />
<UserId>0</UserId>
</RemoteHistoryChangeSet>
{"HistoryChangeSetId":0,
"ProjectId":0,
"UserId":0,
"UserFullName":null,
"ArtifactId":0,
"ArtifactName":null,
"ArtifactTypeId":0,
"ArtifactTypeName":null,
"ChangeDate":"0001-01-01T00:00:00",
"ChangeTypeId":0,
"ChangeTypeName":null,
"SignedId":0,
"Changes":null,
"Meaning":null}