Entity: Board

<< Back to GForge REST API

GET

getBoard

Search for boards given a combination of: section, refId and user.

Parameters (11)

Name	Type	Description
id	int	Board id. When provided, returns a single record.
project	string	Project id or unix name. Required.
section	string	Section the board belongs to (e.g. `tracker`). Optional.
refId	int	Id of the object the board belongs to. Optional.
user	string	User id or unix name to filter by board owner. Optional.
boardName	string	Board name filter. Optional.
isShared	string	Filter by shared status. Optional.
sort_field	string	Field to sort by. Options: section, refId, userId, boardName, isShared. Default `boardName`.
sort_dir	string	Sort direction: `asc` or `desc`. Default `asc`.
page_num	int	Page number (zero-based). Default `0`.
page_size	int	Records per page. Default `20`.

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\core\models\api\BoardBasic

Single record or zero or more BoardBasic records.

Name	Type	Description
id	int	Id
section	string	Section the board belongs to
refId	int	Id of object the board is bound to
boardName	string	Name of the board
description	string	Description for the board
isShared	bool	isShared
createDate	string	Date when the board was created
user	\gforge\core\models\api\UserBasic
project	\gforge\core\models\api\ProjectBasic
config	object	config data for the board

Example 1

Retrieve boards for the specified tracker:

  GET http://api.mygforge.tld/board/?section=tracker&refId=335

POST

postBoard

Creates or updates a board.

Parameters (4)

Name	Type	Description
id	int	Board id. When provided, updates the existing board.
section	string	Section the board belongs to (e.g. `tracker`). Required.
refId	int	Id of the object the board belongs to. Required.
project	int	Project id. Required.

Return: \gforge\core\models\api\BoardBasic

The created or updated board.

Name	Type	Description
id	int	Id
section	string	Section the board belongs to
refId	int	Id of object the board is bound to
boardName	string	Name of the board
description	string	Description for the board
isShared	bool	isShared
createDate	string	Date when the board was created
user	\gforge\core\models\api\UserBasic
project	\gforge\core\models\api\ProjectBasic
config	object	config data for the board

PUT

DELETE

deleteBoard

Deletes a board.

Parameters (1)

Name	Type	Description
id	int	Board id. Required.

Return: void