SpiraPlan: REST Web Service (v5.0)

See all operations

GET: projects/{project_id}/components/{component_id}


Retrieves a single component by its ID

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
component_id The id of the component

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
ComponentId The id of the Component (id - integer)
ProjectId The id of the project the component belongs to (id - integer)
Name The name of the Component (string)
IsActive Is the component active (boolean)
IsDeleted Is the component deleted (boolean)