SpiraTeam: REST Web Service (v4.0)

See all operations

POST: projects/{project_id}/documents/file?filename={filename}&tags={tags}&folder_id={folder_id}&document_type_id={document_type_id}&artifact_type_id={artifact_type_id}&artifact_id={artifact_id}

Description

Adds a new document (file) into the system and associates it with the provided artifact (optional) and project folder/type (optional)

How to Execute

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

http://api.inflectra.com/Spira/Services/v4_0/RestService.svc/projects/{project_id}/documents/file?filename={filename}&tags={tags}&folder_id={folder_id}&document_type_id={document_type_id}&artifact_type_id={artifact_type_id}&artifact_id={artifact_id}

Request Parameters

Name Description
project_id The id of the current project
filename The filename to give the uploaded file
tags Any meta-tags, comma separated
folder_id The id of the document folder to put the file in
document_type_id The id of the document type to associate with
artifact_type_id The id of the type of artifact to attach it to
artifact_id The id of the an artifact to attach it to

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
AttachmentId The id of the attachment
AttachmentTypeId The id of the attachment type File = 1, URL = 2
ProjectAttachmentTypeId The id of the attachment type relative to the current project
ProjectAttachmentFolderId The id of the attachment folder id for the current project
ArtifactTypeId The id of the type of artifact it's attached to Requirement = 1, TestCase = 2, Incident = 3, Release = 4, TestRun = 5, Task = 6, TestStep = 7, TestSet = 8
ArtifactId The id of the artifact it's being attached to
AuthorId The id of the user that uploaded the attachment If no value is provided, the authenticated user is used
EditorId The id of the user that edited the document
FilenameOrUrl The filename of the file (if a file attachment) or the full URL if a URL attachment
Description The description of the attachment
UploadDate The date/time the attachment was uploaded
EditedDate The date/time the attachment was last edited
Size The size of the attachment in bytes Pass 0 for a URL attachment
CurrentVersion The version name of the current attachment
Tags The list of meta-tags that should be associated with the attachment
Versions The list of document versions
ProjectAttachmentTypeName The display name of the attachment type relative to the current project This is not whether it's a file or url, but the project-specific classification
AttachmentTypeName The display name of the attachment type (i.e. whether it's a file or url)
AuthorName The display name of the user that uploaded the attachment
EditorName The display name of the user that edited the document