See all operations
POST: projects?existing_project_id={existing_project_id}
Description
Creates a new project in the system and makes the authenticated user owner of it. "Name" is the only required field in the body of the request (eg {"Name": "New 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):
https://api.inflectra.com/Spira/Services/v5_0/RestService.svc/projects?existing_project_id={existing_project_id}
Request Parameters
Name
|
Description
|
existing_project_id
|
The id of an existing project to use as a template. Enter "...projects?existing_project_id" to use the default template
|
Request Body
Property
|
Description
|
ProjectId
|
The id of the project (integer)
|
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)
|
<RemoteProject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<Active>true</Active>
<CreationDate>0001-01-01T00:00:00</CreationDate>
<Description i:nil="true" />
<Name i:nil="true" />
<NonWorkingHours>0</NonWorkingHours>
<ProjectId i:nil="true" />
<Website i:nil="true" />
<WorkingDays>0</WorkingDays>
<WorkingHours>0</WorkingHours>
</RemoteProject>
{"Active":true,
"CreationDate":"\/Date(-62135578800000-0500)\/",
"Description":null,
"Name":null,
"NonWorkingHours":0,
"ProjectId":null,
"Website":null,
"WorkingDays":0,
"WorkingHours":0}
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)
|
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)
|
<RemoteProject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v5_0.DataObjects">
<Active>true</Active>
<CreationDate>0001-01-01T00:00:00</CreationDate>
<Description i:nil="true" />
<Name i:nil="true" />
<NonWorkingHours>0</NonWorkingHours>
<ProjectId i:nil="true" />
<Website i:nil="true" />
<WorkingDays>0</WorkingDays>
<WorkingHours>0</WorkingHours>
</RemoteProject>
{"Active":true,
"CreationDate":"\/Date(-62135578800000-0500)\/",
"Description":null,
"Name":null,
"NonWorkingHours":0,
"ProjectId":null,
"Website":null,
"WorkingDays":0,
"WorkingHours":0}