<< Back to GForge REST API

Entity: Report

GET

getCheck

API Method. Gets the health check evaluation for the specified criteria.

Parameters (3)

Name Type Description
project int|string The ID or unixName for a single project to be scanned.
tracker int The ID for a single tracker to be scanned. If this parameter is specified, $project is ignored.
user int|string The ID or unixName for a single user to be scanned. If this parameter is specified, $project and $tracker are ignored.

Return: array

A simple array of assoc arrays, each entry representing a single health check result. Note that a single check can return multiple result records.

getDiskUsage

Gets the needed data for disk usage report

Parameters (1)

Name Type Description
request \RequestParameters

Return: array

disk usage info array.

getReport

Gets the data needed to download the report.

Parameters (4)

Name Type Description
projectId mixed The int ID for the desired project.
format string The string defining the format for the file (json, csv, xml)
download bool A boolean in true just to comunicate to RestExportService that it should download the file.
type string The string defining the report to download (activity, trackers, etc)

Return: array

List of items according to the selected report.

getScmCommitInfo

Gets the needed data for disk usage report

Parameters (1)

Name Type Description
request \RequestParameters

Return: array

disk usage info array.

getScmDetails

Gets the needed data for commits detailed info

Parameters (1)

Name Type Description
request \RequestParameters

Return: \a

collection of commits that acomplish the specified filters.

getSite

Gets the data needed to download the report.

Parameters (4)

Name Type Description
projectId mixed The int ID for the desired project.
format string The string defining the format for the file (json, csv, xml)
download bool A boolean in true just to comunicate to RestExportService that it should download the file.
type string The string defining the report to download (activity, trackers, etc)

Return: array

List of items according to the selected report.

getTrackersInfo

Gets the needed data for tracker reports

Parameters (2)

Name Type Description
request \RequestParameters
model \Project The project in which to retrieve data

Return: array

trackerIterms grouped according to the needed info, status, tracker, assignee, etc.

POST

PUT

DELETE