<< Back to GForge REST API

Entity: Reminder

GET

getReminder

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

Parameters (9)

Name Type Description
id int Reminder id. When provided, returns a single record.
section string Section of the related object (e.g. tracker). Required for list queries.
refId int Id of the related object. Required for list queries.
user string User id or unix name to filter by owner. Optional.
label string Label text to filter by. Optional.
sort_field string Field to sort by. Options: section, refId, userId, label. Default label.
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\ReminderBasic

Single record or 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 (3)

Name Type Description
id int Reminder id. When provided, updates the existing reminder.
section string Section of the related object (e.g. tracker). Required.
refId int Id of the related object. Required.

Return: \gforge\core\models\api\ReminderBasic

The created or updated reminder.

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

PUT

DELETE

deleteReminder

Deletes a reminder.

Parameters (1)

Name Type Description
id int Reminder id. Required.

Return: void