SpiraPlan: SoapService SOAP Web Service

See all operations

Document_RetrieveForFolder

Description

Retrieves a filtered list of documents/attachments in a project for the specified folder

Example(s)

            RemoteFilter remoteFilter = new RemoteFilter();
            remoteFilter.PropertyName = "Filename";
            remoteFilter.StringValue = "test_data";
            remoteSort.PropertyName = "Filename";
            remoteSort.SortAscending = true;
            remoteDocuments = spiraImportExport.Document_RetrieveForFolder(credentials, projectId, projectAttachmentFolderId, new RemoteFilter[] { remoteFilter }, remoteSort, 1, 999);
            

Parameters

Type Name Required
RemoteCredentials? credentials - The API credentials
intprojectId - The id of the project Yes
intfolderId - The id of the project attachment folder Yes
ArrayOfRemoteFilter? remoteFilters - The list of filters to apply
RemoteSort? remoteSort - The sort to apply
intstartingRow - The first row to return (starting with 1) Yes
intnumberRows - The number of rows to return Yes

Return Value

ArrayOfRemoteDocument - List of documents