SpiraPlan: SoapService SOAP Web Service

See all operations

RemoteDocument

Represents a document (attachment/url) in the system

Base Classes

This class extends the following base classes:

Properties

The following properties are provided directly by this class:

Name Type Description Required
AttachedArtifactsArrayOfRemoteLinkedArtifact? The list of artifacts the document is attached to
AttachmentIdint? The id of the attachment
AttachmentTypeIdint The id of the attachment type ( File = 1, URL = 2 ) Yes
AttachmentTypeNamestring? The display name of the attachment type (i.e. whether it's a file or url)
AuthorGuidstring? The guid of the author.
AuthorIdint? The id of the user that uploaded the attachment ( If no value is provided, the authenticated user is used )
AuthorNamestring? The display name of the user that uploaded the attachment
CurrentVersionstring? The version name of the current attachment
Descriptionstring? The description of the attachment
DocumentStatusIdint? The id of the document status relative to the current project template
DocumentStatusNamestring? The display name of the document status relative to the current project template
DocumentTypeIdint? The id of the document type relative to the current project template
DocumentTypeNamestring? The display name of the attachment type relative to the current project template ( This is not whether it's a file or url, but the project-template specific classification )
EditedDatedateTime The date/time the attachment was last edited Yes
EditorGuidstring? The guid of the editor.
EditorIdint? The id of the user that edited the document
EditorNamestring? The display name of the user that edited the document
FilenameOrUrlstring? The filename of the file (if a file attachment) or the full URL if a URL attachment
ProjectAttachmentFolderIdint? The id of the attachment folder id for the current project
Sizeint The size of the attachment in bytes ( Pass 0 for a URL attachment ) Yes
UploadDatedateTime The date/time the attachment was uploaded Yes
VersionsArrayOfRemoteDocumentVersion? The list of document versions