<< Back to GForge REST API

Entity: Frsrelease

GET

getBurnDown

Retrieves Release Burndown data

Parameters (1)

Name Type Description
id no type Release Id

Return: array

Array with burndown information

getDetails

Retrieves Release data

Parameters (2)

Name Type Description
id int release Id
rel string comma delimited related information

Return: \models\api\FrsReleaseBasic[]

No return type is defined

getRelease

Returns list of releases with package and file information

Parameters (10)

Name Type Description
sort_fields string Sort by this field. Allowed fields are: id, releaseDate, packageName and releaseName.
sort_dir string Direction of sorting. Allowed options 'asc' and 'desc'.
page_num int Number of the page. Page 1 by default
page_size int Size of each page. 20 Items by default.
isPublic \char Filter by public or private releases. Allowed options 'Y' and 'N'.
isReleased \char Filter by released or non-released releases. Allowed options 'Y' and 'N'.
packageId int Return releases from specified package only
_textsearch string Filter by specified string fields packageName, releaseName, changes, releaseNotes, and files content.
releaseDateFrom string Filter by release date
releaseDateTo string Filter by release data

Return: \models\api\FrsReleaseBasic[]

No return type is defined

getReleaseFile

Get binary object corresponding to a file for a given release id

Parameters (1)

Name Type Description
request \mvcnphpRequestParameters See description for details about expected properties.

Return: (none)

No return type is defined

Example 1

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

POST

postFrsRelease

Creates or edit a release. Expected parameters in the Request object are:

  • package:
  • id:
  • releaseName:
  • isReleased:
  • releaseNotes:
  • changes:
URL example: curl -u gforgeadmin:gforgeadmin \ -X POST \ --header "Content-Type: application/json" \ --header "X-Requested-With: XMLHttpRequest" \ --url http://n.gforge.vm/api/frsrelease/1/?project=1&releaseName=gforge%20v1.1&isReleased=Y&releaseNotes=xyzxyzxyz&changes=xyzxyzxyz

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: (none)

No return type is defined

postReleaseFile

Processes a release file upload

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: array

Array with API location to file and resulting file object

PUT

PUT is not available

DELETE

deleteFrsRelease

Deletes a release. Expected parameters in the Request object are:

  • id:
URL example: curl -u gforgeadmin:gforgeadmin \ -X DELETE \ --header "Content-Type: application/json" \ --header "X-Requested-With: XMLHttpRequest" \ --url http://n.gforge.vm/api/frsrelease/1

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: (none)

No return type is defined

deleteReleaseFile

Processes a release file delete

Parameters (1)

Name Type Description
request \mvcnphp\RequestParameters Request object

Return: (none)

No return type is defined