<< Back to GForge REST API

Entity: Trove

GET

getProjects

Returns all projects tagged with the given trove category (and its descendants).

Parameters (1)

Name Type Description
id int Trove category id. Required.

Return: \gforge\core\models\api\ProjectBasic[]

Zero or more ProjectBasic records.

Name Type Description
id int Unique database identifier for the project
name string Name of the project
unixName string Short, unix-friendly identifier for the project. This is usually also the project's shell logon.
description string Public description for the project
homepageUrl string GFAS url for the project
createDate \DateTime Date of project creation
isPublic string Returns "Y" if the project is public, "N" otherwise
status string Returns the status code for the project
isTemplate string Returns "Y" if the project is a template
templateProjectId int Returns the project used as template for this project
parentProjectId string Returns the parent project id for this project --- used as output, not allowed for input
averageRating int Returns the average rate for the project

getTrove

Returns all trove categories.

Parameters (0)

Name Type Description
No parameters

Return: \gforge\core\models\api\TroveCategoryBasic[]

Zero or more TroveCategoryBasic records.

Name Type Description
id int Unique database identifier for the Trove Category
categoryName string Trove Category name
description string Trove Category description
alias string Trove Category alias
showInSearch string Trove Category showInSearch
rootCategoryId int Trove Category rootCategoryId
parentCategoryId int Trove Category parentCategoryId
accessLevel int Trove Category accessLevel

Example 1

Get all trove categories: 
  GET http://gforge.api/trove

POST

postTrove

Creates or updates a trove category. Requires site admin access.

Parameters (7)

Name Type Description
id int Trove category id. When provided and non-zero, updates the existing record.
alias string Alias for the category. Required for new records.
categoryName string Display name for the category. Required for new records.
description string Description of the category. Optional.
showInSearch string Set to Y to include in search. Optional.
accessLevel int Access level for the category. Optional.
parentCategoryId int Id of the parent category. Required for new records.

Return: \gforge\core\models\api\TroveCategoryBasic

The created or updated category.

Name Type Description
id int Unique database identifier for the Trove Category
categoryName string Trove Category name
description string Trove Category description
alias string Trove Category alias
showInSearch string Trove Category showInSearch
rootCategoryId int Trove Category rootCategoryId
parentCategoryId int Trove Category parentCategoryId
accessLevel int Trove Category accessLevel

PUT

DELETE

deleteTrove

Deletes a trove category. Requires site admin access.

Parameters (1)

Name Type Description
id int Trove category id. Required.

Return: void