<< Back to GForge REST API

Entity: Admin

GET

getCron

Searches for cron history matching criteria, or gets a specific record by ID.

Parameters (8)

Name Type Description
sort_field string Field to sort by (In search requests). (Options include id, rundate, job) Not required
sort_dir string Direction to sort (In search requests). (Either asc or desc) Not required
page_num int Page number of request (In search requests). Not required
page_size int Number of entries to show per request (In search requests). Not required
id int The specific, unique ID to be retrieved. Other params are ignored.
dateStart string Return entries *after* this date. Not required
dateEnd string Return entries *before* this date. Not required
job string Filter entries by this job name (automatically wildcarded). Not required
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: array

Array of data rows, each of which is an associative array of the output values (id, job, rundate, output)

getCronjobs

Retrieves the configuration of cron jobs.

Parameters (1)

Name Type Description
request \RequestParameters The request parameters provided to fetch cron job configurations.

Return: array

The decoded configuration data for cron jobs, or an empty array in case of an error.

getNotification

Searches for notification records matching criteria, or gets a specific record by ID.

Parameters (13)

Name Type Description
id int The specific, unique ID to be retrieved. Other params are ignored.
sort_field string Field to sort by (In search requests). (Options include id, rundate, job) Not required
sort_dir string Direction to sort (In search requests). (Either asc or desc) Not required
page_num int Page number of request (In search requests). Not required
page_size int Number of entries to show per request (In search requests). Not required
project string ID or unixName for the project in which to search.
section string Section in which to search (site, project, trackeritem, etc)
refId string Identifier to match within section. Section is required if refId is specified.
user string Unixname of the notification's author
subject string Text search in the subject line of the notification
dateRange string Return entries *after* this date. Not required
dateStart string Return entries *after* this date. Not required
dateEnd string Return entries *before* this date. Not required
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: array

Array of data rows, each of which is an associative array of the output values (id, job, rundate, output)

POST

postCronjob

Update a single cronjob status. It expects the cronname to update in the url, and the status as a json object

POST /api/admin/0/cronjobs/cronName

Parameters (0)

Name Type Description
No parameters

Return: (none)

PUT

putCronJobs

Update cronjob statuses, accepts a full or partial list of cronjobs with their respective status. Unlisted cronjobs are ignored

Parameters (0)

Name Type Description
No parameters

Return: (none)

DELETE