Entity: Board

<< Back to GForge REST API

GET

getBoard

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

Parameters (1)

Name	Type	Description
request	\mvcnphp\RequestParameters

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

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 (1)
                    
                        
                            
                                
                                    Name
                                    Type
                                    Description
                                
                            
                            
                                                                
                                    request
                                    \mvcnphp\RequestParameters
                                    
                                
                                                            
                        
                    
                

                
                
                
                
                
                    Return: \api\BoardBasic
                    
                        
                                            
                

                            
                    
            
        PUT
    
            
        DELETE
    
                
                        deleteBoard
            
                
                
                    Deletes a board
                
                
                    Parameters (1)
                    
                        
                            
                                
                                    Name
                                    Type
                                    Description
                                
                            
                            
                                                                
                                    request
                                    \mvcnphp\RequestParameters
                                    
                                
                                                            
                        
                    
                

                
                
                
                
                
                    Return: \api\BoardBasic


                            
                    
                        Contents