See all operations

GET: projects/{project_id}

Description

Retrieves a single project in the system

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}

Request Parameters

Name	Description
project_id	The id of the project being requested

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
ProjectId	The id of the project (integer)
ProjectTemplateId	The id of the project template (null on create, means create a new template)
ProjectGroupId	The id of the project group / program (null on create, means use default group)
Name	The name of the project (string)
Description	The description of the project (string)
Website	The url associated with the project (string)
CreationDate	The date/time the project was created (datetime)
Active	Whether the project is active or not (boolean)
WorkingHours	How many working hours are in a day for this project (integer)
WorkingDays	How many working days are in a week for this project (integer)
NonWorkingHours	How many special non-working hours are there in a month in the project (integer)
StartDate	The start date of the project for planning purposes
EndDate	The end date of the project for planning purposes
PercentComplete	The percentage complete of the project

<RemoteProject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v6_0.DataObjects">
  <Active>true</Active>
  <CreationDate>0001-01-01T00:00:00</CreationDate>
  <Description i:nil="true" />
  <EndDate i:nil="true" />
  <Name i:nil="true" />
  <NonWorkingHours>0</NonWorkingHours>
  <PercentComplete>0</PercentComplete>
  <ProjectGroupId i:nil="true" />
  <ProjectId i:nil="true" />
  <ProjectTemplateId i:nil="true" />
  <StartDate i:nil="true" />
  <Website i:nil="true" />
  <WorkingDays>0</WorkingDays>
  <WorkingHours>0</WorkingHours>
</RemoteProject>

{"ProjectId":null,
"ProjectTemplateId":null,
"ProjectGroupId":null,
"Name":null,
"Description":null,
"Website":null,
"CreationDate":"0001-01-01T00:00:00",
"Active":true,
"WorkingHours":0,
"WorkingDays":0,
"NonWorkingHours":0,
"StartDate":null,
"EndDate":null,
"PercentComplete":0}