<< Back to GForge REST API

Entity: Log

GET

getLog

Find system log records matching specified criteria NOTE: To query within a project (specifying p param. below), the calling user must be a project admin on that project.

Parameters (8)

Name Type Description
s string Exact match for source field value
st string Start date - only include records created on or after this date/time
end string End date - only include records created BEFORE this date/time
p string ID or unix name for the project to match
u string ID or unix name for the user to match
p1 string Exact match for param1 field value
p2 string Exact match for param2 field value
p3 string Exact match for param3 field value
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: \SystemLogBasic[]

Zero or more records matching the criteria

POST

postLog

Create a new system log record. Log records cannot be updated, only created.

Parameters (5)

Name Type Description
source string Source identifier for the log entry. Required.
projectId string Project id or unix name. Required unless the caller is a site admin.
param1 string Optional extra parameter.
param2 string Optional extra parameter.
param3 string Optional extra parameter.

Return: \gforge\core\models\api\SystemLogBasic

The created log record.

Name Type Description
id int Unique identifier
logDate \DateTime Date/time of log entry
source string Source of log entry
projectId int (optional) ID of associated project
userId int ID of logging user
param1 string Entry-specific parameter value #1
param2 string Entry-specific parameter value #2
param3 string Entry-specific parameter value #3
externalId string Reference ID for external events
extendedData array Log data for this entry

PUT

DELETE