SpiraPlan: SoapService SOAP Web Service
See all operations
Document_RetrieveForArtifact
Description
Retrieves a filtered list of documents/attachments in a project attached to a specific artifact
Example(s)
remoteFilter = new RemoteFilter();
remoteFilter.PropertyName = "Filename";
remoteFilter.StringValue = "test_data2";
remoteSort.PropertyName = "AttachmentId";
remoteSort.SortAscending = true;
remoteDocuments = spiraImportExport.Document_RetrieveForArtifact(credentials, projectId, (int)DataModel.Artifact.ArtifactTypeEnum.TestCase, testCaseId1, new RemoteFilter[] { remoteFilter }, remoteSort);
Parameters
| Type | Name | Required |
|---|---|---|
| RemoteCredentials? | credentials - The API credentials | |
| int | projectId - The id of the project | Yes |
| int | artifactTypeId - The id of the type of artifact we want to retrieve the documents for: (Requirement = 1, TestCase = 2, Incident = 3, Release = 4, TestRun = 5, Task = 6, TestStep = 7, TestSet = 8) | Yes |
| int | artifactId - The id of the artifact we want the attachments for | Yes |
| ArrayOfRemoteFilter? | remoteFilters - The list of filters to apply | |
| RemoteSort? | remoteSort - The sort to apply |
Return Value
ArrayOfRemoteDocument - List of documents