Package com.mypurecloud.sdk.v2.api
Class GamificationApi
java.lang.Object
com.mypurecloud.sdk.v2.api.GamificationApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddeleteEmployeeperformanceExternalmetricsDefinition(DeleteEmployeeperformanceExternalmetricsDefinitionRequest request) Delete an External Metric DefinitionDelete an External Metric DefinitionvoidDelete an External Metric DefinitionDelete an External Metric DefinitionvoidDelete a Contest by IddeleteGamificationContest(ApiRequest<Void> request) Delete a Contest by IdvoiddeleteGamificationContest(String contestId) Delete a Contest by IddeleteGamificationContestWithHttpInfo(String contestId) Delete a Contest by IdgetEmployeeperformanceExternalmetricsDefinition(GetEmployeeperformanceExternalmetricsDefinitionRequest request) Get an External Metric DefinitionGet an External Metric DefinitionGet an External Metric DefinitiongetEmployeeperformanceExternalmetricsDefinitions(GetEmployeeperformanceExternalmetricsDefinitionsRequest request) Get a list of External Metric Definitions of an organization, sorted by name in ascending orderGet a list of External Metric Definitions of an organization, sorted by name in ascending ordergetEmployeeperformanceExternalmetricsDefinitions(Integer pageSize, Integer pageNumber) Get a list of External Metric Definitions of an organization, sorted by name in ascending ordergetEmployeeperformanceExternalmetricsDefinitionsWithHttpInfo(Integer pageSize, Integer pageNumber) Get a list of External Metric Definitions of an organization, sorted by name in ascending orderGet an External Metric DefinitionGet a Contest by IdgetGamificationContest(ApiRequest<Void> request) Get a Contest by IdgetGamificationContest(String contestId) Get a Contest by IdGet Contest Scores (Admin)getGamificationContestAgentsScores(ApiRequest<Void> request) Get Contest Scores (Admin)getGamificationContestAgentsScores(String contestId, Integer pageNumber, Integer pageSize, LocalDate workday, String returnsView) Get Contest Scores (Admin)Get Contest Scores for the requesting Agent/SupervisorGet Contest Scores for the requesting Agent/SupervisorgetGamificationContestAgentsScoresMe(String contestId, Integer pageNumber, Integer pageSize, LocalDate workday, String returnsView) Get Contest Scores for the requesting Agent/SupervisorgetGamificationContestAgentsScoresMeWithHttpInfo(String contestId, Integer pageNumber, Integer pageSize, LocalDate workday, String returnsView) Get Contest Scores for the requesting Agent/SupervisorGet a Contest Score Trend (Average Trend)Get a Contest Score Trend (Average Trend)getGamificationContestAgentsScoresTrends(String contestId) Get a Contest Score Trend (Average Trend)getGamificationContestAgentsScoresTrendsMe(GetGamificationContestAgentsScoresTrendsMeRequest request) Get a Contest Score Trend for the requesting AgentGet a Contest Score Trend for the requesting AgentgetGamificationContestAgentsScoresTrendsMe(String contestId) Get a Contest Score Trend for the requesting AgentGet a Contest Score Trend for the requesting AgentGet a Contest Score Trend (Average Trend)getGamificationContestAgentsScoresWithHttpInfo(String contestId, Integer pageNumber, Integer pageSize, LocalDate workday, String returnsView) Get Contest Scores (Admin)Get a Contest Prize Image by IdgetGamificationContestPrizeimage(ApiRequest<Void> request) Get a Contest Prize Image by IdgetGamificationContestPrizeimage(String contestId, String prizeImageId) Get a Contest Prize Image by IdgetGamificationContestPrizeimageWithHttpInfo(String contestId, String prizeImageId) Get a Contest Prize Image by IdGet a List of Contests (Admin)getGamificationContests(ApiRequest<Void> request) Get a List of Contests (Admin)getGamificationContests(Integer pageNumber, Integer pageSize, LocalDate dateStart, LocalDate dateEnd, List<String> status, String sortBy, String sortOrder) Get a List of Contests (Admin)Get a List of Contests (Agent/Supervisor)getGamificationContestsMe(ApiRequest<Void> request) Get a List of Contests (Agent/Supervisor)getGamificationContestsMe(Integer pageNumber, Integer pageSize, LocalDate dateStart, LocalDate dateEnd, List<String> status, String sortBy, String sortOrder, String view) Get a List of Contests (Agent/Supervisor)getGamificationContestsMeWithHttpInfo(Integer pageNumber, Integer pageSize, LocalDate dateStart, LocalDate dateEnd, List<String> status, String sortBy, String sortOrder, String view) Get a List of Contests (Agent/Supervisor)getGamificationContestsWithHttpInfo(Integer pageNumber, Integer pageSize, LocalDate dateStart, LocalDate dateEnd, List<String> status, String sortBy, String sortOrder) Get a List of Contests (Admin)getGamificationContestWithHttpInfo(String contestId) Get a Contest by IdGet insights summarygetGamificationInsights(ApiRequest<Void> request) Get insights summarygetGamificationInsights(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday, Integer pageSize, Integer pageNumber, String sortKey, String sortMetricId, String sortOrder, String userIds, String reportsTo) Get insights summaryGet insights details for the current usergetGamificationInsightsDetails(ApiRequest<Void> request) Get insights details for the current usergetGamificationInsightsDetails(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday) Get insights details for the current usergetGamificationInsightsDetailsWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday) Get insights details for the current userGet insights overall trend for the current userGet insights overall trend for the current usergetGamificationInsightsGroupsTrends(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) Get insights overall trend for the current userGet insights overall trendGet insights overall trendgetGamificationInsightsGroupsTrendsAll(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) Get insights overall trendgetGamificationInsightsGroupsTrendsAllWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) Get insights overall trendgetGamificationInsightsGroupsTrendsWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) Get insights overall trend for the current userQuery managers in a profile during a period of timegetGamificationInsightsManagers(ApiRequest<Void> request) Query managers in a profile during a period of timegetGamificationInsightsManagers(String filterType, String filterId, String granularity, LocalDate startWorkday, Integer pageSize, Integer pageNumber) Query managers in a profile during a period of timegetGamificationInsightsManagersWithHttpInfo(String filterType, String filterId, String granularity, LocalDate startWorkday, Integer pageSize, Integer pageNumber) Query managers in a profile during a period of timeQuery users in a profile during a period of timegetGamificationInsightsMembers(ApiRequest<Void> request) Query users in a profile during a period of timegetGamificationInsightsMembers(String filterType, String filterId, String granularity, LocalDate startWorkday, String reportsTo) Query users in a profile during a period of timegetGamificationInsightsMembersWithHttpInfo(String filterType, String filterId, String granularity, LocalDate startWorkday, String reportsTo) Query users in a profile during a period of timeGet insights rankingsgetGamificationInsightsRankings(ApiRequest<Void> request) Get insights rankingsgetGamificationInsightsRankings(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday, String sortKey, String sortMetricId, Integer sectionSize, String userIds, String reportsTo) Get insights rankingsgetGamificationInsightsRankingsWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday, String sortKey, String sortMetricId, Integer sectionSize, String userIds, String reportsTo) Get insights rankingsGet insights user trend for the current usergetGamificationInsightsTrends(ApiRequest<Void> request) Get insights user trend for the current usergetGamificationInsightsTrends(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) Get insights user trend for the current usergetGamificationInsightsTrendsWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) Get insights user trend for the current userGet insights details for the usergetGamificationInsightsUserDetails(ApiRequest<Void> request) Get insights details for the usergetGamificationInsightsUserDetails(String userId, String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday) Get insights details for the usergetGamificationInsightsUserDetailsWithHttpInfo(String userId, String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday) Get insights details for the userGet insights user trend for the usergetGamificationInsightsUserTrends(ApiRequest<Void> request) Get insights user trend for the usergetGamificationInsightsUserTrends(String userId, String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) Get insights user trend for the usergetGamificationInsightsUserTrendsWithHttpInfo(String userId, String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) Get insights user trend for the usergetGamificationInsightsWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday, Integer pageSize, Integer pageNumber, String sortKey, String sortMetricId, String sortOrder, String userIds, String reportsTo) Get insights summaryLeaderboard of the requesting user's division or performance profilegetGamificationLeaderboard(ApiRequest<Void> request) Leaderboard of the requesting user's division or performance profilegetGamificationLeaderboard(LocalDate startWorkday, LocalDate endWorkday, String metricId) Leaderboard of the requesting user's division or performance profileLeaderboard by filter typegetGamificationLeaderboardAll(ApiRequest<Void> request) Leaderboard by filter typegetGamificationLeaderboardAll(String filterType, String filterId, LocalDate startWorkday, LocalDate endWorkday, String metricId) Leaderboard by filter typeBest Points by division or performance profileBest Points by division or performance profilegetGamificationLeaderboardAllBestpoints(String filterType, String filterId) Best Points by division or performance profilegetGamificationLeaderboardAllBestpointsWithHttpInfo(String filterType, String filterId) Best Points by division or performance profilegetGamificationLeaderboardAllWithHttpInfo(String filterType, String filterId, LocalDate startWorkday, LocalDate endWorkday, String metricId) Leaderboard by filter typeBest Points of the requesting user's current performance profile or divisionBest Points of the requesting user's current performance profile or divisionBest Points of the requesting user's current performance profile or divisionBest Points of the requesting user's current performance profile or divisiongetGamificationLeaderboardWithHttpInfo(LocalDate startWorkday, LocalDate endWorkday, String metricId) Leaderboard of the requesting user's division or performance profileMetric definition by idgetGamificationMetricdefinition(ApiRequest<Void> request) Metric definition by idgetGamificationMetricdefinition(String metricDefinitionId) Metric definition by idAll metric definitions Retrieves the metric definitions and their corresponding default objectives used to create a gamified metricAll metric definitions Retrieves the metric definitions and their corresponding default objectives used to create a gamified metricgetGamificationMetricdefinitions(ApiRequest<Void> request) All metric definitions Retrieves the metric definitions and their corresponding default objectives used to create a gamified metricAll metric definitions Retrieves the metric definitions and their corresponding default objectives used to create a gamified metricgetGamificationMetricdefinitionWithHttpInfo(String metricDefinitionId) Metric definition by idPerformance profile by idgetGamificationProfile(ApiRequest<Void> request) Performance profile by idgetGamificationProfile(String profileId) Performance profile by idMembers of a given performance profilegetGamificationProfileMembers(ApiRequest<Void> request) Members of a given performance profilegetGamificationProfileMembers(String profileId) Members of a given performance profilegetGamificationProfileMembersWithHttpInfo(String profileId) Members of a given performance profilePerformance profile gamified metric by idgetGamificationProfileMetric(ApiRequest<Void> request) Performance profile gamified metric by idgetGamificationProfileMetric(String profileId, String metricId, LocalDate workday) Performance profile gamified metric by idAll gamified metrics for a given performance profilegetGamificationProfileMetrics(ApiRequest<Void> request) All gamified metrics for a given performance profilegetGamificationProfileMetrics(String profileId, List<String> expand, LocalDate workday, String metricIds) All gamified metrics for a given performance profilegetGamificationProfileMetricsObjectivedetails(GetGamificationProfileMetricsObjectivedetailsRequest request) All metrics for a given performance profile with objective details such as order and maxPointsAll metrics for a given performance profile with objective details such as order and maxPointsgetGamificationProfileMetricsObjectivedetails(String profileId, LocalDate workday) All metrics for a given performance profile with objective details such as order and maxPointsgetGamificationProfileMetricsObjectivedetailsWithHttpInfo(String profileId, LocalDate workday) All metrics for a given performance profile with objective details such as order and maxPointsgetGamificationProfileMetricsWithHttpInfo(String profileId, List<String> expand, LocalDate workday, String metricIds) All gamified metrics for a given performance profilegetGamificationProfileMetricWithHttpInfo(String profileId, String metricId, LocalDate workday) Performance profile gamified metric by idAll performance profilesAll performance profilesgetGamificationProfiles(ApiRequest<Void> request) All performance profilesPerformance profile of a usergetGamificationProfilesUser(ApiRequest<Void> request) Performance profile of a usergetGamificationProfilesUser(String userId, LocalDate workday) Performance profile of a userPerformance profile of the requesting usergetGamificationProfilesUsersMe(ApiRequest<Void> request) Performance profile of the requesting usergetGamificationProfilesUsersMe(LocalDate workday) Performance profile of the requesting userPerformance profile of the requesting usergetGamificationProfilesUserWithHttpInfo(String userId, LocalDate workday) Performance profile of a userAll performance profilesgetGamificationProfileWithHttpInfo(String profileId) Performance profile by idWorkday performance metrics of the requesting usergetGamificationScorecards(ApiRequest<Void> request) Workday performance metrics of the requesting usergetGamificationScorecards(LocalDate workday, List<String> expand) Workday performance metrics of the requesting userAttendance status metrics of the requesting userAttendance status metrics of the requesting usergetGamificationScorecardsAttendance(LocalDate startWorkday, LocalDate endWorkday) Attendance status metrics of the requesting usergetGamificationScorecardsAttendanceWithHttpInfo(LocalDate startWorkday, LocalDate endWorkday) Attendance status metrics of the requesting userBest points of the requesting userBest points of the requesting userBest points of the requesting userBest points of the requesting userAll-time points of the requesting userAll-time points of the requesting usergetGamificationScorecardsPointsAlltime(LocalDate endWorkday) All-time points of the requesting userAll-time points of the requesting userAverage points of the requesting user's division or performance profileAverage points of the requesting user's division or performance profileAverage points of the requesting user's division or performance profileAverage points of the requesting user's division or performance profilePoints trends of the requesting userPoints trends of the requesting usergetGamificationScorecardsPointsTrends(LocalDate startWorkday, LocalDate endWorkday, String dayOfWeek) Points trends of the requesting usergetGamificationScorecardsPointsTrendsWithHttpInfo(LocalDate startWorkday, LocalDate endWorkday, String dayOfWeek) Points trends of the requesting usergetGamificationScorecardsProfileMetricUsersValuesTrends(GetGamificationScorecardsProfileMetricUsersValuesTrendsRequest request) Average performance values trends by metric of a division or a performance profileAverage performance values trends by metric of a division or a performance profilegetGamificationScorecardsProfileMetricUsersValuesTrends(String profileId, String metricId, String filterType, LocalDate startWorkday, LocalDate endWorkday, String filterId, LocalDate referenceWorkday, String timeZone) Average performance values trends by metric of a division or a performance profilegetGamificationScorecardsProfileMetricUsersValuesTrendsWithHttpInfo(String profileId, String metricId, String filterType, LocalDate startWorkday, LocalDate endWorkday, String filterId, LocalDate referenceWorkday, String timeZone) Average performance values trends by metric of a division or a performance profilegetGamificationScorecardsProfileMetricUserValuesTrends(GetGamificationScorecardsProfileMetricUserValuesTrendsRequest request) Average performance values trends by metric of a userAverage performance values trends by metric of a usergetGamificationScorecardsProfileMetricUserValuesTrends(String profileId, String metricId, String userId, LocalDate startWorkday, LocalDate endWorkday, LocalDate referenceWorkday, String timeZone) Average performance values trends by metric of a usergetGamificationScorecardsProfileMetricUserValuesTrendsWithHttpInfo(String profileId, String metricId, String userId, LocalDate startWorkday, LocalDate endWorkday, LocalDate referenceWorkday, String timeZone) Average performance values trends by metric of a usergetGamificationScorecardsProfileMetricValuesTrends(GetGamificationScorecardsProfileMetricValuesTrendsRequest request) Average performance values trends by metric of the requesting userAverage performance values trends by metric of the requesting usergetGamificationScorecardsProfileMetricValuesTrends(String profileId, String metricId, LocalDate startWorkday, LocalDate endWorkday, String filterType, LocalDate referenceWorkday, String timeZone) Average performance values trends by metric of the requesting usergetGamificationScorecardsProfileMetricValuesTrendsWithHttpInfo(String profileId, String metricId, LocalDate startWorkday, LocalDate endWorkday, String filterType, LocalDate referenceWorkday, String timeZone) Average performance values trends by metric of the requesting userWorkday performance metrics for a usergetGamificationScorecardsUser(ApiRequest<Void> request) Workday performance metrics for a usergetGamificationScorecardsUser(String userId, LocalDate workday, List<String> expand) Workday performance metrics for a userAttendance status metrics for a userAttendance status metrics for a usergetGamificationScorecardsUserAttendance(String userId, LocalDate startWorkday, LocalDate endWorkday) Attendance status metrics for a usergetGamificationScorecardsUserAttendanceWithHttpInfo(String userId, LocalDate startWorkday, LocalDate endWorkday) Attendance status metrics for a userBest points of a userBest points of a userBest points of a userBest points of a usergetGamificationScorecardsUserPointsAlltime(GetGamificationScorecardsUserPointsAlltimeRequest request) All-time points for a userAll-time points for a usergetGamificationScorecardsUserPointsAlltime(String userId, LocalDate endWorkday) All-time points for a usergetGamificationScorecardsUserPointsAlltimeWithHttpInfo(String userId, LocalDate endWorkday) All-time points for a userPoints trend for a userPoints trend for a usergetGamificationScorecardsUserPointsTrends(String userId, LocalDate startWorkday, LocalDate endWorkday, String dayOfWeek) Points trend for a usergetGamificationScorecardsUserPointsTrendsWithHttpInfo(String userId, LocalDate startWorkday, LocalDate endWorkday, String dayOfWeek) Points trend for a usergetGamificationScorecardsUsersPointsAverage(GetGamificationScorecardsUsersPointsAverageRequest request) Workday average points by target groupWorkday average points by target groupgetGamificationScorecardsUsersPointsAverage(String filterType, String filterId, LocalDate workday) Workday average points by target groupgetGamificationScorecardsUsersPointsAverageWithHttpInfo(String filterType, String filterId, LocalDate workday) Workday average points by target groupgetGamificationScorecardsUsersValuesAverage(GetGamificationScorecardsUsersValuesAverageRequest request) Workday average values by target groupWorkday average values by target groupgetGamificationScorecardsUsersValuesAverage(String filterType, String filterId, LocalDate workday, String timeZone) Workday average values by target groupgetGamificationScorecardsUsersValuesAverageWithHttpInfo(String filterType, String filterId, LocalDate workday, String timeZone) Workday average values by target groupgetGamificationScorecardsUsersValuesTrends(GetGamificationScorecardsUsersValuesTrendsRequest request) Values trend by target groupValues trend by target groupgetGamificationScorecardsUsersValuesTrends(String filterType, String filterId, LocalDate startWorkday, LocalDate endWorkday, String timeZone) Values trend by target groupgetGamificationScorecardsUsersValuesTrendsWithHttpInfo(String filterType, String filterId, LocalDate startWorkday, LocalDate endWorkday, String timeZone) Values trend by target groupValues trends of a userValues trends of a usergetGamificationScorecardsUserValuesTrends(String userId, LocalDate startWorkday, LocalDate endWorkday, String timeZone) Values trends of a usergetGamificationScorecardsUserValuesTrendsWithHttpInfo(String userId, LocalDate startWorkday, LocalDate endWorkday, String timeZone) Values trends of a usergetGamificationScorecardsUserWithHttpInfo(String userId, LocalDate workday, List<String> expand) Workday performance metrics for a userAverage values of the requesting user's division or performance profileAverage values of the requesting user's division or performance profilegetGamificationScorecardsValuesAverage(LocalDate workday, String timeZone) Average values of the requesting user's division or performance profilegetGamificationScorecardsValuesAverageWithHttpInfo(LocalDate workday, String timeZone) Average values of the requesting user's division or performance profileValues trends of the requesting user or groupValues trends of the requesting user or groupgetGamificationScorecardsValuesTrends(LocalDate startWorkday, LocalDate endWorkday, String filterType, LocalDate referenceWorkday, String timeZone) Values trends of the requesting user or groupgetGamificationScorecardsValuesTrendsWithHttpInfo(LocalDate startWorkday, LocalDate endWorkday, String filterType, LocalDate referenceWorkday, String timeZone) Values trends of the requesting user or groupgetGamificationScorecardsWithHttpInfo(LocalDate workday, List<String> expand) Workday performance metrics of the requesting userGamification activation statusGamification activation statusgetGamificationStatus(ApiRequest<Void> request) Gamification activation statusGamification activation statusObjective template by idgetGamificationTemplate(ApiRequest<Void> request) Objective template by idgetGamificationTemplate(String templateId) Objective template by idAll objective templatesAll objective templatesgetGamificationTemplates(ApiRequest<Void> request) All objective templatesAll objective templatesgetGamificationTemplateWithHttpInfo(String templateId) Objective template by idpatchEmployeeperformanceExternalmetricsDefinition(PatchEmployeeperformanceExternalmetricsDefinitionRequest request) Update External Metric DefinitionpatchEmployeeperformanceExternalmetricsDefinition(ApiRequest<ExternalMetricDefinitionUpdateRequest> request) Update External Metric DefinitionpatchEmployeeperformanceExternalmetricsDefinition(String metricId, ExternalMetricDefinitionUpdateRequest body) Update External Metric DefinitionpatchEmployeeperformanceExternalmetricsDefinitionWithHttpInfo(String metricId, ExternalMetricDefinitionUpdateRequest body) Update External Metric DefinitionFinalize a Contest by IdFinalize a Contest by IdpatchGamificationContest(String contestId, ContestsFinalizeRequest body) Finalize a Contest by IdpatchGamificationContestWithHttpInfo(String contestId, ContestsFinalizeRequest body) Finalize a Contest by IdpostEmployeeperformanceExternalmetricsData(PostEmployeeperformanceExternalmetricsDataRequest request) Write External Metric DataWrite External Metric DataWrite External Metric DataWrite External Metric DatapostEmployeeperformanceExternalmetricsDefinitions(PostEmployeeperformanceExternalmetricsDefinitionsRequest request) Create External Metric DefinitionpostEmployeeperformanceExternalmetricsDefinitions(ApiRequest<ExternalMetricDefinitionCreateRequest> request) Create External Metric DefinitionCreate External Metric DefinitionpostEmployeeperformanceExternalmetricsDefinitionsWithHttpInfo(ExternalMetricDefinitionCreateRequest body) Create External Metric DefinitionCreates a ContestCreates a ContestCreates a ContestpostGamificationContestsUploadsPrizeimages(PostGamificationContestsUploadsPrizeimagesRequest request) Generates pre-signed URL to upload a prize image for gamification contestspostGamificationContestsUploadsPrizeimages(ApiRequest<GamificationContestPrizeImageUploadUrlRequest> request) Generates pre-signed URL to upload a prize image for gamification contestsGenerates pre-signed URL to upload a prize image for gamification contestspostGamificationContestsUploadsPrizeimagesWithHttpInfo(GamificationContestPrizeImageUploadUrlRequest body) Generates pre-signed URL to upload a prize image for gamification contestsCreates a ContestActivate a performance profilepostGamificationProfileActivate(ApiRequest<Void> request) Activate a performance profilepostGamificationProfileActivate(String profileId) Activate a performance profileActivate a performance profileDeactivate a performance profilepostGamificationProfileDeactivate(ApiRequest<Void> request) Deactivate a performance profilepostGamificationProfileDeactivate(String profileId) Deactivate a performance profileDeactivate a performance profileAssign members to a given performance profileAssign members to a given performance profilepostGamificationProfileMembers(String profileId, AssignUsers body) Assign members to a given performance profileValidate member assignmentValidate member assignmentpostGamificationProfileMembersValidate(String profileId, ValidateAssignUsers body) Validate member assignmentpostGamificationProfileMembersValidateWithHttpInfo(String profileId, ValidateAssignUsers body) Validate member assignmentpostGamificationProfileMembersWithHttpInfo(String profileId, AssignUsers body) Assign members to a given performance profileCreates a linked metricCreates a linked metricpostGamificationProfileMetricLink(String sourceProfileId, String sourceMetricId, TargetPerformanceProfile body) Creates a linked metricpostGamificationProfileMetricLinkWithHttpInfo(String sourceProfileId, String sourceMetricId, TargetPerformanceProfile body) Creates a linked metricCreates a gamified metric with a given metric definition and metric objective under in a performance profileCreates a gamified metric with a given metric definition and metric objective under in a performance profilepostGamificationProfileMetrics(String profileId, CreateMetric body) Creates a gamified metric with a given metric definition and metric objective under in a performance profilepostGamificationProfileMetricsWithHttpInfo(String profileId, CreateMetric body) Creates a gamified metric with a given metric definition and metric objective under in a performance profileCreate a new custom performance profileCreate a new custom performance profilepostGamificationProfiles(CreatePerformanceProfile body, Boolean copyMetrics) Create a new custom performance profileQuery performance profiles in date range for a userQuery performance profiles in date range for a userQuery performance profiles in date range for a userQuery performance profiles in date range for a userQuery performance profiles in date range for the current userQuery performance profiles in date range for the current userQuery performance profiles in date range for the current userQuery performance profiles in date range for the current userpostGamificationProfilesWithHttpInfo(CreatePerformanceProfile body, Boolean copyMetrics) Create a new custom performance profileUpdate a Contest by IdUpdate a Contest by IdputGamificationContest(String contestId, ContestsCreateRequest body) Update a Contest by IdputGamificationContestWithHttpInfo(String contestId, ContestsCreateRequest body) Update a Contest by IdUpdates a performance profileUpdates a performance profileputGamificationProfile(String profileId, PerformanceProfile body) Updates a performance profileUpdates a metric in performance profileUpdates a metric in performance profileputGamificationProfileMetric(String profileId, String metricId, CreateMetric body) Updates a metric in performance profileputGamificationProfileMetricWithHttpInfo(String profileId, String metricId, CreateMetric body) Updates a metric in performance profileputGamificationProfileWithHttpInfo(String profileId, PerformanceProfile body) Updates a performance profileUpdate gamification activation statusUpdate gamification activation statusUpdate gamification activation statusUpdate gamification activation status
-
Constructor Details
-
GamificationApi
public GamificationApi() -
GamificationApi
-
-
Method Details
-
deleteEmployeeperformanceExternalmetricsDefinition
public void deleteEmployeeperformanceExternalmetricsDefinition(String metricId) throws IOException, ApiException Delete an External Metric Definition- Parameters:
metricId- Specifies the External Metric Definition ID (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteEmployeeperformanceExternalmetricsDefinitionWithHttpInfo
public ApiResponse<Void> deleteEmployeeperformanceExternalmetricsDefinitionWithHttpInfo(String metricId) throws IOException Delete an External Metric Definition- Parameters:
metricId- Specifies the External Metric Definition ID (required)- Throws:
IOException- if the request fails to be processed
-
deleteEmployeeperformanceExternalmetricsDefinition
public void deleteEmployeeperformanceExternalmetricsDefinition(DeleteEmployeeperformanceExternalmetricsDefinitionRequest request) throws IOException, ApiException Delete an External Metric Definition- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteEmployeeperformanceExternalmetricsDefinition
public ApiResponse<Void> deleteEmployeeperformanceExternalmetricsDefinition(ApiRequest<Void> request) throws IOException Delete an External Metric Definition- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
deleteGamificationContest
Delete a Contest by Id- Parameters:
contestId- The ID of the contest (required)- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteGamificationContestWithHttpInfo
Delete a Contest by Id- Parameters:
contestId- The ID of the contest (required)- Throws:
IOException- if the request fails to be processed
-
deleteGamificationContest
public void deleteGamificationContest(DeleteGamificationContestRequest request) throws IOException, ApiException Delete a Contest by Id- Parameters:
request- The request object- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
deleteGamificationContest
Delete a Contest by Id- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getEmployeeperformanceExternalmetricsDefinition
public ExternalMetricDefinition getEmployeeperformanceExternalmetricsDefinition(String metricId) throws IOException, ApiException Get an External Metric Definition- Parameters:
metricId- Specifies the External Metric Definition ID (required)- Returns:
- ExternalMetricDefinition
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getEmployeeperformanceExternalmetricsDefinitionWithHttpInfo
public ApiResponse<ExternalMetricDefinition> getEmployeeperformanceExternalmetricsDefinitionWithHttpInfo(String metricId) throws IOException Get an External Metric Definition- Parameters:
metricId- Specifies the External Metric Definition ID (required)- Returns:
- ExternalMetricDefinition
- Throws:
IOException- if the request fails to be processed
-
getEmployeeperformanceExternalmetricsDefinition
public ExternalMetricDefinition getEmployeeperformanceExternalmetricsDefinition(GetEmployeeperformanceExternalmetricsDefinitionRequest request) throws IOException, ApiException Get an External Metric Definition- Parameters:
request- The request object- Returns:
- ExternalMetricDefinition
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getEmployeeperformanceExternalmetricsDefinition
public ApiResponse<ExternalMetricDefinition> getEmployeeperformanceExternalmetricsDefinition(ApiRequest<Void> request) throws IOException Get an External Metric Definition- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getEmployeeperformanceExternalmetricsDefinitions
public ExternalMetricDefinitionListing getEmployeeperformanceExternalmetricsDefinitions(Integer pageSize, Integer pageNumber) throws IOException, ApiException Get a list of External Metric Definitions of an organization, sorted by name in ascending order- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- ExternalMetricDefinitionListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getEmployeeperformanceExternalmetricsDefinitionsWithHttpInfo
public ApiResponse<ExternalMetricDefinitionListing> getEmployeeperformanceExternalmetricsDefinitionsWithHttpInfo(Integer pageSize, Integer pageNumber) throws IOException Get a list of External Metric Definitions of an organization, sorted by name in ascending order- Parameters:
pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)- Returns:
- ExternalMetricDefinitionListing
- Throws:
IOException- if the request fails to be processed
-
getEmployeeperformanceExternalmetricsDefinitions
public ExternalMetricDefinitionListing getEmployeeperformanceExternalmetricsDefinitions(GetEmployeeperformanceExternalmetricsDefinitionsRequest request) throws IOException, ApiException Get a list of External Metric Definitions of an organization, sorted by name in ascending order- Parameters:
request- The request object- Returns:
- ExternalMetricDefinitionListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getEmployeeperformanceExternalmetricsDefinitions
public ApiResponse<ExternalMetricDefinitionListing> getEmployeeperformanceExternalmetricsDefinitions(ApiRequest<Void> request) throws IOException Get a list of External Metric Definitions of an organization, sorted by name in ascending order- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationContest
Get a Contest by Id- Parameters:
contestId- The ID of the contest (required)- Returns:
- ContestsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestWithHttpInfo
public ApiResponse<ContestsResponse> getGamificationContestWithHttpInfo(String contestId) throws IOException Get a Contest by Id- Parameters:
contestId- The ID of the contest (required)- Returns:
- ContestsResponse
- Throws:
IOException- if the request fails to be processed
-
getGamificationContest
public ContestsResponse getGamificationContest(GetGamificationContestRequest request) throws IOException, ApiException Get a Contest by Id- Parameters:
request- The request object- Returns:
- ContestsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContest
public ApiResponse<ContestsResponse> getGamificationContest(ApiRequest<Void> request) throws IOException Get a Contest by Id- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestAgentsScores
public ContestScoresAgentsPagedList getGamificationContestAgentsScores(String contestId, Integer pageNumber, Integer pageSize, LocalDate workday, String returnsView) throws IOException, ApiException Get Contest Scores (Admin)- Parameters:
contestId- The ID of the contest (required)pageNumber- (optional, default to 1)pageSize- (optional, default to 25)workday- Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)returnsView- Desired response results (optional, default to All)- Returns:
- ContestScoresAgentsPagedList
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestAgentsScoresWithHttpInfo
public ApiResponse<ContestScoresAgentsPagedList> getGamificationContestAgentsScoresWithHttpInfo(String contestId, Integer pageNumber, Integer pageSize, LocalDate workday, String returnsView) throws IOException Get Contest Scores (Admin)- Parameters:
contestId- The ID of the contest (required)pageNumber- (optional, default to 1)pageSize- (optional, default to 25)workday- Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)returnsView- Desired response results (optional, default to All)- Returns:
- ContestScoresAgentsPagedList
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestAgentsScores
public ContestScoresAgentsPagedList getGamificationContestAgentsScores(GetGamificationContestAgentsScoresRequest request) throws IOException, ApiException Get Contest Scores (Admin)- Parameters:
request- The request object- Returns:
- ContestScoresAgentsPagedList
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestAgentsScores
public ApiResponse<ContestScoresAgentsPagedList> getGamificationContestAgentsScores(ApiRequest<Void> request) throws IOException Get Contest Scores (Admin)- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestAgentsScoresMe
public ContestScoresAgentsPagedList getGamificationContestAgentsScoresMe(String contestId, Integer pageNumber, Integer pageSize, LocalDate workday, String returnsView) throws IOException, ApiException Get Contest Scores for the requesting Agent/Supervisor- Parameters:
contestId- The ID of the contest (required)pageNumber- (optional, default to 1)pageSize- (optional, default to 25)workday- Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)returnsView- Desired response results (Supervisor Only) (optional, default to All)- Returns:
- ContestScoresAgentsPagedList
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestAgentsScoresMeWithHttpInfo
public ApiResponse<ContestScoresAgentsPagedList> getGamificationContestAgentsScoresMeWithHttpInfo(String contestId, Integer pageNumber, Integer pageSize, LocalDate workday, String returnsView) throws IOException Get Contest Scores for the requesting Agent/Supervisor- Parameters:
contestId- The ID of the contest (required)pageNumber- (optional, default to 1)pageSize- (optional, default to 25)workday- Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)returnsView- Desired response results (Supervisor Only) (optional, default to All)- Returns:
- ContestScoresAgentsPagedList
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestAgentsScoresMe
public ContestScoresAgentsPagedList getGamificationContestAgentsScoresMe(GetGamificationContestAgentsScoresMeRequest request) throws IOException, ApiException Get Contest Scores for the requesting Agent/Supervisor- Parameters:
request- The request object- Returns:
- ContestScoresAgentsPagedList
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestAgentsScoresMe
public ApiResponse<ContestScoresAgentsPagedList> getGamificationContestAgentsScoresMe(ApiRequest<Void> request) throws IOException Get Contest Scores for the requesting Agent/Supervisor- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestAgentsScoresTrends
public ContestScoresGroupTrendList getGamificationContestAgentsScoresTrends(String contestId) throws IOException, ApiException Get a Contest Score Trend (Average Trend)- Parameters:
contestId- The ID of the contest (required)- Returns:
- ContestScoresGroupTrendList
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestAgentsScoresTrendsWithHttpInfo
public ApiResponse<ContestScoresGroupTrendList> getGamificationContestAgentsScoresTrendsWithHttpInfo(String contestId) throws IOException Get a Contest Score Trend (Average Trend)- Parameters:
contestId- The ID of the contest (required)- Returns:
- ContestScoresGroupTrendList
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestAgentsScoresTrends
public ContestScoresGroupTrendList getGamificationContestAgentsScoresTrends(GetGamificationContestAgentsScoresTrendsRequest request) throws IOException, ApiException Get a Contest Score Trend (Average Trend)- Parameters:
request- The request object- Returns:
- ContestScoresGroupTrendList
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestAgentsScoresTrends
public ApiResponse<ContestScoresGroupTrendList> getGamificationContestAgentsScoresTrends(ApiRequest<Void> request) throws IOException Get a Contest Score Trend (Average Trend)- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestAgentsScoresTrendsMe
public ContestScoresAgentTrendList getGamificationContestAgentsScoresTrendsMe(String contestId) throws IOException, ApiException Get a Contest Score Trend for the requesting Agent- Parameters:
contestId- The ID of the contest (required)- Returns:
- ContestScoresAgentTrendList
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestAgentsScoresTrendsMeWithHttpInfo
public ApiResponse<ContestScoresAgentTrendList> getGamificationContestAgentsScoresTrendsMeWithHttpInfo(String contestId) throws IOException Get a Contest Score Trend for the requesting Agent- Parameters:
contestId- The ID of the contest (required)- Returns:
- ContestScoresAgentTrendList
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestAgentsScoresTrendsMe
public ContestScoresAgentTrendList getGamificationContestAgentsScoresTrendsMe(GetGamificationContestAgentsScoresTrendsMeRequest request) throws IOException, ApiException Get a Contest Score Trend for the requesting Agent- Parameters:
request- The request object- Returns:
- ContestScoresAgentTrendList
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestAgentsScoresTrendsMe
public ApiResponse<ContestScoresAgentTrendList> getGamificationContestAgentsScoresTrendsMe(ApiRequest<Void> request) throws IOException Get a Contest Score Trend for the requesting Agent- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestPrizeimage
public PrizeImages getGamificationContestPrizeimage(String contestId, String prizeImageId) throws IOException, ApiException Get a Contest Prize Image by Id- Parameters:
contestId- The ID of the contest (required)prizeImageId- The ID of the prize image (required)- Returns:
- PrizeImages
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestPrizeimageWithHttpInfo
public ApiResponse<PrizeImages> getGamificationContestPrizeimageWithHttpInfo(String contestId, String prizeImageId) throws IOException Get a Contest Prize Image by Id- Parameters:
contestId- The ID of the contest (required)prizeImageId- The ID of the prize image (required)- Returns:
- PrizeImages
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestPrizeimage
public PrizeImages getGamificationContestPrizeimage(GetGamificationContestPrizeimageRequest request) throws IOException, ApiException Get a Contest Prize Image by Id- Parameters:
request- The request object- Returns:
- PrizeImages
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestPrizeimage
public ApiResponse<PrizeImages> getGamificationContestPrizeimage(ApiRequest<Void> request) throws IOException Get a Contest Prize Image by Id- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationContests
public GetContestsEssentialsListing getGamificationContests(Integer pageNumber, Integer pageSize, LocalDate dateStart, LocalDate dateEnd, List<String> status, String sortBy, String sortOrder) throws IOException, ApiException Get a List of Contests (Admin)- Parameters:
pageNumber- (optional, default to 1)pageSize- (optional, default to 25)dateStart- Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)dateEnd- End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)status- (optional)sortBy- (optional, default to dateStart)sortOrder- (optional, default to desc)- Returns:
- GetContestsEssentialsListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestsWithHttpInfo
public ApiResponse<GetContestsEssentialsListing> getGamificationContestsWithHttpInfo(Integer pageNumber, Integer pageSize, LocalDate dateStart, LocalDate dateEnd, List<String> status, String sortBy, String sortOrder) throws IOException Get a List of Contests (Admin)- Parameters:
pageNumber- (optional, default to 1)pageSize- (optional, default to 25)dateStart- Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)dateEnd- End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)status- (optional)sortBy- (optional, default to dateStart)sortOrder- (optional, default to desc)- Returns:
- GetContestsEssentialsListing
- Throws:
IOException- if the request fails to be processed
-
getGamificationContests
public GetContestsEssentialsListing getGamificationContests(GetGamificationContestsRequest request) throws IOException, ApiException Get a List of Contests (Admin)- Parameters:
request- The request object- Returns:
- GetContestsEssentialsListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContests
public ApiResponse<GetContestsEssentialsListing> getGamificationContests(ApiRequest<Void> request) throws IOException Get a List of Contests (Admin)- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestsMe
public GetContestsEssentialsListing getGamificationContestsMe(Integer pageNumber, Integer pageSize, LocalDate dateStart, LocalDate dateEnd, List<String> status, String sortBy, String sortOrder, String view) throws IOException, ApiException Get a List of Contests (Agent/Supervisor)- Parameters:
pageNumber- (optional, default to 1)pageSize- (optional, default to 25)dateStart- Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)dateEnd- End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)status- (optional)sortBy- (optional, default to dateStart)sortOrder- (optional, default to desc)view- (optional, default to participant)- Returns:
- GetContestsEssentialsListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestsMeWithHttpInfo
public ApiResponse<GetContestsEssentialsListing> getGamificationContestsMeWithHttpInfo(Integer pageNumber, Integer pageSize, LocalDate dateStart, LocalDate dateEnd, List<String> status, String sortBy, String sortOrder, String view) throws IOException Get a List of Contests (Agent/Supervisor)- Parameters:
pageNumber- (optional, default to 1)pageSize- (optional, default to 25)dateStart- Start date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)dateEnd- End date for the query. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)status- (optional)sortBy- (optional, default to dateStart)sortOrder- (optional, default to desc)view- (optional, default to participant)- Returns:
- GetContestsEssentialsListing
- Throws:
IOException- if the request fails to be processed
-
getGamificationContestsMe
public GetContestsEssentialsListing getGamificationContestsMe(GetGamificationContestsMeRequest request) throws IOException, ApiException Get a List of Contests (Agent/Supervisor)- Parameters:
request- The request object- Returns:
- GetContestsEssentialsListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationContestsMe
public ApiResponse<GetContestsEssentialsListing> getGamificationContestsMe(ApiRequest<Void> request) throws IOException Get a List of Contests (Agent/Supervisor)- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsights
public InsightsSummary getGamificationInsights(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday, Integer pageSize, Integer pageNumber, String sortKey, String sortMetricId, String sortOrder, String userIds, String reportsTo) throws IOException, ApiException Get insights summary- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortKey- Sort key (optional)sortMetricId- Sort Metric Id (optional)sortOrder- Sort order (optional, default to asc)userIds- A list of up to 100 comma-separated user Ids (optional)reportsTo- The reportsTo used by ABAC policies. (optional)- Returns:
- InsightsSummary
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsWithHttpInfo
public ApiResponse<InsightsSummary> getGamificationInsightsWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday, Integer pageSize, Integer pageNumber, String sortKey, String sortMetricId, String sortOrder, String userIds, String reportsTo) throws IOException Get insights summary- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)pageSize- Page size (optional, default to 25)pageNumber- Page number (optional, default to 1)sortKey- Sort key (optional)sortMetricId- Sort Metric Id (optional)sortOrder- Sort order (optional, default to asc)userIds- A list of up to 100 comma-separated user Ids (optional)reportsTo- The reportsTo used by ABAC policies. (optional)- Returns:
- InsightsSummary
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsights
public InsightsSummary getGamificationInsights(GetGamificationInsightsRequest request) throws IOException, ApiException Get insights summary- Parameters:
request- The request object- Returns:
- InsightsSummary
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsights
public ApiResponse<InsightsSummary> getGamificationInsights(ApiRequest<Void> request) throws IOException Get insights summary- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsDetails
public InsightsDetails getGamificationInsightsDetails(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday) throws IOException, ApiException Get insights details for the current user- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- InsightsDetails
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsDetailsWithHttpInfo
public ApiResponse<InsightsDetails> getGamificationInsightsDetailsWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday) throws IOException Get insights details for the current user- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- InsightsDetails
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsDetails
public InsightsDetails getGamificationInsightsDetails(GetGamificationInsightsDetailsRequest request) throws IOException, ApiException Get insights details for the current user- Parameters:
request- The request object- Returns:
- InsightsDetails
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsDetails
public ApiResponse<InsightsDetails> getGamificationInsightsDetails(ApiRequest<Void> request) throws IOException Get insights details for the current user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsGroupsTrends
public InsightsTrend getGamificationInsightsGroupsTrends(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) throws IOException, ApiException Get insights overall trend for the current user- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)comparativePeriodEndWorkday- The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodEndWorkday- The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- InsightsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsGroupsTrendsWithHttpInfo
public ApiResponse<InsightsTrend> getGamificationInsightsGroupsTrendsWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) throws IOException Get insights overall trend for the current user- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)comparativePeriodEndWorkday- The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodEndWorkday- The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- InsightsTrend
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsGroupsTrends
public InsightsTrend getGamificationInsightsGroupsTrends(GetGamificationInsightsGroupsTrendsRequest request) throws IOException, ApiException Get insights overall trend for the current user- Parameters:
request- The request object- Returns:
- InsightsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsGroupsTrends
public ApiResponse<InsightsTrend> getGamificationInsightsGroupsTrends(ApiRequest<Void> request) throws IOException Get insights overall trend for the current user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsGroupsTrendsAll
public InsightsTrend getGamificationInsightsGroupsTrendsAll(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) throws IOException, ApiException Get insights overall trend- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)comparativePeriodEndWorkday- The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodEndWorkday- The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- InsightsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsGroupsTrendsAllWithHttpInfo
public ApiResponse<InsightsTrend> getGamificationInsightsGroupsTrendsAllWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) throws IOException Get insights overall trend- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)comparativePeriodEndWorkday- The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodEndWorkday- The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- InsightsTrend
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsGroupsTrendsAll
public InsightsTrend getGamificationInsightsGroupsTrendsAll(GetGamificationInsightsGroupsTrendsAllRequest request) throws IOException, ApiException Get insights overall trend- Parameters:
request- The request object- Returns:
- InsightsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsGroupsTrendsAll
public ApiResponse<InsightsTrend> getGamificationInsightsGroupsTrendsAll(ApiRequest<Void> request) throws IOException Get insights overall trend- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsManagers
public InsightsAgents getGamificationInsightsManagers(String filterType, String filterId, String granularity, LocalDate startWorkday, Integer pageSize, Integer pageNumber) throws IOException, ApiException Query managers in a profile during a period of time- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)startWorkday- The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)pageSize- Page size (optional, default to 100)pageNumber- Page number (optional, default to 1)- Returns:
- InsightsAgents
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsManagersWithHttpInfo
public ApiResponse<InsightsAgents> getGamificationInsightsManagersWithHttpInfo(String filterType, String filterId, String granularity, LocalDate startWorkday, Integer pageSize, Integer pageNumber) throws IOException Query managers in a profile during a period of time- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)startWorkday- The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)pageSize- Page size (optional, default to 100)pageNumber- Page number (optional, default to 1)- Returns:
- InsightsAgents
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsManagers
public InsightsAgents getGamificationInsightsManagers(GetGamificationInsightsManagersRequest request) throws IOException, ApiException Query managers in a profile during a period of time- Parameters:
request- The request object- Returns:
- InsightsAgents
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsManagers
public ApiResponse<InsightsAgents> getGamificationInsightsManagers(ApiRequest<Void> request) throws IOException Query managers in a profile during a period of time- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsMembers
public InsightsAgents getGamificationInsightsMembers(String filterType, String filterId, String granularity, LocalDate startWorkday, String reportsTo) throws IOException, ApiException Query users in a profile during a period of time- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)startWorkday- The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)reportsTo- The reportsTo used by ABAC policies. (optional)- Returns:
- InsightsAgents
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsMembersWithHttpInfo
public ApiResponse<InsightsAgents> getGamificationInsightsMembersWithHttpInfo(String filterType, String filterId, String granularity, LocalDate startWorkday, String reportsTo) throws IOException Query users in a profile during a period of time- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)startWorkday- The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)reportsTo- The reportsTo used by ABAC policies. (optional)- Returns:
- InsightsAgents
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsMembers
public InsightsAgents getGamificationInsightsMembers(GetGamificationInsightsMembersRequest request) throws IOException, ApiException Query users in a profile during a period of time- Parameters:
request- The request object- Returns:
- InsightsAgents
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsMembers
public ApiResponse<InsightsAgents> getGamificationInsightsMembers(ApiRequest<Void> request) throws IOException Query users in a profile during a period of time- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsRankings
public InsightsRankings getGamificationInsightsRankings(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday, String sortKey, String sortMetricId, Integer sectionSize, String userIds, String reportsTo) throws IOException, ApiException Get insights rankings- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)sortKey- Sort key (required)sortMetricId- Sort Metric Id (optional)sectionSize- The number of top and bottom users to return before ties (optional)userIds- A list of up to 100 comma-separated user Ids (optional)reportsTo- The reportsTo used by ABAC policies. (optional)- Returns:
- InsightsRankings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsRankingsWithHttpInfo
public ApiResponse<InsightsRankings> getGamificationInsightsRankingsWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday, String sortKey, String sortMetricId, Integer sectionSize, String userIds, String reportsTo) throws IOException Get insights rankings- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)sortKey- Sort key (required)sortMetricId- Sort Metric Id (optional)sectionSize- The number of top and bottom users to return before ties (optional)userIds- A list of up to 100 comma-separated user Ids (optional)reportsTo- The reportsTo used by ABAC policies. (optional)- Returns:
- InsightsRankings
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsRankings
public InsightsRankings getGamificationInsightsRankings(GetGamificationInsightsRankingsRequest request) throws IOException, ApiException Get insights rankings- Parameters:
request- The request object- Returns:
- InsightsRankings
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsRankings
public ApiResponse<InsightsRankings> getGamificationInsightsRankings(ApiRequest<Void> request) throws IOException Get insights rankings- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsTrends
public UserInsightsTrend getGamificationInsightsTrends(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) throws IOException, ApiException Get insights user trend for the current user- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)comparativePeriodEndWorkday- The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodEndWorkday- The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- UserInsightsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsTrendsWithHttpInfo
public ApiResponse<UserInsightsTrend> getGamificationInsightsTrendsWithHttpInfo(String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) throws IOException Get insights user trend for the current user- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)comparativePeriodEndWorkday- The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodEndWorkday- The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- UserInsightsTrend
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsTrends
public UserInsightsTrend getGamificationInsightsTrends(GetGamificationInsightsTrendsRequest request) throws IOException, ApiException Get insights user trend for the current user- Parameters:
request- The request object- Returns:
- UserInsightsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsTrends
public ApiResponse<UserInsightsTrend> getGamificationInsightsTrends(ApiRequest<Void> request) throws IOException Get insights user trend for the current user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsUserDetails
public InsightsDetails getGamificationInsightsUserDetails(String userId, String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday) throws IOException, ApiException Get insights details for the user- Parameters:
userId- The ID of a user. (required)filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- InsightsDetails
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsUserDetailsWithHttpInfo
public ApiResponse<InsightsDetails> getGamificationInsightsUserDetailsWithHttpInfo(String userId, String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate primaryPeriodStartWorkday) throws IOException Get insights details for the user- Parameters:
userId- The ID of a user. (required)filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- InsightsDetails
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsUserDetails
public InsightsDetails getGamificationInsightsUserDetails(GetGamificationInsightsUserDetailsRequest request) throws IOException, ApiException Get insights details for the user- Parameters:
request- The request object- Returns:
- InsightsDetails
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsUserDetails
public ApiResponse<InsightsDetails> getGamificationInsightsUserDetails(ApiRequest<Void> request) throws IOException Get insights details for the user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsUserTrends
public UserInsightsTrend getGamificationInsightsUserTrends(String userId, String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) throws IOException, ApiException Get insights user trend for the user- Parameters:
userId- The ID of a user. (required)filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)comparativePeriodEndWorkday- The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodEndWorkday- The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- UserInsightsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsUserTrendsWithHttpInfo
public ApiResponse<UserInsightsTrend> getGamificationInsightsUserTrendsWithHttpInfo(String userId, String filterType, String filterId, String granularity, LocalDate comparativePeriodStartWorkday, LocalDate comparativePeriodEndWorkday, LocalDate primaryPeriodStartWorkday, LocalDate primaryPeriodEndWorkday) throws IOException Get insights user trend for the user- Parameters:
userId- The ID of a user. (required)filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)granularity- Granularity (required)comparativePeriodStartWorkday- The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)comparativePeriodEndWorkday- The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodStartWorkday- The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)primaryPeriodEndWorkday- The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- UserInsightsTrend
- Throws:
IOException- if the request fails to be processed
-
getGamificationInsightsUserTrends
public UserInsightsTrend getGamificationInsightsUserTrends(GetGamificationInsightsUserTrendsRequest request) throws IOException, ApiException Get insights user trend for the user- Parameters:
request- The request object- Returns:
- UserInsightsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationInsightsUserTrends
public ApiResponse<UserInsightsTrend> getGamificationInsightsUserTrends(ApiRequest<Void> request) throws IOException Get insights user trend for the user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationLeaderboard
public Leaderboard getGamificationLeaderboard(LocalDate startWorkday, LocalDate endWorkday, String metricId) throws IOException, ApiException Leaderboard of the requesting user's division or performance profile- Parameters:
startWorkday- Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)metricId- Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given. (optional)- Returns:
- Leaderboard
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationLeaderboardWithHttpInfo
public ApiResponse<Leaderboard> getGamificationLeaderboardWithHttpInfo(LocalDate startWorkday, LocalDate endWorkday, String metricId) throws IOException Leaderboard of the requesting user's division or performance profile- Parameters:
startWorkday- Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)metricId- Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given. (optional)- Returns:
- Leaderboard
- Throws:
IOException- if the request fails to be processed
-
getGamificationLeaderboard
public Leaderboard getGamificationLeaderboard(GetGamificationLeaderboardRequest request) throws IOException, ApiException Leaderboard of the requesting user's division or performance profile- Parameters:
request- The request object- Returns:
- Leaderboard
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationLeaderboard
public ApiResponse<Leaderboard> getGamificationLeaderboard(ApiRequest<Void> request) throws IOException Leaderboard of the requesting user's division or performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationLeaderboardAll
public Leaderboard getGamificationLeaderboardAll(String filterType, String filterId, LocalDate startWorkday, LocalDate endWorkday, String metricId) throws IOException, ApiException Leaderboard by filter type- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. For example, division or performance profile Id (required)startWorkday- Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)metricId- Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given. (optional)- Returns:
- Leaderboard
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationLeaderboardAllWithHttpInfo
public ApiResponse<Leaderboard> getGamificationLeaderboardAllWithHttpInfo(String filterType, String filterId, LocalDate startWorkday, LocalDate endWorkday, String metricId) throws IOException Leaderboard by filter type- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. For example, division or performance profile Id (required)startWorkday- Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)metricId- Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given. (optional)- Returns:
- Leaderboard
- Throws:
IOException- if the request fails to be processed
-
getGamificationLeaderboardAll
public Leaderboard getGamificationLeaderboardAll(GetGamificationLeaderboardAllRequest request) throws IOException, ApiException Leaderboard by filter type- Parameters:
request- The request object- Returns:
- Leaderboard
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationLeaderboardAll
public ApiResponse<Leaderboard> getGamificationLeaderboardAll(ApiRequest<Void> request) throws IOException Leaderboard by filter type- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationLeaderboardAllBestpoints
public OverallBestPoints getGamificationLeaderboardAllBestpoints(String filterType, String filterId) throws IOException, ApiException Best Points by division or performance profile- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. For example, division or performance profile Id (required)- Returns:
- OverallBestPoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationLeaderboardAllBestpointsWithHttpInfo
public ApiResponse<OverallBestPoints> getGamificationLeaderboardAllBestpointsWithHttpInfo(String filterType, String filterId) throws IOException Best Points by division or performance profile- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. For example, division or performance profile Id (required)- Returns:
- OverallBestPoints
- Throws:
IOException- if the request fails to be processed
-
getGamificationLeaderboardAllBestpoints
public OverallBestPoints getGamificationLeaderboardAllBestpoints(GetGamificationLeaderboardAllBestpointsRequest request) throws IOException, ApiException Best Points by division or performance profile- Parameters:
request- The request object- Returns:
- OverallBestPoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationLeaderboardAllBestpoints
public ApiResponse<OverallBestPoints> getGamificationLeaderboardAllBestpoints(ApiRequest<Void> request) throws IOException Best Points by division or performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationLeaderboardBestpoints
Best Points of the requesting user's current performance profile or division- Returns:
- OverallBestPoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationLeaderboardBestpointsWithHttpInfo
public ApiResponse<OverallBestPoints> getGamificationLeaderboardBestpointsWithHttpInfo() throws IOExceptionBest Points of the requesting user's current performance profile or division- Returns:
- OverallBestPoints
- Throws:
IOException- if the request fails to be processed
-
getGamificationLeaderboardBestpoints
public OverallBestPoints getGamificationLeaderboardBestpoints(GetGamificationLeaderboardBestpointsRequest request) throws IOException, ApiException Best Points of the requesting user's current performance profile or division- Parameters:
request- The request object- Returns:
- OverallBestPoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationLeaderboardBestpoints
public ApiResponse<OverallBestPoints> getGamificationLeaderboardBestpoints(ApiRequest<Void> request) throws IOException Best Points of the requesting user's current performance profile or division- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationMetricdefinition
public MetricDefinition getGamificationMetricdefinition(String metricDefinitionId) throws IOException, ApiException Metric definition by id- Parameters:
metricDefinitionId- metric definition id (required)- Returns:
- MetricDefinition
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationMetricdefinitionWithHttpInfo
public ApiResponse<MetricDefinition> getGamificationMetricdefinitionWithHttpInfo(String metricDefinitionId) throws IOException Metric definition by id- Parameters:
metricDefinitionId- metric definition id (required)- Returns:
- MetricDefinition
- Throws:
IOException- if the request fails to be processed
-
getGamificationMetricdefinition
public MetricDefinition getGamificationMetricdefinition(GetGamificationMetricdefinitionRequest request) throws IOException, ApiException Metric definition by id- Parameters:
request- The request object- Returns:
- MetricDefinition
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationMetricdefinition
public ApiResponse<MetricDefinition> getGamificationMetricdefinition(ApiRequest<Void> request) throws IOException Metric definition by id- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationMetricdefinitions
public GetMetricDefinitionsResponse getGamificationMetricdefinitions() throws IOException, ApiExceptionAll metric definitions Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric- Returns:
- GetMetricDefinitionsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationMetricdefinitionsWithHttpInfo
public ApiResponse<GetMetricDefinitionsResponse> getGamificationMetricdefinitionsWithHttpInfo() throws IOExceptionAll metric definitions Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric- Returns:
- GetMetricDefinitionsResponse
- Throws:
IOException- if the request fails to be processed
-
getGamificationMetricdefinitions
public GetMetricDefinitionsResponse getGamificationMetricdefinitions(GetGamificationMetricdefinitionsRequest request) throws IOException, ApiException All metric definitions Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric- Parameters:
request- The request object- Returns:
- GetMetricDefinitionsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationMetricdefinitions
public ApiResponse<GetMetricDefinitionsResponse> getGamificationMetricdefinitions(ApiRequest<Void> request) throws IOException All metric definitions Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfile
Performance profile by id- Parameters:
profileId- performanceProfileId (required)- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfileWithHttpInfo
public ApiResponse<PerformanceProfile> getGamificationProfileWithHttpInfo(String profileId) throws IOException Performance profile by id- Parameters:
profileId- performanceProfileId (required)- Returns:
- PerformanceProfile
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfile
public PerformanceProfile getGamificationProfile(GetGamificationProfileRequest request) throws IOException, ApiException Performance profile by id- Parameters:
request- The request object- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfile
public ApiResponse<PerformanceProfile> getGamificationProfile(ApiRequest<Void> request) throws IOException Performance profile by id- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfileMembers
public MemberListing getGamificationProfileMembers(String profileId) throws IOException, ApiException Members of a given performance profile- Parameters:
profileId- Profile Id (required)- Returns:
- MemberListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfileMembersWithHttpInfo
public ApiResponse<MemberListing> getGamificationProfileMembersWithHttpInfo(String profileId) throws IOException Members of a given performance profile- Parameters:
profileId- Profile Id (required)- Returns:
- MemberListing
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfileMembers
public MemberListing getGamificationProfileMembers(GetGamificationProfileMembersRequest request) throws IOException, ApiException Members of a given performance profile- Parameters:
request- The request object- Returns:
- MemberListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfileMembers
public ApiResponse<MemberListing> getGamificationProfileMembers(ApiRequest<Void> request) throws IOException Members of a given performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfileMetric
public Metric getGamificationProfileMetric(String profileId, String metricId, LocalDate workday) throws IOException, ApiException Performance profile gamified metric by id- Parameters:
profileId- Performance Profile Id (required)metricId- Metric Id (required)workday- The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)- Returns:
- Metric
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfileMetricWithHttpInfo
public ApiResponse<Metric> getGamificationProfileMetricWithHttpInfo(String profileId, String metricId, LocalDate workday) throws IOException Performance profile gamified metric by id- Parameters:
profileId- Performance Profile Id (required)metricId- Metric Id (required)workday- The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)- Returns:
- Metric
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfileMetric
public Metric getGamificationProfileMetric(GetGamificationProfileMetricRequest request) throws IOException, ApiException Performance profile gamified metric by id- Parameters:
request- The request object- Returns:
- Metric
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfileMetric
public ApiResponse<Metric> getGamificationProfileMetric(ApiRequest<Void> request) throws IOException Performance profile gamified metric by id- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfileMetrics
public GetMetricResponse getGamificationProfileMetrics(String profileId, List<String> expand, LocalDate workday, String metricIds) throws IOException, ApiException All gamified metrics for a given performance profile- Parameters:
profileId- Performance Profile Id (required)expand- Which fields, if any, to expand. (optional)workday- The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)metricIds- List of metric ids to filter the response (Optional, comma-separated). (optional)- Returns:
- GetMetricResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfileMetricsWithHttpInfo
public ApiResponse<GetMetricResponse> getGamificationProfileMetricsWithHttpInfo(String profileId, List<String> expand, LocalDate workday, String metricIds) throws IOException All gamified metrics for a given performance profile- Parameters:
profileId- Performance Profile Id (required)expand- Which fields, if any, to expand. (optional)workday- The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)metricIds- List of metric ids to filter the response (Optional, comma-separated). (optional)- Returns:
- GetMetricResponse
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfileMetrics
public GetMetricResponse getGamificationProfileMetrics(GetGamificationProfileMetricsRequest request) throws IOException, ApiException All gamified metrics for a given performance profile- Parameters:
request- The request object- Returns:
- GetMetricResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfileMetrics
public ApiResponse<GetMetricResponse> getGamificationProfileMetrics(ApiRequest<Void> request) throws IOException All gamified metrics for a given performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfileMetricsObjectivedetails
public GetMetricsResponse getGamificationProfileMetricsObjectivedetails(String profileId, LocalDate workday) throws IOException, ApiException All metrics for a given performance profile with objective details such as order and maxPoints- Parameters:
profileId- Performance Profile Id (required)workday- The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)- Returns:
- GetMetricsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfileMetricsObjectivedetailsWithHttpInfo
public ApiResponse<GetMetricsResponse> getGamificationProfileMetricsObjectivedetailsWithHttpInfo(String profileId, LocalDate workday) throws IOException All metrics for a given performance profile with objective details such as order and maxPoints- Parameters:
profileId- Performance Profile Id (required)workday- The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)- Returns:
- GetMetricsResponse
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfileMetricsObjectivedetails
public GetMetricsResponse getGamificationProfileMetricsObjectivedetails(GetGamificationProfileMetricsObjectivedetailsRequest request) throws IOException, ApiException All metrics for a given performance profile with objective details such as order and maxPoints- Parameters:
request- The request object- Returns:
- GetMetricsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfileMetricsObjectivedetails
public ApiResponse<GetMetricsResponse> getGamificationProfileMetricsObjectivedetails(ApiRequest<Void> request) throws IOException All metrics for a given performance profile with objective details such as order and maxPoints- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfiles
All performance profiles- Returns:
- GetProfilesResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfilesWithHttpInfo
All performance profiles- Returns:
- GetProfilesResponse
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfiles
public GetProfilesResponse getGamificationProfiles(GetGamificationProfilesRequest request) throws IOException, ApiException All performance profiles- Parameters:
request- The request object- Returns:
- GetProfilesResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfiles
public ApiResponse<GetProfilesResponse> getGamificationProfiles(ApiRequest<Void> request) throws IOException All performance profiles- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfilesUser
public PerformanceProfile getGamificationProfilesUser(String userId, LocalDate workday) throws IOException, ApiException Performance profile of a user- Parameters:
userId- (required)workday- Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfilesUserWithHttpInfo
public ApiResponse<PerformanceProfile> getGamificationProfilesUserWithHttpInfo(String userId, LocalDate workday) throws IOException Performance profile of a user- Parameters:
userId- (required)workday- Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)- Returns:
- PerformanceProfile
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfilesUser
public PerformanceProfile getGamificationProfilesUser(GetGamificationProfilesUserRequest request) throws IOException, ApiException Performance profile of a user- Parameters:
request- The request object- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfilesUser
public ApiResponse<PerformanceProfile> getGamificationProfilesUser(ApiRequest<Void> request) throws IOException Performance profile of a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfilesUsersMe
public PerformanceProfile getGamificationProfilesUsersMe(LocalDate workday) throws IOException, ApiException Performance profile of the requesting user- Parameters:
workday- Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfilesUsersMeWithHttpInfo
public ApiResponse<PerformanceProfile> getGamificationProfilesUsersMeWithHttpInfo(LocalDate workday) throws IOException Performance profile of the requesting user- Parameters:
workday- Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)- Returns:
- PerformanceProfile
- Throws:
IOException- if the request fails to be processed
-
getGamificationProfilesUsersMe
public PerformanceProfile getGamificationProfilesUsersMe(GetGamificationProfilesUsersMeRequest request) throws IOException, ApiException Performance profile of the requesting user- Parameters:
request- The request object- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationProfilesUsersMe
public ApiResponse<PerformanceProfile> getGamificationProfilesUsersMe(ApiRequest<Void> request) throws IOException Performance profile of the requesting user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecards
public WorkdayMetricListing getGamificationScorecards(LocalDate workday, List<String> expand) throws IOException, ApiException Workday performance metrics of the requesting user- Parameters:
workday- Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)expand- Which fields, if any, to expand. (optional)- Returns:
- WorkdayMetricListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsWithHttpInfo
public ApiResponse<WorkdayMetricListing> getGamificationScorecardsWithHttpInfo(LocalDate workday, List<String> expand) throws IOException Workday performance metrics of the requesting user- Parameters:
workday- Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)expand- Which fields, if any, to expand. (optional)- Returns:
- WorkdayMetricListing
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecards
public WorkdayMetricListing getGamificationScorecards(GetGamificationScorecardsRequest request) throws IOException, ApiException Workday performance metrics of the requesting user- Parameters:
request- The request object- Returns:
- WorkdayMetricListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecards
public ApiResponse<WorkdayMetricListing> getGamificationScorecards(ApiRequest<Void> request) throws IOException Workday performance metrics of the requesting user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsAttendance
public AttendanceStatusListing getGamificationScorecardsAttendance(LocalDate startWorkday, LocalDate endWorkday) throws IOException, ApiException Attendance status metrics of the requesting user- Parameters:
startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- AttendanceStatusListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsAttendanceWithHttpInfo
public ApiResponse<AttendanceStatusListing> getGamificationScorecardsAttendanceWithHttpInfo(LocalDate startWorkday, LocalDate endWorkday) throws IOException Attendance status metrics of the requesting user- Parameters:
startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- AttendanceStatusListing
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsAttendance
public AttendanceStatusListing getGamificationScorecardsAttendance(GetGamificationScorecardsAttendanceRequest request) throws IOException, ApiException Attendance status metrics of the requesting user- Parameters:
request- The request object- Returns:
- AttendanceStatusListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsAttendance
public ApiResponse<AttendanceStatusListing> getGamificationScorecardsAttendance(ApiRequest<Void> request) throws IOException Attendance status metrics of the requesting user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsBestpoints
Best points of the requesting user- Returns:
- UserBestPoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsBestpointsWithHttpInfo
public ApiResponse<UserBestPoints> getGamificationScorecardsBestpointsWithHttpInfo() throws IOExceptionBest points of the requesting user- Returns:
- UserBestPoints
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsBestpoints
public UserBestPoints getGamificationScorecardsBestpoints(GetGamificationScorecardsBestpointsRequest request) throws IOException, ApiException Best points of the requesting user- Parameters:
request- The request object- Returns:
- UserBestPoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsBestpoints
public ApiResponse<UserBestPoints> getGamificationScorecardsBestpoints(ApiRequest<Void> request) throws IOException Best points of the requesting user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsPointsAlltime
public AllTimePoints getGamificationScorecardsPointsAlltime(LocalDate endWorkday) throws IOException, ApiException All-time points of the requesting user- Parameters:
endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- AllTimePoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsPointsAlltimeWithHttpInfo
public ApiResponse<AllTimePoints> getGamificationScorecardsPointsAlltimeWithHttpInfo(LocalDate endWorkday) throws IOException All-time points of the requesting user- Parameters:
endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- AllTimePoints
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsPointsAlltime
public AllTimePoints getGamificationScorecardsPointsAlltime(GetGamificationScorecardsPointsAlltimeRequest request) throws IOException, ApiException All-time points of the requesting user- Parameters:
request- The request object- Returns:
- AllTimePoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsPointsAlltime
public ApiResponse<AllTimePoints> getGamificationScorecardsPointsAlltime(ApiRequest<Void> request) throws IOException All-time points of the requesting user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsPointsAverage
public SingleWorkdayAveragePoints getGamificationScorecardsPointsAverage(LocalDate workday) throws IOException, ApiException Average points of the requesting user's division or performance profile- Parameters:
workday- The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- SingleWorkdayAveragePoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsPointsAverageWithHttpInfo
public ApiResponse<SingleWorkdayAveragePoints> getGamificationScorecardsPointsAverageWithHttpInfo(LocalDate workday) throws IOException Average points of the requesting user's division or performance profile- Parameters:
workday- The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- SingleWorkdayAveragePoints
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsPointsAverage
public SingleWorkdayAveragePoints getGamificationScorecardsPointsAverage(GetGamificationScorecardsPointsAverageRequest request) throws IOException, ApiException Average points of the requesting user's division or performance profile- Parameters:
request- The request object- Returns:
- SingleWorkdayAveragePoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsPointsAverage
public ApiResponse<SingleWorkdayAveragePoints> getGamificationScorecardsPointsAverage(ApiRequest<Void> request) throws IOException Average points of the requesting user's division or performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsPointsTrends
public WorkdayPointsTrend getGamificationScorecardsPointsTrends(LocalDate startWorkday, LocalDate endWorkday, String dayOfWeek) throws IOException, ApiException Points trends of the requesting user- Parameters:
startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)dayOfWeek- Optional filter to specify which day of weeks to be included in the response (optional)- Returns:
- WorkdayPointsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsPointsTrendsWithHttpInfo
public ApiResponse<WorkdayPointsTrend> getGamificationScorecardsPointsTrendsWithHttpInfo(LocalDate startWorkday, LocalDate endWorkday, String dayOfWeek) throws IOException Points trends of the requesting user- Parameters:
startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)dayOfWeek- Optional filter to specify which day of weeks to be included in the response (optional)- Returns:
- WorkdayPointsTrend
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsPointsTrends
public WorkdayPointsTrend getGamificationScorecardsPointsTrends(GetGamificationScorecardsPointsTrendsRequest request) throws IOException, ApiException Points trends of the requesting user- Parameters:
request- The request object- Returns:
- WorkdayPointsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsPointsTrends
public ApiResponse<WorkdayPointsTrend> getGamificationScorecardsPointsTrends(ApiRequest<Void> request) throws IOException Points trends of the requesting user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricUserValuesTrends
public MetricValueTrendAverage getGamificationScorecardsProfileMetricUserValuesTrends(String profileId, String metricId, String userId, LocalDate startWorkday, LocalDate endWorkday, LocalDate referenceWorkday, String timeZone) throws IOException, ApiException Average performance values trends by metric of a user- Parameters:
profileId- performanceProfileId (required)metricId- metricId (required)userId- (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)referenceWorkday- Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- MetricValueTrendAverage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricUserValuesTrendsWithHttpInfo
public ApiResponse<MetricValueTrendAverage> getGamificationScorecardsProfileMetricUserValuesTrendsWithHttpInfo(String profileId, String metricId, String userId, LocalDate startWorkday, LocalDate endWorkday, LocalDate referenceWorkday, String timeZone) throws IOException Average performance values trends by metric of a user- Parameters:
profileId- performanceProfileId (required)metricId- metricId (required)userId- (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)referenceWorkday- Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- MetricValueTrendAverage
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricUserValuesTrends
public MetricValueTrendAverage getGamificationScorecardsProfileMetricUserValuesTrends(GetGamificationScorecardsProfileMetricUserValuesTrendsRequest request) throws IOException, ApiException Average performance values trends by metric of a user- Parameters:
request- The request object- Returns:
- MetricValueTrendAverage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricUserValuesTrends
public ApiResponse<MetricValueTrendAverage> getGamificationScorecardsProfileMetricUserValuesTrends(ApiRequest<Void> request) throws IOException Average performance values trends by metric of a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricUsersValuesTrends
public MetricValueTrendAverage getGamificationScorecardsProfileMetricUsersValuesTrends(String profileId, String metricId, String filterType, LocalDate startWorkday, LocalDate endWorkday, String filterId, LocalDate referenceWorkday, String timeZone) throws IOException, ApiException Average performance values trends by metric of a division or a performance profile- Parameters:
profileId- performanceProfileId (required)metricId- metricId (required)filterType- Filter type for the query request. (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)filterId- ID for the filter type. Only required when filterType is Division. (optional)referenceWorkday- Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- MetricValueTrendAverage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricUsersValuesTrendsWithHttpInfo
public ApiResponse<MetricValueTrendAverage> getGamificationScorecardsProfileMetricUsersValuesTrendsWithHttpInfo(String profileId, String metricId, String filterType, LocalDate startWorkday, LocalDate endWorkday, String filterId, LocalDate referenceWorkday, String timeZone) throws IOException Average performance values trends by metric of a division or a performance profile- Parameters:
profileId- performanceProfileId (required)metricId- metricId (required)filterType- Filter type for the query request. (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)filterId- ID for the filter type. Only required when filterType is Division. (optional)referenceWorkday- Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- MetricValueTrendAverage
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricUsersValuesTrends
public MetricValueTrendAverage getGamificationScorecardsProfileMetricUsersValuesTrends(GetGamificationScorecardsProfileMetricUsersValuesTrendsRequest request) throws IOException, ApiException Average performance values trends by metric of a division or a performance profile- Parameters:
request- The request object- Returns:
- MetricValueTrendAverage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricUsersValuesTrends
public ApiResponse<MetricValueTrendAverage> getGamificationScorecardsProfileMetricUsersValuesTrends(ApiRequest<Void> request) throws IOException Average performance values trends by metric of a division or a performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricValuesTrends
public MetricValueTrendAverage getGamificationScorecardsProfileMetricValuesTrends(String profileId, String metricId, LocalDate startWorkday, LocalDate endWorkday, String filterType, LocalDate referenceWorkday, String timeZone) throws IOException, ApiException Average performance values trends by metric of the requesting user- Parameters:
profileId- performanceProfileId (required)metricId- metricId (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)filterType- Filter type for the query request. If not set, returns the values trends of the requesting user (optional)referenceWorkday- Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- MetricValueTrendAverage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricValuesTrendsWithHttpInfo
public ApiResponse<MetricValueTrendAverage> getGamificationScorecardsProfileMetricValuesTrendsWithHttpInfo(String profileId, String metricId, LocalDate startWorkday, LocalDate endWorkday, String filterType, LocalDate referenceWorkday, String timeZone) throws IOException Average performance values trends by metric of the requesting user- Parameters:
profileId- performanceProfileId (required)metricId- metricId (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)filterType- Filter type for the query request. If not set, returns the values trends of the requesting user (optional)referenceWorkday- Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- MetricValueTrendAverage
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricValuesTrends
public MetricValueTrendAverage getGamificationScorecardsProfileMetricValuesTrends(GetGamificationScorecardsProfileMetricValuesTrendsRequest request) throws IOException, ApiException Average performance values trends by metric of the requesting user- Parameters:
request- The request object- Returns:
- MetricValueTrendAverage
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsProfileMetricValuesTrends
public ApiResponse<MetricValueTrendAverage> getGamificationScorecardsProfileMetricValuesTrends(ApiRequest<Void> request) throws IOException Average performance values trends by metric of the requesting user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUser
public WorkdayMetricListing getGamificationScorecardsUser(String userId, LocalDate workday, List<String> expand) throws IOException, ApiException Workday performance metrics for a user- Parameters:
userId- (required)workday- Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)expand- Which fields, if any, to expand. (optional)- Returns:
- WorkdayMetricListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserWithHttpInfo
public ApiResponse<WorkdayMetricListing> getGamificationScorecardsUserWithHttpInfo(String userId, LocalDate workday, List<String> expand) throws IOException Workday performance metrics for a user- Parameters:
userId- (required)workday- Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)expand- Which fields, if any, to expand. (optional)- Returns:
- WorkdayMetricListing
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUser
public WorkdayMetricListing getGamificationScorecardsUser(GetGamificationScorecardsUserRequest request) throws IOException, ApiException Workday performance metrics for a user- Parameters:
request- The request object- Returns:
- WorkdayMetricListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUser
public ApiResponse<WorkdayMetricListing> getGamificationScorecardsUser(ApiRequest<Void> request) throws IOException Workday performance metrics for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUserAttendance
public AttendanceStatusListing getGamificationScorecardsUserAttendance(String userId, LocalDate startWorkday, LocalDate endWorkday) throws IOException, ApiException Attendance status metrics for a user- Parameters:
userId- (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- AttendanceStatusListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserAttendanceWithHttpInfo
public ApiResponse<AttendanceStatusListing> getGamificationScorecardsUserAttendanceWithHttpInfo(String userId, LocalDate startWorkday, LocalDate endWorkday) throws IOException Attendance status metrics for a user- Parameters:
userId- (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- AttendanceStatusListing
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUserAttendance
public AttendanceStatusListing getGamificationScorecardsUserAttendance(GetGamificationScorecardsUserAttendanceRequest request) throws IOException, ApiException Attendance status metrics for a user- Parameters:
request- The request object- Returns:
- AttendanceStatusListing
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserAttendance
public ApiResponse<AttendanceStatusListing> getGamificationScorecardsUserAttendance(ApiRequest<Void> request) throws IOException Attendance status metrics for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUserBestpoints
public UserBestPoints getGamificationScorecardsUserBestpoints(String userId) throws IOException, ApiException Best points of a user- Parameters:
userId- (required)- Returns:
- UserBestPoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserBestpointsWithHttpInfo
public ApiResponse<UserBestPoints> getGamificationScorecardsUserBestpointsWithHttpInfo(String userId) throws IOException Best points of a user- Parameters:
userId- (required)- Returns:
- UserBestPoints
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUserBestpoints
public UserBestPoints getGamificationScorecardsUserBestpoints(GetGamificationScorecardsUserBestpointsRequest request) throws IOException, ApiException Best points of a user- Parameters:
request- The request object- Returns:
- UserBestPoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserBestpoints
public ApiResponse<UserBestPoints> getGamificationScorecardsUserBestpoints(ApiRequest<Void> request) throws IOException Best points of a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUserPointsAlltime
public AllTimePoints getGamificationScorecardsUserPointsAlltime(String userId, LocalDate endWorkday) throws IOException, ApiException All-time points for a user- Parameters:
userId- (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- AllTimePoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserPointsAlltimeWithHttpInfo
public ApiResponse<AllTimePoints> getGamificationScorecardsUserPointsAlltimeWithHttpInfo(String userId, LocalDate endWorkday) throws IOException All-time points for a user- Parameters:
userId- (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- AllTimePoints
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUserPointsAlltime
public AllTimePoints getGamificationScorecardsUserPointsAlltime(GetGamificationScorecardsUserPointsAlltimeRequest request) throws IOException, ApiException All-time points for a user- Parameters:
request- The request object- Returns:
- AllTimePoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserPointsAlltime
public ApiResponse<AllTimePoints> getGamificationScorecardsUserPointsAlltime(ApiRequest<Void> request) throws IOException All-time points for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUserPointsTrends
public WorkdayPointsTrend getGamificationScorecardsUserPointsTrends(String userId, LocalDate startWorkday, LocalDate endWorkday, String dayOfWeek) throws IOException, ApiException Points trend for a user- Parameters:
userId- (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)dayOfWeek- Optional filter to specify which day of weeks to be included in the response (optional)- Returns:
- WorkdayPointsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserPointsTrendsWithHttpInfo
public ApiResponse<WorkdayPointsTrend> getGamificationScorecardsUserPointsTrendsWithHttpInfo(String userId, LocalDate startWorkday, LocalDate endWorkday, String dayOfWeek) throws IOException Points trend for a user- Parameters:
userId- (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)dayOfWeek- Optional filter to specify which day of weeks to be included in the response (optional)- Returns:
- WorkdayPointsTrend
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUserPointsTrends
public WorkdayPointsTrend getGamificationScorecardsUserPointsTrends(GetGamificationScorecardsUserPointsTrendsRequest request) throws IOException, ApiException Points trend for a user- Parameters:
request- The request object- Returns:
- WorkdayPointsTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserPointsTrends
public ApiResponse<WorkdayPointsTrend> getGamificationScorecardsUserPointsTrends(ApiRequest<Void> request) throws IOException Points trend for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUserValuesTrends
public WorkdayValuesTrend getGamificationScorecardsUserValuesTrends(String userId, LocalDate startWorkday, LocalDate endWorkday, String timeZone) throws IOException, ApiException Values trends of a user- Parameters:
userId- (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- WorkdayValuesTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserValuesTrendsWithHttpInfo
public ApiResponse<WorkdayValuesTrend> getGamificationScorecardsUserValuesTrendsWithHttpInfo(String userId, LocalDate startWorkday, LocalDate endWorkday, String timeZone) throws IOException Values trends of a user- Parameters:
userId- (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- WorkdayValuesTrend
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUserValuesTrends
public WorkdayValuesTrend getGamificationScorecardsUserValuesTrends(GetGamificationScorecardsUserValuesTrendsRequest request) throws IOException, ApiException Values trends of a user- Parameters:
request- The request object- Returns:
- WorkdayValuesTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUserValuesTrends
public ApiResponse<WorkdayValuesTrend> getGamificationScorecardsUserValuesTrends(ApiRequest<Void> request) throws IOException Values trends of a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUsersPointsAverage
public SingleWorkdayAveragePoints getGamificationScorecardsUsersPointsAverage(String filterType, String filterId, LocalDate workday) throws IOException, ApiException Workday average points by target group- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)workday- The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- SingleWorkdayAveragePoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUsersPointsAverageWithHttpInfo
public ApiResponse<SingleWorkdayAveragePoints> getGamificationScorecardsUsersPointsAverageWithHttpInfo(String filterType, String filterId, LocalDate workday) throws IOException Workday average points by target group- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)workday- The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)- Returns:
- SingleWorkdayAveragePoints
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUsersPointsAverage
public SingleWorkdayAveragePoints getGamificationScorecardsUsersPointsAverage(GetGamificationScorecardsUsersPointsAverageRequest request) throws IOException, ApiException Workday average points by target group- Parameters:
request- The request object- Returns:
- SingleWorkdayAveragePoints
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUsersPointsAverage
public ApiResponse<SingleWorkdayAveragePoints> getGamificationScorecardsUsersPointsAverage(ApiRequest<Void> request) throws IOException Workday average points by target group- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUsersValuesAverage
public SingleWorkdayAverageValues getGamificationScorecardsUsersValuesAverage(String filterType, String filterId, LocalDate workday, String timeZone) throws IOException, ApiException Workday average values by target group- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. For example, division Id (required)workday- The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- SingleWorkdayAverageValues
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUsersValuesAverageWithHttpInfo
public ApiResponse<SingleWorkdayAverageValues> getGamificationScorecardsUsersValuesAverageWithHttpInfo(String filterType, String filterId, LocalDate workday, String timeZone) throws IOException Workday average values by target group- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. For example, division Id (required)workday- The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- SingleWorkdayAverageValues
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUsersValuesAverage
public SingleWorkdayAverageValues getGamificationScorecardsUsersValuesAverage(GetGamificationScorecardsUsersValuesAverageRequest request) throws IOException, ApiException Workday average values by target group- Parameters:
request- The request object- Returns:
- SingleWorkdayAverageValues
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUsersValuesAverage
public ApiResponse<SingleWorkdayAverageValues> getGamificationScorecardsUsersValuesAverage(ApiRequest<Void> request) throws IOException Workday average values by target group- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUsersValuesTrends
public WorkdayValuesTrend getGamificationScorecardsUsersValuesTrends(String filterType, String filterId, LocalDate startWorkday, LocalDate endWorkday, String timeZone) throws IOException, ApiException Values trend by target group- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- WorkdayValuesTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUsersValuesTrendsWithHttpInfo
public ApiResponse<WorkdayValuesTrend> getGamificationScorecardsUsersValuesTrendsWithHttpInfo(String filterType, String filterId, LocalDate startWorkday, LocalDate endWorkday, String timeZone) throws IOException Values trend by target group- Parameters:
filterType- Filter type for the query request. (required)filterId- ID for the filter type. (required)startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- WorkdayValuesTrend
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsUsersValuesTrends
public WorkdayValuesTrend getGamificationScorecardsUsersValuesTrends(GetGamificationScorecardsUsersValuesTrendsRequest request) throws IOException, ApiException Values trend by target group- Parameters:
request- The request object- Returns:
- WorkdayValuesTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsUsersValuesTrends
public ApiResponse<WorkdayValuesTrend> getGamificationScorecardsUsersValuesTrends(ApiRequest<Void> request) throws IOException Values trend by target group- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsValuesAverage
public SingleWorkdayAverageValues getGamificationScorecardsValuesAverage(LocalDate workday, String timeZone) throws IOException, ApiException Average values of the requesting user's division or performance profile- Parameters:
workday- The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- SingleWorkdayAverageValues
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsValuesAverageWithHttpInfo
public ApiResponse<SingleWorkdayAverageValues> getGamificationScorecardsValuesAverageWithHttpInfo(LocalDate workday, String timeZone) throws IOException Average values of the requesting user's division or performance profile- Parameters:
workday- The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- SingleWorkdayAverageValues
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsValuesAverage
public SingleWorkdayAverageValues getGamificationScorecardsValuesAverage(GetGamificationScorecardsValuesAverageRequest request) throws IOException, ApiException Average values of the requesting user's division or performance profile- Parameters:
request- The request object- Returns:
- SingleWorkdayAverageValues
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsValuesAverage
public ApiResponse<SingleWorkdayAverageValues> getGamificationScorecardsValuesAverage(ApiRequest<Void> request) throws IOException Average values of the requesting user's division or performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsValuesTrends
public WorkdayValuesTrend getGamificationScorecardsValuesTrends(LocalDate startWorkday, LocalDate endWorkday, String filterType, LocalDate referenceWorkday, String timeZone) throws IOException, ApiException Values trends of the requesting user or group- Parameters:
startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)filterType- Filter type for the query request. If not set, then the request is for the requesting user. (optional)referenceWorkday- Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- WorkdayValuesTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsValuesTrendsWithHttpInfo
public ApiResponse<WorkdayValuesTrend> getGamificationScorecardsValuesTrendsWithHttpInfo(LocalDate startWorkday, LocalDate endWorkday, String filterType, LocalDate referenceWorkday, String timeZone) throws IOException Values trends of the requesting user or group- Parameters:
startWorkday- Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)endWorkday- End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (required)filterType- Filter type for the query request. If not set, then the request is for the requesting user. (optional)referenceWorkday- Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional)timeZone- Timezone for the workday. Defaults to UTC (optional, default to UTC)- Returns:
- WorkdayValuesTrend
- Throws:
IOException- if the request fails to be processed
-
getGamificationScorecardsValuesTrends
public WorkdayValuesTrend getGamificationScorecardsValuesTrends(GetGamificationScorecardsValuesTrendsRequest request) throws IOException, ApiException Values trends of the requesting user or group- Parameters:
request- The request object- Returns:
- WorkdayValuesTrend
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationScorecardsValuesTrends
public ApiResponse<WorkdayValuesTrend> getGamificationScorecardsValuesTrends(ApiRequest<Void> request) throws IOException Values trends of the requesting user or group- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationStatus
Gamification activation status- Returns:
- GamificationStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationStatusWithHttpInfo
Gamification activation status- Returns:
- GamificationStatus
- Throws:
IOException- if the request fails to be processed
-
getGamificationStatus
public GamificationStatus getGamificationStatus(GetGamificationStatusRequest request) throws IOException, ApiException Gamification activation status- Parameters:
request- The request object- Returns:
- GamificationStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationStatus
public ApiResponse<GamificationStatus> getGamificationStatus(ApiRequest<Void> request) throws IOException Gamification activation status- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationTemplate
public ObjectiveTemplate getGamificationTemplate(String templateId) throws IOException, ApiException Objective template by id- Parameters:
templateId- template id (required)- Returns:
- ObjectiveTemplate
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationTemplateWithHttpInfo
public ApiResponse<ObjectiveTemplate> getGamificationTemplateWithHttpInfo(String templateId) throws IOException Objective template by id- Parameters:
templateId- template id (required)- Returns:
- ObjectiveTemplate
- Throws:
IOException- if the request fails to be processed
-
getGamificationTemplate
public ObjectiveTemplate getGamificationTemplate(GetGamificationTemplateRequest request) throws IOException, ApiException Objective template by id- Parameters:
request- The request object- Returns:
- ObjectiveTemplate
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationTemplate
public ApiResponse<ObjectiveTemplate> getGamificationTemplate(ApiRequest<Void> request) throws IOException Objective template by id- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
getGamificationTemplates
All objective templates- Returns:
- GetTemplatesResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationTemplatesWithHttpInfo
All objective templates- Returns:
- GetTemplatesResponse
- Throws:
IOException- if the request fails to be processed
-
getGamificationTemplates
public GetTemplatesResponse getGamificationTemplates(GetGamificationTemplatesRequest request) throws IOException, ApiException All objective templates- Parameters:
request- The request object- Returns:
- GetTemplatesResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
getGamificationTemplates
public ApiResponse<GetTemplatesResponse> getGamificationTemplates(ApiRequest<Void> request) throws IOException All objective templates- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchEmployeeperformanceExternalmetricsDefinition
public ExternalMetricDefinition patchEmployeeperformanceExternalmetricsDefinition(String metricId, ExternalMetricDefinitionUpdateRequest body) throws IOException, ApiException Update External Metric Definition- Parameters:
metricId- Specifies the metric definition ID (required)body- The External Metric Definition parameters to be updated (required)- Returns:
- ExternalMetricDefinition
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchEmployeeperformanceExternalmetricsDefinitionWithHttpInfo
public ApiResponse<ExternalMetricDefinition> patchEmployeeperformanceExternalmetricsDefinitionWithHttpInfo(String metricId, ExternalMetricDefinitionUpdateRequest body) throws IOException Update External Metric Definition- Parameters:
metricId- Specifies the metric definition ID (required)body- The External Metric Definition parameters to be updated (required)- Returns:
- ExternalMetricDefinition
- Throws:
IOException- if the request fails to be processed
-
patchEmployeeperformanceExternalmetricsDefinition
public ExternalMetricDefinition patchEmployeeperformanceExternalmetricsDefinition(PatchEmployeeperformanceExternalmetricsDefinitionRequest request) throws IOException, ApiException Update External Metric Definition- Parameters:
request- The request object- Returns:
- ExternalMetricDefinition
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchEmployeeperformanceExternalmetricsDefinition
public ApiResponse<ExternalMetricDefinition> patchEmployeeperformanceExternalmetricsDefinition(ApiRequest<ExternalMetricDefinitionUpdateRequest> request) throws IOException Update External Metric Definition- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
patchGamificationContest
public ContestsResponse patchGamificationContest(String contestId, ContestsFinalizeRequest body) throws IOException, ApiException Finalize a Contest by Id- Parameters:
contestId- The ID of the contest (required)body- Finalize Contest (required)- Returns:
- ContestsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchGamificationContestWithHttpInfo
public ApiResponse<ContestsResponse> patchGamificationContestWithHttpInfo(String contestId, ContestsFinalizeRequest body) throws IOException Finalize a Contest by Id- Parameters:
contestId- The ID of the contest (required)body- Finalize Contest (required)- Returns:
- ContestsResponse
- Throws:
IOException- if the request fails to be processed
-
patchGamificationContest
public ContestsResponse patchGamificationContest(PatchGamificationContestRequest request) throws IOException, ApiException Finalize a Contest by Id- Parameters:
request- The request object- Returns:
- ContestsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
patchGamificationContest
public ApiResponse<ContestsResponse> patchGamificationContest(ApiRequest<ContestsFinalizeRequest> request) throws IOException Finalize a Contest by Id- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postEmployeeperformanceExternalmetricsData
public ExternalMetricDataWriteResponse postEmployeeperformanceExternalmetricsData(ExternalMetricDataWriteRequest body) throws IOException, ApiException Write External Metric Data- Parameters:
body- The External Metric Data to be added (optional)- Returns:
- ExternalMetricDataWriteResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postEmployeeperformanceExternalmetricsDataWithHttpInfo
public ApiResponse<ExternalMetricDataWriteResponse> postEmployeeperformanceExternalmetricsDataWithHttpInfo(ExternalMetricDataWriteRequest body) throws IOException Write External Metric Data- Parameters:
body- The External Metric Data to be added (optional)- Returns:
- ExternalMetricDataWriteResponse
- Throws:
IOException- if the request fails to be processed
-
postEmployeeperformanceExternalmetricsData
public ExternalMetricDataWriteResponse postEmployeeperformanceExternalmetricsData(PostEmployeeperformanceExternalmetricsDataRequest request) throws IOException, ApiException Write External Metric Data- Parameters:
request- The request object- Returns:
- ExternalMetricDataWriteResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postEmployeeperformanceExternalmetricsData
public ApiResponse<ExternalMetricDataWriteResponse> postEmployeeperformanceExternalmetricsData(ApiRequest<ExternalMetricDataWriteRequest> request) throws IOException Write External Metric Data- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postEmployeeperformanceExternalmetricsDefinitions
public ExternalMetricDefinition postEmployeeperformanceExternalmetricsDefinitions(ExternalMetricDefinitionCreateRequest body) throws IOException, ApiException Create External Metric Definition- Parameters:
body- The External Metric Definition to be created (optional)- Returns:
- ExternalMetricDefinition
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postEmployeeperformanceExternalmetricsDefinitionsWithHttpInfo
public ApiResponse<ExternalMetricDefinition> postEmployeeperformanceExternalmetricsDefinitionsWithHttpInfo(ExternalMetricDefinitionCreateRequest body) throws IOException Create External Metric Definition- Parameters:
body- The External Metric Definition to be created (optional)- Returns:
- ExternalMetricDefinition
- Throws:
IOException- if the request fails to be processed
-
postEmployeeperformanceExternalmetricsDefinitions
public ExternalMetricDefinition postEmployeeperformanceExternalmetricsDefinitions(PostEmployeeperformanceExternalmetricsDefinitionsRequest request) throws IOException, ApiException Create External Metric Definition- Parameters:
request- The request object- Returns:
- ExternalMetricDefinition
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postEmployeeperformanceExternalmetricsDefinitions
public ApiResponse<ExternalMetricDefinition> postEmployeeperformanceExternalmetricsDefinitions(ApiRequest<ExternalMetricDefinitionCreateRequest> request) throws IOException Create External Metric Definition- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationContests
public ContestsResponse postGamificationContests(ContestsCreateRequest body) throws IOException, ApiException Creates a Contest- Parameters:
body- Create Contest (required)- Returns:
- ContestsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationContestsWithHttpInfo
public ApiResponse<ContestsResponse> postGamificationContestsWithHttpInfo(ContestsCreateRequest body) throws IOException Creates a Contest- Parameters:
body- Create Contest (required)- Returns:
- ContestsResponse
- Throws:
IOException- if the request fails to be processed
-
postGamificationContests
public ContestsResponse postGamificationContests(PostGamificationContestsRequest request) throws IOException, ApiException Creates a Contest- Parameters:
request- The request object- Returns:
- ContestsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationContests
public ApiResponse<ContestsResponse> postGamificationContests(ApiRequest<ContestsCreateRequest> request) throws IOException Creates a Contest- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationContestsUploadsPrizeimages
public UploadUrlResponse postGamificationContestsUploadsPrizeimages(GamificationContestPrizeImageUploadUrlRequest body) throws IOException, ApiException Generates pre-signed URL to upload a prize image for gamification contests- Parameters:
body- query (required)- Returns:
- UploadUrlResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationContestsUploadsPrizeimagesWithHttpInfo
public ApiResponse<UploadUrlResponse> postGamificationContestsUploadsPrizeimagesWithHttpInfo(GamificationContestPrizeImageUploadUrlRequest body) throws IOException Generates pre-signed URL to upload a prize image for gamification contests- Parameters:
body- query (required)- Returns:
- UploadUrlResponse
- Throws:
IOException- if the request fails to be processed
-
postGamificationContestsUploadsPrizeimages
public UploadUrlResponse postGamificationContestsUploadsPrizeimages(PostGamificationContestsUploadsPrizeimagesRequest request) throws IOException, ApiException Generates pre-signed URL to upload a prize image for gamification contests- Parameters:
request- The request object- Returns:
- UploadUrlResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationContestsUploadsPrizeimages
public ApiResponse<UploadUrlResponse> postGamificationContestsUploadsPrizeimages(ApiRequest<GamificationContestPrizeImageUploadUrlRequest> request) throws IOException Generates pre-signed URL to upload a prize image for gamification contests- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileActivate
public PerformanceProfile postGamificationProfileActivate(String profileId) throws IOException, ApiException Activate a performance profile- Parameters:
profileId- performanceProfileId (required)- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileActivateWithHttpInfo
public ApiResponse<PerformanceProfile> postGamificationProfileActivateWithHttpInfo(String profileId) throws IOException Activate a performance profile- Parameters:
profileId- performanceProfileId (required)- Returns:
- PerformanceProfile
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileActivate
public PerformanceProfile postGamificationProfileActivate(PostGamificationProfileActivateRequest request) throws IOException, ApiException Activate a performance profile- Parameters:
request- The request object- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileActivate
public ApiResponse<PerformanceProfile> postGamificationProfileActivate(ApiRequest<Void> request) throws IOException Activate a performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileDeactivate
public PerformanceProfile postGamificationProfileDeactivate(String profileId) throws IOException, ApiException Deactivate a performance profile- Parameters:
profileId- performanceProfileId (required)- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileDeactivateWithHttpInfo
public ApiResponse<PerformanceProfile> postGamificationProfileDeactivateWithHttpInfo(String profileId) throws IOException Deactivate a performance profile- Parameters:
profileId- performanceProfileId (required)- Returns:
- PerformanceProfile
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileDeactivate
public PerformanceProfile postGamificationProfileDeactivate(PostGamificationProfileDeactivateRequest request) throws IOException, ApiException Deactivate a performance profile- Parameters:
request- The request object- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileDeactivate
public ApiResponse<PerformanceProfile> postGamificationProfileDeactivate(ApiRequest<Void> request) throws IOException Deactivate a performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileMembers
public Assignment postGamificationProfileMembers(String profileId, AssignUsers body) throws IOException, ApiException Assign members to a given performance profile- Parameters:
profileId- Profile Id (required)body- assignUsers (required)- Returns:
- Assignment
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileMembersWithHttpInfo
public ApiResponse<Assignment> postGamificationProfileMembersWithHttpInfo(String profileId, AssignUsers body) throws IOException Assign members to a given performance profile- Parameters:
profileId- Profile Id (required)body- assignUsers (required)- Returns:
- Assignment
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileMembers
public Assignment postGamificationProfileMembers(PostGamificationProfileMembersRequest request) throws IOException, ApiException Assign members to a given performance profile- Parameters:
request- The request object- Returns:
- Assignment
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileMembers
public ApiResponse<Assignment> postGamificationProfileMembers(ApiRequest<AssignUsers> request) throws IOException Assign members to a given performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileMembersValidate
public AssignmentValidation postGamificationProfileMembersValidate(String profileId, ValidateAssignUsers body) throws IOException, ApiException Validate member assignment- Parameters:
profileId- Profile Id (required)body- memberAssignments (required)- Returns:
- AssignmentValidation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileMembersValidateWithHttpInfo
public ApiResponse<AssignmentValidation> postGamificationProfileMembersValidateWithHttpInfo(String profileId, ValidateAssignUsers body) throws IOException Validate member assignment- Parameters:
profileId- Profile Id (required)body- memberAssignments (required)- Returns:
- AssignmentValidation
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileMembersValidate
public AssignmentValidation postGamificationProfileMembersValidate(PostGamificationProfileMembersValidateRequest request) throws IOException, ApiException Validate member assignment- Parameters:
request- The request object- Returns:
- AssignmentValidation
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileMembersValidate
public ApiResponse<AssignmentValidation> postGamificationProfileMembersValidate(ApiRequest<ValidateAssignUsers> request) throws IOException Validate member assignment- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileMetricLink
public Metric postGamificationProfileMetricLink(String sourceProfileId, String sourceMetricId, TargetPerformanceProfile body) throws IOException, ApiException Creates a linked metric- Parameters:
sourceProfileId- Source Performance Profile Id (required)sourceMetricId- Source Metric Id (required)body- linkedMetric (required)- Returns:
- Metric
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileMetricLinkWithHttpInfo
public ApiResponse<Metric> postGamificationProfileMetricLinkWithHttpInfo(String sourceProfileId, String sourceMetricId, TargetPerformanceProfile body) throws IOException Creates a linked metric- Parameters:
sourceProfileId- Source Performance Profile Id (required)sourceMetricId- Source Metric Id (required)body- linkedMetric (required)- Returns:
- Metric
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileMetricLink
public Metric postGamificationProfileMetricLink(PostGamificationProfileMetricLinkRequest request) throws IOException, ApiException Creates a linked metric- Parameters:
request- The request object- Returns:
- Metric
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileMetricLink
public ApiResponse<Metric> postGamificationProfileMetricLink(ApiRequest<TargetPerformanceProfile> request) throws IOException Creates a linked metric- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileMetrics
public Metric postGamificationProfileMetrics(String profileId, CreateMetric body) throws IOException, ApiException Creates a gamified metric with a given metric definition and metric objective under in a performance profile- Parameters:
profileId- Performance Profile Id (required)body- Metric (required)- Returns:
- Metric
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileMetricsWithHttpInfo
public ApiResponse<Metric> postGamificationProfileMetricsWithHttpInfo(String profileId, CreateMetric body) throws IOException Creates a gamified metric with a given metric definition and metric objective under in a performance profile- Parameters:
profileId- Performance Profile Id (required)body- Metric (required)- Returns:
- Metric
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfileMetrics
public Metric postGamificationProfileMetrics(PostGamificationProfileMetricsRequest request) throws IOException, ApiException Creates a gamified metric with a given metric definition and metric objective under in a performance profile- Parameters:
request- The request object- Returns:
- Metric
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfileMetrics
public ApiResponse<Metric> postGamificationProfileMetrics(ApiRequest<CreateMetric> request) throws IOException Creates a gamified metric with a given metric definition and metric objective under in a performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfiles
public PerformanceProfile postGamificationProfiles(CreatePerformanceProfile body, Boolean copyMetrics) throws IOException, ApiException Create a new custom performance profile- Parameters:
body- performanceProfile (required)copyMetrics- Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile. (optional, default to true)- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfilesWithHttpInfo
public ApiResponse<PerformanceProfile> postGamificationProfilesWithHttpInfo(CreatePerformanceProfile body, Boolean copyMetrics) throws IOException Create a new custom performance profile- Parameters:
body- performanceProfile (required)copyMetrics- Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile. (optional, default to true)- Returns:
- PerformanceProfile
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfiles
public PerformanceProfile postGamificationProfiles(PostGamificationProfilesRequest request) throws IOException, ApiException Create a new custom performance profile- Parameters:
request- The request object- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfiles
public ApiResponse<PerformanceProfile> postGamificationProfiles(ApiRequest<CreatePerformanceProfile> request) throws IOException Create a new custom performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfilesUserQuery
public UserProfilesInDateRange postGamificationProfilesUserQuery(String userId, UserProfilesInDateRangeRequest body) throws IOException, ApiException Query performance profiles in date range for a user- Parameters:
userId- The ID of a user. (required)body- The date range of work day. (required)- Returns:
- UserProfilesInDateRange
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfilesUserQueryWithHttpInfo
public ApiResponse<UserProfilesInDateRange> postGamificationProfilesUserQueryWithHttpInfo(String userId, UserProfilesInDateRangeRequest body) throws IOException Query performance profiles in date range for a user- Parameters:
userId- The ID of a user. (required)body- The date range of work day. (required)- Returns:
- UserProfilesInDateRange
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfilesUserQuery
public UserProfilesInDateRange postGamificationProfilesUserQuery(PostGamificationProfilesUserQueryRequest request) throws IOException, ApiException Query performance profiles in date range for a user- Parameters:
request- The request object- Returns:
- UserProfilesInDateRange
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfilesUserQuery
public ApiResponse<UserProfilesInDateRange> postGamificationProfilesUserQuery(ApiRequest<UserProfilesInDateRangeRequest> request) throws IOException Query performance profiles in date range for a user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfilesUsersMeQuery
public UserProfilesInDateRange postGamificationProfilesUsersMeQuery(UserProfilesInDateRangeRequest body) throws IOException, ApiException Query performance profiles in date range for the current user- Parameters:
body- The date range of work day. (required)- Returns:
- UserProfilesInDateRange
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfilesUsersMeQueryWithHttpInfo
public ApiResponse<UserProfilesInDateRange> postGamificationProfilesUsersMeQueryWithHttpInfo(UserProfilesInDateRangeRequest body) throws IOException Query performance profiles in date range for the current user- Parameters:
body- The date range of work day. (required)- Returns:
- UserProfilesInDateRange
- Throws:
IOException- if the request fails to be processed
-
postGamificationProfilesUsersMeQuery
public UserProfilesInDateRange postGamificationProfilesUsersMeQuery(PostGamificationProfilesUsersMeQueryRequest request) throws IOException, ApiException Query performance profiles in date range for the current user- Parameters:
request- The request object- Returns:
- UserProfilesInDateRange
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
postGamificationProfilesUsersMeQuery
public ApiResponse<UserProfilesInDateRange> postGamificationProfilesUsersMeQuery(ApiRequest<UserProfilesInDateRangeRequest> request) throws IOException Query performance profiles in date range for the current user- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putGamificationContest
public ContestsResponse putGamificationContest(String contestId, ContestsCreateRequest body) throws IOException, ApiException Update a Contest by Id- Parameters:
contestId- The ID of the contest (required)body- Contest (required)- Returns:
- ContestsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putGamificationContestWithHttpInfo
public ApiResponse<ContestsResponse> putGamificationContestWithHttpInfo(String contestId, ContestsCreateRequest body) throws IOException Update a Contest by Id- Parameters:
contestId- The ID of the contest (required)body- Contest (required)- Returns:
- ContestsResponse
- Throws:
IOException- if the request fails to be processed
-
putGamificationContest
public ContestsResponse putGamificationContest(PutGamificationContestRequest request) throws IOException, ApiException Update a Contest by Id- Parameters:
request- The request object- Returns:
- ContestsResponse
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putGamificationContest
public ApiResponse<ContestsResponse> putGamificationContest(ApiRequest<ContestsCreateRequest> request) throws IOException Update a Contest by Id- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putGamificationProfile
public PerformanceProfile putGamificationProfile(String profileId, PerformanceProfile body) throws IOException, ApiException Updates a performance profile- Parameters:
profileId- performanceProfileId (required)body- performanceProfile (optional)- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putGamificationProfileWithHttpInfo
public ApiResponse<PerformanceProfile> putGamificationProfileWithHttpInfo(String profileId, PerformanceProfile body) throws IOException Updates a performance profile- Parameters:
profileId- performanceProfileId (required)body- performanceProfile (optional)- Returns:
- PerformanceProfile
- Throws:
IOException- if the request fails to be processed
-
putGamificationProfile
public PerformanceProfile putGamificationProfile(PutGamificationProfileRequest request) throws IOException, ApiException Updates a performance profile- Parameters:
request- The request object- Returns:
- PerformanceProfile
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putGamificationProfile
public ApiResponse<PerformanceProfile> putGamificationProfile(ApiRequest<PerformanceProfile> request) throws IOException Updates a performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putGamificationProfileMetric
public Metric putGamificationProfileMetric(String profileId, String metricId, CreateMetric body) throws IOException, ApiException Updates a metric in performance profile- Parameters:
profileId- Performance Profile Id (required)metricId- Metric Id (required)body- Metric (required)- Returns:
- Metric
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putGamificationProfileMetricWithHttpInfo
public ApiResponse<Metric> putGamificationProfileMetricWithHttpInfo(String profileId, String metricId, CreateMetric body) throws IOException Updates a metric in performance profile- Parameters:
profileId- Performance Profile Id (required)metricId- Metric Id (required)body- Metric (required)- Returns:
- Metric
- Throws:
IOException- if the request fails to be processed
-
putGamificationProfileMetric
public Metric putGamificationProfileMetric(PutGamificationProfileMetricRequest request) throws IOException, ApiException Updates a metric in performance profile- Parameters:
request- The request object- Returns:
- Metric
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putGamificationProfileMetric
public ApiResponse<Metric> putGamificationProfileMetric(ApiRequest<CreateMetric> request) throws IOException Updates a metric in performance profile- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-
putGamificationStatus
public GamificationStatus putGamificationStatus(GamificationStatus status) throws IOException, ApiException Update gamification activation status- Parameters:
status- Gamification status (required)- Returns:
- GamificationStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putGamificationStatusWithHttpInfo
public ApiResponse<GamificationStatus> putGamificationStatusWithHttpInfo(GamificationStatus status) throws IOException Update gamification activation status- Parameters:
status- Gamification status (required)- Returns:
- GamificationStatus
- Throws:
IOException- if the request fails to be processed
-
putGamificationStatus
public GamificationStatus putGamificationStatus(PutGamificationStatusRequest request) throws IOException, ApiException Update gamification activation status- Parameters:
request- The request object- Returns:
- GamificationStatus
- Throws:
ApiException- if the request fails on the serverIOException- if the request fails to be processed
-
putGamificationStatus
public ApiResponse<GamificationStatus> putGamificationStatus(ApiRequest<GamificationStatus> request) throws IOException Update gamification activation status- Parameters:
request- The request object- Returns:
- the response
- Throws:
IOException- if the request fails to be processed
-