SpiraPlan: REST Web Service (v7.0)

See all operations

GET: projects/{project_id}/components?active_only={active_only}&include_deleted={include_deleted}


Retrieves a list of all the components in the current project

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):


Request Parameters

Name Description
project_id The id of the project
active_only Do we want to only include active components (set to true or false: eg "...active_only=true")
include_deleted Should we include deleted components (set to true or false: eg "...include_deleted=false")

Request Body

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