See all operations
POST: projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/history?start_row={start_row}&number_rows={number_rows}&sort_property={sort_property}&sort_direction={sort_direction}
Description
Retrieves the history of changes for a specific artifact
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}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/history?start_row={start_row}&number_rows={number_rows}&sort_property={sort_property}&sort_direction={sort_direction}
Request Parameters
Name
|
Description
|
project_id
|
The id of the project
|
artifact_type_id
|
The type of artifact:
(Requirement = 1,
TestCase = 2,
Incident = 3,
Release = 4,
TestRun = 5,
Task = 6,
TestStep = 7,
TestSet = 8)
|
artifact_id
|
The id of the artifact
|
start_row
|
The starting row (starting at 1)
|
number_rows
|
The number of rows to retrieve
|
sort_property
|
The field to sort by
|
sort_direction
|
Sort direction [asc|desc]
|
Request Body
<ArrayOfRemoteFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<RemoteFilter>
<DateRangeValue i:nil="true" />
<IntValue i:nil="true" />
<MultiValue i:nil="true" />
<PropertyName i:nil="true" />
<StringValue i:nil="true" />
</RemoteFilter>
</ArrayOfRemoteFilter>
[{"PropertyName":null,
"IntValue":null,
"StringValue":null,
"MultiValue":null,
"DateRangeValue":null}]
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.
<ArrayOfRemoteHistoryChange xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
<RemoteHistoryChange>
<ArtifactFieldId i:nil="true" />
<ChangeSet i:nil="true" />
<ChangeSetId>0</ChangeSetId>
<CustomPropertyId i:nil="true" />
<FieldCaption i:nil="true" />
<FieldName i:nil="true" />
<HistoryChangeId>0</HistoryChangeId>
<NewValue i:nil="true" />
<OldValue i:nil="true" />
</RemoteHistoryChange>
</ArrayOfRemoteHistoryChange>
[{"HistoryChangeId":0,
"ChangeSetId":0,
"CustomPropertyId":null,
"ArtifactFieldId":null,
"FieldName":null,
"OldValue":null,
"NewValue":null,
"FieldCaption":null,
"ChangeSet":null}]