<< Back to GForge REST API

Entity: Admin

GET

getAierrors

Returns a paged list of errored knowledge-source records for a project.

Parameters (5)

Name Type Description
id string Project numeric ID or unixName. URL segment.
sort_field string Field to sort by. Default index_date.
sort_dir string Sort direction: asc or desc. Default desc.
page_num int Page number (one-based). Default 1.
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: object

Object with total, page_num, page_size, and items fields.

getAiknowledgesources

Diagnostic sub-endpoint: count qualifying ref_ids for a section after applying the NOT EXISTS filter. Useful for human testing and troubleshooting.

Parameters (2)

Name Type Description
id string Project numeric ID or unixName. URL segment.
section string Content section to count (e.g. trackeritem). Required.

Return: object

Object with section (string) and count (int) fields.

getAisummary

Returns the knowledge-index dashboard summary for a project.

Parameters (1)

Name Type Description
id string Project numeric ID or unixName. URL segment.

Return: object

Object with project_totals and sections fields.

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

Returns the configuration of all scheduled cron jobs. Requires site admin access.

Parameters (0)

Name Type Description
No parameters

Return: array

The decoded cron job configuration data, or an empty array on 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

postAiqueueindex

Enqueue a background job to bulk-index knowledge sources for a project.

Parameters (2)

Name Type Description
id string Project numeric ID or unixName. URL segment.
sections string[] Array of content sections to index (e.g. ["trackeritem", "wikipage"]). Required.

Return: object

Object with job_id (int) field.

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)

postReindex

Resets index_status to pending for matching knowledge-source records.

Parameters (5)

Name Type Description
id string Project numeric ID or unixName. URL segment.
scope string Reindex scope: section or errors. Required.
section string Content section to reindex (e.g. trackeritem). Required when scope=section.
all bool When true, resets all errored sources. Used when scope=errors.
ids int[] Array of knowledge-source IDs to reset. Used when scope=errors and all is not set.

Return: object

Object with affected (int) field.

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