Entity: Reminder

<< Back to GForge REST API

GET

getReminder

Search for reminders 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\ReminderBasic

Zero or more ReminderBasic records

Name	Type	Description
id	int	Id
section	string	Section the reminder belongs to
refId	int	Id of object the reminder is bound to
label	string	label for identifying a reminder
comments	string	Comments for the reminder
schedulingType	int	type Indicates the reminder schedule type (days, weeks, months, etc)
schedulingValue	int	type Indicates the reminder value (e.g.: 2 days, 1 week, etc)
targetDate	string	Date when the reminder is set for
createDate	string	Date when the reminder was created
status	int	status Indicates the status of the reminder
user	\gforge\core\models\api\UserBasic
extraData	object	any data to be saved in JSON format
notifyUsers	object	users to notify in JSON format

Example 1

Retrieve reminders for the specified tracker:

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


        POST
    
                
                        postReminder
            
                
                
                    Creates or updates a reminder
                
                
                    Parameters (1)
                    
                        
                            
                                
                                    Name
                                    Type
                                    Description
                                
                            
                            
                                                                
                                    request
                                    \mvcnphp\RequestParameters
                                    
                                
                                                            
                        
                    
                

                
                
                
                
                
                    Return: \api\ReminderBasic
                    
                        
                                            
                

                            
                    
            
        PUT
    
            
        DELETE
    
                
                        deleteReminder
            
                
                
                    Deletes a reminder
                
                
                    Parameters (1)
                    
                        
                            
                                
                                    Name
                                    Type
                                    Description
                                
                            
                            
                                                                
                                    request
                                    \mvcnphp\RequestParameters
                                    
                                
                                                            
                        
                    
                

                
                
                
                
                
                    Return: \api\ReminderBasic


                            
                    
                        Contents