SpiraTeam: REST Web Service (v5.0)

See all operations

GET: 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):

http://api.inflectra.com/Spira/Services/v5_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

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