<< Back to GForge REST API

Entity: Activitylog

GET

getActivityLog

Fetch an activity log entry, or a list of entries.

Parameters (9)

Name Type Description
id int Activity log id. When provided, returns a single record.
sort_field string Field to sort by. Options: id, date, section, refId, description, activityType, url, userId, projectId. Default id.
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.
userId int Filter by user id.
projectId int Filter by project id.
download string When set, returns results as a download file.
format string Download format: csv, xml, or json. Default csv.
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\ActivityLogBasic

Single record if id is provided, grouped array otherwise.

Name Type Description
id int Unique database field for the activity log
date \datetimetz Date and time of the log
section string Type of the associated object
refId int Id of object associated with this activity log
description string Description of the action that was logged
activityType string Type of activity
url string Url associated with the log
userApiUrl string Api url of user
projectApiUrl string Api url of project
userId int Unique identifier for the user
project \models\Project
projectId int
extendedData object Additional information about the target of this activity record (e.g., tracker item, document, wiki page, user, etc.). Fields and format depend on the target object.

POST

postActivityLog

Create a new Activity Log entry.

Parameters (6)

Name Type Description
date string Entry date of the event. Not required
section string Section of the entry. Required
ref_id int Reference identifier of the entry. Required
description string Description of the entry. Not required
url string URL location of the event entry. Not required
project mixed Project identifier of entry. This identifier can be the synthetic numeric identifier or the unix name of the project. Required

Return: \StdClass

An object with one field (location) and the URL to the newly-created activity log record

Example 1

Submit a new activity log entry. 
curl -d section=tracker -d refId=1 -d description="This is a description" -d project=example_project --user username:password http://gforge.api/activitylog
{
    id: <id of created activity log>
    date: <current date in string format>
    section: "tracker"
    refId: 1
    descrption: "This is a description"
    activityType: "create"
    url: "create"
    userApiUrl: "/api/user/<user id>"
    projectApiUrl: "/api/project/<project id>"
    userId: <user id>
    projectId: <project id>
}

PUT

DELETE