class Projects::Api::ProjectsAPI
-
ProjectsAPI
is used to: -
Get list of projects.
-
Get the details of a project.
-
Create a new project.
-
Update the details of a project.
-
Delete an existing project.
Public Class Methods
-
Construct a new
ProjectsAPI
using User's authToken and portalId.
Parameters¶ ↑
- authToken
-
User's authToken.
-
- portalId
-
User's portalId.
-
Projects::Api::API::new
# File lib/projects/api/ProjectsAPI.rb, line 39 def initialize(authToken,portalId) super(authToken,portalId) end
Public Instance Methods
-
Add the status for the project.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- status
-
Status object.
-
Returns¶ ↑
-
Status object.
# File lib/projects/api/ProjectsAPI.rb, line 196 def addProjectStatus(projectId,status) url = getProjectUrl(projectId)+"statuses/" return $projectParser.getStatus(ZohoHTTPClient.post(url, getQueryMap, status.toParamMAP)); end
-
Get list of project activities.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- queryMap
-
This queryMap contains the filters in the form of key-value pair.
-
Returns¶ ↑
-
List of Activity object.
# File lib/projects/api/ProjectsAPI.rb, line 154 def getProjectActivities(projectId, queryMap=nil) url = getProjectUrl(projectId)+"activities/" if queryMap == nil return $projectParser.getActivities(ZohoHTTPClient.get(url, getQueryMap)) else return $projectParser.getActivities(ZohoHTTPClient.get(url, getQueryMap(queryMap))) end end
-
Get list of project statuses.
Parameters¶ ↑
- projectId
-
ID of the project.
-
- queryMap
-
This queryMap contains the filters in the form of key-value pair.
-
Returns¶ ↑
-
List of Status object.
# File lib/projects/api/ProjectsAPI.rb, line 175 def getProjectStatuses(projectId,queryMap=nil) url = getProjectUrl(projectId)+"statuses/" if queryMap == nil return $projectParser.getStatuses(ZohoHTTPClient.get(url, getQueryMap)) else return $projectParser.getStatuses(ZohoHTTPClient.get(url, getQueryMap(queryMap))) end end
-
Get list of projects.
Parameters¶ ↑
- queryMap
-
This queryMap contains the filters in the form of key-value pair.
-
Returns¶ ↑
-
List of Project object.
# File lib/projects/api/ProjectsAPI.rb, line 74 def getProjects(queryMap=nil) if queryMap == nil return $projectParser.getProjects(ZohoHTTPClient.get(getProjectsUrl,getQueryMap)) else return $projectParser.getProjects(ZohoHTTPClient.get(getProjectsUrl,getQueryMap(queryMap))) end end
-
Update the details of a project.
Parameters¶ ↑
- project
-
Project object.
-
Returns¶ ↑
-
Project object.
# File lib/projects/api/ProjectsAPI.rb, line 122 def updateProject(project) updateProject = ZohoHTTPClient.post(getProjectUrl(project.getId),getQueryMap, project.toParamMAP) return $projectParser.getProject(updateProject) end