class Projects::Api::TimesheetsAPI
-
TimesheetAPI is used to:
-
Get list of time logs.
-
Add new task log.
-
update the details of a task log.
-
Delete an existing task log.
-
Add new bug log.
-
Update the details of a bug log.
-
Delete an existing bug log.
-
Add new general log.
-
Update the details of a general log.
-
Delete an existing general log.
Public Class Methods
-
Construct a new
TimesheetsAPI
using User's authToken and portalId.
Parameters¶ ↑
- authToken
-
User's authToken.
-
- portalId
-
User's portalId.
-
Projects::Api::API::new
# File lib/projects/api/TimesheetsAPI.rb, line 47 def initialize(authToken,portalId) super(authToken,portalId) end
Public Instance Methods
-
Add a new bug log for the project.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- buglog
-
Buglog object.
-
Returns¶ ↑
-
Buglog object.
# File lib/projects/api/TimesheetsAPI.rb, line 137 def addBuglog(projectId, buglog) url = getBaseURL+"projects/"+String(projectId)+"/bugs/"+String(buglog.getBugId)+"/logs/" response = ZohoHTTPClient.post(url, getQueryMap, buglog.toParamMAP) return $timesheetParser.getBuglog(response) end
-
Add a new general log for the project.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- generallog
-
Generallog object.
-
Returns¶ ↑
-
Generallog object.
# File lib/projects/api/TimesheetsAPI.rb, line 193 def addGenerallog(projectId, generallog) url = getBaseURL+"projects/"+String(projectId)+"/logs/" requestBody = generallog.toParamMAP requestBody["name"] = generallog.getName response = ZohoHTTPClient.post(url, getQueryMap, requestBody) return $timesheetParser.getGenerallog(response) end
-
Add a new task log for the project.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- tasklog
-
Tasklog object.
-
Returns¶ ↑
-
Tasklog object.
# File lib/projects/api/TimesheetsAPI.rb, line 81 def addTasklog(projectId, tasklog) url = getBaseURL+"projects/"+String(projectId)+"/tasks/"+String(tasklog.getTaskId)+"/logs/" response = ZohoHTTPClient.post(url, getQueryMap, tasklog.toParamMAP) return $timesheetParser.getTasklog(response) end
-
Delete an existing bug log for the project.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- bugId
-
ID of the bug.
-
- logId
-
ID of the log.
-
Returns¶ ↑
-
String object.
# File lib/projects/api/TimesheetsAPI.rb, line 175 def deleteBuglog(projectId, bugId, logId) url = getBaseURL+"projects/"+String(projectId)+"/bugs/"+String(bugId)+"/logs/"+String(logId)+"/" response = ZohoHTTPClient.delete(url, getQueryMap) return $timesheetParser.getResult(response) end
-
Delete an existing general log for the project.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- logId
-
ID of the log.
-
Returns¶ ↑
-
String object.
# File lib/projects/api/TimesheetsAPI.rb, line 233 def deleteGenerallog(projectId, logId) url = getBaseURL+"projects/"+String(projectId)+"/logs/"+String(logId)+"/" response = ZohoHTTPClient.delete(url, getQueryMap) return $timesheetParser.getResult(response) end
-
Delete an existing task log for the project.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- taskId
-
ID of the task.
-
- logId
-
ID of the log.
-
Returns¶ ↑
-
String object.
# File lib/projects/api/TimesheetsAPI.rb, line 119 def deleteTasklog(projectId, taskId, logId) url = getBaseURL+"projects/"+String(projectId)+"/tasks/"+String(taskId)+"/logs/"+String(logId)+"/" response = ZohoHTTPClient.delete(url, getQueryMap) return $timesheetParser.getResult(response) end
-
Get list of time logs for the project.
Parameters¶ ↑
- projectId
-
ID 0f the project.
-
- queryMap
-
This queryMap contains the filters in the form of key-value pair.
-
Returns¶ ↑
-
TimelogList object.
# File lib/projects/api/TimesheetsAPI.rb, line 63 def getTimeLogs(projectId, queryMap) url = getBaseURL+"projects/"+String(projectId)+"/logs/" response = ZohoHTTPClient.get(url, getQueryMap(queryMap)) return $timesheetParser.getTimeLogs(response) end
-
Update the details of a bug log.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- buglog
-
Buglog object.
-
Returns¶ ↑
-
Buglog object.
# File lib/projects/api/TimesheetsAPI.rb, line 155 def updateBuglog(projectId, buglog) url = getBaseURL+"projects/"+String(projectId)+"/bugs/"+String(buglog.getBugId)+"/logs/"+String(buglog.getId)+"/" response = ZohoHTTPClient.post(url, getQueryMap, buglog.toParamMAP) return $timesheetParser.getBuglog(response) end
-
Update the details of a general log.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- generallog
-
Generallog object.
-
Returns¶ ↑
-
Generallog object.
# File lib/projects/api/TimesheetsAPI.rb, line 213 def updateGenerallog(projectId, generallog) url = getBaseURL+"projects/"+String(projectId)+"/logs/"+String(generallog.getId)+"/" requestBody = generallog.toParamMAP requestBody["name"] = generallog.getName response = ZohoHTTPClient.post(url, getQueryMap, requestBody) return $timesheetParser.getGenerallog(response) end
-
Update the details of a task log.
Parameters¶ ↑
-
projectId ID of the project.
- tasklog
-
Tasklog object.
-
Returns¶ ↑
-
Tasklog object.
# File lib/projects/api/TimesheetsAPI.rb, line 99 def updateTasklog(projectId, tasklog) url = getBaseURL+"projects/"+String(projectId)+"/tasks/"+String(tasklog.getTaskId)+"/logs/"+String(tasklog.getId)+"/" response = ZohoHTTPClient.post(url, getQueryMap, tasklog.toParamMAP) return $timesheetParser.getTasklog(response) end