SpiraPlan: REST Web Service (v7.0)

See all operations

GET: projects/{project_id}


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


Request Parameters

Name Description
project_id The id of the project being requested

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