API
The following operations are supported. For a formal definition, please review the Service Description.
-
AddHolidayForUser
Creates a holiday for a specific user. -
AddHolidayForUser_v2
Creates a holiday for a specific user. -
AddHolidayLimitsForUser
Creates a holidaylimit for a specific user's year. -
AddManualWorkitem
Adds a manual workitem -
AddManualWorkitems
OBSOLETE - Adds manual workitems to the users of the company -
AddSickLeaveForUser
Creates a sick-leave for a specific user. -
AddSickLeaveForUser_v2
Creates a sick-leave for a specific user. -
ApplyTemplate
Apply template to an existing project -
AssignCostCentersToUsers
Alter the default assigned cost center to user on the given day -
AssignUserToWorkerGroups
Assigns one user to one or more workergroup. -
AssignUsersToRole
Assign one role to one or more users. -
AssignUsersToTasks_v3
Assigns one or more users to one or more works -
AssignUsersToTasks_v4
Assigns one or more users to one or more works -
CloseTask
Closes a task or project -
CreateCalendar
Creates a calendar for company -
CreateCalendarException
Creates a calendar exception for a calendar -
CreateCollectedItem
Creates a collectedItem for a user -
CreateCostCenter
Create cost center -
CreateCostCenter_v2
Create cost center -
CreateCostCenter_v3
Create cost center -
CreateCostCenter_v4
Create cost center -
CreateIssue
Creates an issue -
CreateNotificationForm
Creates a new notification form -
CreateProject
Creates a project under an existing project or directly under the root -
CreateProjectMembership
Creates a project membership -
CreateProject_v2
Creates a project under an existing project or directly under the root -
CreateUser
Creates a user. If domain login is going to be used, domain users are upserted every 12 hours. -
CreateUserGroup
Creates a user group. -
CreateWork_v3
Creates a work under an existing project -
CreateWork_v4
Creates a work under an existing project -
CreateWorktimeSchedule
Creates a worktime schedule for a user -
CreateWorktimeSchedule_v2
Creates a worktime schedule for a user -
DeassignUserFromWorkerGroups
Deassigns one user to one from more workergroup. -
DeassignUsersFromRole
Deassigns one role to one or more users. -
DeassignUsersFromTasks
Deassigns one or more users from one or more works -
DeleteCalendar
Deletes a calendar for company -
DeleteCalendarException
Deletes a calendar exception -
DeleteDictionaryAutoRule
Deletes a dictionaryautorule -
DeleteHoliday
Deletes a holiday entry. -
DeleteManualWorkitem
Adds a manual workitem -
DeleteProjectMembership
Deletes project membership -
DeleteSickLeave
Deletes a sick-leave entry. -
DeleteUser
Deletes a user -
DeleteUserGroup
Deletes a user group. -
DeleteWorktimeSchedule
Deletes a worktime schedule -
DeleteWorktimesInInterval
OBSOLETE - Deletes workitems of the company for the given interval -
DownloadDataSourceFile
Downloads a datasource file used by custom reports -
ExportLeavesAndSchedulesToExcel
Exports leaves and schedules as a structured excel data set -
ExportTaskSubTree
Exports a task subtree. This function is designed to prepare the input for the ImportTaskSubTree function. -
ExportUsersAndGroupsToExcel
Exports users and groups as a structured excel data set -
GetAllUserGroups
Gets all non-deleted user groups of the company. -
GetAllUsers
Gets all non-deleted users of the company. -
GetApprovableHolidayRequests
Gets the approvable holiday requests for specific users or for the whole company. -
GetApprovableWorktimeModificationRequests
Gets the approvable worktime modification requests for specific users or for the whole company. -
GetAssignedSupervisorsToWorkerGroup
Gets the IDs of users assigned as supervisors for the given workergroup. -
GetAssignedTaskHistory
Gets history of assigned tasks. -
GetCalendarExceptionsOfCalendar
Returns the a calendar exceptions directly assigned to a specific calendar -
GetChildrenForTask
Gets the child tasks for the given TaskId. -
GetCommentsOfUsers
Gets comments of users - GetCompanyDataCollectorReportDefinitions
-
GetCompanyDictionaryAutoRuleSamples
Gets dictionary autorule samples and their parameters that are assigned to the company. Dictionary autorules can be assigned to these parameters -
GetCompetenciesForUser
Get the raw list of competencies in a company -
GetCompetenciesInCompany
Get the raw list of competencies in a company -
GetCostCenters
Gets the cost centers -
GetCostCenters_v2
Gets the cost centers -
GetCostCenters_v3
Gets the cost centers -
GetCostCenters_v4
Gets the cost centers -
GetDailyWorktimeReport
Get the company's daily work time report for the specified time interval -
GetDataCollectorReport
Get the company's data collector report for the specified time interval -
GetEffectiveSettingsForUsers
Gets the effective settings for users. -
GetFavoriteCustomReport
Get the company's custom report saved as favorite for the specified time interval -
GetHolidayCategories
Gets the holiday categories for the company. -
GetHolidayLimitsOfUser
Gets the holidaylimits for a specific user. -
GetHolidaysForCompany
Gets the holidays for the whole company. -
GetHolidaysOfUser
Gets the holidays for a specific user. -
GetJiraToken
Gets the JIRA token of the company -
GetManualWorkitemsOfUser
Gets manual workitems of a user within the given period -
GetMobileClientLocations
Gets mobile locations of users -
GetModifiedTasks_v2
Gets the modified tasks in hierarchy since the given versions -
GetModifiedTasks_v4
Gets the modified tasks in hierarchy since the given versions -
GetOrganizationHierarchy
Gets the organization hierarchy of the company -
GetOrganizationHierarchy_v2
Gets the organization hierarchy of the company -
GetPOIs
Gets the POIs of the company -
GetPlanningPeriods
Gets the planning periods for the company. -
GetProjectMembersOfProject
Gets project members of a project -
GetProjectMembershipOfUser
Gets project membership of a user -
GetProjectReport
Get the company's project report for the specified time interval -
GetProjectReport_v2
Get the company's project report for the specified time interval -
GetRolesAssignedToUser
Get roles assigned to a user. - GetSavedFavoriteReportsForRegistratorUser
-
GetScreenRecordingById
Gets the screenrecording file by id. -
GetScreenRecordingInfo
Gets the metadata records for each screenrecording file for the user in the given period. -
GetSickLeavesForCompany
Gets the sick leaves for the whole company. -
GetSickLeavesOfUser
Gets the sick leaves for a specific user. -
GetStartWorkDictionaryAutoRules
Gets startworkdictionaryautorules of the company (if taskid is not null, it returns dictionaryautorules assigned to a specific task not all to the company) -
GetStopWorkDictionaryAutoRules
Gets stopworkdictionaryautorules of the company -
GetTask
Gets a work or project. -
GetTaskCategories
Gets the currently existing task categories of the company -
GetTaskHierarchy
Gets the task hierarchy for the company -
GetTaskHierarchy_v2
Gets the task hierarchy for the company -
GetTaskHierarchy_v3
Gets the task hierarchy for the company -
GetTaskHistory
Gets history of tasks or projects. -
GetTask_V2
Gets a work or project. -
GetTask_V3
Gets a work or project. -
GetTasksOfUser_v2
Gets the currently open tasks for the given user -
GetTasksOfUser_v4
Gets the currently open tasks for the given user -
GetUser
Gets a user. -
GetUserGroup
Gets a usergroup. -
GetUsersAssignedToRole
Get users assigned to a role. -
GetUsersDictionaryAutoRules
Gets dictionaryautorules of users -
GetWorkTimeForUser
Gets a worktime for user. -
GetWorkdaysBetweenDatesForCalendar
Gets the official workdays between the given dates. -
GetWorkflowReport
Get the company's workflow report for the specified time interval -
GetWorktimeReport
Get the company's work time report for the specified time interval -
GetWorktimeSchedulesOfUsers
Gets schedules of users -
GetWorktimeSchedulesOfUsers_v2
Gets schedules of users -
ImportLeavesAndSchedulesFromExcel
Imports schedules and leaves from an excel file -
ImportPOIs
Import POIs for the company -
ImportTaskSubTree
Imports a task subtree. It only creates and updates tasks and assignments. Deletion is not supported. -
ImportUsersAndGroups
Imports users and groups into JobCTRL -
ImportUsersAndGroupsFromExcel
Imports users and groups from an excel file -
ImportUsersAndGroups_v2
Imports users and groups into JobCTRL with detailed errors if any -
ModifyWorktime
Modifies worktime and deletes collected data -
MoveTask_v3
Moves a task or project to a different project -
MoveUser
Move user to another user group. -
MoveUserGroup
Move user group to another user group. -
RemoveHolidayLimitsForUser
Deletes a holidaylimit by holidayLimitId -
ReopenTask
Reopens a closed work or project. Recursively opens closed parent projects. -
SetExternalIdForTask
Sets an external id for works and projects. -
SetHourlyWagesForUser
Sets hourly wages for user -
SetPhoneNumberForUser
Sets phone number for user -
SetSystemSettingsForUser
Sets the system settings for user. -
ShowNotificationForm
Displays a form for the given users -
UpdateCalendar
Updates a calendar for company -
UpdateCalendarException
Updates a calendar exception -
UpdateCostCenter
Update cost center -
UpdateCostCenter_v2
Update cost center -
UpdateCostCenter_v3
Update cost center -
UpdateCostCenter_v4
Update cost center -
UpdateProjectMembership
Updates project membership -
UpdateProject_v3
Updates an existing project -
UpdateSystemSettingForUser
Updates settings for user. Fields left null are ignored. -
UpdateTaskAssignment_v2
Updates assignment details of a work for the user -
UpdateTaskAssignment_v3
Updates assignment details of a work for the user -
UpdateUser
Updates a user -
UpdateUserGroup
Updates a user group -
UpdateUser_v2
Updates a user -
UpdateWork_v3
Updates an existing work -
UpdateWork_v4
Updates an existing work -
UpdateWorktimeSchedule
Updates a worktime schedule for a user -
UpdateWorktimeSchedule_v2
Updates a worktime schedule for a user -
UploadDataSourceFile
Creates or updates a datasource file used by custom reports -
UpsertStartWorkDictionaryAutoRule
Creates or updates a startwork(assigned to a task) or creates a stopwork(assigned to users and roles) dictionary autorule. Both can be simple(sample contains one parameter) or complex(sample contains more than parameters) -
UpsertStopWorkDictionaryAutoRule
Creates or updates a stoptwork(assigned to users and/or roles) dictionary autorule. Both can be simple(sample contains one parameter) or complex(sample contains more than parameters)