See all operations

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

Description

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

https://api.inflectra.com/spira/services/v6_0/RestService.svc/projects/{project_id}/components/{component_id}

Request Parameters

Name	Description
project_id	The id of the project
component_id	The id of the component

Request Body

Nothing Expected

Nothing Expected

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)

<RemoteComponent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
  <ComponentId i:nil="true" />
  <IsActive>true</IsActive>
  <IsDeleted>false</IsDeleted>
  <Name i:nil="true" />
  <ProjectId>0</ProjectId>
</RemoteComponent>

{"ComponentId":null,
"ProjectId":0,
"Name":null,
"IsActive":true,
"IsDeleted":false}