SpiraPlan: REST Web Service (v5.0)

See all operations

DELETE: projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/documents/{document_id}


Deletes an attachment from an artifact. The attachment will still remain in the project

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 current project
artifact_type_id The id of the type of artifact we want to remove the documents from: (Requirement = 1, TestCase = 2, Incident = 3, Release = 4, TestRun = 5, Task = 6, TestStep = 7, TestSet = 8)
artifact_id The id of the artifact we want to remove the attachment from
document_id The id of the document being removed

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.