SpiraPlan: REST Web Service (v7.0)

See all operations

POST: projects/{project_id}/documents/{document_id}/versions/file?make_current={make_current}

Description

Adds a new version to a file attachment in the system

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

https://api.inflectra.com/Spira/Services/v7_0/RestService.svc/projects/{project_id}/documents/{document_id}/versions/file?make_current={make_current}

Request Parameters

Name Description
project_id The id of the current project
document_id The id of the document that we're adding this new version to
make_current Should we make this the current version

Request Body

Property Description
BinaryData The file data base64 encoded if using the REST service
AttachmentVersionId The id of the document version
AttachmentVersionGuid The unique identifier for the artifact
AttachmentId The id of the document
AttachmentGuid The unique identifier for the artifact
AuthorId The id of the user that uploaded the version If no value is provided, the authenticated user is used
FilenameOrUrl The filename of the file (if a file attachment) or the full URL if a URL attachment
Description The description of the attachment version
UploadDate The date/time the attachment version was uploaded
Size The size of the attachment version in bytes Pass 0 for a URL attachment
VersionNumber The version number
AuthorName The display name of the user that uploaded the attachment version
IsActive Discerns whether this is the current active version of this document

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
AttachmentVersionId The id of the document version
AttachmentVersionGuid The unique identifier for the artifact
AttachmentId The id of the document
AttachmentGuid The unique identifier for the artifact
AuthorId The id of the user that uploaded the version If no value is provided, the authenticated user is used
FilenameOrUrl The filename of the file (if a file attachment) or the full URL if a URL attachment
Description The description of the attachment version
UploadDate The date/time the attachment version was uploaded
Size The size of the attachment version in bytes Pass 0 for a URL attachment
VersionNumber The version number
AuthorName The display name of the user that uploaded the attachment version
IsActive Discerns whether this is the current active version of this document