SpiraTeam: ImportExport SOAP Web Service

See all operations

RemoteDocument

Represents a document (attachment/url) in the system

Base Classes

None

Properties

The following properties are provided directly by this class:

Name Type Description Required
ArtifactIdint? The id of the artifact it's being attached to
ArtifactTypeIdint? 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 )
AttachmentIdint? The id of the attachment
AttachmentTypeIdintThe 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)
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
EditedDatedateTimeThe date/time the attachment was last edited Yes
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
ProjectAttachmentTypeIdint? The id of the attachment type relative to the current project
ProjectAttachmentTypeNamestring? 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 )
SizeintThe size of the attachment in bytes ( Pass 0 for a URL attachment ) Yes
Tagsstring? The list of meta-tags that should be associated with the attachment
UploadDatedateTimeThe date/time the attachment was uploaded Yes
VersionsArrayOfRemoteDocumentVersion? The list of document versions