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/v7_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)
|
|
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
|
|
RequirementCount
|
The requirement count of the project
|
|
Guid
|
The unique identifier for the workspace
|
|
ConcurrencyGuid
|
The field used to track optimistic concurrency to prevent edit conflicts
It's a GUID, but we use the string representation to make compatibility easier
|
|
CustomProperties
|
The list of associated custom properties/fields for this workspace
|
<RemoteProject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyGuid i:nil="true" />
<CustomProperties i:nil="true" />
<Guid i:nil="true" />
<LastUpdatedDate i:nil="true" />
<WorkspaceTypeId>0</WorkspaceTypeId>
<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" />
<RequirementCount>0</RequirementCount>
<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,
"RequirementCount":0,
"WorkspaceTypeId":0,
"Guid":null,
"LastUpdatedDate":null,
"ArtifactTypeId":0,
"ConcurrencyGuid":null,
"CustomProperties":null}
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
|
|
RequirementCount
|
The requirement count of the project
|
|
WorkspaceTypeId
|
The type of workspace that we have
|
|
Guid
|
The unique identifier for the workspace
|
|
LastUpdatedDate
|
Last time this item was updated
|
|
ArtifactTypeId
|
The type of artifact that we have
|
|
ConcurrencyGuid
|
The field used to track optimistic concurrency to prevent edit conflicts
It's a GUID, but we use the string representation to make compatibility easier
|
|
CustomProperties
|
The list of associated custom properties/fields for this workspace
|
<RemoteProject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Inflectra.SpiraTest.Web.Services.v7_0.DataObjects">
<ArtifactTypeId>0</ArtifactTypeId>
<ConcurrencyGuid i:nil="true" />
<CustomProperties i:nil="true" />
<Guid i:nil="true" />
<LastUpdatedDate i:nil="true" />
<WorkspaceTypeId>0</WorkspaceTypeId>
<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" />
<RequirementCount>0</RequirementCount>
<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,
"RequirementCount":0,
"WorkspaceTypeId":0,
"Guid":null,
"LastUpdatedDate":null,
"ArtifactTypeId":0,
"ConcurrencyGuid":null,
"CustomProperties":null}