See all operations
POST: projects/{project_id}/documents/search?start_row={start_row}&number_rows={number_rows}&sort_by={sort_by}
Description
Retrieves a filtered list of documents/attachments in a project across all folders
How to Execute
To access this REST web service, you need to use the following URL:
https://api.inflectra.com/Spira/Services/v4_0/RestService.svc/projects/{project_id}/documents/search?start_row={start_row}&number_rows={number_rows}&sort_by={sort_by}
Request Parameters
Name
|
Description
|
project_id
|
The id of the current project
|
start_row
|
The first row to return (starting with 1)
|
number_rows
|
The number of rows to return
|
sort_by
|
The name of the column to sort by (ascending)
|
Request Body
<ArrayOfRemoteFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v4_0.DataObjects">
<RemoteFilter>
<DateRangeValue i:nil="true" />
<IntValue i:nil="true" />
<MultiValue i:nil="true" />
<PropertyName i:nil="true" />
<StringValue i:nil="true" />
</RemoteFilter>
</ArrayOfRemoteFilter>
[{"DateRangeValue":null,
"IntValue":null,
"MultiValue":null,
"PropertyName":null,
"StringValue":null}]
Return Data
The JSON and XML examples below show the shape of one entry that will be returned. It does not show an example of how that entry will be populated.
<ArrayOfRemoteDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v4_0.DataObjects">
<RemoteDocument>
<ArtifactId i:nil="true" />
<ArtifactTypeId i:nil="true" />
<AttachmentId i:nil="true" />
<AttachmentTypeId>0</AttachmentTypeId>
<AttachmentTypeName i:nil="true" />
<AuthorId i:nil="true" />
<AuthorName i:nil="true" />
<CurrentVersion i:nil="true" />
<Description i:nil="true" />
<EditedDate>0001-01-01T00:00:00</EditedDate>
<EditorId i:nil="true" />
<EditorName i:nil="true" />
<FilenameOrUrl i:nil="true" />
<ProjectAttachmentFolderId i:nil="true" />
<ProjectAttachmentTypeId i:nil="true" />
<ProjectAttachmentTypeName i:nil="true" />
<Size>0</Size>
<Tags i:nil="true" />
<UploadDate>0001-01-01T00:00:00</UploadDate>
<Versions i:nil="true" />
</RemoteDocument>
</ArrayOfRemoteDocument>
[{"ArtifactId":null,
"ArtifactTypeId":null,
"AttachmentId":null,
"AttachmentTypeId":0,
"AttachmentTypeName":null,
"AuthorId":null,
"AuthorName":null,
"CurrentVersion":null,
"Description":null,
"EditedDate":"\/Date(-62135578800000-0500)\/",
"EditorId":null,
"EditorName":null,
"FilenameOrUrl":null,
"ProjectAttachmentFolderId":null,
"ProjectAttachmentTypeId":null,
"ProjectAttachmentTypeName":null,
"Size":0,
"Tags":null,
"UploadDate":"\/Date(-62135578800000-0500)\/",
"Versions":null}]