<< Back to GForge REST API

Entity: Frspackage

GET

getPackage

Return all FRS packages visible to the current user for the specified project.

Parameters (1)

Name Type Description
project string Project unix name or integer database ID (route segment).

Return: \gforge\plugins\frs\models\api\FrsPackageBasic[]

Name Type Description
id int Unique database identifier for the Package
packageName string Package name
isVisible \char Visibility status
isPublic \char Public/private status
requireLogin \char Require login status
project \gforge\core\models\api\ProjectBasic Project
releases \FrsReleaseBasic[] List of releases

POST

postFrsPackage

Create or update an FRS package.

Parameters (6)

Name Type Description
id int Database ID of the package to update, or 0 to create a new one.
project int Project database ID (required when creating a new package).
packageName string Name of the package.
isVisible bool Whether the package is visible in the file listing.
isPublic bool Whether the package is publicly accessible.
requireLogin bool Whether a login is required to download files from this package.

Return: array

Array with location key containing the API URL of the resulting package.

PUT

DELETE

deleteFrsPackage

Delete an FRS package by its database ID.

Parameters (1)

Name Type Description
id int Database ID of the package to delete.

Return: array

Array with result key set to success.