Click here for a complete list of operations.
Document_AddFile
Adds a new document (file) into the system and associates it with the provided artifact (optional) and project folder/type (optional)
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /spira/services/v2_2/ImportExport.asmx HTTP/1.1
Host: api.inflectra.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.inflectra.com/SpiraTest/Services/v2.2/Document_AddFile"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<Document_AddFile xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
<remoteDocument>
<AttachmentId>int</AttachmentId>
<AttachmentTypeId>int</AttachmentTypeId>
<ProjectAttachmentTypeId>int</ProjectAttachmentTypeId>
<ProjectAttachmentFolderId>int</ProjectAttachmentFolderId>
<ArtifactTypeId>int</ArtifactTypeId>
<ArtifactId>int</ArtifactId>
<AuthorId>int</AuthorId>
<EditorId>int</EditorId>
<FilenameOrUrl>string</FilenameOrUrl>
<Description>string</Description>
<UploadDate>dateTime</UploadDate>
<EditedDate>dateTime</EditedDate>
<Size>int</Size>
<CurrentVersion>string</CurrentVersion>
<Tags>string</Tags>
</remoteDocument>
<binaryData>base64Binary</binaryData>
</Document_AddFile>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<Document_AddFileResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
<Document_AddFileResult>
<AttachmentId>int</AttachmentId>
<AttachmentTypeId>int</AttachmentTypeId>
<ProjectAttachmentTypeId>int</ProjectAttachmentTypeId>
<ProjectAttachmentFolderId>int</ProjectAttachmentFolderId>
<ArtifactTypeId>int</ArtifactTypeId>
<ArtifactId>int</ArtifactId>
<AuthorId>int</AuthorId>
<EditorId>int</EditorId>
<FilenameOrUrl>string</FilenameOrUrl>
<Description>string</Description>
<UploadDate>dateTime</UploadDate>
<EditedDate>dateTime</EditedDate>
<Size>int</Size>
<CurrentVersion>string</CurrentVersion>
<Tags>string</Tags>
</Document_AddFileResult>
</Document_AddFileResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /spira/services/v2_2/ImportExport.asmx HTTP/1.1
Host: api.inflectra.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<Document_AddFile xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
<remoteDocument>
<AttachmentId>int</AttachmentId>
<AttachmentTypeId>int</AttachmentTypeId>
<ProjectAttachmentTypeId>int</ProjectAttachmentTypeId>
<ProjectAttachmentFolderId>int</ProjectAttachmentFolderId>
<ArtifactTypeId>int</ArtifactTypeId>
<ArtifactId>int</ArtifactId>
<AuthorId>int</AuthorId>
<EditorId>int</EditorId>
<FilenameOrUrl>string</FilenameOrUrl>
<Description>string</Description>
<UploadDate>dateTime</UploadDate>
<EditedDate>dateTime</EditedDate>
<Size>int</Size>
<CurrentVersion>string</CurrentVersion>
<Tags>string</Tags>
</remoteDocument>
<binaryData>base64Binary</binaryData>
</Document_AddFile>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<Document_AddFileResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
<Document_AddFileResult>
<AttachmentId>int</AttachmentId>
<AttachmentTypeId>int</AttachmentTypeId>
<ProjectAttachmentTypeId>int</ProjectAttachmentTypeId>
<ProjectAttachmentFolderId>int</ProjectAttachmentFolderId>
<ArtifactTypeId>int</ArtifactTypeId>
<ArtifactId>int</ArtifactId>
<AuthorId>int</AuthorId>
<EditorId>int</EditorId>
<FilenameOrUrl>string</FilenameOrUrl>
<Description>string</Description>
<UploadDate>dateTime</UploadDate>
<EditedDate>dateTime</EditedDate>
<Size>int</Size>
<CurrentVersion>string</CurrentVersion>
<Tags>string</Tags>
</Document_AddFileResult>
</Document_AddFileResponse>
</soap12:Body>
</soap12:Envelope>