SpiraPlan: REST Web Service (v4.0)

See all operations

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

Description

Adds an existing attachment to the specified artifact.

How to Execute

To access this REST web service, you need to use the following URL:

https://api.inflectra.com/Spira/Services/v4_0/RestService.svc/projects/{project_id}/artifact-types/{artifact_type_id}/artifacts/{artifact_id}/documents/{document_id}

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 add the documents to: (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 the attachments for
document_id The id of the document being added

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.