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 |
|---|---|---|---|
| AttachedArtifacts | ArrayOfRemoteLinkedArtifact? | The list of artifacts the document is attached to | |
| AttachmentId | int? | The id of the attachment | |
| AttachmentTypeId | int | The id of the attachment type ( File = 1, URL = 2 ) | Yes |
| AttachmentTypeName | string? | The display name of the attachment type (i.e. whether it's a file or url) | |
| AuthorGuid | string? | The guid of the author. | |
| AuthorId | int? | The id of the user that uploaded the attachment ( If no value is provided, the authenticated user is used ) | |
| AuthorName | string? | The display name of the user that uploaded the attachment | |
| CurrentVersion | string? | The version name of the current attachment | |
| Description | string? | The description of the attachment | |
| DocumentStatusId | int? | The id of the document status relative to the current project template | |
| DocumentStatusName | string? | The display name of the document status relative to the current project template | |
| DocumentTypeId | int? | The id of the document type relative to the current project template | |
| DocumentTypeName | string? | 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 ) | |
| EditedDate | dateTime | The date/time the attachment was last edited | Yes |
| EditorGuid | string? | The guid of the editor. | |
| EditorId | int? | The id of the user that edited the document | |
| EditorName | string? | The display name of the user that edited the document | |
| FilenameOrUrl | string? | The filename of the file (if a file attachment) or the full URL if a URL attachment | |
| ProjectAttachmentFolderId | int? | The id of the attachment folder id for the current project | |
| Size | int | The size of the attachment in bytes ( Pass 0 for a URL attachment ) | Yes |
| UploadDate | dateTime | The date/time the attachment was uploaded | Yes |
| Versions | ArrayOfRemoteDocumentVersion? | The list of document versions |