SpiraPlan: REST Web Service (v7.0)

See all operations

POST: projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/documents/search?sort_by={sort_by}


Retrieves the list of documents/attachments in a project attached to a specific artifact

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 relevant project
artifact_type_id The id of the type of artifact we want to retrieve the documents for: (Requirement = 1, TestCase = 2, Incident = 3, Release = 4, TestRun = 5, Task = 6, TestStep = 7, TestSet = 8, AutomationHost = 9, AutomationEngine = 10, RequirementStep = 12)
artifact_id The id of the artifact we want the attachments for
sort_by The sort to apply (Field ASC|DESC)

Request Body

Property Description

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