<< Back to GForge REST API

Entity: Frsrelease

GET

getBurnDown

Retrieve burndown chart data for the tracker items associated with the specified release.

Parameters (3)

Name Type Description
id int Release database ID.
start_date string Start date for the burndown range (format: Y-m-d). Optional.
end_date string End date for the burndown range (format: Y-m-d). Optional.

Return: array

Array with burndown information.

getDetails

Retrieve a single FRS release with full detail.

Parameters (2)

Name Type Description
releaseId int Database ID of the release to retrieve (route segment).
rel string Comma-separated related data to include. Supported: files, trove, tisummary, remaining.

Return: \gforge\plugins\frs\models\api\FrsReleaseBasic

Name Type Description
id int Unique database identifier for the Release
releaseDate string When was the release published
releaseName string Release name
isVisible \char Visibility status
preformatted \char Preserve pre-formatted text status
releaseNotes string Release Notes
changes string Changes
isReleased \char Released status
package \FrsPackageBasic Package
user \gforge\core\models\api\UserBasic

getRelease

Returns list of releases with package and file information.

Parameters (14)

Name Type Description
project string Project unix name or integer database ID (route segment).
sort_field string Field to sort by. Allowed values: releaseId, releaseDate, packageName, releaseName. Defaults to releaseId.
sort_dir string Sort direction: asc or desc. Defaults to desc.
page_num int 0-based page offset. Defaults to 0.
page_size int Number of items per page. Defaults to 20.
isPublic string Filter by visibility: Y for public, N for private.
isReleased string Filter by release status: Y for released, N for unreleased.
isVisible string Filter by visible flag: Y or N.
packageId int Return releases from the specified package only.
_textsearch string Full-text search string matched against packageName, releaseName, changes, releaseNotes and file content.
releaseDateFrom string Filter to releases on or after this date (format: Y-m-d).
releaseDateTo string Filter to releases on or before this date (format: Y-m-d).
recentReleases string When Y, return only the most recent release per package.
rel string Comma-separated related data to include. Supported: files, trove, tisummary, remaining.
Sortable
Use the sort_field and sort_dir parameters to control the order in which records are returned.
Pageable
Use the page_size and page_num parameters to control the set of records returned.

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

Name Type Description
id int Unique database identifier for the Release
releaseDate string When was the release published
releaseName string Release name
isVisible \char Visibility status
preformatted \char Preserve pre-formatted text status
releaseNotes string Release Notes
changes string Changes
isReleased \char Released status
package \FrsPackageBasic Package
user \gforge\core\models\api\UserBasic

getReleaseFile

Stream, open or retrieve metadata for a file attached to an FRS release.

Parameters (3)

Name Type Description
id int Release database ID (route segment).
fileId int Filesystem record ID of the file to retrieve (route segment).
option string Optional modifier: omit or open to stream the file inline; data to return file metadata only.

Return: (none)

Example 1

Retrieve binary object for a specified release ID and file ID: 
  GET http://api.mygforge.tld/frsrelease/2/attachment/5

POST

postFrsRelease

Create or update an FRS release.

Parameters (7)

Name Type Description
id int Database ID of the release to update, or 0 to create a new one.
package int Parent package database ID (required when creating a new release).
releaseName string Name of the release.
isReleased string Whether the release is publicly available: Y or N.
releaseNotes string Release notes text.
changes string Change log text.
releaseDate string Release date (format: Y-m-d). Auto-set to today when first releasing.

Return: array

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

postReleaseFile

Attach a previously uploaded chunk file to an FRS release.

Parameters (4)

Name Type Description
id int Release database ID.
hash string Chunked-upload hash identifying the uploaded file.
fileName string Original filename to store.
fileType string MIME type of the file.

Return: array

Array with location key (API URL) and file key (FilesystemBasic object).

PUT

DELETE

deleteFrsRelease

Delete an FRS release by its database ID.

Parameters (1)

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

Return: array

Array with result key set to success.

deleteReleaseFile

Remove a file from an FRS release.

Parameters (2)

Name Type Description
id int Release database ID (route segment).
fileId int Filesystem record ID of the file to delete (route segment).

Return: array

Array with result key set to success.