SpiraTeam: REST Web Service (v5.0)

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 (make sure to replace any parameters (eg {project_id}) with the relevant value (eg 1):

http://api.inflectra.com/Spira/Services/v5_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

Property Description

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.

Property Description