Connectors

HR & People

UKG Pro Workforce Management

Timekeeping and scheduling: people, shifts, pay codes, labor tasks, and leave
Signs in with
OAuth 2.0 sign-in
Runs on
Cloud or On-Prem Worker
Operations
2,687
Ready-made triggers
0

Connect UKG Pro Workforce Management

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for UKG Pro Workforce Management and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
For services offered under Connect a Service you only sign in and approve access. Otherwise use Connect with OAuth2 with your own OAuth app. See Authorize with OAuth.
FieldWhat to enter
Tenant hostRequiredYour UKG Pro Workforce Management tenant host without https:// (for example mycompany.prd.mykronos.com); the API base is https://<host>/api.Example: mycompany.prd.mykronos.com
Token endpointRequiredUKG Authentication: https://welcome-us.ukg.net/oauth/token (client credentials). Legacy OAuth: https://<tenant host>/api/authentication/access_token (password grant with a user name and password).
Client IDRequiredThe client ID of your UKG Authentication or Pro WFM OAuth client.
Client secretRequiredSecretThe client secret issued with that client ID.
AudienceOptionalFor UKG Authentication: https://wfm.ukg.net/api. Leave empty for the legacy token endpoint.
OrganizationOptionalFor UKG Authentication: the organization ID of your tenant.
User nameOptionalFor the legacy token endpoint only: the API user the integration signs in as.
PasswordOptionalSecretFor the legacy token endpoint only: that user's password.
Authentication chainOptionalFor the legacy token endpoint only: OAuthLdapService. Leave empty for UKG Authentication.
Client authenticationOptionalBoth token endpoints read the client credentials from the token request body.

Use it in a flow

  1. Open a flow, open the node library and search for UKG Pro Workforce Management.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. Use Test this step to see what it returns, then save.

To start a flow from UKG Pro Workforce Management without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if UKG Pro Workforce Management can send webhooks, a Webhook trigger receives them at its own URL.

Operations

2,687 operations in 551 groups. Each one is a step you can add to a flow.

Absence Quota Overrides2
Create, Update, or Delete Absence Quota OverridescreateUpdateOrDeleteAbsenceQuotaOverridesPOSTThis operation provides a versatile request structure that allows you to create, update, or delete absence quota overrides for a specified team definition.
Retrieve Absence Quota OverridesretrieveAbsenceQuotaOverridesPOSTThis operation returns absence quota overrides for a specified team definition reference within a date range.
Absence Spans1
Retrieve Absence SpansretrieveAbsenceSpansPOSTThis operation returns absence spans by object references.
Access Control Points1
Retrieve All Access Control PointsretrieveAllAccessControlPointsGETThis operation returns a list of all Access Control Points.
Access Method Profiles10
Create Access Method ProfilecreateAccessMethodProfilePOSTThis operation creates an access method profile.
Create or Update Access Method ProfilescreateOrUpdateAccessMethodProfilesPOSTThis operation creates or updates one or more access method profiles.
Delete Access Method Profile by IDdeleteAccessMethodProfileByIDDELETEThis operation deletes an access method profile by ID.
Delete Access Method ProfilesdeleteAccessMethodProfilesPOSTThis operation deletes one or more access method profiles.
Retrieve Access Method Profile by IDretrieveAccessMethodProfileByIDGETThis operation returns an access method profile by ID.
Retrieve Access Method ProfilesretrieveAccessMethodProfilesPOSTThis operation returns one or more access method profiles by object references.
Retrieve Access MethodsretrieveAccessMethodsGETThis operation returns access methods.
Retrieve All Access Method ProfilesretrieveAllAccessMethodProfilesGETThis operation returns all access method profiles.
Retrieve Role Profiles for Access Method ProfilesretrieveRoleProfilesForAccessMethodProfilesGETThis operation returns role profiles.
Update Access Method Profile by IDupdateAccessMethodProfileByIDPUTThis operation updates an access method profile by ID.
Accrual Codes3
Retrieve Accrual Code by IDretrieveAccrualCodeByIDGETThis operation returns an accrual code by ID according to the user's access rights.
Retrieve Accrual CodesretrieveAccrualCodesGETThis operation returns a list of accrual code types according to the user's access rights.
Retrieve Accrual Codes (Deprecated)retrieveAccrualCodesDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/accrual codes.
Accrual Move Balances1
Move Accrual Balances for Multiple EmployeesmoveAccrualBalancesForMultipleEmployeesPOSTThis operation performs a move action on one or more accrual balances for multiple employees.
Accrual Policies5
Create or Update Accrual PoliciescreateOrUpdateAccrualPoliciesPOSTThis operation creates or updates one or more accrual policies.
Delete Accrual PoliciesdeleteAccrualPoliciesPOSTThis operation deletes one or more accrual policies according to the specified properties.
Delete Accrual Policy by IDdeleteAccrualPolicyByIDDELETEThis operation deletes an accrual policy by ID.
Retrieve Accrual PoliciesretrieveAccrualPoliciesPOSTThis operation returns a list of accrual policies according to the calling user's access rights.
Retrieve Accrual Policy by IDretrieveAccrualPolicyByIDGETThis operation returns an accrual policy by ID.
Accrual Profiles8
Create or Update Accrual ProfilescreateOrUpdateAccrualProfilesPOSTThe operation creates or updates one or more accrual profiles.
Delete Accrual Profile by IDdeleteAccrualProfileByIDDELETEThis operation deletes an accrual profile by ID.
Retrieve Accrual Profile by IDretrieveAccrualProfileByIDGETThis operation takes an ID and returns the specified accrual profile type according to the user's access rights.
Retrieve Accrual Profile by ID (Deprecated)retrieveAccrualProfileByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/accrual profiles/{id}.
Retrieve Accrual ProfilesretrieveAccrualProfilesPOSTThis operation returns a list of accrual profiles by object references.
Retrieve All Accrual ProfilesretrieveAllAccrualProfilesGETThis operation returns a paginated list of accrual profiles according to the user's access rights.
Retrieve All Accrual Profiles (Deprecated V1)retrieveAllAccrualProfilesDeprecatedV1GETThis operation is deprecated; instead use GET /v3/timekeeping/setup/accrual profiles.
Retrieve All Accrual Profiles (Deprecated V2)retrieveAllAccrualProfilesDeprecatedV2GETThis operation is deprecated; instead use GET /v3/timekeeping/setup/accrual profiles.
Accruals Bulk Transactions3
Bulk Accrual PayoutbulkAccrualPayoutPOSTThis operation performs a bulk accrual payout.
Bulk Accrual ResetbulkAccrualResetPOSTThis operation performs a bulk accrual reset.
Bulk Accrual Suspensions or ReinstatementsbulkAccrualSuspensionsOrReinstatementsPOSTThis operation performs bulk accrual suspensions or reinstatements.
Accruals Bulk Update1
Apply Updates to Accrual Balances for Multiple EmployeesapplyUpdatesToAccrualBalancesForMultipleEmployeesPOSTThis operation updates accrual balances in bulk.
Accruals from Paycodes1
Retrieve Accrual Codes from PaycodesretrieveAccrualCodesFromPaycodesPOSTThis operation returns a list of matching accrual codes from a list of pay codes for an employee.
Accuracy Metrics Engine1
Execute Accuracy Metrics EngineexecuteAccuracyMetricsEnginePOSTThis operation executes the Accuracy Metrics engine and returns the results.
Action Templates2
Retrieve All Announcement Action TemplatesretrieveAllAnnouncementActionTemplatesGETThis operation returns all announcement action template definitions.
Retrieve Announcement Action Template by IDretrieveAnnouncementActionTemplateByIDGETThis operation returns an announcement action template by ID.
Actions6
Complete ActionscompleteActionsPOSTThis operation completes actions for a list of employees whose actions fall within a date range.
Retrieve Action by IDretrieveActionByIDGETThis operation returns information about an action by ID.
Retrieve Action Documents by IDretrieveActionDocumentsByIDGETThis operation returns all the documents associated with an action by ID.
Retrieve Actions' DocumentsretrieveActionsDocumentsPOSTThis operation returns all documents associated with a group of actions for a list of employees within a date range.
Retrieve Multiple ActionsretrieveMultipleActionsPOSTThis operation returns all actions for a list of employees within a date range irrespective of their status.
Update Action by IDupdateActionByIDPOSTThis operation updates an action's completion date and user note by ID.
Active Team Members1
Retrieve Active Team MembersretrieveActiveTeamMembersPOSTThis operation returns active team members by activity team segment identifiers.
Activity11
Create ActivitiescreateActivitiesPOSTThis operation creates and returns one or more activities.
Create ActivitycreateActivityPOSTThis operation creates and returns an activity.
Create or Update ActivitiescreateOrUpdateActivitiesPOSTThis operation creates or updates one or more activities.
Delete ActivitiesdeleteActivitiesPOSTThis operation deletes one or more activities by object references.
Delete Activity by IDdeleteActivityByIDDELETEThis operation deletes an activity by ID.
Retrieve ActivitiesretrieveActivitiesPOSTThis operation returns one or more activities by object references.
Retrieve Activity by IDretrieveActivityByIDGETThis operation returns an activity by ID.
Retrieve Activity by NameretrieveActivityByNameGETThis operation returns an activity by combined name.
Retrieve Activity Export DefinitionsretrieveActivityExportDefinitionsPOSTThis operation returns a list of activity export definitions for the specified query.
Update ActivitiesupdateActivitiesPOSTThis operation updates and returns a list of activities.
Update Activity by IDupdateActivityByIDPUTThis operation updates and returns an activity by ID.
Activity Actions9
Create Activity ActioncreateActivityActionPOSTThis operation creates a activity action.
Create Activity ActionscreateActivityActionsPOSTThis operation creates one or more Activity Actions.
Delete Activity Action by IDdeleteActivityActionByIDDELETEThis operation deletes a Activity Action by ID.
Delete Activity ActionsdeleteActivityActionsPOSTThis operation deletes one or more Activity Actions by object references.
Retrieve Activity Action by IDretrieveActivityActionByIDGETThis operation returns a activity action by ID.
Retrieve Activity ActionsretrieveActivityActionsPOSTThis operation returns activity actions by object references.
Retrieve All Activity Actions or by NameretrieveAllActivityActionsOrByNameGETThis operation returns a list of all activity actions or returns a single activity action by name.
Update Activity Action by IDupdateActivityActionByIDPUTThis operation updates a Activity Action by ID.
Update Activity ActionsupdateActivityActionsPOSTThis operation updates one or more Activity Actions.
Activity Assignments1
Retrieve Activities for Multiple EmployeesretrieveActivitiesForMultipleEmployeesPOSTThis operation returns the activities assigned to employees.
Activity Customers9
Create CustomercreateCustomerPOSTThis operation creates a Customer.
Create CustomerscreateCustomersPOSTThis operation creates one or more Customers.
Delete Customer by IDdeleteCustomerByIDDELETEThis operation deletes a Customer by ID.
Delete CustomersdeleteCustomersPOSTThis operation deletes one or more Customers by object references.
Retrieve All Customers or by NameretrieveAllCustomersOrByNameGETThis operation returns all Customers if no parameter is specified, all matching Customers if a name with wildcards is specified, or a particular Customer if a strict name is specified.
Retrieve Customer by IDretrieveCustomerByIDGETThis operation returns a Customer by ID.
Retrieve CustomersretrieveCustomersPOSTThis operation returns one or more Customers by object references.
Update Customer by IDupdateCustomerByIDPUTThis operation updates a Customer by ID.
Update CustomersupdateCustomersPOSTThis operation updates one or more Customers.
Activity Efficiencies1
Retrieve Activity EfficienciesretrieveActivityEfficienciesPOSTThis operation returns a list of activity efficiencies for specified employees and activities over a specified date range.
Activity Form Profiles9
Create Form ProfilecreateFormProfilePOSTThis operation creates a form profile.
Create Form ProfilescreateFormProfilesPOSTThis operation creates one or more form profiles.
Delete Form Profile by IDdeleteFormProfileByIDDELETEThis operation deletes a form profile by ID.
Delete Form ProfilesdeleteFormProfilesPOSTThis operation deletes one or more form profiles.
Retrieve All Form Profiles or by NameretrieveAllFormProfilesOrByNameGETThis operation returns all form profiles without associated forms if no parameter is specified or a particular form profile if a name is provided.
Retrieve Form Profile by IDretrieveFormProfileByIDGETThis operation returns a form profile by ID.
Retrieve Form ProfilesretrieveFormProfilesPOSTThis operation returns form profiles according to the specified object references.
Update Form Profile by IDupdateFormProfileByIDPUTThis operation updates a form profile by ID.
Update Form ProfilesupdateFormProfilesPOSTThis operation updates one or more form profiles.
Activity Form Resources6
Retrieve All Control Types or Only Applicable TyperetrieveAllControlTypesOrOnlyApplicableTypeGETThis operation returns all control types or a single applicable control type by ID.
Retrieve All Entry TypesretrieveAllEntryTypesGETThis operation returns all entry types.
Retrieve All Form TypesretrieveAllFormTypesGETThis operation returns all form types complete statuses.
Retrieve All Input Source TypesretrieveAllInputSourceTypesGETThis operation returns all input source types.
Retrieve All Validation TypesretrieveAllValidationTypesGETThis operation returns all validation types.
Retrieve Offline FormsretrieveOfflineFormsGETThis operation returns all offline forms.
Activity Forms9
Create Activity FormcreateActivityFormPOSTThis operation creates and returns an Activity form.
Create Activity FormscreateActivityFormsPOSTThis operation creates and returns Activity forms.
Delete Activity Form by IDdeleteActivityFormByIDDELETEThis operation deletes an Activity form by ID.
Delete Activity FormsdeleteActivityFormsPOSTThis operation deletes Activity forms.
Retrieve Activity Form by IDretrieveActivityFormByIDGETThis operation returns an Activity form by ID.
Retrieve Activity FormsretrieveActivityFormsPOSTThis operation returns a list of Activity forms by object references.
Retrieve All Activity Forms or by NameretrieveAllActivityFormsOrByNameGETThis operation returns all Activity forms if no parameter is specified or a particular form if a name is provided.
Update Activity Form by IDupdateActivityFormByIDPUTThis operation updates and returns an Activity form by ID.
Update Activity FormsupdateActivityFormsPOSTThis operation updates and returns Activity forms.
Activity Historical Net Changes1
Retrieve Historical Net Changes for Activity ShiftsretrieveHistoricalNetChangesForActivityShiftsPOSTThis operation returns Activity Shifts data.
Activity Move Quantity Transaction Audits1
Retrieve Activity Move Quantity Transaction AuditsretrieveActivityMoveQuantityTransactionAuditsPOSTThis operation returns transactions for Activity auto or manual move quantities according to the specified date range.
Activity Net Changes1
Retrieve Net Changes for Activity ShiftsretrieveNetChangesForActivityShiftsPOSTThis operation returns Activity Shifts data.
Activity Profile Resources4
Retrieve Future Validation TypesretrieveFutureValidationTypesGETThis operation returns all Future Validation Types.
Retrieve Tracking Status TypesretrieveTrackingStatusTypesGETThis operation returns Tracking Status Types.
Retrieve Variance Check TypesretrieveVarianceCheckTypesGETThis operation returns all Variance Check Types.
Retrieve Work Rules for ActivitiesretrieveWorkRulesForActivitiesGETThis operation returns all Work Rules.
Activity Profiles9
Create Activity ProfilecreateActivityProfilePOSTThis operation creates an Activity Profile.
Create Activity ProfilescreateActivityProfilesPOSTThis operation creates one or more Activity Profiles.
Delete Activity Profile by IDdeleteActivityProfileByIDDELETEThis operation deletes an Activity Profile by ID.
Delete Activity ProfilesdeleteActivityProfilesPOSTThis operation deletes one or more Activity Profiles by object references.
Retrieve Activity Profile by IDretrieveActivityProfileByIDGETThis operation returns an Activity Profile by ID.
Retrieve Activity ProfilesretrieveActivityProfilesPOSTThis operation returns one or more Activity Profiles by object references.
Retrieve All Activity Profiles or by NameretrieveAllActivityProfilesOrByNameGETThis operation returns all Activity Profiles if no parameter is specified or a particular Profile if a name is provided.
Update Activity Profile by IDupdateActivityProfileByIDPUTThis operation updates an Activity Profile by ID.
Update Activity ProfilesupdateActivityProfilesPOSTThis operation updates one or more Activity Profiles.
Activity Queries9
Create Activity QueriescreateActivityQueriesPOSTThis operation creates one or more Activity queries.
Create Activity QuerycreateActivityQueryPOSTThis operation creates an Activity query.
Delete Activity QueriesdeleteActivityQueriesPOSTThis operation deletes one or more Activity queries.
Delete Activity Query by IDdeleteActivityQueryByIDDELETEThis operation deletes an Activity query by ID.
Retrieve Activity QueriesretrieveActivityQueriesPOSTThis operation returns one or more Activity queries by object references.
Retrieve Activity Query by IDretrieveActivityQueryByIDGETThis operation returns an Activity query by ID.
Retrieve All Activity Queries or by NameretrieveAllActivityQueriesOrByNameGETThis operation returns all Activity queries if no parameter is specified or a particular query if a name is provided.
Update Activity QueriesupdateActivityQueriesPOSTThis operation updates one or more Activity queries.
Update Activity Query by IDupdateActivityQueryByIDPUTThis operation updates an Activity query by ID.
Activity Query Profiles9
Create Activity Query ProfilecreateActivityQueryProfilePOSTThis operation creates an Activity query profile.
Create Activity Query ProfilescreateActivityQueryProfilesPOSTThis operation creates one or more Activity query profiles.
Delete Activity Query Profile by IDdeleteActivityQueryProfileByIDDELETEThis operation deletes an Activity query profile by ID.
Delete Activity Query ProfilesdeleteActivityQueryProfilesPOSTThis operation deletes one or more Activity query profiles by object references.
Retrieve Activity Query Profile by IDretrieveActivityQueryProfileByIDGETThis operation returns an Activity query profile by ID.
Retrieve Activity Query ProfilesretrieveActivityQueryProfilesPOSTThis operation returns one or more Activity query profiles by object references.
Retrieve All Activity Query Profiles by NameretrieveAllActivityQueryProfilesByNameGETThis operation returns all Activity query profiles if no parameter is specified or a particular Activity query profile if a name is provided.
Update Activity Query Profile by IDupdateActivityQueryProfileByIDPUTThis operation updates an Activity query profile by ID.
Update Activity Query ProfilesupdateActivityQueryProfilesPOSTThis operation updates one or more Activity query profiles.
Activity Query Resources2
Retrieve All Activity Query Date Range Date TypesretrieveAllActivityQueryDateRangeDateTypesGETThis operation returns all Activity query date range date types.
Retrieve All Query TypesretrieveAllQueryTypesGETThis operation returns all query types.
Activity Resource Queries5
Create Resource QuerycreateResourceQueryPOSTThis operation creates a resource query.
Delete Resource Query by IDdeleteResourceQueryByIDDELETEThis operation deletes a resource query by ID.
Retrieve All Resource Queries or by NameretrieveAllResourceQueriesOrByNameGETThis operation returns all resource queries if no parameter is specified or a particular resource query if a name is provided.
Retrieve Resource Query by IDretrieveResourceQueryByIDGETThis operation returns a resource query by ID.
Update Resource Query by IDupdateResourceQueryByIDPUTThis operation updates a resource query by ID.
Activity Resources4
Create ResourcecreateResourcePOSTThis operation creates a resource.
Delete Resource by IDdeleteResourceByIDDELETEThis operation deletes a resource by ID.
Retrieve Resource by IDretrieveResourceByIDGETThis operation returns a resource by ID.
Update Resource by IDupdateResourceByIDPUTThis operation updates a resource by ID.
Activity Resources Data Retrieval11
Retrieve All Activity Complete StatusesretrieveAllActivityCompleteStatusesGETThis operation returns all activity complete statuses.
Retrieve All Activity Held HistoryretrieveAllActivityHeldHistoryGETThis operation returns all activity held history.
Retrieve All Activity Priority TypesretrieveAllActivityPriorityTypesGETThis operation returns all activity priority types.
Retrieve All Activity Process TypesretrieveAllActivityProcessTypesGETThis operation returns all activity process types.
Retrieve All Activity TypesretrieveAllActivityTypesGETThis operation returns all activity types.
Retrieve All Data Access TypesretrieveAllDataAccessTypesGETThis operation returns all data access types.
Retrieve All Eligible Default ActivitiesretrieveAllEligibleDefaultActivitiesGETThis operation returns all eligible default activities.
Retrieve All Event TypesretrieveAllEventTypesGETThis operation returns all event types.
Retrieve All Hours Allocation TypesretrieveAllHoursAllocationTypesGETThis operation returns all hours allocation types.
Retrieve All Quantity Allocation TypesretrieveAllQuantityAllocationTypesGETThis operation returns all quantity allocation types.
Retrieve All Sequence Validation TypesretrieveAllSequenceValidationTypesGETThis operation returns all sequence validation types.
Activity Results Template Resources1
Retrieve All Step TypesretrieveAllStepTypesGETThis operation returns all step types.
Activity Results Templates9
Create Results TemplatecreateResultsTemplatePOSTThis operation creates a results template.
Create Results TemplatescreateResultsTemplatesPOSTThis operation creates one or more results templates.
Delete Results Template by IDdeleteResultsTemplateByIDDELETEThis operation deletes a results template by ID.
Delete Results TemplatesdeleteResultsTemplatesPOSTThis operation deletes one or more results templates.
Retrieve All Results Templates or by NameretrieveAllResultsTemplatesOrByNameGETThis operation returns all results templates if no parameter is specified or a particular results template if a name is provided.
Retrieve Results Template by IDretrieveResultsTemplateByIDGETThis operation returns a results template by ID.
Retrieve Results TemplatesretrieveResultsTemplatesPOSTThis operation returns one or more results templates by object references.
Update Results Template by IDupdateResultsTemplateByIDPUTThis operation updates a results template by ID.
Update Results TemplatesupdateResultsTemplatesPOSTThis operation updates one or more results templates.
Activity Settings5
Retrieve Activity Setting by IDretrieveActivitySettingByIDGETThis operation returns an Activity setting by ID.
Retrieve Activity SettingsretrieveActivitySettingsPOSTThis operation returns one or more Activity settings by object references.
Retrieve All Activity SettingsretrieveAllActivitySettingsGETThis operation returns all Activity settings.
Update Activity Setting by IDupdateActivitySettingByIDPUTThis operation updates an Activity setting.
Update Activity SettingsupdateActivitySettingsPOSTThis operation updates one or more Activity settings.
Activity Shifts3
Create or Update Activity ShiftscreateOrUpdateActivityShiftsPOSTThis operation creates or updates activity shifts from a third party source for multiple employees.
Delete Activity ShiftsdeleteActivityShiftsPOSTThis operation deletes one or more activity shifts.
Retrieve Activity ShiftsretrieveActivityShiftsPOSTThis operation returns activity shifts by object references.
Activity Team Resources1
Retrieve All Days of a WeekretrieveAllDaysOfAWeekGETThis operation returns all days of a week.
Activity Team Segment Audits1
Retrieve Activity Team Segment AuditsretrieveActivityTeamSegmentAuditsPOSTThis operation returns audits for activity team segments or activity team segment results according to the specified date range.
Activity Team Segments3
Create or Update Activity Team SegmentscreateOrUpdateActivityTeamSegmentsPOSTThis operation creates or updates activity team segments from a third party source for multiple teams.
Delete Activity Team SegmentsdeleteActivityTeamSegmentsPOSTThis operation deletes activity team segments from a third party source for multiple teams.
Retrieve Activity Team SegmentsretrieveActivityTeamSegmentsPOSTThis operation returns activity team segments by teams or by activity team segment identifiers.
Activity Teams8
Create Activity TeamcreateActivityTeamPOSTThis operation creates and returns an Activity team.
Create or Update Activity TeamscreateOrUpdateActivityTeamsPOSTThis operation creates or updates one or more Activity teams.
Delete Activity Team by IDdeleteActivityTeamByIDDELETEThis operation deletes an Activity team by ID.
Delete Activity TeamsdeleteActivityTeamsPOSTThis operation deletes Activity teams.
Retrieve Activity Team by IDretrieveActivityTeamByIDGETThis operation returns an Activity team by ID.
Retrieve Activity TeamsretrieveActivityTeamsPOSTThis operation returns a list of Activity teams by object references.
Retrieve All Activity Teams or by NameretrieveAllActivityTeamsOrByNameGETThis operation returns all Activity teams if no parameter is specified or a particular team if a name is provided.
Update Activity Team by IDupdateActivityTeamByIDPUTThis operation updates and returns an Activity team by ID.
Activity Totals2
Retrieve Activity TotalsretrieveActivityTotalsGETThis operation returns a list of activity totals for an employee over a specified timeframe.
Retrieve Activity Totals for Multiple EmployeesretrieveActivityTotalsForMultipleEmployeesPOSTThis operation returns a list of activity totals for specified employees and activities over a specified timeframe.
Activity Transactions1
Retrieve Activity TransactionsretrieveActivityTransactionsPOSTThis operation returns a list of activity transactions for the specified activity and its child activities..
Actual Volume3
Import Actual VolumeimportActualVolumePOSTThis operation imports actual volumes for a given date span.
Retrieve Actual Volume by SiteretrieveActualVolumeBySitePOSTThis operation returns actual volume for a site.
Retrieve Actual Volume by SitesretrieveActualVolumeBySitesPOSTThis operation returns actual volumes for one or more sites within a date span.
Adjustment Driver Settings10
Create Adjustment Driver SettingscreateAdjustmentDriverSettingsPOSTThis operation creates a set of Adjustment Driver Settings.
Create Multiple Adjustment Driver SettingscreateMultipleAdjustmentDriverSettingsPOSTThis operation creates one or more Adjustment Driver Settings.
Delete Adjustment Driver Settings by IDdeleteAdjustmentDriverSettingsByIDDELETEThis operation deletes a set of Adjustment Driver Settings by ID.
Delete Multiple Adjustment Driver SettingsdeleteMultipleAdjustmentDriverSettingsPOSTThis operation deletes Adjustment Driver Settings according to the specified object references.
Retrieve Adjustment Driver SettingsretrieveAdjustmentDriverSettingsPOSTThis operation returns Adjustment Driver Settings according to the specified object references.
Retrieve Adjustment Driver Settings by IDretrieveAdjustmentDriverSettingsByIDGETThis operation returns Adjustment Driver Settings by ID.
Retrieve Adjustment Driver Settings by LocationretrieveAdjustmentDriverSettingsByLocationPOSTThis operation returns Adjustment Driver Settings by location.
Retrieve All Adjustment Driver Settings or by NameretrieveAllAdjustmentDriverSettingsOrByNameGETThis operation returns all Adjustment Driver Settings or a particular set of Adjustment Driver Settings if a name is provided.
Update Adjustment Driver Settings by IDupdateAdjustmentDriverSettingsByIDPUTThis operation updates a set of Adjustment Driver Settings by ID.
Update Multiple Adjustment Driver SettingsupdateMultipleAdjustmentDriverSettingsPOSTThis operation updates one or more Adjustment Driver Settings.
Adjustment Drivers3
Retrieve Adjustment Driver ValuesretrieveAdjustmentDriverValuesPOSTThis operation returns Adjustment Driver Values.
Update Adjustment Driver ValuesupdateAdjustmentDriverValuesPOSTThis operation updates Adjustment Driver Values.
Update Values for Multiple Adjustment DriversupdateValuesForMultipleAdjustmentDriversPOSTThis operation updates the values associated with one or more adjustment drivers at the department or store level.
Adjustment Rule Assignments10
Create Adjustment Rule AssignmentcreateAdjustmentRuleAssignmentPOSTThis operation assigns an adjustment rule to an employee.
Create Adjustment Rule AssignmentscreateAdjustmentRuleAssignmentsPOSTThis operation assigns an employee adjustment rule to one or more employees.
Delete Adjustment Rule AssignmentdeleteAdjustmentRuleAssignmentDELETEThis operation deletes the assignment of an adjustment rule to an employee.
Delete Adjustment Rule AssignmentsdeleteAdjustmentRuleAssignmentsPOSTThis operation deletes employee adjustment rule assignments for one or more employees.
Retrieve Adjustment Rule Assignments by IDretrieveAdjustmentRuleAssignmentsByIDGETThis operation returns a list of an employee's adjustment rule assignments by person ID.
Retrieve Adjustment Rule Assignments by Person NumberretrieveAdjustmentRuleAssignmentsByPersonNumberGETThis operation returns a list of an employee's adjustment rule assignments by person number.
Retrieve Adjustment Rules-Multiple EmployeesretrieveAdjustmentRulesMultipleEmployeesPOSTThis operation returns a list of adjustment rule assignments for one or more employees.
Retrieve All Adjustment Rules (Deprecated)retrieveAllAdjustmentRulesDeprecatedGETThis operation is deprecated; instead use POST /v1/commons/persons/adjustment rule/multi read This operation returns a list of all employee adjustment rule assignments.
Update Adjustment Rule AssignmentupdateAdjustmentRuleAssignmentPUTThis operation updates an adjustment rule assigned to an employee.
Update Adjustment Rule AssignmentsupdateAdjustmentRuleAssignmentsPOSTThis operation updates the assignment of an adjustment rule to one or more employees.
Adjustment Rules11
Create Adjustment RulecreateAdjustmentRulePOSTThe operation creates an Adjustment Rule.
Create and Assign Adjustment Rule Version by IDcreateAndAssignAdjustmentRuleVersionByIDPOSTThe operation creates an Adjustment Rule Version and assigns it to an Adjustment Rule by ID.
Create or Update Adjustment Rule VersionscreateOrUpdateAdjustmentRuleVersionsPOSTThe operation creates, updates, or deletes an adjustment rule version.
Create or Update Adjustment RulescreateOrUpdateAdjustmentRulesPOSTThe operation creates or updates one or more adjustment rules according to the specified properties.
Delete Adjustment Rule by IDdeleteAdjustmentRuleByIDDELETEThe operation deletes an adjustment rule by its ID.
Delete Adjustment Rule by ID (Deprecated)deleteAdjustmentRuleByIDDeprecatedDELETEThis operation is deprecated; instead use Delete Adjustment Rule by ID DELETE /v2/timekeeping/setup/adjustment rules/{id}.
Delete Adjustment RulesdeleteAdjustmentRulesPOSTThe operation deletes one or more adjustment rules.
Retrieve Adjustment RulesretrieveAdjustmentRulesPOSTThis operation returns a list of adjustment rules or a list of adjustment rule versions if the allDetails Boolean is passed as true.
Retrieve All Adjustment RulesretrieveAllAdjustmentRulesGETThis operation returns all Adjustment Rules.
Retrieve All Adjustment Rules (Deprecated) (Timekeeping)retrieveAllAdjustmentRulesDeprecatedTimekeepingGETThis operation is deprecated; instead use Retrieve All Adjustment Rules GET /v2/timekeeping/setup/adjustment rules.
Update Adjustment Rule by IDupdateAdjustmentRuleByIDPUTThis operation updates an Adjustment Rule by ID.
Aggregated Data1
Retrieve DataretrieveDataPOSTThis operation returns aggregated data by executing an ad hoc query.
Aggregated Person Assignments5
Modify Assignments for Multiple PeoplemodifyAssignmentsForMultiplePeoplePOSTThis operation modifies one or more assignments for one or more people.
Retrieve All Assignment NamesretrieveAllAssignmentNamesGETThis operation returns the names of all supported person assignments.
Retrieve All Assignments by CriteriaretrieveAllAssignmentsByCriteriaGETThis operation returns all assignments for a person by person number, or Associate Object ID (AOID) and Client Object ID (COID).
Retrieve All Assignments by Person IDretrieveAllAssignmentsByPersonIDGETThis operation returns all assignments for a person by person ID.
Retrieve All Assignments for Multiple PeopleretrieveAllAssignmentsForMultiplePeoplePOSTThis operation returns one or more assignments for one or more persons.
Aggregated Transfer Data1
Return Aggregated Transfer DatareturnAggregatedTransferDataPOSTThis operation returns Aggregated Transfer Data.
API Integrations4
Execute API Integration by KeyexecuteAPIIntegrationByKeyPOSTThis operation executes an API integration with a key that is generated when an API integration is installed.
Retrieve API Integration by KeyretrieveAPIIntegrationByKeyGETThis operation returns the details of an API integration that is identified by key.
Retrieve API IntegrationsretrieveAPIIntegrationsGETThis operation returns a list of all API integrations in the system.
Retrieve Integration Status by IDretrieveIntegrationStatusByIDGETThis operation returns the execution status of an API integration by ID.
Attendance Actions2
Retrieve All Attendance ActionsretrieveAllAttendanceActionsGETThis operation returns a list of all the Attendance actions.
Retrieve Attendance Action by IDretrieveAttendanceActionByIDGETThis operation returns the available Attendance action by ID.
Attendance Administrator Assignment7
Delete Attendance AdmindeleteAttendanceAdminDELETEThis operation deletes the assignment of an administrator to an Attendance employee.
Delete Attendance Admin for Multiple EmployeesdeleteAttendanceAdminForMultipleEmployeesPOSTThis operation deletes the assignment of an administrator to one or more Attendance employees.
Retrieve Attendance Admin by Person IDretrieveAttendanceAdminByPersonIDGETThis operation returns the administrator assigned to an Attendance employee by person ID.
Retrieve Attendance Admin by Person NumberretrieveAttendanceAdminByPersonNumberGETThis operation returns the administrator assigned to an Attendance employee by person ID.
Retrieve Attendance Admin for Multiple EmployeesretrieveAttendanceAdminForMultipleEmployeesPOSTThis operation returns the administrators assigned to one or more Attendance employees.
Update Attendance AdminupdateAttendanceAdminPUTThis operation updates the assignment of an administrator to an Attendance employee.
Update Attendance Admin for Multiple EmployeesupdateAttendanceAdminForMultipleEmployeesPOSTThis operation updates the assignment of an administrator to one or more Attendance employees.
Attendance Audit Records1
Retrieve Attendance Audit RecordsretrieveAttendanceAuditRecordsPOSTThis operation returns auditing records for the specified auditing entities and employees within a date range.
Attendance Events2
Retrieve All Attendance EventsretrieveAllAttendanceEventsGETThis operation returns a list of all Attendance events.
Retrieve Attendance Event by IDretrieveAttendanceEventByIDGETThis operation returns an Attendance event by ID.
Attendance Patterns2
Retrieve All Attendance PatternsretrieveAllAttendancePatternsGETThis operation returns a list of all the Attendance Patterns.
Retrieve Attendance Pattern by IDretrieveAttendancePatternByIDGETThis operation returns an Attendance Pattern by ID.
Attendance Policies1
Retrieve All Attendance PoliciesretrieveAllAttendancePoliciesGETThis operation returns a list of all Attendance Policies.
Attendance Profile Assignments5
Retrieve Attendance Profile by Person IDretrieveAttendanceProfileByPersonIDGETThis operation returns an Attendance profile assignment by person ID.
Retrieve Attendance Profile by Person NumberretrieveAttendanceProfileByPersonNumberGETThis operation returns an Attendance profile assignment by person number.
Retrieve Attendance Profile for Multiple EmployeesretrieveAttendanceProfileForMultipleEmployeesPOSTThis operation returns Attendance profile assignments for one or more employees by person ID.
Update Attendance ProfileupdateAttendanceProfilePUTThis operation updates an attendance profile assignment for an employee.
Update Attendance Profile for Multiple EmployeesupdateAttendanceProfileForMultipleEmployeesPOSTThis operation updates Attendance profile assignments for one or more employees by person ID.
Attendance Profiles3
Retrieve All Attendance ProfilesretrieveAllAttendanceProfilesGETThis operation returns all attendance profiles.
Retrieve Attendance Profile by IDretrieveAttendanceProfileByIDGETThis operation returns an attendance profile by ID.
Retrieve Attendance ProfilesretrieveAttendanceProfilesPOSTThis operation returns attendance profiles by object references.
Attestation Answers12
Create Attestation AnswercreateAttestationAnswerPOSTThis operation creates an Attestation answer.
Create Attestation AnswerscreateAttestationAnswersPOSTThis operation creates one or more Attestation answers.
Create or Update Attestation AnswerscreateOrUpdateAttestationAnswersPOSTThis operation creates or updates one or more Attestation answers.
Delete Attestation Answer by IDdeleteAttestationAnswerByIDDELETEThis operation deletes an Attestation answer by ID.
Delete Attestation AnswersdeleteAttestationAnswersPOSTThis operation deletes one or more Attestation answers.
Retrieve Action Types for Attestation AnswersretrieveActionTypesForAttestationAnswersGETThis operartion returns action types for Attestation answers.
Retrieve All Attestation Answers or by NameretrieveAllAttestationAnswersOrByNameGETThis operation returns a list of all Attestation answers.
Retrieve Attestation Answer by IDretrieveAttestationAnswerByIDGETThis operation returns an Attestation answer by ID.
Retrieve Attestation AnswersretrieveAttestationAnswersPOSTThis operation returns one or more Attestation answers by object references.
Retrieve Paginated Attestation AnswersretrievePaginatedAttestationAnswersGETThis operation returns a paginated list of Attestation answers.
Update Attestation Answer by IDupdateAttestationAnswerByIDPUTThis operation updates an Attestation answer by ID.
Update Attestation AnswersupdateAttestationAnswersPOSTThis operation updates one or more Attestation answers.
Attestation Assignments8
Create Attestation AssignmentcreateAttestationAssignmentPOSTThis operation creates an Attestation assignment.
Create or Update Attestation AssignmentscreateOrUpdateAttestationAssignmentsPOSTThis operation creates or updates one or more Attestation Assignments.
Delete Attestation Assignment by IDdeleteAttestationAssignmentByIDDELETEThis operation deletes an Attestation assignment by ID.
Delete Attestation AssignmentsdeleteAttestationAssignmentsPOSTThis operation deletes one or more Attestation Assignments according to the specified properties when ACP "EMPLOYEE GROUP" is allowed.
Retrieve All Attestation AssignmentsretrieveAllAttestationAssignmentsGETThis operation returns a list of all Attestation assignments.
Retrieve Attestation Assignment by IDretrieveAttestationAssignmentByIDGETThis operation returns an Attestation assignment by ID.
Retrieve Paginated List of Attestation AssignmentsretrievePaginatedListOfAttestationAssignmentsGETThis operation returns a paginated list of all Attestation assignments.
Update Attestation Assignment by IDupdateAttestationAssignmentByIDPUTThis operation updates an Attestation assignment by ID.
Attestation Buttons8
Create Attestation ButtoncreateAttestationButtonPOSTThis operation creates an Attestation button.
Create or Update Attestation ButtonscreateOrUpdateAttestationButtonsPOSTThis operation creates or updates one or more Attestation Buttons.
Delete Attestation Button by IDdeleteAttestationButtonByIDDELETEThis operation deletes an Attestation button by ID.
Delete Attestation ButtonsdeleteAttestationButtonsPOSTThis operation deletes one or more Attestation Buttons according to the specified properties when ACP "EMPLOYEE GROUP" is allowed.
Retrieve All Attestation ButtonsretrieveAllAttestationButtonsGETThis operation returns a list of all Attestation buttons.
Retrieve Attestation Button by IDretrieveAttestationButtonByIDGETThis operation returns an Attestation button by ID.
Retrieve Paginated List of Attestation ButtonsretrievePaginatedListOfAttestationButtonsGETThis operation returns a paginated list of all Attestation buttons.
Update Attestation Button by IDupdateAttestationButtonByIDPUTThis operation updates an Attestation button by ID.
Attestation Conditions8
Create Attestation ConditioncreateAttestationConditionPOSTThis operation creates an Attestation condition.
Create or Update Attestation ConditionscreateOrUpdateAttestationConditionsPOSTThis operation creates or updates one or more Attestation conditions based on the provided data.
Delete Attestation Condition by IDdeleteAttestationConditionByIDDELETEThis operation deletes an Attestation condition by ID.
Delete Attestation ConditionsdeleteAttestationConditionsPOSTThis operation deletes one or more Attestation Conditions according to the specified properties in the request payload.
Retrieve All Attestation ConditionsretrieveAllAttestationConditionsGETThis operation returns a list of all Attestation conditions.
Retrieve Attestation Condition by IDretrieveAttestationConditionByIDGETThis operation returns an Attestation condition by ID.
Retrieve Paginated List of Attestation ConditionsretrievePaginatedListOfAttestationConditionsGETThis operation retrieves a paginated list of Attestation conditions based on the specified query parameters.
Update Attestation Condition by IDupdateAttestationConditionByIDPUTThis operation updates an Attestation condition by ID.
Attestation Daily Details1
Retrieve Attestation Daily DetailsretrieveAttestationDailyDetailsPOSTThis operation returns Attestation data responses that contain Attestation daily details.
Attestation Display and Submit Forms2
Create Attestation Display FormcreateAttestationDisplayFormPOSTThis operation creates an Attestation Display Form.
Create Attestation Submit FormcreateAttestationSubmitFormPOSTThis operation creates an Attestation Submit Form.
Attestation Models1
Retrieve All Attestation ModelsretrieveAllAttestationModelsGETThis operation returns a list of all Attestation models.
Attestation Profile Assignments2
Assign Attestation ProfileassignAttestationProfilePOSTThis operation assigns an Attestation profile to a person.
Retrieve Assigned Attestation ProfilesretrieveAssignedAttestationProfilesGETThis operation returns a list of the assigned Attestation profiles for a person.
Attestation Profile Assignments by Person Number4
Assign Attestation Profile by Person NumberassignAttestationProfileByPersonNumberPOSTThis operation assigns an Attestation profile to a person by person number.
Retrieve Assigned Attestation Profiles by Person NumberretrieveAssignedAttestationProfilesByPersonNumberGETThis operation returns a list of the assigned Attestation profiles for a person by person number.
Retrieve Attestation Profile Assignments by Person NumberretrieveAttestationProfileAssignmentsByPersonNumberPOSTThis operation returns Attestation profile assignments for one or more employees.
Update Attestation Profile Assignments by Person NumberupdateAttestationProfileAssignmentsByPersonNumberPOSTThis operation updates Attestation profile assignments for one or more employees.
Attestation Profile Buttons1
Retrieve Attestation Profile ButtonsretrieveAttestationProfileButtonsGETThe operation returns a list of Attestation buttons associated with the logged-in user's attestation profile.
Attestation Profiles5
Create Attestation ProfilecreateAttestationProfilePOSTThis operation creates an Attestation profile.
Delete Attestation Profile by IDdeleteAttestationProfileByIDDELETEThis operation deletes an Attestation profile by ID.
Retrieve All Attestation ProfilesretrieveAllAttestationProfilesGETThis operation returns a list of all Attestation profiles.
Retrieve Attestation Profile by IDretrieveAttestationProfileByIDGETThis operation returns an Attestation profile by ID.
Update Attestation Profile by IDupdateAttestationProfileByIDPUTThis operation updates an Attestation profile by ID.
Attestation Questions12
Create Attestation QuestioncreateAttestationQuestionPOSTThis operation creates an Attestation question.
Create Attestation QuestionscreateAttestationQuestionsPOSTThis operation creates one or more Attestation questions.
Create or Update Attestation QuestionscreateOrUpdateAttestationQuestionsPOSTThis operation creates or updates one or more Attestation questions.
Delete Attestation Question by IDdeleteAttestationQuestionByIDDELETEThis operation deletes an Attestation question by ID.
Delete Attestation QuestionsdeleteAttestationQuestionsPOSTThis operation deletes one or more Attestation questions.
Retrieve a Paginated List of Attestation QuestionsretrieveAPaginatedListOfAttestationQuestionsGETThis operation retrieves a paginated list of Attestation questions based on the specified query parameters.
Retrieve All Attestation Questions or by NameretrieveAllAttestationQuestionsOrByNameGETThis operation returns a list of all Attestation questions.
Retrieve Attestation Question by IDretrieveAttestationQuestionByIDGETThis operation returns an Attestation question by ID.
Retrieve Attestation Question Display TypesretrieveAttestationQuestionDisplayTypesGETThis operation returns a list of Attestation question display types.
Retrieve Attestation QuestionsretrieveAttestationQuestionsPOSTThis operation returns one or more Attestation questions.
Update Attestation Question by IDupdateAttestationQuestionByIDPUTThis operation updates an Attestation question by ID.
Update Attestation QuestionsupdateAttestationQuestionsPOSTThis operation updates one or more Attestation questions.
Attestation Template Mappings9
Create Attestation Template MappingcreateAttestationTemplateMappingPOSTThis operation creates an Attestation template mapping.
Create or Update Attestation Template MappingscreateOrUpdateAttestationTemplateMappingsPOSTThis operation creates or updates one or more Attestation Template Mappings.
Delete Attestation Template Mapping by IDdeleteAttestationTemplateMappingByIDDELETEThis operation deletes an Attestation template mapping by ID.
Delete Attestation Template MappingsdeleteAttestationTemplateMappingsPOSTThis operation deletes one or more Attestation template mapping.
Retrieve All Attestation Template MappingsretrieveAllAttestationTemplateMappingsGETThis operation returns a list of all Attestation template mappings.
Retrieve Attestation Template Mapping by IDretrieveAttestationTemplateMappingByIDGETThis operation returns an Attestation template mapping by ID.
Retrieve Attestation Template MappingsretrieveAttestationTemplateMappingsPOSTThis operation returns one or more Attestation template mapping.
Retrieve Paginated List of Attestation Template MappingsretrievePaginatedListOfAttestationTemplateMappingsGETThis operation returns a paginated list of all Attestation Template Mappings.
Update Attestation Template Mapping by IDupdateAttestationTemplateMappingByIDPUTThis operation updates an Attestation template mapping by ID.
Attestation Unapproved Timecard Data1
Retrieve Unapproved Timecard DataretrieveUnapprovedTimecardDataGETThis operation returns attestation timecard data in the form of a list punches, paycodes, and formatted data for punches and paycodes.
Attestation Workflow Attributes1
Set Attestation Workflow Attributes by IDsetAttestationWorkflowAttributesByIDPOSTThis operation sets Attestation workflow attributes by ID.
Attestation Workflows2
Retrieve Attestation Workflow by NameretrieveAttestationWorkflowByNameGETThis operation returns an Attestation workflow by name.
Retrieve Attestation Workflows by NameretrieveAttestationWorkflowsByNameGETThis operation returns a list of Attestation workflows by name.
Availabilities5
Create Availabilities by IDcreateAvailabilitiesByIDPOSTThis operation creates or updates one or more availabilities by ID.
Create AvailabilitycreateAvailabilityPOSTThis operation creates or updates an availability according to the specified parameters.
Delete AvailabilitiesdeleteAvailabilitiesDELETEThis operation deletes one or more availabilities according to the specified parameters.
Delete Availability by IDdeleteAvailabilityByIDDELETEThis operation deletes an availability by employee ID or person number and the specified date.
Retrieve Availability by IDretrieveAvailabilityByIDGETThis operation returns an availability by employee ID or person number and the specified date.
Average Pay Rate Sets8
Create Average Pay Rate SetcreateAveragePayRateSetPOSTThis operation creates and returns an Average Pay Rate Set.
Create Average Pay Rate SetscreateAveragePayRateSetsPOSTThis operation creates and returns one or more Average Pay Rate Sets.
Delete Average Pay Rate Set by IDdeleteAveragePayRateSetByIDDELETEThis operation deletes an Average Pay Rate Set by ID.
Delete Average Pay Rate SetsdeleteAveragePayRateSetsPOSTThis operation deletes one or more Average Pay Rate Sets.
Retrieve All Average Pay Rate SetsretrieveAllAveragePayRateSetsGETThis operation returns all Average Pay Rate Sets.
Retrieve Average Pay Rate Set - One LocationretrieveAveragePayRateSetOneLocationPOSTThis operation returns the average pay rate set for a single location on a date.
Update Average Pay Rate Set by IDupdateAveragePayRateSetByIDPUTThis operation updates and returns an Average Pay Rate Set by ID.
Update Average Pay Rate SetsupdateAveragePayRateSetsPOSTThis operation updates and returns one or more Average Pay Rate Sets.
Average Pay Rates1
Retrieve Average Pay Rate - One LocationretrieveAveragePayRateOneLocationPOSTThis operation returns the average pay rate for a single location on a date.
Balance Adjustments4
Bulk Update and Return BalancesbulkUpdateAndReturnBalancesPOSTThis operation updates balances for a list of employees within a date range based on a balance type and returns a list of balance adjustment IDs.
Mark Balance Adjustments for Deletion by IDmarkBalanceAdjustmentsForDeletionByIDPOSTThis operation marks point balance adjustments for deletion by ID.
Retrieve Balance AdjustmentsretrieveBalanceAdjustmentsPOSTThis operation returns point balance adjustments for a list of employees within a date range.
Update and Return BalancesupdateAndReturnBalancesPOSTThis operation updates balances for a list of employees within a date range based on a balance type and returns a list of balance adjustment IDs.
Balance Expirations1
Retrieve Expiring BalancesretrieveExpiringBalancesPOSTThis operation returns expiring points for a list of employees within a date range.
Balance Resets4
Bulk Reset BalancesbulkResetBalancesPOSTThis operation resets the balances for a list of employees within a date range and based on a balance type and returns a list of the reset balances.
Mark Balance Resets for Deletion by IDmarkBalanceResetsForDeletionByIDPOSTThis operation marks point balance resets for deletion by ID.
Reset BalancesresetBalancesPOSTThis operation resets the balances for a list of employees within a date range and based on a balance type and returns a list of the reset balances.
Retrieve Balance ResetsretrieveBalanceResetsPOSTThis operation returns balance resets for a list of employees within a date range.
Balance Types6
Retrieve All Available Calculated Balances Balance TypesretrieveAllAvailableCalculatedBalancesBalanceTypesGETThis operation returns a list of all available Calculated Balances balance types.
Retrieve All Available Point and Occurrences Balance TypesretrieveAllAvailablePointAndOccurrencesBalanceTypesGETThis operation returns a list of all available Point and Occurrences balance types.
Retrieve All Available Time Balance TypesretrieveAllAvailableTimeBalanceTypesGETThis operation returns a list of all available Time balance types.
Retrieve Calculated Balance Balance Type by IDretrieveCalculatedBalanceBalanceTypeByIDGETThis operation returns a calculated balance balance type by ID.
Retrieve Point and Occurrences Balance Type by IDretrievePointAndOccurrencesBalanceTypeByIDGETThis operation returns a Point and Occurrences balance type by ID.
Retrieve Time Balance Type by IDretrieveTimeBalanceTypeByIDGETThis operation returns a time balance type by ID.
Balances1
Retrieve BalancesretrieveBalancesPOSTThis operation returns point balance summaries for a list of employees within a date range.
Basic Accuracy Engine2
Delete Basic Accuracy MetricsdeleteBasicAccuracyMetricsPOSTThis operation deletes basic accuracy metrics by site and date span.
Execute Basic Accuracy Metrics EngineexecuteBasicAccuracyMetricsEnginePOSTThis operation executes the basic accuracy engine, which generates basic accuracy metrics.
Batch Event Scheduling1
Schedule Batch EventsscheduleBatchEventsPOSTThis operation schedules one or more batch events.
Batch Events8
Create Batch EventscreateBatchEventsPOSTThis operation creates one or more batch events.
Delete Batch Event by IDdeleteBatchEventByIDDELETEThis operation deletes a batch event by ID.
Delete Batch EventsdeleteBatchEventsPOSTThis operation deletes one or more batch events.
Retrieve All Batch EventsretrieveAllBatchEventsGETThis operation returns all batch events.
Retrieve Batch Event by IDretrieveBatchEventByIDGETThis operation returns a batch event by ID.
Retrieve Batch Tasks by Batch Event IDretrieveBatchTasksByBatchEventIDGETThis operation returns a list of all batch tasks that are available to a batch event by batch event ID.
Update Batch EventsupdateBatchEventsPOSTThis operation updates one or more batch events.
Update Batch Events by IDupdateBatchEventsByIDPUTThis operation updates a batch event by ID.
Batch Groups8
Create Batch GroupscreateBatchGroupsPOSTThis operation creates one or more batch groups.
Delete Batch Group by IDdeleteBatchGroupByIDDELETEThis operation deletes a batch group by ID.
Delete Batch GroupsdeleteBatchGroupsPOSTThis operation deletes one or more batch groups.
Retrieve All Batch GroupsretrieveAllBatchGroupsGETThis operation returns all batch groups.
Retrieve Batch Events by Batch Group IDretrieveBatchEventsByBatchGroupIDGETThis operation returns a list of all batch events available to a batch group by batch group ID.
Retrieve Batch Group by IDretrieveBatchGroupByIDGETThis operation returns a batch group by ID.
Update Batch Group by IDupdateBatchGroupByIDPUTThis operation updates a batch group by ID.
Update Batch GroupsupdateBatchGroupsPOSTThis operation updates one or more batch groups.
Batch Job Statuses1
Retrieve Batch Job StatusesretrieveBatchJobStatusesPOSTThis operation returns one or more batch job statuses.
Batch Job Statuses with Pagination1
Retrieve Batch Job Statuses with PaginationretrieveBatchJobStatusesWithPaginationPOSTThis operation returns one or more batch job statuses with paginated results.
Batch Tasks8
Create Batch TaskscreateBatchTasksPOSTThis operation creates one or more batch tasks.
Delete Batch Task by IDdeleteBatchTaskByIDDELETEThis operation deletes a batch task by ID.
Delete Batch TasksdeleteBatchTasksPOSTThis operation deletes one or more batch tasks.
Retrieve All Batch Task Action TypesretrieveAllBatchTaskActionTypesGETThis operation returns all batch task action types.
Retrieve All Batch TasksretrieveAllBatchTasksGETThis operation returns all batch tasks.
Retrieve Batch Task by IDretrieveBatchTaskByIDGETThis operation returns a batch task by ID.
Update Batch Task by IDupdateBatchTaskByIDPUTThis operation updates a batch task by ID.
Update Batch TasksupdateBatchTasksPOSTThis operation updates one or more batch tasks.
Billing Department and Work Unit Maps2
Create or Update Billing Department and Work Unit MapscreateOrUpdateBillingDepartmentAndWorkUnitMapsPOSTThis operation creates or updates billing department and work unit maps.
Retrieve All Billing Department and Work Unit MapsretrieveAllBillingDepartmentAndWorkUnitMapsGETThis operation returns all of the maps between billing departments and work units.
Biometric Consent History1
Retrieve Biometric Consent HistoryretrieveBiometricConsentHistoryPOSTThis operation returns employee biometric consent history by object references.
Bonus and Deduction Rules6
Delete Bonus and Deduction RulesdeleteBonusAndDeductionRulesPOSTThis operation deletes one or more bonus or deduction rules based on the specified parameters.
Delete Bonus or Deduction Rule by IDdeleteBonusOrDeductionRuleByIDDELETEThis operaton deletes a bonus or deduction rule by ID.
Retrieve Bonus and Deduction RulesretrieveBonusAndDeductionRulesGETThis operation returns a list of bonus and deduction rules.
Retrieve Bonus and Deduction Rules (Deprecated)retrieveBonusAndDeductionRulesDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/deduct rules.
Retrieve Bonus or Deduction Rule by IDretrieveBonusOrDeductionRuleByIDGETThis operation takes an ID and returns the specified bonus or deduction rule.
Retrieve Bonus or Deduction Rule by ID (Deprecated)retrieveBonusOrDeductionRuleByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/deduct rules/{id}.
Brazil Compliance Companies5
Create Brazil Compliance CompanycreateBrazilComplianceCompanyPOSTThis operation creates a Brazil compliance company.
Delete Brazil Compliance Company by IDdeleteBrazilComplianceCompanyByIDDELETEThis operation deletes a Brazil compliance company by ID.
Retrieve All Brazil Compliance CompaniesretrieveAllBrazilComplianceCompaniesGETThis operation returns all Brazil compliance companies.
Retrieve Brazil Compliance Company by IDretrieveBrazilComplianceCompanyByIDGETThis operation returns a Brazil compliance company by ID.
Update Brazil Compliance Company by IDupdateBrazilComplianceCompanyByIDPUTThis operation updates a Brazil compliance company by ID.
Brazil Compliance Device Groups5
Create Brazil Compliance Device GroupcreateBrazilComplianceDeviceGroupPOSTThis operation creates a Brazil compliance device group.
Delete Brazil Compliance Device Group by IDdeleteBrazilComplianceDeviceGroupByIDDELETEThis operation deletes a Brazil compliance device group by ID.
Retrieve All Brazil Compliance Device Groups or by SpecificationretrieveAllBrazilComplianceDeviceGroupsOrBySpecificationGETThis operation returns all Brazil compliance device groups if no parameters are specified or returns a particular device group by ID, name, or according to the select filter.
Retrieve Brazil Compliance Device Group by IDretrieveBrazilComplianceDeviceGroupByIDGETThis operation returns a Brazil compliance device group by ID.
Update Brazil Compliance Device Group by IDupdateBrazilComplianceDeviceGroupByIDPUTThis operation updates a Brazil compliance device group by ID.
Brazil Compliance Devices5
Create Brazil Compliance DevicecreateBrazilComplianceDevicePOSTThis operation creates a Brazil compliance device.
Delete Brazil Compliance Device by IDdeleteBrazilComplianceDeviceByIDDELETEThis operation deletes a brazil compliance device by ID.
Retrieve All Brazil Compliance Devices or by SpecificationretrieveAllBrazilComplianceDevicesOrBySpecificationGETThis operation returns all Brazil compliance devices if no parameters are specified or returns a particular device by ID, name, or according to the select filter.
Retrieve Brazil Compliance Device by IDretrieveBrazilComplianceDeviceByIDGETThis operation returns a Brazil compliance device by ID.
Update Brazil Compliance Device by IDupdateBrazilComplianceDeviceByIDPUTThis operation update a Brazil compliance device by ID.
Brazil Compliance Digital Signature1
Sign Brazil Compliance ReportssignBrazilComplianceReportsPOSTThis operation signs all of the Brazil compliance reports inside a ZIP file using a digital certificate and returns all of the signed reports along with the original reports.
Brazil Compliance Identity Types2
Retrieve All Brazil Compliance Identity Types or by SpecificationretrieveAllBrazilComplianceIdentityTypesOrBySpecificationGETThis operation returns all Brazil compliance identity types.
Retrieve Brazil Compliance Identity Type by IDretrieveBrazilComplianceIdentityTypeByIDGETThis operation returns a Brazil compliance identity type by ID.
Brazil Compliance Paycode Attributes7
Create Brazil Compliance Paycode Attribute DefinitioncreateBrazilCompliancePaycodeAttributeDefinitionPOSTThis operation creates a Brazil Compliance paycode attribute definition.
Delete Brazil Compliance Paycode Attribute Definition by IDdeleteBrazilCompliancePaycodeAttributeDefinitionByIDDELETEThis operation deletes a Brazil compliance paycode attribute definition by ID.
Retrieve All Brazil Compliance Paycode Attribute Definition Keys or by SpecificationretrieveAllBrazilCompliancePaycodeAttributeDefinitionKeysOrBySpecificationGETThis operation returns all Brazil compliance paycode attribute definition keys if no parameters are specified or returns a particular paycode attribute definition key by ID or name.
Retrieve All Brazil Compliance Paycode Attribute Definitions or by SpecificationretrieveAllBrazilCompliancePaycodeAttributeDefinitionsOrBySpecificationGETThis operation returns all Brazil compliance paycode attribute definitions if no parameters are specified or returns a particular paycode attribute definition by ID or name.
Retrieve Brazil Compliance Paycode Attribute Definition by IDretrieveBrazilCompliancePaycodeAttributeDefinitionByIDGETThis operation returns a Brazil compliance paycode attribute definition by ID.
Retrieve Brazil Compliance Paycode Attribute Definition Key by IDretrieveBrazilCompliancePaycodeAttributeDefinitionKeyByIDGETThis operation returns a Brazil compliance paycode attribute definition key by ID.
Update Brazil Compliance Paycode Attribute Definition by IDupdateBrazilCompliancePaycodeAttributeDefinitionByIDPUTThis operation updates a Brazil Compliance paycode attribute definition by ID.
Brazil Compliance System Settings1
Retrieve Brazil Compliance System SettingsretrieveBrazilComplianceSystemSettingsGETThis operation returns Brazil compliance system settings.
Brazil Employee Assignments4
Add or Update Brazil Employee AssignmentsaddOrUpdateBrazilEmployeeAssignmentsPOSTThis operation adds or updates Brazil Employee Assignments for one or more employees.
Retrieve Brazil Employee AssignmentsretrieveBrazilEmployeeAssignmentsPOSTThis operations returns Brazil Employee Assignments for one or more employees.
Retrieve Brazil Employee Assignments by Person IDretrieveBrazilEmployeeAssignmentsByPersonIDGETThis operation returns a list of Brazil Employee Assignments by person ID.
Retrieve Brazil Employee Assignments by Person ID or NumberretrieveBrazilEmployeeAssignmentsByPersonIDOrNumberGETThis operation returns a list of Brazil Employee Assignments by person ID or person number.
Break Rules4
Retrieve All Break RulesretrieveAllBreakRulesGETThis operation returns a list containing the ID and name of all break rules in the system.
Retrieve Break Rule by IDretrieveBreakRuleByIDGETThis operation returns the ID and name of a break rule by ID.
Retrieve GDAP-filtered Break Rule by IDretrieveGDAPFilteredBreakRuleByIDGETThis operation returns a complete break rule definition by ID.
Retrieve GDAP-filtered Break RulesretrieveGDAPFilteredBreakRulesGETThis operation returns a list of complete break rule definitions filtered by the calling user's GDAP.
Budget Distribution Types1
Retrieve All Budget Distribution TypesretrieveAllBudgetDistributionTypesGETThis operation returns all Budget Distribution Types.
Bulk Asynchronous Paycode Edits4
Bulk Import Paycode Edits AsynchronouslybulkImportPaycodeEditsAsynchronouslyPOSTThis operation imports paycode edits asynchronously.
Retrieve Asynchronous Paycode Edit Import Response Payload by KeyretrieveAsynchronousPaycodeEditImportResponsePayloadByKeyGETThis operation returns the response payload for an asynchronous operation by execution key.
Retrieve Paycode Edit Import Asynchronous Request Status by KeyretrievePaycodeEditImportAsynchronousRequestStatusByKeyGETThis operation returns the status of an asynchronous paycode edit import request by execution key.
Retrieve Summary of Asynchronous Paycode Edit Import JobsretrieveSummaryOfAsynchronousPaycodeEditImportJobsGETThis operation returns a summary of asynchronous paycode edit import jobs.
Bulk Downloads5
Delete Bulk DownloadsdeleteBulkDownloadsPOSTThis operation deletes the specified download requests by ID.
Retrieve Bulk Download ResultsretrieveBulkDownloadResultsGETThis operation returns a CSV file containing combined data sets based on a tracking request ID.
Retrieve Download Request SummaryretrieveDownloadRequestSummaryGETThis operation returns a summary of all download requests submitted by the current user.
Retrieve Download StatusretrieveDownloadStatusGETThis operation returns the status of a bulk download request.
Submit Bulk DownloadsubmitBulkDownloadPOSTThis operation processes and returns bulk data requests asynchronously.
Bulk Enable Edits1
Enable Edits Bulk UpdateenableEditsBulkUpdatePOSTThis operation returns a list of employees with enabled edits.
Bulk Paycode Edits2
Bulk Delete Paycode EditsbulkDeletePaycodeEditsPOSTThis operation performs a bulk delete of paycode edits for multiple employees using a list of paycode edit IDs.
Bulk Import Paycode EditsbulkImportPaycodeEditsPOSTThis operation imports paycode edits in bulk.
Bulk Payroll Lock1
Lock Payroll in BulklockPayrollInBulkPOSTThis operation locks employee payroll according to a specified date.
Bulk Punches1
Bulk Import PunchesbulkImportPunchesPOSTThis operation imports punches from a third party source for multiple employees.
Bulk Punches and Paycode Edits1
Bulk Import Punches and Paycode EditsbulkImportPunchesAndPaycodeEditsPOSTThis operation imports and returns a list of successfully updated punches and paycodes edits.
Bulk Real Time Punches1
Retrieve Punches in Real TimeretrievePunchesInRealTimePOSTThis operation returns a list of punches for employees in real time.
Bulk Timecard Approvals2
Approve Timecards in BulkapproveTimecardsInBulkPOSTThis operation approves a list of employee timecards in bulk for a specified timeframe or date range.
Bulk Timecard Delete ApprovalsbulkTimecardDeleteApprovalsPOSTThis operation deletes the approvals of a list of employee timecards in bulk for a specified timeframe or date range.
Bulk Timecard Signoffs1
Bulk Timecard SignoffsbulkTimecardSignoffsPOSTBulk Timecard Signoffs
Calendar Profiles6
Create or Update Calendar ProfilescreateOrUpdateCalendarProfilesPOSTThis operation creates or updates and returns a list of ESS Calendar Profile.
Delete Calendar Profile by IDdeleteCalendarProfileByIDDELETEThis operation deletes an Employee Self Service (ESS) Calendar Profile by ID.
Delete Calendar ProfilesdeleteCalendarProfilesPOSTThis operation deletes one or more ESS Calendar Profiles according to the parameters provided.
Retrieve All Calendar Profiles or by Name (Deprecated)retrieveAllCalendarProfilesOrByNameDeprecatedGETThis operation is deprecated; instead use Retrieve All Calendar Profiles or by Name (GET /v2/scheduling/setup/ess calendar profiles).
Retrieve Calendar Profile by IDretrieveCalendarProfileByIDGETThis operation returns a Calendar profile by ID.
Retrieve Calendar ProfilesretrieveCalendarProfilesPOSTThis operation returns a list of Calendar profiles by object references.
Call Logs4
Create Call LogcreateCallLogPOSTThis operation creates a call log according to the parameters provided.
Create Call LogscreateCallLogsPOSTThis operation creates one or more call logs according to the parameters provided.
Retrieve Call Log by IDretrieveCallLogByIDGETThis operation returns a call log by ID.
Retrieve Call LogsretrieveCallLogsPOSTThis operation returns one or more Call Logs matching the specified search criteria.
Cascade Profile Assignments7
Assign Cascade ProfileassignCascadeProfilePUTThis operation assigns a cascade profile to an employee.
Assign Cascade Profiles to Multiple EmployeesassignCascadeProfilesToMultipleEmployeesPOSTThis operation assigns one or more cascade profiles to one or more employees.
Delete Cascade ProfiledeleteCascadeProfileDELETEThis operation deletes a cascade profile assignment for an employee.
Delete Cascade Profiles for Multiple EmployeesdeleteCascadeProfilesForMultipleEmployeesPOSTThis operation deletes the assignment of one or more cascade profiles to one or more employees.
Retrieve Cascade Profiles by Person IDretrieveCascadeProfilesByPersonIDGETThis operation returns cascade profile assignments for an employee by person ID.
Retrieve Cascade Profiles by Person NumberretrieveCascadeProfilesByPersonNumberGETThis operation returns cascade profile assignments for an employee by person number.
Retrieve Cascade Profiles for Multiple EmployeesretrieveCascadeProfilesForMultipleEmployeesPOSTThis operation returns cascade profile assignments for one or more employees.
Category Property Set Assignments4
Create or Update Category Property Set AssignmentscreateOrUpdateCategoryPropertySetAssignmentsPOSTThis operation creates or updates category property set assignments for multiple locations.
Delete Category Property Set AssignmentsdeleteCategoryPropertySetAssignmentsPOSTThis operation deletes category property set assignments for multiple locations.
Retrieve Category Property Set AssignmentsretrieveCategoryPropertySetAssignmentsPOSTThis operation returns Category Property Set Assignments.
Retrieve Category Property Set Assignments by CategoryretrieveCategoryPropertySetAssignmentsByCategoryGETThis operation returns Category Property Set Assignments by Category and date span.
Category Property Sets5
Create Category Property SetcreateCategoryPropertySetPOSTThis operation creates a Category Property Set.
Create Category Property SetscreateCategoryPropertySetsPOSTThis operation creates Category Property Sets.
Retrieve All Category Property Sets, Only Active, or by NameretrieveAllCategoryPropertySetsOnlyActiveOrByNameGETThis operation returns all Category Property Sets, or allows you to filter out inactive Category Property Sets or return a specific Category Property Set by name.
Retrieve Category Property Set by IDretrieveCategoryPropertySetByIDGETThis operation returns a Category Property Set by ID.
Retrieve Category Property SetsretrieveCategoryPropertySetsPOSTThis operation returns Category Property Sets according to the specified object references.
Certification Assignments6
Delete Certification AssignmentsdeleteCertificationAssignmentsPOSTThis operation deletes one or more certification assignments for a person.
Retrieve All Certification AssignmentsretrieveAllCertificationAssignmentsPOSTThis operation returns all of a person's certification assignments.
Retrieve Certification Assignments by IDretrieveCertificationAssignmentsByIDGETThis operation returns a person's certification assignments by person ID.
Retrieve Certification Assignments by Person NumberretrieveCertificationAssignmentsByPersonNumberGETThis operation returns a person's certification assignments by person number.
Update Certification Assignment by IDupdateCertificationAssignmentByIDPUTThis operation updates one certification assignment by person ID.
Update Certification AssignmentsupdateCertificationAssignmentsPOSTThis operation updates certification assignments for one or more persons.
Certifications Setup9
Create CertificationcreateCertificationPOSTThis operation creates a new certification.
Create CertificationscreateCertificationsPOSTThis operation creates multiple certifications.
Delete Certification by IDdeleteCertificationByIDDELETEThis operation deletes a certification by ID.
Delete CertificationsdeleteCertificationsPOSTThis operation deletes multiple certifications.
Retrieve All Certifications or by NameretrieveAllCertificationsOrByNameGETThis operation returns a list of all certifications or a single certification by name.
Retrieve Certification by IDretrieveCertificationByIDGETThis operation returns a certification by ID.
Retrieve CertificationsretrieveCertificationsPOSTThis operation returns multiple certifications.
Update Certification by IDupdateCertificationByIDPUTThis operation updates a certification by ID.
Update CertificationsupdateCertificationsPOSTThis operation updates multiple certifications.
Change Indicators4
Retrieve Marker EventsretrieveMarkerEventsPOSTThis operation returns marker events according to the specified criteria.
Retrieve Marker TypesretrieveMarkerTypesGETThis operation returns a list of active change markers available for subscription, a list of all available marker cadences, and a list of available retention periods.
Retrieve SubscriptionsretrieveSubscriptionsGETThis operation returns the complete list of change marker subscriptions as well as all marker type attributes.
Subscribe or Unsubscribe to Change IndicatorssubscribeOrUnsubscribeToChangeIndicatorsPOSTThis operation subscribes to or unsubscribes from active change markers and sets or updates the retention period and cadence of new or existing subscriptions.
Charge Masters3
Create or Update Charge MasterscreateOrUpdateChargeMastersPOSTThis operation creates a new or updates an existing charge master.
Retrieve All Charge MastersretrieveAllChargeMastersGETThis operation returns all charge masters.
Retrieve Volume LabelsretrieveVolumeLabelsPOSTThis operation returns one or more volume labels by object references.
Combination Rules10
Create Combination RulecreateCombinationRulePOSTThis operation creates a combination rule.
Create Combination RulescreateCombinationRulesPOSTThis operation creates one or more combination rules.
Create or Update Combination RulescreateOrUpdateCombinationRulesPOSTThis operation creates or updates one or more combination rules.
Delete Combination Rule by IDdeleteCombinationRuleByIDDELETEThis operation deletes a combination rule by ID.
Delete Combination RulesdeleteCombinationRulesPOSTThis operation deletes one or more combination rules.
Retrieve All Combination RulesretrieveAllCombinationRulesGETThis operation returns a list of combination rules.
Retrieve Combination Rule by IDretrieveCombinationRuleByIDGETThis operation returns a combination rule by ID.
Retrieve Combination RulesretrieveCombinationRulesPOSTThis operation returns one or more combination rules by object references.
Update Combination Rule by IDupdateCombinationRuleByIDPUTThis operation updates a combination rule by ID.
Update Combination RulesupdateCombinationRulesPOSTThis operation updates one or more combination rules.
Combined Distribution Offset Types1
Retrieve Combined Distribution Offset TypesretrieveCombinedDistributionOffsetTypesGETThis operation returns all combined distribution offset types.
Combined Distribution Types1
Retrieve Combined Distribution TypesretrieveCombinedDistributionTypesGETThis operation returns all combined distribution types.
Combined Events2
Retrieve All Combined EventsretrieveAllCombinedEventsGETThis operation returns a list of all Combined Events.
Retrieve Combined Event by IDretrieveCombinedEventByIDGETThis operation returns a Combined Event by ID.
Combined Labor Distributions9
Create Combined Labor DistributioncreateCombinedLaborDistributionPOSTThis operation creates and returns a Combined Labor Distribution.
Create Combined Labor DistributionscreateCombinedLaborDistributionsPOSTThis operation creates and returns Combined Labor Distribution objects.
Delete Combined Labor Distribution by IDdeleteCombinedLaborDistributionByIDDELETEThis operation deletes a Combined Labor Distribution object by ID.
Delete Combined Labor DistributionsdeleteCombinedLaborDistributionsPOSTThis operation deletes a list of Combined Labor Distribution objects.
Retrieve All Combined Labor Distributions or by SpecificationretrieveAllCombinedLaborDistributionsOrBySpecificationGETThis operation returns a Combined Labor Distribution by generic department ID or qualifier and combined distribution name.
Retrieve Combined Labor Distribution by IDretrieveCombinedLaborDistributionByIDGETThis operation returns a Combined Labor Distribution by ID.
Retrieve Combined Labor DistributionsretrieveCombinedLaborDistributionsPOSTThis operation returns Combined Labor Distributions by object references to a generic department and, optionally, a list of Combined Labor Distributions.
Update Combined Labor Distribution by IDupdateCombinedLaborDistributionByIDPUTThis operation updates and returns a Combined Labor Distribution object by ID.
Update Combined Labor DistributionsupdateCombinedLaborDistributionsPOSTThis operation updates and returns a list of Combined Labor Distribution objects.
Combined Paycodes for Timekeeping3
Add Paycodes to or Remove Paycodes from Combined PaycodesaddPaycodesToOrRemovePaycodesFromCombinedPaycodesPOSTThis operation adds or removes one or more paycodes from one or more GDAP-filtered combined paycodes for the logged-in user by object references.
Retrieve Combined Paycode by IDretrieveCombinedPaycodeByIDGETThis operation returns a combined paycode with selected paycodes by ID for the logged-in user.
Retrieve Combined PaycodesretrieveCombinedPaycodesPOSTThis operation returns one or more GDAP-filtered combined paycodes with selected paycodes to the logged-in user by object references.
Comments2
Retrieve Comments as EmployeeretrieveCommentsAsEmployeeGETThis operation returns a filtered list of Comments that are associated with the request category type.
Retrieve Comments as ManagerretrieveCommentsAsManagerGETThis operation returns a filtered list of Comments.
Complete Attestation Process1
Complete an Attestation ProcesscompleteAnAttestationProcessPOSTThis operation completes an Attestation request.
Complete Manual Time Entry Attestation Process1
Complete a Manual Time Entry Attestation ProcesscompleteAManualTimeEntryAttestationProcessPOSTThis operation completes a Manual Time Entry Attestation request.
Consolidated Labor Forecast1
Retrieve Consolidated Labor ForecastsretrieveConsolidatedLaborForecastsPOSTThis operation returns consolidated labor forecasts by category and time period separated into immediate children categories.
Control Center Profiles3
Retrieve All Control Center ProfilesretrieveAllControlCenterProfilesGETThis operation returns a list of all Control Center profiles.
Retrieve Control Center Profile by IDretrieveControlCenterProfileByIDGETThis operation returns a Control Center profile by ID.
Retrieve Control Center ProfilesretrieveControlCenterProfilesPOSTThis operation returns a list of Control Center profiles by object references.
Cost Centers9
Create Cost CenterscreateCostCentersPOSTThis operation creates a list of cost centers.
Delete Cost CentersdeleteCostCentersPOSTThis operation deletes a list of cost centers by object references.
Retrieve All Cost CentersretrieveAllCostCentersGETThis operation returns a list of all cost centers in the system.
Retrieve All Cost Centers (Deprecated)retrieveAllCostCentersDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/cost centers.
Retrieve Cost Center by IDretrieveCostCenterByIDGETThis operation returns a cost center by ID.
Retrieve Cost Center by ID (Deprecated)retrieveCostCenterByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/cost centers/{id}.
Retrieve Cost CentersretrieveCostCentersPOSTThis operation returns one or more cost centers by object references.
Retrieve Paginated List of Cost CentersretrievePaginatedListOfCostCentersPOSTThis operation returns a paginated list of cost centers.
Update Cost CentersupdateCostCentersPOSTThis operation updates a list of cost centers.
Coverage Counting Profiles5
Retrieve All Coverage Counting Profiles or by NameretrieveAllCoverageCountingProfilesOrByNameGETThis operation returns a list of all coverage counting profiles or a single profile by name.
Retrieve Coverage Counting Profile AssignmentretrieveCoverageCountingProfileAssignmentGETThis operation returns coverage counting profile assignments by org node ID or PATH.
Retrieve Coverage Counting Profile AssignmentsretrieveCoverageCountingProfileAssignmentsPOSTThis operation returns a collection of coverage counting profile assignments by org node references.
Retrieve Coverage Counting Profile by IDretrieveCoverageCountingProfileByIDGETThis operation returns a coverage counting profile by ID.
Retrieve Coverage Counting ProfilesretrieveCoverageCountingProfilesPOSTThis operation returns a collection of coverage counting profiles by object references, or all coverage counting profiles if no references are passed.
Currency Definitions2
Retrieve All Currency DefinitionsretrieveAllCurrencyDefinitionsGETThis operation returns all currency definitions.
Retrieve Currency Definition by IDretrieveCurrencyDefinitionByIDGETThis operation returns a currency definition by ID.
Currency Policies7
Create Currency PolicycreateCurrencyPolicyPOSTThis operation creates a currency policy containing a currency code, an initial exchange rate, and exchange rates.
Create or update Currency PoliciescreateOrUpdateCurrencyPoliciesPOSTThis operation creates or updates one or more currency policies.
Retrieve All Currency PoliciesretrieveAllCurrencyPoliciesGETThis operation returns all currency policies.
Retrieve Base Currency PolicyretrieveBaseCurrencyPolicyGETThis operation returns the base currency policy.
Retrieve Currency PoliciesretrieveCurrencyPoliciesPOSTThis operation returns one or more currency policies by currency object references.
Retrieve Currency Policy by IDretrieveCurrencyPolicyByIDGETThis operation returns a currency policy by ID.
Update Currency PolicyupdateCurrencyPolicyPOSTThis operation updates a currency policy's currency code and exchange rates by ID.
Custom Driver Assignments3
Retrieve Custom Driver AssignmentsretrieveCustomDriverAssignmentsGETThis operation returns Custom Driver Assignments.
Retrieve Custom Driver Assignments by CategoryretrieveCustomDriverAssignmentsByCategoryPOSTThis operation returns Custom Driver Assignments by category.
Retrieve Custom Driver Assignments by ContextretrieveCustomDriverAssignmentsByContextPOSTThis operation returns Custom Driver Assignments.
Custom Drivers3
Retrieve Custom Driver ValuesretrieveCustomDriverValuesPOSTThis operation returns custom driver values.
Update Custom Driver ValuesupdateCustomDriverValuesPOSTThis operation updates custom driver values.
Update Values for Multiple Custom DriversupdateValuesForMultipleCustomDriversPOSTThis operation updates the values associated with a collection of custom drivers.
Custom Drivers Setup9
Create Custom DrivercreateCustomDriverPOSTThis operation creates a Custom Driver.
Create Custom DriverscreateCustomDriversPOSTThis operation creates Custom Drivers.
Delete Custom Driver by IDdeleteCustomDriverByIDDELETEThis operation deletes a Custom Driver by ID.
Delete Custom DriversdeleteCustomDriversPOSTThis operation deletes Custom Drivers.
Retrieve a Custom Driver by IDretrieveACustomDriverByIDGETThis operation returns a Custom Driver by ID.
Retrieve a Custom Driver by Name and Generic DepartmentretrieveACustomDriverByNameAndGenericDepartmentGETThis operation returns a Custom Driver by Name and Generic Department.
Retrieve Custom DriversretrieveCustomDriversPOSTThis operation returns Custom Drivers assigned to the specified Generic Department, resolves a collection of Custom Drivers for the specified Generic Department if a collection is...
Update Custom Driver by IDupdateCustomDriverByIDPUTThis operation updates a Custom Driver by ID.
Update Custom DriversupdateCustomDriversPOSTThis operation updates Custom Drivers.
Custom Tiles6
Create Custom TilecreateCustomTilePOSTThis operation creates a new custom tile and returns the successfully created resource as a response.
Delete Custom Tile by IDdeleteCustomTileByIDDELETEThis operation deletes a custom tile by ID.
Retrieve All Custom TilesretrieveAllCustomTilesGETThis operation returns a list of all the custom tiles present in the system which are accessible to the currently logged-in user.
Retrieve Custom Tile by IDretrieveCustomTileByIDGETThis operation returns a custom tile by ID.
Retrieve Custom TilesretrieveCustomTilesPOSTThis operation returns custom tiles based on the provided list of references.
Update Custom Tile by IDupdateCustomTileByIDPUTThis operation updates a custom tile by ID and returns the successfully updated resource as a response.
Daily Actual Volume1
Create Daily Actual VolumecreateDailyActualVolumePOSTThis operation creates daily actual volume.
Dashboard Profiles2
Retrieve Dashboard ProfilesretrieveDashboardProfilesPOSTThis operation returns Dashboard Profiles based on the specified criteria.
Update Dashboard ProfilesupdateDashboardProfilesPOSTThis operation updates one or more Dashboard Profiles based on the specified parameters.
Data Dictionary2
Retrieve Data Element DefinitionsretrieveDataElementDefinitionsGETThis operation returns a Data Element's definitions.
Retrieve Data Element Definitions by KeysretrieveDataElementDefinitionsByKeysPOSTThis operation returns a Data Element's definitions by keys.
Dataview Profiles6
Create Dataview ProfilecreateDataviewProfilePOSTThis operation creates a Dataview Profile.
Delete Dataview Profile by IDdeleteDataviewProfileByIDDELETEThis operation deletes a Dataview Profile by ID.
Retrieve All Dataview ProfilesretrieveAllDataviewProfilesGETThis operation returns all Dataview Profiles or, if passed a name, returns the named Dataview Profile.
Retrieve Dataview Profile by IDretrieveDataviewProfileByIDGETThis operation returns a Dataview Profile by ID.
Retrieve Dataview ProfilesretrieveDataviewProfilesPOSTThis operation returns Dataview profiles by object references.
Update Dataview Profile by IDupdateDataviewProfileByIDPUTThis operation updates a Dataview Profile by ID.
Dataviews9
Create Administrator DataviewcreateAdministratorDataviewPOSTThis operation creates a new administrator Dataview.
Create Personalized DataviewcreatePersonalizedDataviewPOSTThis operation creates a new personalized Dataview.
Delete Administrator Dataview by IDdeleteAdministratorDataviewByIDDELETEThis operation deletes an Administrator Dataview by ID.
Delete Personalized Dataview by IDdeletePersonalizedDataviewByIDDELETEThis operation deletes a personalized Dataview by ID.
Retrieve Dataview by CriteriaretrieveDataviewByCriteriaPOSTThis operation returns a Dataview by search criteria.
Retrieve Dataview by IDretrieveDataviewByIDGETThis operation returns, by ID, either an administrator or a personalized Dataview based on the specified query parameters.
Retrieve DataviewsretrieveDataviewsGETThis operation returns either administrator or personalized Dataviews based on the specified query parameters.
Update Administrator Dataview by IDupdateAdministratorDataviewByIDPUTThis operation updates an administrator Dataview by ID.
Update Personalized Dataview by IDupdatePersonalizedDataviewByIDPUTThis operation updates a personalized Dataview by ID.
Day Locks2
Lock Multiple DayslockMultipleDaysPOSTThis operation locks the schedule for a set of employees within a date range.
Unlock Multiple DaysunlockMultipleDaysPOSTThis operation unlocks the schedule for a set of employees within a date range.
Day Type Equivalencies3
Retrieve All Day Type EquivalenciesretrieveAllDayTypeEquivalenciesPOSTThis operation returns a collection of all day type equivalencies.
Retrieve All Day Type Equivalencies or by NameretrieveAllDayTypeEquivalenciesOrByNameGETThis operation returns a list of all day type equivalencies or a single equivalence by name.
Retrieve Day Type Equivalence by IDretrieveDayTypeEquivalenceByIDGETThis operation returns a day type equivalence by ID.
Delegate Profiles14
Add or Remove Delegate Profile DelegatesaddOrRemoveDelegateProfileDelegatesPOSTThis operation adds or removes delegates from delegate profiles.
Add or Remove Delegate Profile Delegates AsynchronouslyaddOrRemoveDelegateProfileDelegatesAsynchronouslyPOSTThis operation adds or removes delegates from delegate profiles asynchronously.
Create Delegate ProfilecreateDelegateProfilePOSTThis operation creates a delegate profile.
Create or Update Delegate ProfilescreateOrUpdateDelegateProfilesPOSTThis operation creates or updates one or more delegate profiles.
Create or Update Delegate Profiles AsynchronouslycreateOrUpdateDelegateProfilesAsynchronouslyPOSTThis operation processes and returns delegate profiles requests asynchronously.
Delete Delegate Profile by IDdeleteDelegateProfileByIDDELETEThis operation deletes a delegate profile by ID.
Delete Delegate ProfilesdeleteDelegateProfilesPOSTThis operation deletes one or more delegate profiles.
Retrieve All Delegate ProfilesretrieveAllDelegateProfilesGETThis operation returns all delegate profiles.
Retrieve Asynchronous Response Payload by KeyretrieveAsynchronousResponsePayloadByKeyGETThis operation returns the response payload for an asynchronous operation by execution key.
Retrieve Delegate Profile Asynchronous Request Status by KeyretrieveDelegateProfileAsynchronousRequestStatusByKeyGETThis operation returns the status of an asynchronous Delegate Profiles request by execution key.
Retrieve Delegate Profile by IDretrieveDelegateProfileByIDGETThis operation returns a delegate profile by ID.
Retrieve Delegate ProfilesretrieveDelegateProfilesPOSTThis operation returns one or more delegate profiles.
Retrieve Summary of Asynchronous Delegate Profile JobsretrieveSummaryOfAsynchronousDelegateProfileJobsGETThis operation returns a summary of asynchronous Delegate Profile jobs.
Update Delegate Profile by IDupdateDelegateProfileByIDPUTThis operation updates a delegate profile by ID.
Device Groups1
Retrieve Device GroupsretrieveDeviceGroupsGETThis operation returns a list of all device groups in the system.
Direct Assignments1
Retrieve All People Direct Assignment ProfilesretrieveAllPeopleDirectAssignmentProfilesGETThis operation returns all people direct assignments profiles.
Discipline Levels3
Retrieve All Discipline LevelsretrieveAllDisciplineLevelsGETThis operation returns a list of all the discipline levels.
Retrieve Discipline Level by IDretrieveDisciplineLevelByIDGETThis operation returns a discipline level by ID.
Retrieve Discipline LevelsretrieveDisciplineLevelsPOSTThis operation returns the discipline levels for a list of employees within a date range.
Discipline Policies2
Retrieve All Discipline PoliciesretrieveAllDisciplinePoliciesGETThis operation returns a list of all the Discipline Policies.
Retrieve Discipline Policy by IDretrieveDisciplinePolicyByIDGETThis operation returns a Discipline Policy by ID.
Display Profiles9
Create Display ProfilecreateDisplayProfilePOSTThis operation creates a display profile.
Create Display ProfilescreateDisplayProfilesPOSTThis operation creates a list of display profiles.
Delete Display Profile by IDdeleteDisplayProfileByIDDELETEDeletes a display profile.
Delete Display ProfilesdeleteDisplayProfilesPOSTThis operation deletes a list of display profiles.
Retrieve All Display ProfilesretrieveAllDisplayProfilesGETThis operation returns a list of all display profiles.
Retrieve Display Profile by IDretrieveDisplayProfileByIDGETThis operation returns a display profile by ID.
Retrieve Display ProfilesretrieveDisplayProfilesPOSTThis operation returns a list of display profiles by object references.
Update Display Profile by IDupdateDisplayProfileByIDPUTThis operation updates a display profile by ID.
Update Display ProfilesupdateDisplayProfilesPOSTThis operation updates a list of display profiles.
Domain Event Categories7
Create Domain Event CategorycreateDomainEventCategoryPOSTThis operation creates a domain event category.
Create or Update Domain Event CategoriescreateOrUpdateDomainEventCategoriesPOSTThis operation creates or updates domain event categories.
Delete Domain Event Category by IDdeleteDomainEventCategoryByIDDELETEThis operation deletes a domain event category by ID.
Retrieve All Domain Event CategoriesretrieveAllDomainEventCategoriesGETThis operation returns all domain event categories.
Retrieve Domain Event CategoriesretrieveDomainEventCategoriesPOSTThis operation returns a list of domain event categories.
Retrieve Domain Event Category by IDretrieveDomainEventCategoryByIDGETThis operation returns a domain event category by ID.
Update Domain Event Category by IDupdateDomainEventCategoryByIDPUTThis operation updates a domain event category by ID.
Domain Event Navigations7
Create Domain Event NavigationcreateDomainEventNavigationPOSTThis operation creates a domain event navigation.
Delete Domain Event Navigation by IDdeleteDomainEventNavigationByIDDELETEThis operation deletes a domain event navigation by ID.
Retrieve All Domain Event NavigationsretrieveAllDomainEventNavigationsGETThis operation returns all domain event navigations.
Retrieve Domain Event Navigation by IDretrieveDomainEventNavigationByIDGETThis operation returns a domain event navigation by ID.
Retrieve Domain Event NavigationsretrieveDomainEventNavigationsPOSTThis operation returns a list of domain event navigations.
Update Domain Event Navigation by IDupdateDomainEventNavigationByIDPUTThis operation updates a domain event navigation by ID.
Update or Create Domain Event NavigationsupdateOrCreateDomainEventNavigationsPOSTThis operation updates or creates a list of domain event navigations.
Domain Events8
Create Domain EventcreateDomainEventPOSTThis operation creates a Domain Event.
Create or Update Domain EventscreateOrUpdateDomainEventsPOSTThis operation creates or updates one or more Domain Events.
Delete Domain Event by IDdeleteDomainEventByIDDELETEThis operation deletes a Domain Event by ID.
Delete Domain EventsdeleteDomainEventsPOSTThis operation deletes one or more Domain Events by object references.
Retrieve All Domain EventsretrieveAllDomainEventsGETThis operation returns a list of all Domain Events.
Retrieve Domain Event by IDretrieveDomainEventByIDGETThis operation returns a Domain Event by ID.
Retrieve Domain EventsretrieveDomainEventsPOSTThis operation returns a list of Domain Events by object references.
Update Domain Event by IDupdateDomainEventByIDPUTThis operation updates a Domain Event by ID.
Dynamic Event Notification Mappings8
Create a Dynamic Event Notification MappingcreateADynamicEventNotificationMappingPOSTThis operation creates and returns a dynamic event notification mapping.
Create or Update Dynamic Event Notification MappingscreateOrUpdateDynamicEventNotificationMappingsPOSTThis operation creates or updates and returns a list of dynamic event notification mappings.
Delete Dynamic Event Notification Mapping by IDdeleteDynamicEventNotificationMappingByIDDELETEThis operation deletes a dynamic event notification mapping by ID.
Delete Dynamic Event Notification MappingsdeleteDynamicEventNotificationMappingsPOSTThis operation deletes a list of dynamic event notification mappings.
Retrieve All Dynamic Event Notification MappingsretrieveAllDynamicEventNotificationMappingsGETThis operation returns a list of all dynamic event notification mappings.
Retrieve Dynamic Event Notification Mapping by IDretrieveDynamicEventNotificationMappingByIDGETThis operation returns a dynamic event notification mapping by ID.
Retrieve Dynamic Event Notification MappingsretrieveDynamicEventNotificationMappingsPOSTThis operation returns a list of dynamic event notification mappings by object references.
Update a Dynamic Event Notification Mapping by IDupdateADynamicEventNotificationMappingByIDPUTThis operation updates and returns a dynamic event notification mapping by ID.
Dynamic Event Notifications1
Send Dynamic Event NotificationssendDynamicEventNotificationsPOSTThis operation sends one or more notifications for an event to a specified recipient.
Earned Hours Engine1
Execute Earned Hours EngineexecuteEarnedHoursEnginePOSTThis operation executes the earned hours engine.
Employee Announcements2
Retrieve Announcement Message Response by ID as EmployeeretrieveAnnouncementMessageResponseByIDAsEmployeeGETThis operation returns an announcement message response by message ID.
Update Announcement Message Response as EmployeeupdateAnnouncementMessageResponseAsEmployeePOSTThis operation updates an announcement message response as an employee.
Employee Availability Pattern Requests6
Create Availability Pattern RequestcreateAvailabilityPatternRequestPOSTThis operation creates an availability pattern request and returns the results.
Retrieve Availability Pattern Request by IDretrieveAvailabilityPatternRequestByIDGETThis operation returns an availability pattern request by ID.
Retrieve Availability Types for Availability Pattern Request SegmentsretrieveAvailabilityTypesForAvailabilityPatternRequestSegmentsGETThis operation returns all availability types for availability segments.
Retrieve Request Subtypes by Availability Type for Pattern RequestsretrieveRequestSubtypesByAvailabilityTypeForPatternRequestsGETThis operation returns all request subtypes by availability type.
Retrieve Submission Periods for Pattern RequestsretrieveSubmissionPeriodsForPatternRequestsGETThis operation returns submission periods for the availability pattern request type or for the subtype, if specified.
Update Availability Pattern Request StateupdateAvailabilityPatternRequestStatePOSTThis operation updates the state of an availability pattern request by transitioning the request from one state to another.
Employee Availability Requests7
Create Availability RequestcreateAvailabilityRequestPOSTThis operation creates an availability request and returns the results.
Retrieve Availability Request by IDretrieveAvailabilityRequestByIDGETThis operation returns an availability request by ID.
Retrieve Availability RequestsretrieveAvailabilityRequestsPOSTThis operation returns one or more availability requests by date range.
Retrieve Availability Types for Availability SegmentsretrieveAvailabilityTypesForAvailabilitySegmentsGETThis operation returns all availability types for availability segments.
Retrieve Request Subtypes by Availability TyperetrieveRequestSubtypesByAvailabilityTypeGETThis operation returns all request subtypes by availability type.
Retrieve Submission Periods by Availability Type or SubtyperetrieveSubmissionPeriodsByAvailabilityTypeOrSubtypeGETThis operation returns submission periods for the availability request type or for the subtype, if specified.
Update Availability Request StateupdateAvailabilityRequestStatePOSTThis operation updates the state of an availability request by transitioning the request from one state to another.
Employee Cover Requests9
Create Shift Cover RequestcreateShiftCoverRequestPOSTThis operation creates a shift cover request according to the specified parameters.
Invalidate Cover RequestinvalidateCoverRequestPOSTThis operation invalidates a cover request posted within an evaluation time period provided to a workflow model.
Retrieve Candidate EmployeesretrieveCandidateEmployeesGETThis operation returns one or more employees eligible to receive a shift cover request.
Retrieve Offerable ShiftsretrieveOfferableShiftsGETThis operation returns all shifts offerable for a shift cover request within the date range.
Retrieve Shift Cover Request by IDretrieveShiftCoverRequestByIDGETThis operation returns a shift cover request by ID.
Retrieve Shift Cover Request SubtypesretrieveShiftCoverRequestSubtypesGETThis operation returns one or more request subtypes that have schedule submission period open for today.
Retrieve Shift Cover RequestsretrieveShiftCoverRequestsPOSTThis operation returns one or more shift cover requests matching specified search criteria corresponding to a set of cover request IDs, employees, or current state.
Retrieve Submission PeriodsretrieveSubmissionPeriodsGETThis operation returns one or more employee visibility submission periods for the cover request type.
Update Shift Cover RequestupdateShiftCoverRequestPOSTThis operation updates the state of a shift cover request by transitioning the request from one state to another.
Employee Glance Setting Resources1
Retrieve All Custom FieldsretrieveAllCustomFieldsGETThis operation returns all custom fields.
Employee Glance Settings8
Create Employee Glance SettingcreateEmployeeGlanceSettingPOSTThis operation creates an employee glance setting.
Create or Update Employee Glance SettingscreateOrUpdateEmployeeGlanceSettingsPOSTThis operation creates or updates one or more employee glance settings.
Delete Employee Glance Setting by IDdeleteEmployeeGlanceSettingByIDDELETEThis operation deletes an employee glance setting by ID.
Delete Employee Glance SettingsdeleteEmployeeGlanceSettingsPOSTThis operation deletes one or more employee glance settings.
Retrieve All Employee Glance Settings or by NameretrieveAllEmployeeGlanceSettingsOrByNameGETThis operation returns all employee glance settings if no parameter is specified or a particular employee glance setting if a name is provided.
Retrieve Employee Glance Setting by IDretrieveEmployeeGlanceSettingByIDGETThis operation returns an employee glance setting by ID.
Retrieve Employee Glance SettingsretrieveEmployeeGlanceSettingsPOSTThis operation returns one or more employee glance settings by object references.
Update Employee Glance Setting by IDupdateEmployeeGlanceSettingByIDPUTThis operation updates an employee glance setting by ID.
Employee Groups9
Create Employee GroupscreateEmployeeGroupsPOSTThis operation creates employee groups.
Create or Update Employee GroupscreateOrUpdateEmployeeGroupsPOSTThis operation creates or updates one or more employee groups when ACP "EMPLOYEE GROUP" is allowed.
Delete Employee Group By IDdeleteEmployeeGroupByIDDELETEThis operation deletes an employee group by ID when ACP "EMPLOYEE GROUP" is allowed.
Delete Employee GroupsdeleteEmployeeGroupsPOSTThis operation deletes one or more employee groups according to the specified properties when ACP "EMPLOYEE GROUP" is allowed.
Retrieve All Employee Groups or by NameretrieveAllEmployeeGroupsOrByNameGETThis operation returns a list of all employee groups or returns a single employee group by name.
Retrieve All Employee Groups or by Name with PaginationretrieveAllEmployeeGroupsOrByNameWithPaginationGETThis operation returns a list of all employee groups or returns a single employee group by name with pagination support when the Access Control Point "EMPLOYEE GROUP" is allowed.
Retrieve Employee Group by IDretrieveEmployeeGroupByIDGETThis operation returns an employee group by ID.
Retrieve Employee GroupsretrieveEmployeeGroupsPOSTThis operation returns employee groups by object references.
Update Employee GroupsupdateEmployeeGroupsPOSTThis operation updates employee groups.
Employee Job Preferences5
Retrieve Job Preferences by IDretrieveJobPreferencesByIDGETThis operation returns employee job preferences by ID.
Retrieve Job Preferences by Person NumberretrieveJobPreferencesByPersonNumberGETThis operation returns an employee's job preferences by person number.
Retrieve Job Preferences for Multiple EmployeesretrieveJobPreferencesForMultipleEmployeesPOSTThis operation returns job preferences for one or more employees.
Update Job PreferencesupdateJobPreferencesPUTThis operation updates job preferences for an employee by person number.
Update Job Preferences for Multiple EmployeesupdateJobPreferencesForMultipleEmployeesPOSTThis operation updates job preferences for one or more employees.
Employee Open Shift Requests11
Create Employee Open Shift RequestcreateEmployeeOpenShiftRequestPOSTCreates an employee open shift request.
Retrieve Employee Open Shift Request by IDretrieveEmployeeOpenShiftRequestByIDGETReturns an employee open shift request.
Retrieve Employee Open Shift RequestsretrieveEmployeeOpenShiftRequestsPOSTThis operation returns one or more employee open shift requests.
Retrieve Employee Open Shift Resources (Deprecated)retrieveEmployeeOpenShiftResourcesDeprecatedPOSTThis operation returns one or more employee open shift resources.
Retrieve Jobs for Open Shift RequestsretrieveJobsForOpenShiftRequestsGETThis operation returns a list of jobs by date and employee open shift request subtype ID or name.
Retrieve Open Shift Request Information (Deprecated)retrieveOpenShiftRequestInformationDeprecatedPOSTThis operation is deprecated; instead use GET /v1/scheduling/employee open shift requests/request subtypes.
Retrieve Open Shift Request SubtypesretrieveOpenShiftRequestSubtypesGETThis operation returns all employee open shift request subtypes that correspond to an open submission period applicable to the current user.
Retrieve Other Employees Reporting to ManagerretrieveOtherEmployeesReportingToManagerGETThis operation returns other employees that report to the same manager if the request subtype is configured to show other employees.
Retrieve Request Submission PeriodsretrieveRequestSubmissionPeriodsGETThis operation returns all employee open shift request submission periods or all request submission periods for the given request subtype.
Retrieve Requestable Open ShiftsretrieveRequestableOpenShiftsPOSTThis operation returns requestable open shifts by request subtype, start date, end date, and optional additional filtering context.
Update Employee Open Shift RequestupdateEmployeeOpenShiftRequestPOSTThis operation updates an employee open shift request.
Employee Photos1
Retrieve Photos for Multiple EmployeesretrievePhotosForMultipleEmployeesPOSTThis operation returns employee photos as base64 encoded strings for one or more employees based on single or multi-key attributes such as personid or a combination of AOID and COID values.
Employee Schedule Patterns7
Create Employee Schedule PatterncreateEmployeeSchedulePatternPOSTThis operation creates an employee schedule pattern.
Delete Employee Schedule Pattern by IDdeleteEmployeeSchedulePatternByIDDELETEThis operation deletes an employee schedule pattern by ID.
Retrieve Builder ConfigurationretrieveBuilderConfigurationGETThis operation returns builder public configuration data for an employee schedule pattern.
Retrieve Employee Schedule Pattern by IDretrieveEmployeeSchedulePatternByIDGETThis operation returns an employee schedule pattern by ID.
Retrieve Employee Schedule Pattern ChangesretrieveEmployeeSchedulePatternChangesPOSTThis operation returns changes in employee schedule patterns based on the specified parameters.
Retrieve Employee Schedule PatternsretrieveEmployeeSchedulePatternsPOSTThis operation returns one or more employee schedule patterns.
Update Employee Schedule PatternsupdateEmployeeSchedulePatternsPOSTThis operation updates multiple employee schedule patterns.
Employee Schedules1
Retrieve Employee ScheduleretrieveEmployeeScheduleGETThis operation returns an employee's schedule according to the specified parameters.
Employee Schedules for Leave1
Retrieve Employee Schedule for LeaveretrieveEmployeeScheduleForLeaveGETThis operation returns the schedule for an employee associated with a leave case.
Employee Self-Schedule Requests13
Create Self-Schedule RequestcreateSelfScheduleRequestPOSTThis operation creates a self-schedule request.
Retrieve Open Self-Scheduling Request SubtypesretrieveOpenSelfSchedulingRequestSubtypesGETThis operation retrieves all employee self-scheduling request subtypes that correspond to an open submission period applicable to the current user.
Retrieve Other Employees Reporting to Manager for Self-SchedulingretrieveOtherEmployeesReportingToManagerForSelfSchedulingGETThis operation retrieves other employees that also report to your manager, provided the request subtype provided is configured to show other employees.
Retrieve Requestable Open Shifts (Deprecated)retrieveRequestableOpenShiftsDeprecatedPOSTThis operation is deprecated; instead use POST /v1/scheduling/employee self schedule request/open shifts/multi read.
Retrieve Requestable Open Shifts for Self-SchedulingretrieveRequestableOpenShiftsForSelfSchedulingPOSTThis operation retrieves requestable open shifts by request subtype, start date, end date, and optional additional filtering context.
Retrieve Requestable Open Shifts, Request Subtypes, or Submission Periods (Deprecated)retrieveRequestableOpenShiftsRequestSubtypesOrSubmissionPeriodsDeprecatedPOSTThis operation is deprecated; instead use GET /v1/scheduling/employee self schedule requests/request subtypes, GET /v1/scheduling/employee self schedule requests/submission periods and...
Retrieve Requestable Shift Templates for Self-SchedulingretrieveRequestableShiftTemplatesForSelfSchedulingPOSTThis operation retrieves requestable shift templates by request subtype, start date, end date, location, job, selected shift templates, filtering order, common shift templates, and...
Retrieve Self-Schedule Request by IDretrieveSelfScheduleRequestByIDGETThis operation returns a self-schedule request by ID.
Retrieve Self-Schedule Request by Job IDretrieveSelfScheduleRequestByJobIDGETThis operation returns a self-schedule request by job ID.
Retrieve Self-Schedule RequestsretrieveSelfScheduleRequestsPOSTThis operation returns one or more self-schedule requests by request IDs, employee IDs, or current state.
Retrieve Self-Scheduling Request Submission PeriodsretrieveSelfSchedulingRequestSubmissionPeriodsGETThis operation retrieves all employee self-scheduling request submission periods or all request submission periods for the given request subtype.
Update Self-Schedule Request by IDupdateSelfScheduleRequestByIDPUTThis operation updates a self-schedule request by ID.
Update Self-Schedule Request StateupdateSelfScheduleRequestStatePOSTThis operation updates the state of a self-schedule request by transtioning the request from one state to another.
Employee Swap Requests5
Create Shift Swap RequestcreateShiftSwapRequestPOSTThis operation creates a shift swap request according to the specified parameters.
Retrieve Shift Swap Request by IDretrieveShiftSwapRequestByIDGETThis operation returns a shift swap request by ID.
Retrieve Shift Swap Request InformationretrieveShiftSwapRequestInformationPOSTThis operation returns the information needed to create a shift swap request.
Retrieve Shift Swap RequestsretrieveShiftSwapRequestsPOSTThis operation returns one or more shift swap requests matching specified search criteria corresponding to a set of swap request IDs, employees, or current state.
Update Shift Swap RequestupdateShiftSwapRequestPOSTThis operation updates the state of a shift swap request by transitioning the request from one state to another.
Employee Tag Assignments9
Create Employee Tag AssignmentscreateEmployeeTagAssignmentsPOSTThis operation creates employee tag assignments.
Create Employee Tag Assignments for Multiple EmployeescreateEmployeeTagAssignmentsForMultipleEmployeesPOSTThis operation creates employee tag assignments for multiple employees.
Create, Update, or Remove Employee Tag AssignmentscreateUpdateOrRemoveEmployeeTagAssignmentsPUTThis operation replaces existing tag assignments, or, if none exist, creates new assignments.
Create, Update, or Remove Employee Tag Assignments for Multiple EmployeescreateUpdateOrRemoveEmployeeTagAssignmentsForMultipleEmployeesPOSTFor each set of employee tag assignments within the request body, this operation replaces existing tag assignments, or, if none exist, creates new assignments.
Delete Employee Tag AssignmentsdeleteEmployeeTagAssignmentsPOSTThis operation deletes (or removes) the tag assignments for multiple employees.
Delete Employee Tag Assignments for Multiple EmployeesdeleteEmployeeTagAssignmentsForMultipleEmployeesPOSTThis operation deletes employee tag assignments for multiple employees.
Retrieve Employee Tag Assignments by Person IDretrieveEmployeeTagAssignmentsByPersonIDGETThis operation returns all employee tag assignments for the employee with the provided person ID.
Retrieve Employee Tag Assignments by Person NumberretrieveEmployeeTagAssignmentsByPersonNumberGETThis operation returns all employee tag assignments for the employee with the provided person number.
Retrieve Employee Tag Assignments for Multiple EmployeesretrieveEmployeeTagAssignmentsForMultipleEmployeesPOSTThis operation returns employee tag assignments by employees or by tag definition and date range.
Employee Time Off Requests8
Create Employee Time Off RequestcreateEmployeeTimeOffRequestPOSTThis operation creates a time off request according to the specified parameters.
Retrieve Employee Accrual BalanceretrieveEmployeeAccrualBalanceGETThis operation returns an accrual balance.
Retrieve Employee Request PeriodretrieveEmployeeRequestPeriodGETThis operation returns a request period.
Retrieve Employee Request SubtyperetrieveEmployeeRequestSubtypeGETThis operation returns a request subtype.
Retrieve Employee Symbolic ValueretrieveEmployeeSymbolicValueGETThis operation returns a symbolic value.
Retrieve Employee Time Off Request by IDretrieveEmployeeTimeOffRequestByIDGETThis operation returns a time off request by ID.
Retrieve Employee Time Off RequestsretrieveEmployeeTimeOffRequestsPOSTThis operation returns one or more time off requests matching specified search criteria, corresponding to a set of time off request IDs, employees, or complete state.
Update Employee Time Off RequestupdateEmployeeTimeOffRequestPOSTThis operation updates the state of a time off request by transitioning a time off request from one state to another.
Employee Visibility Periods7
Create Employee Visibility PeriodscreateEmployeeVisibilityPeriodsPOSTThis operation creates one or more Employee Visibility Periods.
Delete Employee Visibility PeriodsdeleteEmployeeVisibilityPeriodsPOSTThis operation deletes one or more Employee Visibility Periods.
Retrieve All Employee Visibility Periods or by NameretrieveAllEmployeeVisibilityPeriodsOrByNameGETThis operation returns a list of all employee visibility periods or returns a single employee visibility period by name.
Retrieve Eligible Submission PeriodsretrieveEligibleSubmissionPeriodsPOSTThis operation returns employee eligible submission periods by search criteria.
Retrieve Employee Visibility Period by IDretrieveEmployeeVisibilityPeriodByIDGETThis operation returns an employee visibility period by ID.
Retrieve Employee Visibility PeriodsretrieveEmployeeVisibilityPeriodsPOSTThis operation returns employee visibility periods by search criteria.
Update Employee Visibility PeriodsupdateEmployeeVisibilityPeriodsPOSTThis operation updates one or more Employee Visibility Periods.
Employee Wage Work Rules2
Create or Update Wage and Work Rule OverridescreateOrUpdateWageAndWorkRuleOverridesPOSTThis operation creates or updates wage and work rule overrides for one or more employees.
Retrieve Employee Wage and Work RulesretrieveEmployeeWageAndWorkRulesPOSTThis operation returns a list of locations and jobs along with wage and work rules.
Employment Term Assignments9
Create Employment Term AssignmentcreateEmploymentTermAssignmentPOSTThis operation creates and returns employment term assignments for one employee according to the specified parameters.
Create Employment Term AssignmentscreateEmploymentTermAssignmentsPOSTThis operation creates and returns employment term assignments for multiple employees according to the specified parameters.
Delete Employment Term AssignmentdeleteEmploymentTermAssignmentPOSTThis operation removes employment term assignments for one employee according to the specified parameters.
Delete Employment Term AssignmentsdeleteEmploymentTermAssignmentsPOSTThis operation removes employment term memberships for multiple employees according to the specified parameters.
Retrieve Employment Term Assignment by IDretrieveEmploymentTermAssignmentByIDGETThis operation returns employment term memberships for one employee by person ID.
Retrieve Employment Term Assignment by Person NumberretrieveEmploymentTermAssignmentByPersonNumberGETThis operation returns employment term memberships for one employee by person number.
Retrieve Employment Term AssignmentsretrieveEmploymentTermAssignmentsPOSTThis operation returns employment term memberships for multiple employees according to the specified parameters.
Update Employment Term AssignmentupdateEmploymentTermAssignmentPUTThis operation updates and returns employment term assignments for one employee according to the specified parameters.
Update Employment Term AssignmentsupdateEmploymentTermAssignmentsPOSTThis operation updates and returns employment term assignments for multiple employees according to the specified parameters.
Employment Term Schedule Patterns6
Create Employment Term Schedule PatterncreateEmploymentTermSchedulePatternPOSTThis operation creates an Employment Term schedule pattern.
Delete Employment Term Schedule Pattern by IDdeleteEmploymentTermSchedulePatternByIDDELETEThis operation deletes an Employment Term schedule pattern by ID.
Retrieve Employment Term Schedule Pattern by IDretrieveEmploymentTermSchedulePatternByIDGETThis operation returns an Employment Term schedule pattern by ID.
Retrieve Employment Term Schedule Pattern ConfigurationretrieveEmploymentTermSchedulePatternConfigurationGETThis operation returns an abridged list of the Employment Term schedule pattern builder's public settings and configuration data.
Retrieve Employment Term Schedule PatternsretrieveEmploymentTermSchedulePatternsPOSTThis operation returns Employment Term schedule pattern entities based on the specified search criteria.
Update or Remove Employment Term Schedule PatternsupdateOrRemoveEmploymentTermSchedulePatternsPOSTThis operation updates or removes multiple Employment Term schedule patterns.
Employment Terms9
Create Employment TermcreateEmploymentTermPOSTThis operation creates an employment term.
Delete Employment Term by IDdeleteEmploymentTermByIDDELETEThis operation deletes an employment term by ID.
Retrieve All Employment TermsretrieveAllEmploymentTermsGETThis operation returns all employment terms.
Retrieve Employment Term (Deprecated)retrieveEmploymentTermDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/employment terms.
Retrieve Employment Term by IDretrieveEmploymentTermByIDGETThis operation returns an employment term by ID.
Retrieve Employment Term by ID (Deprecated)retrieveEmploymentTermByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/employment terms/{id}.
Retrieve Employment TermsretrieveEmploymentTermsPOSTThis operation returns one or more employment terms by object references.
Update Employment Term by IDupdateEmploymentTermByIDPUTThe operation updates an employment term by ID.
Update Employment Term VersionsupdateEmploymentTermVersionsPOSTThis operation updates one or more employment term versions and allows for partial update operations in which only the changes specified in the payload are made.
Employment Terms for Manager5
Retrieve Employee Employment TermsretrieveEmployeeEmploymentTermsPOSTThis operation returns the employment terms, group shifts, group paycode edits and memberships according to the specified parameters: employee, Hyperfind, location, or schedule employment...
Retrieve Employee Employment Terms ScheduleretrieveEmployeeEmploymentTermsScheduleGETThis operation returns the employment terms, group shifts, group paycode edits, and memberships according to the specified parameters.
Retrieve Employment Term ChangesretrieveEmploymentTermChangesGETThis operation returns incremental changes to Employment Terms based on a specified modification date range.
Retrieve Employment Terms Schedule StatusesretrieveEmploymentTermsScheduleStatusesPOSTThis operation returns one or more schedule statuses pertaining to a collection of Employment Terms within a specified date range.
Update Schedule Employment TermsupdateScheduleEmploymentTermsPOSTThis operation updates the employment terms assignments and returns a schedule according to the provided criteria.
Employment Terms Paycode Edits4
Create Employment Terms PCEscreateEmploymentTermsPCEsPOSTThis operation creates multiple paycode edits per employment term and returns the result of added Employment Terms paycode edits to the specified schedule employment terms.
Delete Employment Terms PCEsdeleteEmploymentTermsPCEsPOSTThis operation deletes multiple Employment Terms paycode edits by ID.
Retrieve Employment Terms PCE by IDretrieveEmploymentTermsPCEByIDGETThis operation returns the requested Employment Terms paycode edit by ID.
Update Employment Terms PCEsupdateEmploymentTermsPCEsPOSTThis operation updates multiple paycode edits per employment term.
Employment Terms Shifts4
Create Employment Terms ShiftscreateEmploymentTermsShiftsPOSTThis operation creates and returns multiple employment terms shifts per the specified schedule employment terms.
Delete Employment Terms ShiftsdeleteEmploymentTermsShiftsPOSTThis operation deletes multiple shifts per employment terms.
Retrieve Employment Terms Shift by IDretrieveEmploymentTermsShiftByIDGETThis operation returns the specified employment terms shift by ID.
Update Employment Terms ShiftsupdateEmploymentTermsShiftsPOSTThis operation updates multiple employment terms shifts.
Engine Status1
Retrieve Engine StatusesretrieveEngineStatusesPOSTThis operation returns the status of forecasting engine runs launched from the UI or API.
Entitlements2
Entitlement HistoryentitlementHistoryGETThis operation returns list of entitlement-history (history details) for all license-packages.
Entitlement SummaryentitlementSummaryGETThis operation returns list of entitlement-summary for all license-packages.
ESS Calendar Settings11
Create ESS Calendar SettingscreateESSCalendarSettingsPOSTThis operation creates an Employee Self Service (ESS) Calendar Settings.
Create Multiple ESS Calendar SettingscreateMultipleESSCalendarSettingsPOSTThis operation creates a set of new Employee Self Service (ESS) Calendar Settings.
Delete ESS Calendar Settings by IDdeleteESSCalendarSettingsByIDDELETEThis operation deletes an Employee Self Service (ESS) Calendar Settings by ID.
Delete Multiple ESS Calendar SettingsdeleteMultipleESSCalendarSettingsPOSTThis operation deletes one or more ESS Calendar Settings according to the parameters provided.
Retrieve All Schedule Insights Widget EntitiesretrieveAllScheduleInsightsWidgetEntitiesGETThis operation returns a list of all Schedule Insights Widget Entities.
Retrieve ESS Calendar Settings by IDretrieveESSCalendarSettingsByIDGETThis operation returns Employee Self Service (ESS) Calendar Settings by ID.
Retrieve ESS Calendar Settings by NameretrieveESSCalendarSettingsByNameGETThis operation returns a specific Employee Self Service (ESS) Calendar Settings by name.
Retrieve Multiple ESS Calendar SettingsretrieveMultipleESSCalendarSettingsPOSTThis operation returns specific Employee Self Service (ESS) Calendar Settings by object references or returns all ESS Calendar Settings if no references are provided.
Retrieve Transfer Types for ESS Calendar SettingsretrieveTransferTypesForESSCalendarSettingsGETThis operation returns all ESS Calendar Settings transfer types.
Update ESS Calendar SettingsupdateESSCalendarSettingsPUTThis operation updates an Employee Self Service (ESS) Calendar Settings by ID.
Update Multiple ESS Calendar SettingsupdateMultipleESSCalendarSettingsPUTThis operation updates one or more Employee Self Service (ESS) Calendar Settings.
Event Managers2
Delete Event ManagersdeleteEventManagersPOSTThis operation deletes one or more event manager according to the event IDs and validations provided.
Retrieve All Event ManagersretrieveAllEventManagersGETThis operation returns a paginated list of event managers.
Events8
Create EventscreateEventsPOSTThis operation creates basic Attendance events for one or more employees.
Delete Event by IDdeleteEventByIDDELETEThis operation deletes a basic Attendance event by ID.
Mark Event as Deleted by IDmarkEventAsDeletedByIDPOSTThis operation marks a basic attendance event as deleted by ID.
Retrieve Event by IDretrieveEventByIDGETThis operation returns an event by an ID and type.
Retrieve Event TypesretrieveEventTypesGETThis operation returns a list of the following event types: basic, pattern, combined, lost time, and perfect attendance.
Retrieve EventsretrieveEventsPOSTThis operation returns events for a list of employees within a date range.
Retrieve Events by ActionretrieveEventsByActionGETThis operation returns events that resulted in a specified action.
Update Event by IDupdateEventByIDPOSTThis operation updates a basic attendance event by ID.
Exception Categories10
Create Exception CategoriescreateExceptionCategoriesPOSTThis operation creates one or more exception categories.
Create Exception CategorycreateExceptionCategoryPOSTThis operation creates an exception category.
Delete Exception CategoriesdeleteExceptionCategoriesPOSTThis operation deletes one or more exception categories.
Delete Exception Category by IDdeleteExceptionCategoryByIDDELETEThis operation deletes an category tile by ID.
Retrieve All Exception CategoriesretrieveAllExceptionCategoriesGETThis operation returns all exception categories.
Retrieve All Exception TypesretrieveAllExceptionTypesGETThis operation returns all exception types.
Retrieve Exception CategoriesretrieveExceptionCategoriesPOSTThis operation returns one or more exception categories by object references.
Retrieve Exception Category by IDretrieveExceptionCategoryByIDGETThis operation returns an exception category by ID.
Update Exception CategoriesupdateExceptionCategoriesPOSTThis operation updates one or more exception categories.
Update Exception Category by IDupdateExceptionCategoryByIDPUTThis operation updates an exception category by ID.
Exception Tiles8
Create Exception TilecreateExceptionTilePOSTThis operation creates an exception tile.
Create Exception TilescreateExceptionTilesPOSTThis operation creates one or more exception tiles.
Delete Exception Tile by IDdeleteExceptionTileByIDDELETEThis operation deletes an exception tile by ID.
Delete Exception TilesdeleteExceptionTilesPOSTThis operation deletes one or more exception tiles.
Retrieve All Exception TilesretrieveAllExceptionTilesGETThis operation returns all exception tiles.
Retrieve Exception Tile by IDretrieveExceptionTileByIDGETThis operation returns an exception tile by ID.
Update Exception Tile by IDupdateExceptionTileByIDPUTThis operation updates an exception tile by ID.
Update Exception TilesupdateExceptionTilesPOSTThis operation updates one or more exception tiles.
Exchange Rates1
Retrieve Converted AmountretrieveConvertedAmountPOSTThis operation converts an amount in one currency to an amount in another currency, both of which must already be defined, valid currencies in your environment.
Feature Switches2
Retrieve Feature Switch by NameretrieveFeatureSwitchByNameGETThis operation returns a feature switch by name.
Retrieve Feature SwitchesretrieveFeatureSwitchesPOSTThis operation returns one or more feature switches by object references.
Field Definitions9
Create Field DefinitioncreateFieldDefinitionPOSTThis operation creates a Field Definition.
Create Field DefinitionscreateFieldDefinitionsPOSTThis operation creates one or more Field Definitions.
Delete Field Definition by IDdeleteFieldDefinitionByIDDELETEThis operation deletes a Field Definition by ID.
Delete Field DefinitionsdeleteFieldDefinitionsPOSTThis operation deletes one or more Field Definitions.
Retrieve All Field Definitions or by NameretrieveAllFieldDefinitionsOrByNameGETThis operation returns all Field Definitions (active and inactive) if no parameter is specified or a particular Field Definition if a name is provided.
Retrieve Field Definition by IDretrieveFieldDefinitionByIDGETThis operation returns a Field Definition by ID.
Retrieve Field DefinitionsretrieveFieldDefinitionsPOSTThis operation returns one or more Field Definitions by object references.
Update Field Definition by IDupdateFieldDefinitionByIDPUTThis operation updates a Field Definition by ID.
Update Field DefinitionsupdateFieldDefinitionsPOSTThis operation updates one or more Field Definitions.
File-based Integrations7
Create an Integration ProcesscreateAnIntegrationProcessPOSTThis operation creates an integration process and returns the process along with its unique ID.
Delete Integration by IDdeleteIntegrationByIDDELETEThis operation deletes an integration process by ID.
Execute Integration by IDexecuteIntegrationByIDPOSTThis operation submits an integration by ID to run immediately.
Retrieve Integration Process by IDretrieveIntegrationProcessByIDGETThis operation returns an integration process by ID.
Retrieve IntegrationsretrieveIntegrationsGETThis operation returns a list of all integrations and user-prompted parameters.
Schedule Integration by IDscheduleIntegrationByIDPOSTThis operation submits an integration by ID to schedule for execution.
Update Integration by IDupdateIntegrationByIDPUTThis operation updates an integration process by ID.
Fill Open Shifts3
Accept Open ShiftacceptOpenShiftPOSTThis operation accepts an open shift based on an open shift notification.
Decline Open ShiftdeclineOpenShiftPOSTThis operation declines an open shift based on an open shift notification.
Send Open Shift NotificationssendOpenShiftNotificationsPOSTThis operation notifies employees that a new open shift is available.
Fiscal Calendars2
Create Fiscal PeriodscreateFiscalPeriodsPOSTThis operation creates one or more fiscal periods.
Delete Fiscal PeriodsdeleteFiscalPeriodsPOSTThis operation deletes one or more fiscal periods.
Forecast Planner Profiles10
Create a Forecast Planner ProfilecreateAForecastPlannerProfilePOSTThis operation creates a Forecast Planner Profile.
Create Forecast Planner ProfilescreateForecastPlannerProfilesPOSTThis operation creates Forecast Planner Profiles.
Delete a Forecast Planner Profile by IDdeleteAForecastPlannerProfileByIDDELETEThis operation deletes a Forecast Planner Profile by ID.
Delete a Forecast Planner Profile by NamedeleteAForecastPlannerProfileByNameDELETEThis operation deletes a Forecast Planner Profile by name.
Delete Forecast Planner ProfilesdeleteForecastPlannerProfilesPOSTThis operation deletes Forecast Planner Profiles according to the specified object references.
Retrieve a Forecast Planner Profile by IDretrieveAForecastPlannerProfileByIDGETThis operation returns a Forecast Planner Profile by ID.
Retrieve All Forecast Planner Profiles or by NameretrieveAllForecastPlannerProfilesOrByNameGETThis operation returns all Forecast Planner Profiles or a particular Forecast Planner Profile if a name is provided.
Retrieve Forecast Planner ProfilesretrieveForecastPlannerProfilesPOSTThis operation returns Forecast Planner Profiles according to the specified object references.
Update a Forecast Planner Profile by IDupdateAForecastPlannerProfileByIDPUTThis operation updates a Forecast Planner Profile by ID.
Update Forecast Planner ProfilesupdateForecastPlannerProfilesPOSTThis operation updates Forecast Planner Profiles.
Forecast Planner Settings14
Create a Forecast Planner SettingcreateAForecastPlannerSettingPOSTThis operation creates a Forecast Planner Setting.
Create Forecast Planner SettingscreateForecastPlannerSettingsPOSTThis operation creates Forecast Planner Settings.
Delete a Forecast Planner Setting by IDdeleteAForecastPlannerSettingByIDDELETEThis operation deletes a Forecast Planner Setting by ID.
Delete a Forecast Planner Setting by NamedeleteAForecastPlannerSettingByNameDELETEThis operation deletes a Forecast Planner Setting by name.
Delete Forecast Planner SettingsdeleteForecastPlannerSettingsPOSTThis operation deletes Forecast Planner Settings according to the specified object references.
Retrieve a Forecast Planner Setting by IDretrieveAForecastPlannerSettingByIDGETThis operation returns a Forecast Planner Setting by ID.
Retrieve All Forecast Planner Settings or by NameretrieveAllForecastPlannerSettingsOrByNameGETThis operation returns all Forecast Planner Settings or a particular Forecast Planner Setting if a name is provided.
Retrieve Factor Definition TypesretrieveFactorDefinitionTypesGETThis operation returns factor definition types.
Retrieve Forecast Planner SettingsretrieveForecastPlannerSettingsPOSTThis operation returns Forecast Planner Settings according to the specified object references.
Retrieve StepsretrieveStepsGETThis operation returns steps.
Retrieve Volume Drivers Available to Forecast PlannerretrieveVolumeDriversAvailableToForecastPlannerGETThis operation returns all volume drivers available to the Forecast Planner.
Retrieve Volume Forecast IntervalsretrieveVolumeForecastIntervalsGETThis operations returns volume forcast intervals.
Update a Forecast Planner Setting by IDupdateAForecastPlannerSettingByIDPUTThis operation updates a Forecast Planner Setting by ID.
Update Forecast Planner SettingsupdateForecastPlannerSettingsPOSTThis operation updates Forecast Planner Settings.
Forecast Week2
Retrieve a Forecast WeekretrieveAForecastWeekGETThis operation returns a forecast week.
Retrieve a Forecast Week (Deprecated)retrieveAForecastWeekDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/forecast week.
Forecast Week Start Days6
Retrieve Forecast Week Default Start DayretrieveForecastWeekDefaultStartDayGETThe operation returns the default start day of a forecast week.
Retrieve Forecast Week Default Start Day (Deprecated)retrieveForecastWeekDefaultStartDayDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/forecast week/default start day.
Retrieve Forecast Week Start Day by IDretrieveForecastWeekStartDayByIDGETThis operation returns the start day of a forecast week by category ID and the effective date of a location (optional, default value is today).
Retrieve Forecast Week Start Day by ID (Deprecated)retrieveForecastWeekStartDayByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/forecast week/start day.
Retrieve Forecast Week Start DaysretrieveForecastWeekStartDaysPOSTThis operation returns forecast week start days for a list of category IDs and the effective date associated with one or more locations (optional, default value is today).
Retrieve Forecast Week Start Days (Deprecated)retrieveForecastWeekStartDaysDeprecatedPOSTThis operation is deprecated; instead use GET /v2/forecasting/forecast week/start days.
Forecasted Jobs1
Retrieve Forecasted JobsretrieveForecastedJobsPOSTThis operation returns Forecasted Jobs.
Forecasting Audits1
Retrieve Forecasting Audit DataretrieveForecastingAuditDataPOSTThis operation returns forecasting audit data.
Forecasting Category Profile Assignments7
Create or Update Category Profile AssignmentcreateOrUpdateCategoryProfileAssignmentPUTThis operation updates an existing or creates a new category profile assignment.
Delete Category Profile AssignmentdeleteCategoryProfileAssignmentDELETEThis operation deletes a category profile assignment.
Delete Category Profile AssignmentsdeleteCategoryProfileAssignmentsPOSTThis operation deletes category profile assignments.
Retrieve Category Profile Assignment by Person KeyretrieveCategoryProfileAssignmentByPersonKeyGETThis operation returns a category profile assignment by person key.
Retrieve Category Profile Assignment by Person NumberretrieveCategoryProfileAssignmentByPersonNumberGETThis operation returns a category profile assignment by person number.
Retrieve Category Profile AssignmentsretrieveCategoryProfileAssignmentsPOSTReturns category profile assignments.
Update Category Profile AssignmentsupdateCategoryProfileAssignmentsPOSTThis operation updates category profile assignments.
Forecasting Category Profiles9
Create Forecasting Category ProfilecreateForecastingCategoryProfilePOSTThis operation creates a Forecasting Category Profile.
Create Forecasting Category ProfilescreateForecastingCategoryProfilesPOSTThis operation creates Forecasting Category Profiles.
Delete Forecasting Category Profile by IDdeleteForecastingCategoryProfileByIDDELETEThis operation deletes a Forecasting Category Profile by ID.
Delete Forecasting Category ProfilesdeleteForecastingCategoryProfilesPOSTThis operation deletes Forecasting Category Profiles.
Retrieve All Forecasting Category Profiles, Only Active, or by NameretrieveAllForecastingCategoryProfilesOnlyActiveOrByNameGETThis operation returns all Forecasting Category Profiles, or allows you to filter out inactive Category Profiles or return a specific Category Profile by name.
Retrieve Forecasting Category Profile by IDretrieveForecastingCategoryProfileByIDGETThis operation returns a Forecasting Category Profile by ID.
Retrieve Forecasting Category ProfilesretrieveForecastingCategoryProfilesPOSTThis operation returns Forecasting Category Profiles by object references.
Update Forecasting Category Profile by IDupdateForecastingCategoryProfileByIDPUTThis operation updates a Forecasting Category Profile by ID.
Update Forecasting Category ProfilesupdateForecastingCategoryProfilesPOSTThis operation updates Forecasting Category Profiles.
Formula Policies2
Retrieve All Formula PoliciesretrieveAllFormulaPoliciesGETThis operation returns a list of all Formula Policies.
Retrieve Formula Policy by IDretrieveFormulaPolicyByIDGETThis operation returns a Formula Policy by ID.
Function Access Profiles5
Create Function Access ProfilecreateFunctionAccessProfilePOSTThis operation creates a Function Access Profile.
Delete Function Access Profile by IDdeleteFunctionAccessProfileByIDDELETEThis operation deletes a Function Access Profile by ID.
Retrieve All Function Access Profiles or by NameretrieveAllFunctionAccessProfilesOrByNameGETThis operation returns a list of all Function Access Profiles or a single profile by name.
Retrieve Function Access Profile by IDretrieveFunctionAccessProfileByIDGETThis operation returns a Function Access Profile by ID.
Update Function Access Profile by IDupdateFunctionAccessProfileByIDPUTThis operation updates a Function Access Profile by ID.
Gate Entry Punches1
Retrieve Gate Entry PunchesretrieveGateEntryPunchesPOSTThis operation returns employee gate entry punches by object references.
Generic Categories6
Retrieve All Generic Categories or by NameretrieveAllGenericCategoriesOrByNameGETThis operation returns all Generic Categories if no parameter is specified or a particular Generic Category if a name is provided.
Retrieve All Generic Categories or by Name (Deprecated)retrieveAllGenericCategoriesOrByNameDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/generic categories.
Retrieve Generic CategoriesretrieveGenericCategoriesPOSTThis operation returns Generic Categories according to the specified object references.
Retrieve Generic Categories (Deprecated)retrieveGenericCategoriesDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/generic categories/multi read.
Retrieve Generic Category by IDretrieveGenericCategoryByIDGETThis operation returns a Generic Category by ID.
Retrieve Generic Category by ID (Deprecated)retrieveGenericCategoryByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/generic categories/{id}.
Generic Data Access Profiles7
Create or Update Generic Data Access ProfilescreateOrUpdateGenericDataAccessProfilesPOSTThis operation creates or updates and returns a list of Generic Data Access Profiles.
Retrieve All Generic Data Access Profiles by Category IDretrieveAllGenericDataAccessProfilesByCategoryIDGETThis operation returns a list of all Generic Data Access Profiles by Category ID.
Retrieve All Generic Data Access Profiles CategoriesretrieveAllGenericDataAccessProfilesCategoriesGETThis operation returns a list of Generic Data Access Profiles Categories.
Retrieve Generic Data Access Profile by IDretrieveGenericDataAccessProfileByIDGETThis operation returns a Generic Data Access Profile by ID.
Retrieve Generic Data Access Profile by ID With Available ItemsretrieveGenericDataAccessProfileByIDWithAvailableItemsGETThis operation returns a Generic Data Access Profile by ID with available items.
Retrieve Generic Data Access ProfilesretrieveGenericDataAccessProfilesPOSTThis operation returns a list of generic data access profiles by object references.
Retrieve Setup Category Available Items for Generic Data Access ProfileretrieveSetupCategoryAvailableItemsForGenericDataAccessProfileGETThis operation returns setup category available items for a specified setup category.
Generic Departments2
Retrieve All Generic Departments or by NameretrieveAllGenericDepartmentsOrByNameGETThis operation returns all Generic Departments if no parameters are specified or a particular Generic Department by name.
Retrieve Generic Department by IDretrieveGenericDepartmentByIDGETThis operation returns a Generic Department by ID.
Generic Locations7
Create Generic LocationcreateGenericLocationPOSTThis operation creates a generic location.
Create or Update Generic LocationscreateOrUpdateGenericLocationsPOSTThis operation creates or updates one or more generic locations.
Delete Generic Location by IDdeleteGenericLocationByIDDELETEThis operation deletes a generic location by ID.
Retrieve a List of Generic LocationsretrieveAListOfGenericLocationsGETThis operation returns a list of generic locations by date and type.
Retrieve Generic Location by IDretrieveGenericLocationByIDGETThis operation returns generic location information by ID.
Retrieve Generic LocationsretrieveGenericLocationsPOSTThis operation returns one or more generic locations based on search criteria.
Update Generic Location by IDupdateGenericLocationByIDPUTThis operation updates a generic location by ID.
Generic Notifications8
Create Generic NotificationcreateGenericNotificationPOSTThis operation creates a new Generic Notification.
Create or Update Generic NotificationscreateOrUpdateGenericNotificationsPOSTThis operation creates or updates and returns a list of Generic Notifications.
Delete Generic NotificationdeleteGenericNotificationDELETEThis operation deletes a Generic Notification.
Delete Generic NotificationsdeleteGenericNotificationsPOSTThis operation deletes a list of Generic Notifications by object references.
Retrieve All Generic NotificationsretrieveAllGenericNotificationsGETThis operation returns a list of all Generic Notifications.
Retrieve Generic Notification by IDretrieveGenericNotificationByIDGETThis operation returns a Generic Notification by ID.
Retrieve Generic NotificationsretrieveGenericNotificationsPOSTThis operation returns a list of Generic Notifications by object references.
Update Generic NotificationupdateGenericNotificationPUTThis operation updates a Generic Notification.
GPS Known Places11
Create Known PlacecreateKnownPlacePOSTThis operation creates a Known Place.
Create Known PlacescreateKnownPlacesPOSTThis operation creates one or more Known Places.
Create or Update Known PlacescreateOrUpdateKnownPlacesPOSTThis operation creates or updates one or more Known Places.
Delete Known Place by IDdeleteKnownPlaceByIDDELETEThis operation deletes a Known Place by ID.
Delete Known Place by Persistent IDdeleteKnownPlaceByPersistentIDDELETEThis operation deletes a Known Place by persistent ID.
Delete Known PlacesdeleteKnownPlacesPOSTThis operation deletes one or more Known Places.
Retrieve All Known Places or by SpecificationretrieveAllKnownPlacesOrBySpecificationGETThis operation returns a list of all Known Places if no query parameter is specified, or by employee ID, person number, or persistent ID.
Retrieve Known Place by IDretrieveKnownPlaceByIDGETThis operation returns a Known Place by ID.
Retrieve Known PlacesretrieveKnownPlacesPOSTThis operation returns one or more known places by ID, name, or orgJob (which is a location on the Business Structure).
Update Known Place by IDupdateKnownPlaceByIDPUTThis operation updates a Known Place.
Update Known Place by Persistent IDupdateKnownPlaceByPersistentIDPUTThis operation updates a Known Place by persistent ID.
Group Assignments2
Add Group MembershipaddGroupMembershipPOSTThis operation creates and returns group assignments according to the specified parameters.
Remove Group MembershipremoveGroupMembershipPOSTThis operation removes group assignments according to the provided criteria.
Group Paycode Edits4
Create Group PCEscreateGroupPCEsPOSTThis operation creates multiple paycode edits per group and returns the result of added paycode edits to the specified group.
Delete Group PCEsdeleteGroupPCEsPOSTThis operation deletes multiple group paycode edits.
Retrieve Group PCE by IDretrieveGroupPCEByIDGETThis operation returns a group paycode edit by ID.
Update Group PCEsupdateGroupPCEsPOSTThis operation updates multiple group paycode edits.
Group Schedule Patterns6
Create Group Schedule PatterncreateGroupSchedulePatternPOSTThis operation creates a group schedule pattern.
Delete Group Schedule Pattern by IDdeleteGroupSchedulePatternByIDDELETEThis operation deletes a group schedule pattern by ID.
Retrieve Group Schedule Pattern by IDretrieveGroupSchedulePatternByIDGETThis operation retrieves a group schedule pattern by ID.
Retrieve Group Schedule Pattern ConfigurationretrieveGroupSchedulePatternConfigurationGETThis operation retrieves an abridged list of builder public settings and configuration data.
Retrieve Multiple Group Schedule PatternsretrieveMultipleGroupSchedulePatternsPOSTThis operation selects and retrieves group schedule pattern entities based on the specified search criteria.
Update or Remove Group Schedule PatternsupdateOrRemoveGroupSchedulePatternsPOSTThis operation updates or removes multiple group schedule patterns.
Group Schedules for Manager4
Retrieve Employee Group ScheduleretrieveEmployeeGroupScheduleGETThis operation returns the groups, shifts, group paycode edits, and memberships according to the matched input parameters.
Retrieve Group Schedule StatusesretrieveGroupScheduleStatusesPOSTThis operation returns one or more schedule statuses pertaining to a collection of Schedule Groups within a specified date range.
Retrieve Multiple Employee Group SchedulesretrieveMultipleEmployeeGroupSchedulesPOSTThis operation returns a schedule according to the specified parameters, including groups, shifts, group paycode edits, and memberships.
Update Schedule GroupupdateScheduleGroupPOSTThis operation updates group assignments and returns a schedule according to the specified criteria.
Group Shifts4
Create Group ShiftscreateGroupShiftsPOSTThis operation creates multiple shifts per group and returns the result of adding the group shifts to the specified schedule groups.
Delete Group ShiftsdeleteGroupShiftsPOSTThis operation deletes multiple shifts per group.
Retrieve Group Shift by IDretrieveGroupShiftByIDGETThis operation returns a group shift by ID.
Update Group ShiftsupdateGroupShiftsPOSTThis operation updates multiple group shifts.
HCM Payroll Aggregation1
Retrieve Payroll Data for HCMretrievePayrollDataForHCMPOSTThis operation aggregates and returns payroll according to the specified parameters.
Holiday and Unscheduled Day Request Settings9
Create Holiday and Unscheduled Day Request SettingscreateHolidayAndUnscheduledDayRequestSettingsPOSTThis operation create a set of holiday and unscheduled day request settings.
Create Multiple Holiday and Unscheduled Day Request SettingscreateMultipleHolidayAndUnscheduledDayRequestSettingsPOSTThis operation creates one or more sets of holiday and unscheduled day request settings.
Delete Holiday and Unscheduled Day Request Settings by IDdeleteHolidayAndUnscheduledDayRequestSettingsByIDDELETEThis operation deletes a set of holiday and unscheduled day request settings by ID.
Delete Multiple Holiday and Unscheduled Day Request SettingsdeleteMultipleHolidayAndUnscheduledDayRequestSettingsPOSTThis operation deletes one or more sets of holiday and unscheduled day request settings by object references.
Retrieve Holiday and Unscheduled Day Request Settings by IDretrieveHolidayAndUnscheduledDayRequestSettingsByIDGETThis operation returns a set of holiday and unscheduled day request settings by ID.
Retrieve Holiday and Unscheduled Day Request Settings by Object RefsretrieveHolidayAndUnscheduledDayRequestSettingsByObjectRefsPOSTThis operation returns one or more holiday and unscheduled day request settings by object references.
Retrieve Holiday and Unscheduled Day Request Settings by SpecificationretrieveHolidayAndUnscheduledDayRequestSettingsBySpecificationGETThis operation returns holiday and unscheduled day request settings by name, by paycode value profile name or ID, and by paycode name or ID.
Update Holiday and Unscheduled Day Request Settings by IDupdateHolidayAndUnscheduledDayRequestSettingsByIDPUTThis operation updates a set of holiday and unscheduled day request settings by ID.
Update Multiple Holiday and Unscheduled Day Request SettingsupdateMultipleHolidayAndUnscheduledDayRequestSettingsPOSTThis operation updates one or more sets of holiday and unscheduled day request settings.
Home Pages8
Create Home PagecreateHomePagePOSTThis operation creates a home page with tile assignments.
Delete a Personalized Home Page by IDdeleteAPersonalizedHomePageByIDDELETEThis operation deletes a personalized home page and restores that home page to a default state by removing all personalized tile associations according to the provided home page ID.
Delete Home Page by IDdeleteHomePageByIDDELETEThis operation deletes a home page and associated tiles by ID.
Personalize Home Page by IDpersonalizeHomePageByIDPOSTThis operation personalizes a home page by ID.
Retrieve Home Page by IDretrieveHomePageByIDGETThis operation returns a home page by ID.
Retrieve Home Page ProfilesretrieveHomePageProfilesPOSTThis operation returns a list of Home page profiles by object references.
Retrieve Home PagesretrieveHomePagesGETThis operation returns all home pages.
Update Home Page by IDupdateHomePageByIDPUTThis operation updates a home page by ID.
Hours of Operation19
Create Hours of OperationcreateHoursOfOperationPOSTThis operation creates and returns an Hours of Operation object with effective versions.
Create Hours of Operation (Deprecated)createHoursOfOperationDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/hours operation.
Create Multiple Hours of OperationcreateMultipleHoursOfOperationPOSTThis operation creates one or more Hours of Operation objects with effective versions.
Create Multiple Hours of Operation (Deprecated)createMultipleHoursOfOperationDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/hours operation/multi create.
Delete Hours of Operation by IDdeleteHoursOfOperationByIDDELETEThis operation deletes an Hours of Operation object by ID.
Delete Hours of Operation by ID (Deprecated)deleteHoursOfOperationByIDDeprecatedDELETEThis operation is deprecated; instead use DELETE /v2/commons/hours operation/{id}.
Delete Hours of Operation Effective VersiondeleteHoursOfOperationEffectiveVersionPOSTThis operation deletes an Hours of Operation effective version by ID and effective date.
Delete Multiple Hours of OperationdeleteMultipleHoursOfOperationPOSTThis operation deletes one or more Hours of Operation objects.
Delete Multiple Hours of Operation (Deprecated)deleteMultipleHoursOfOperationDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/hours operation/multi delete.
Retrieve All Hours of Operation or by NameretrieveAllHoursOfOperationOrByNameGETThis operation returns all Hours of Operation objects with effective versions if no parameter is specified or a particular Hours of Operation object if a name is provided.
Retrieve All Hours of Operation or by Name (Deprecated)retrieveAllHoursOfOperationOrByNameDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/hours operation.
Retrieve Hours of Operation by IDretrieveHoursOfOperationByIDGETThis operation returns an Hours of Operation object with effective versions by ID.
Retrieve Hours of Operation by ID (Deprecated)retrieveHoursOfOperationByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/hours operation/{id}.
Retrieve Multiple Hours of OperationretrieveMultipleHoursOfOperationPOSTThis operation returns one or more Hours of Operation with effective versions by object references.
Retrieve Multiple Hours of Operation (Deprecated)retrieveMultipleHoursOfOperationDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/hours operation/multi read.
Update Hours of Operation by IDupdateHoursOfOperationByIDPUTThis operation updates an Hours of Operation object with effective versions by ID.
Update Hours of Operation by ID (Deprecated)updateHoursOfOperationByIDDeprecatedPUTThis operation is deprecated; instead use PUT /v2/commons/hours operation/{id}.
Update Multiple Hours of OperationupdateMultipleHoursOfOperationPOSTThis operation updates one or more Hours of Operation objects with effective versions.
Update Multiple Hours of Operation (Deprecated)updateMultipleHoursOfOperationDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/hours operation/multi update.
Hours of Operation Assignments4
Create or Update Hours of Operation AssignmentscreateOrUpdateHoursOfOperationAssignmentsPOSTThis operation creates or updates hours of operation assignments for multiple locations.
Delete Hours of Operation AssignmentsdeleteHoursOfOperationAssignmentsPOSTThis operation deletes hours of operation assignments for multiple locations.
Retrieve Hours of Operation Assignments for Multiple LocationsretrieveHoursOfOperationAssignmentsForMultipleLocationsPOSTThis operation returns hours of operation assignments for multiple locations.
Retrieve Hours of Operation Assignments for One LocationretrieveHoursOfOperationAssignmentsForOneLocationGETThis operation returns hours of operation assignments for a single location.
Hours of Operation Assignments (Deprecated)4
Create or Update Hours of Operation Assignments (Deprecated)createOrUpdateHoursOfOperationAssignmentsDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation assignments/multi upsert.
Delete Hours of Operation Assignments (Deprecated)deleteHoursOfOperationAssignmentsDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation assignments/multi delete.
Retrieve Hours of Operation Assignments for Multiple Locations (Deprecated)retrieveHoursOfOperationAssignmentsForMultipleLocationsDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation assignments/multi read.
Retrieve Hours of Operation Assignments--One Location (Deprecated)retrieveHoursOfOperationAssignmentsOneLocationDeprecatedGETThis operation is deprecated; instead use GET /v1/commons/hours operation assignments.
Hours of Operation Override Assignments4
Create or Update Hours of Operation Override AssignmentscreateOrUpdateHoursOfOperationOverrideAssignmentsPOSTThis operation creates or updates hours of operation override assignments for multiple locations.
Delete Hours of Operation Override AssignmentsdeleteHoursOfOperationOverrideAssignmentsPOSTThis operation deletes hours of operation override assignments for multiple locations.
Retrieve Hours of Operation Override AssignmentretrieveHoursOfOperationOverrideAssignmentGETThis operation returns an hours of operation override assignment for a single location.
Retrieve Hours of Operation Override AssignmentsretrieveHoursOfOperationOverrideAssignmentsPOSTThis operation returns hours of operation override assignments for multiple locations.
Hours of Operation Override Assignments (Deprecated)4
Create or Update Hours of Operation Override Assignments (Deprecated)createOrUpdateHoursOfOperationOverrideAssignmentsDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation override assignments/multi upsert.
Delete Hours of Operation Override Assignments (Deprecated)deleteHoursOfOperationOverrideAssignmentsDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation override assignments/multi delete.
Retrieve Hours of Operation Override Assignment (Deprecated)retrieveHoursOfOperationOverrideAssignmentDeprecatedGETThis operation is deprecated; instead use GET /v1/commons/hours operation override assignments.
Retrieve Hours of Operation Override Assignments (Deprecated)retrieveHoursOfOperationOverrideAssignmentsDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation override assignments/multi read.
Hours of Operation Overrides9
Create Hours of Operation OverridecreateHoursOfOperationOverridePOSTThis operation creates and returns an Hours of Operation Override.
Create Hours of Operation OverridescreateHoursOfOperationOverridesPOSTThis operation creates and returns Hours of Operation Overrides.
Delete Hours of Operation Override by IDdeleteHoursOfOperationOverrideByIDDELETEThis operation deletes an Hours of Operation Override by ID.
Delete Hours of Operation OverridesdeleteHoursOfOperationOverridesPOSTThis operation deletes a list of Hours of Operation Overrides.
Retrieve All Hours of Operation Overrides or by NameretrieveAllHoursOfOperationOverridesOrByNameGETThis operation returns all Hours of Operation Overrides if no parameter is specified or a particular Hours of Operation Override if a name is provided.
Retrieve Hours of Operation Override by IDretrieveHoursOfOperationOverrideByIDGETThis operation returns an Hours of Operation Override by ID.
Retrieve Hours of Operation OverridesretrieveHoursOfOperationOverridesPOSTThis operation returns Hours of Operation Overrides according to the specified object references.
Update Hours of Operation Override by IDupdateHoursOfOperationOverrideByIDPUTThis operation updates and returns an Hours of Operation Override by ID.
Update Hours of Operation OverridesupdateHoursOfOperationOverridesPOSTThis operation updates and returns a list of Hours of Operation Overrides.
Hours of Operation Overrides (Deprecated)9
Create Hours of Operation Override (Deprecated)createHoursOfOperationOverrideDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation override.
Create Hours of Operation Overrides (Deprecated)createHoursOfOperationOverridesDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation override/multi create.
Delete Hours of Operation Override by ID (Deprecated)deleteHoursOfOperationOverrideByIDDeprecatedDELETEThis operation is deprecated; instead use DELETE /v1/commons/hours operation override/{id}.
Delete Hours of Operation Overrides (Deprecated)deleteHoursOfOperationOverridesDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation override/multi delete.
Retrieve All Hours of Operation Overrides or by Name (Deprecated)retrieveAllHoursOfOperationOverridesOrByNameDeprecatedGETThis operation is deprecated; instead use GET /v1/commons/hours operation override.
Retrieve Hours of Operation Override by ID (Deprecated)retrieveHoursOfOperationOverrideByIDDeprecatedGETThis operation is deprecated; instead use GET /v1/commons/hours operation override/{id}.
Retrieve Hours of Operation Overrides (Deprecated)retrieveHoursOfOperationOverridesDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation override/multi read.
Update Hours of Operation Override by ID (Deprecated)updateHoursOfOperationOverrideByIDDeprecatedPUTThis operation is deprecated; instead use PUT /v1/commons/hours operation override/{id}.
Update Hours of Operation Overrides (Deprecated)updateHoursOfOperationOverridesDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/hours operation override/multi update.
Hyperfind Profiles3
Retrieve All Hyperfind ProfilesretrieveAllHyperfindProfilesGETThis operation returns a list of all Hyperfind Profiles.
Retrieve Hyperfind Profile by IDretrieveHyperfindProfileByIDGETThis operation returns a Hyperfind Profile by ID.
Retrieve Hyperfind ProfilesretrieveHyperfindProfilesPOSTThis operation returns a list of Hyperfind Profiles by object references.
Hyperfind Queries11
Create or Update Hyperfind QueriescreateOrUpdateHyperfindQueriesPOSTThis operation creates or updates Hyperfind queries by object references.
Delete Hyperfind QueriesdeleteHyperfindQueriesPOSTThis operation deletes Hyperfind queries by object references.
Delete Personal Hyperfind QueriesdeletePersonalHyperfindQueriesPOSTThis operation deletes a list of personal Hyperfind queries.
Execute Hyperfind QueryexecuteHyperfindQueryPOSTThis operation executes a Hyperfind query by ID or qualifier and returns the result.
Retrieve Hyperfind Filter Details by Filter IDretrieveHyperfindFilterDetailsByFilterIDGETThis operation returns information about a specific Hyperfind filter by filter ID.
Retrieve Hyperfind FiltersretrieveHyperfindFiltersGETThis operation returns a list of Hyperfind filters.
Retrieve Hyperfind QueriesretrieveHyperfindQueriesPOSTThis operation returns a list of Hyperfind queries by object references.
Retrieve Hyperfind Queries for Current UserretrieveHyperfindQueriesForCurrentUserGETThis operation returns a list of all Hyperfind queries accessible to the current user.
Retrieve Hyperfind Query by IDretrieveHyperfindQueryByIDGETThis operation returns a Hyperfind query by ID.
Retrieve Personal Hyperfind Queries for Inactive and Terminated EmployeesretrievePersonalHyperfindQueriesForInactiveAndTerminatedEmployeesGETThis operation returns a list of personal Hyperfind queries for inactive and terminated employees.
Retrieve Public Hyperfind QueriesretrievePublicHyperfindQueriesGETThis operation returns a list of public Hyperfind queries accessible to the current user.
Incentive Definitions9
Create Incentive DefinitioncreateIncentiveDefinitionPOSTThis operation creates a schedule incentive definition.
Create Incentive DefinitionscreateIncentiveDefinitionsPOSTThis operation creates one or more schedule incentive definitions.
Delete Incentive Definition by IDdeleteIncentiveDefinitionByIDDELETEThis operation deletes a schedule incentive definition by ID.
Delete Incentive DefinitionsdeleteIncentiveDefinitionsPOSTThis operation deletes one or more schedule incentive definitions.
Retrieve Incentive Definition by IDretrieveIncentiveDefinitionByIDGETThis operation returns a schedule incentive definition by ID.
Retrieve Incentive Definition by NameretrieveIncentiveDefinitionByNameGETThis operation returns one incentive definition by name.
Retrieve Incentive DefinitionsretrieveIncentiveDefinitionsPOSTThis operation returns one or more incentive definitions according to the specified criteria.
Update Incentive Definition by IDupdateIncentiveDefinitionByIDPUTThis operation updates a schedule incentive definition by ID.
Update Incentive DefinitionsupdateIncentiveDefinitionsPOSTThis operation updates one or more schedule incentive definitions.
Incentive Levels9
Create Incentive LevelcreateIncentiveLevelPOSTThis operation creates a schedule incentive level.
Create Incentive LevelscreateIncentiveLevelsPOSTThis operation creates one or more schedule incentive levels.
Delete Incentive Level by IDdeleteIncentiveLevelByIDDELETEThis operation deletes a schedule incentive level by ID.
Delete Incentive LevelsdeleteIncentiveLevelsPOSTThis operation deletes one or more schedule incentive levels.
Retrieve Incentive Level by IDretrieveIncentiveLevelByIDGETThis operation returns a schedule incentive level by ID.
Retrieve Incentive Level by NameretrieveIncentiveLevelByNameGETThis operation returns a schedule incentive level by name.
Retrieve Incentive LevelsretrieveIncentiveLevelsPOSTThis operation returns one or more schedule incentive levels.
Update Incentive Level by IDupdateIncentiveLevelByIDPUTThis operation updates a schedule incentive level by ID.
Update Incentive LevelsupdateIncentiveLevelsPOSTThis operation updates one or more schedule incentive levels.
Incentive Profiles9
Create Incentive ProfilecreateIncentiveProfilePOSTThis operation creates a schedule incentive profile.
Create Incentive ProfilescreateIncentiveProfilesPOSTThis operation creates one or more schedule incentive profiles.
Delete Incentive Profile by IDdeleteIncentiveProfileByIDDELETEThis operation deletes a schedule incentive profile by ID.
Delete Incentive ProfilesdeleteIncentiveProfilesPOSTThis operation deletes one or more schedule incentive profiles.
Retrieve Incentive Profile by IDretrieveIncentiveProfileByIDGETThis operation returns a schedule incentive profile by ID.
Retrieve Incentive Profile by NameretrieveIncentiveProfileByNameGETThis operation returns a schedule incentive profile by name.
Retrieve Incentive ProfilesretrieveIncentiveProfilesPOSTThis operation returns one or more schedule incentive profiles.
Update Incentive Profile by IDupdateIncentiveProfileByIDPUTThis operation updates a schedule incentive profile by ID.
Update Incentive ProfilesupdateIncentiveProfilesPOSTThis operation updates one or more schedule incentive profiles.
Indicators3
Retrieve All Indicators or by NameretrieveAllIndicatorsOrByNameGETThis operation returns a list of all indicators or a single indicator by name.
Retrieve Indicator by IDretrieveIndicatorByIDGETThis operation returns an indicator by ID.
Retrieve IndicatorsretrieveIndicatorsPOSTThis operation returns a set of indicators by object references, or all indicators if no references are specified.
Integration Executions6
Download File by IntegrationdownloadFileByIntegrationGETThis operation downloads a file by integration ID and file name.
Retrieve All Integration ExecutionsretrieveAllIntegrationExecutionsGETThis operation returns a list of all integration runs including completed, in-progress, scheduled, and failed integration runs.
Retrieve File Names by Integration IDretrieveFileNamesByIntegrationIDGETThis operation returns a list of file names by integration ID.
Retrieve Integration Execution by IDretrieveIntegrationExecutionByIDGETThis operation returns the status of and detailed information about an executed integration by ID.
Retrieve Integration ExecutionsretrieveIntegrationExecutionsPOSTThis operation returns a list of integration runs.
Submit Integration Execution Additional DetailssubmitIntegrationExecutionAdditionalDetailsPOSTThis operation submits all additional details related to an integration execution (API or batch) into system.
Integration List Parameters2
Create or Update Integration List ParameterscreateOrUpdateIntegrationListParametersPOSTThis operation creates or updates one or more integration list parameters.
Retrieve Integration List Parameter by NameretrieveIntegrationListParameterByNameGETThis operation returns an integration list parameter by name.
Integration Process Callback1
Update Integration Execution DetailsupdateIntegrationExecutionDetailsPOSTThis operation updates and returns the callback instance against the provided integration execution details.
Integration Schedules4
Delete Scheduled Integration Instance by IDdeleteScheduledIntegrationInstanceByIDDELETEThis operation deletes a scheduled integration instance by ID.
Retrieve All Scheduled Integration InstancesretrieveAllScheduledIntegrationInstancesGETThis operation returns a list of all scheduled integrations for a date range.
Retrieve Scheduled Integration Instance by IDretrieveScheduledIntegrationInstanceByIDGETThis operation returns details about a scheduled integration instance by ID.
Update Scheduled Integration Instance by IDupdateScheduledIntegrationInstanceByIDPUTThis operation updates details about a scheduled integration instance by ID.
Jobs14
Create Generic JobcreateGenericJobPOSTThis operation creates a generic job according to the provided data.
Delete Generic JobdeleteGenericJobDELETEThis operation deletes a generic job according to the provided data.
Delete Generic Job by IDdeleteGenericJobByIDDELETEThis operation deletes all revisions of a generic job by ID and according to the provided data.
Delete Multiple Generic JobsdeleteMultipleGenericJobsPOSTThis operation deletes one or more generic jobs.
Retrieve Effective Job by IDretrieveEffectiveJobByIDGETThis operation returns an effective job by ID and date.
Retrieve Effective Job by NameretrieveEffectiveJobByNameGETThis operation returns an effective job by name and date.
Retrieve Effective Job Reference by External IDretrieveEffectiveJobReferenceByExternalIDGETThis operation returns an object reference to an effective job by external ID and date.
Retrieve Effective Job References by External IDsretrieveEffectiveJobReferencesByExternalIDsPOSTThis operation returns effective job object references by external IDs and date.
Retrieve Generic Jobs by Job AssignmentretrieveGenericJobsByJobAssignmentPOSTThis operation returns generic jobs by Job Assignment (job node) and date.
Retrieve Generic Jobs by ReferenceretrieveGenericJobsByReferencePOSTThis operation returns generic jobs by reference data and date.
Retrieve Job Asynchronous Request Status by KeyretrieveJobAsynchronousRequestStatusByKeyGETThis operation returns the status of an asynchronous Job request by execution key.
Retrieve Job Mappings by Persistent IDsretrieveJobMappingsByPersistentIDsPOSTThis operation returns mappings between nodeId and persistentId by persistent IDs.
Update Generic Job Asynchronously by IDupdateGenericJobAsynchronouslyByIDPOSTThis operation asynchronously updates a generic job by ID with the provided data.
Update Generic Job by IDupdateGenericJobByIDPOSTThis operation updates a generic job by ID according to the provided data.
Kiosk11
Create Kiosk ConfigurationcreateKioskConfigurationPOSTThis operation creates a kiosk configuration.
Create Kiosk InstancecreateKioskInstancePOSTThis operation creates a kiosk instance.
Delete Kiosk Configuration by IDdeleteKioskConfigurationByIDDELETEThis operation deletes a kiosk configuration by ID.
Delete Kiosk Instance by IDdeleteKioskInstanceByIDDELETEThis operation deletes a kiosk instance by ID.
Retrieve All Kiosk ConfigurationsretrieveAllKioskConfigurationsGETThis operation returns a list of all kiosk configurations.
Retrieve All Kiosk InstancesretrieveAllKioskInstancesGETThis operation returns all kiosk instances.
Retrieve Kiosk Configuration by IDretrieveKioskConfigurationByIDGETThis operation returns a kiosk configuration by ID.
Retrieve Kiosk Instance by IDretrieveKioskInstanceByIDGETThis operation returns a kiosk instance by ID.
Retrieve Kiosk Login TransactionsretrieveKioskLoginTransactionsPOSTThis operation returns kiosk login transactions for a list of employees within a date range.
Update Kiosk Configuration by IDupdateKioskConfigurationByIDPUTThis operation updates a kiosk configuration by ID.
Update Kiosk Instance by IDupdateKioskInstanceByIDPUTThis operation updates a kiosk instance by ID.
Known IP Addresses6
Create Known IP AddresscreateKnownIPAddressPOSTThis operation creates a Known IP Address.
Create or Update Known IP AddressescreateOrUpdateKnownIPAddressesPOSTThis operation creates or updates one or more Known IP Addresses.
Delete Known IP Address by IDdeleteKnownIPAddressByIDDELETEThis operation deletes a Known IP Address by ID.
Retrieve Known IP Address by IDretrieveKnownIPAddressByIDGETThis operation returns a Known IP Address by ID.
Retrieve Known IP AddressesretrieveKnownIPAddressesGETThis operation returns all Known IP Addresses.
Update Known IP Address by IDupdateKnownIPAddressByIDPUTThis operation updates a Known IP Address by ID.
Labor Budget4
Import Labor BudgetsimportLaborBudgetsPOSTThis operation imports labor budgets.
Retrieve Labor Budget ValuesretrieveLaborBudgetValuesPOSTThis operation returns Labor Budget Values.
Retrieve Labor BudgetsretrieveLaborBudgetsPOSTThis operation returns labor budgets.
Update Labor BudgetsupdateLaborBudgetsPOSTThis operation updates labor budgets.
Labor Categories7
Create Labor CategoriescreateLaborCategoriesPOSTThis operation creates a list of labor categories.
Delete Labor CategoriesdeleteLaborCategoriesPOSTThis operation deletes a list of labor categories.
Retrieve All Labor Categories or by CriteriaretrieveAllLaborCategoriesOrByCriteriaGETThis operation returns a list of all labor categories if no parameter is specified, a single labor category by name, or a list of labor categories updated after a specified date and time.
Retrieve All Labor Categories or by Name (Deprecated)retrieveAllLaborCategoriesOrByNameDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/labor categories.
Retrieve Labor Category by IDretrieveLaborCategoryByIDGETThis operation returns a labor category by ID.
Retrieve Labor Category by ID (Deprecated)retrieveLaborCategoryByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/labor categories/{id}.
Update Labor CategoriesupdateLaborCategoriesPOSTThis operation updates a list of labor categories.
Labor Category Entries10
Create Labor Category EntriescreateLaborCategoryEntriesPOSTThis operation creates a list of labor category entries.
Delete Labor Category EntriesdeleteLaborCategoryEntriesPOSTThis operation deletes a list of labor category entries.
Delete Labor Category Entry by IDdeleteLaborCategoryEntryByIDDELETEThis operation deletes a labor category entry by ID.
Retrieve Labor Category EntriesretrieveLaborCategoryEntriesPOSTThis operation returns one or more labor category entries by object references.
Retrieve Labor Category Entries by Category IDretrieveLaborCategoryEntriesByCategoryIDGETThis operation returns a list of all labor category entries associated with a labor category ID.
Retrieve Labor Category Entries by Category ID (Deprecated)retrieveLaborCategoryEntriesByCategoryIDDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/labor entries.
Retrieve Labor Category Entry by IDretrieveLaborCategoryEntryByIDGETThis operation returns a labor category entry by ID.
Retrieve Labor Category Entry by ID (Deprecated)retrieveLaborCategoryEntryByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/labor entries/{id}.
Retrieve Paginated List of Labor Category EntriesretrievePaginatedListOfLaborCategoryEntriesPOSTThis operation returns a paginated list of labor category entries.
Update Labor Category EntriesupdateLaborCategoryEntriesPOSTThis operation updates a list of labor category entries.
Labor Category List Assignments5
Create Labor Category List AssignmentscreateLaborCategoryListAssignmentsPOSTThis operation creates a list of labor category list assignments.
Delete Labor Category List AssignmentsdeleteLaborCategoryListAssignmentsPOSTThis operation deletes a list of labor category list assignments.
Delete Labor Category List Assignments by ID (Deprecated)deleteLaborCategoryListAssignmentsByIDDeprecatedPOSTThis operation is deprecated; instead use POST /v1/commons/labor category list assignments/multi delete.
Retrieve Labor Category List AssignmentsretrieveLaborCategoryListAssignmentsPOSTThis operation returns a list labor category list assignments.
Update Labor Category List AssignmentsupdateLaborCategoryListAssignmentsPOSTThis operation updates a list of labor category list assignments.
Labor Category Lists13
Create Labor Category ListscreateLaborCategoryListsPOSTThis operation creates a list of labor category lists.
Create Labor Category Lists with Effective VersionscreateLaborCategoryListsWithEffectiveVersionsPOSTThis operation creates one or more labor category lists with effective versions.
Create or Update Labor Category ListscreateOrUpdateLaborCategoryListsPOSTThis operation creates or updates a list of labor category lists.
Delete Labor Category List by IDdeleteLaborCategoryListByIDDELETEThis operation deletes a labor category list by ID.
Delete Labor Category ListsdeleteLaborCategoryListsPOSTThis operation deletes a list of labor category lists.
Retrieve All Labor Category ListsretrieveAllLaborCategoryListsGETThis operation returns all labor category lists.
Retrieve All Labor Category Lists with Effective VersionsretrieveAllLaborCategoryListsWithEffectiveVersionsGETThis operation returns all labor category lists with effective versions.
Retrieve Labor Category List by IDretrieveLaborCategoryListByIDGETThis operation returns a labor category list by ID.
Retrieve Labor Category List of EntriesretrieveLaborCategoryListOfEntriesPOSTThis operation returns a paginated labor category list of entries.
Retrieve Labor Category List with Effective Version by IDretrieveLaborCategoryListWithEffectiveVersionByIDGETThis operation returns a labor category list with effective version by ID.
Retrieve Paginated Labor Category List with Effective VersionretrievePaginatedLaborCategoryListWithEffectiveVersionPOSTThis operation returns a paginated labor category list with effective version.
Update Labor Category ListsupdateLaborCategoryListsPOSTThis operation updates a list of labor category lists.
Update Labor Category Lists with Effective VersionsupdateLaborCategoryListsWithEffectiveVersionsPOSTThis operation updates one or more labor category lists with effective versions.
Labor Category Profiles11
Create Labor Category ProfilescreateLaborCategoryProfilesPOSTThis operation creates a list of labor category profiles.
Create or Update Labor Category ProfilescreateOrUpdateLaborCategoryProfilesPOSTThis operation creates and updates a list of labor category profiles.
Delete Labor Category Profile by IDdeleteLaborCategoryProfileByIDDELETEThis operation deletes a labor category profile by ID.
Delete Labor Category Profile by ObjectRefdeleteLaborCategoryProfileByObjectRefDELETEThis operation deletes a labor category profile by ObjectRef.
Delete Labor Category ProfilesdeleteLaborCategoryProfilesPOSTThis operation deletes a list of labor category profiles.
Retrieve All Labor Category ProfilesretrieveAllLaborCategoryProfilesGETThis operation returns a list of all labor category profiles in the system.
Retrieve Labor Category Profile by IDretrieveLaborCategoryProfileByIDGETThis operation returns a labor category profile by ID.
Retrieve Labor Category Profile for Current UserretrieveLaborCategoryProfileForCurrentUserGETThis operation returns the labor category profile for the current user.
Retrieve Labor Category ProfilesretrieveLaborCategoryProfilesPOSTThis operation returns a list of labor category profiles for request payload.
Retrieve Paginated List of Labor Category ProfilesretrievePaginatedListOfLaborCategoryProfilesPOSTThis operation returns a paginated list of labor category profiles.
Update Labor Category ProfilesupdateLaborCategoryProfilesPOSTThis operation updates a list of labor category profiles.
Labor Constraint Engine1
Execute Labor Constraint EngineexecuteLaborConstraintEnginePOSTThis operation executes the labor constraint engine and returns the results.
Labor Constraint Profiles10
Create a Labor Constraint ProfilecreateALaborConstraintProfilePOSTThis operation creates a Labor Constraint Profile.
Create Labor Constraint ProfilescreateLaborConstraintProfilesPOSTThis operation creates Labor Constraint Profiles.
Delete a Labor Constraint Profile by IDdeleteALaborConstraintProfileByIDDELETEThis operation deletes a Labor Constraint Profile by ID.
Delete Labor Constraint ProfilesdeleteLaborConstraintProfilesPOSTThis operation deletes Labor Constraint Profiles according to the specified object references.
Retrieve a Labor Constraint Profile by IDretrieveALaborConstraintProfileByIDGETThis operation returns a Labor Constraint Profile by ID.
Retrieve a Labor Constraint Profile by LocationretrieveALaborConstraintProfileByLocationPOSTThis operation returns a Labor Constraint Profile by location.
Retrieve All Labor Constraint Profiles or by NameretrieveAllLaborConstraintProfilesOrByNameGETThis operation returns all Labor Constraint Profiles or a particular Labor Constraint Profile if a name is provided.
Retrieve Labor Constraint ProfilesretrieveLaborConstraintProfilesPOSTThis operation returns Labor Constraint Profiles according to the specified object references.
Update a Labor Constraint Profile by IDupdateALaborConstraintProfileByIDPUTThis operation updates a Labor Constraint Profile by ID.
Update Labor Constraint ProfilesupdateLaborConstraintProfilesPOSTThis operation updates Labor Constraint Profiles.
Labor Constraint Settings13
Create Labor Constraint SettingscreateLaborConstraintSettingsPOSTThis operation creates Labor Constraint Settings.
Create Multiple Labor Constraint SettingscreateMultipleLaborConstraintSettingsPOSTThis operation creates one or more Labor Constraint Settings.
Delete Labor Constraint SettingsdeleteLaborConstraintSettingsPOSTThis operation deletes Labor Constraint Settings according to the specified object references.
Delete Labor Constraint Settings by IDdeleteLaborConstraintSettingsByIDDELETEThis operation deletes Labor Constraint Settings by ID.
Retrieve Adjustment TypesretrieveAdjustmentTypesGETThis operation returns Adjustment Types.
Retrieve All Labor Constraint Settings or by NameretrieveAllLaborConstraintSettingsOrByNameGETThis operation returns all Labor Constraint Settings or a particular set of Labor Constraint Settings if a name is provided.
Retrieve Control TypesretrieveControlTypesGETThis operation returns Control Types.
Retrieve Labor Constraint SettingsretrieveLaborConstraintSettingsPOSTThis operation returns Labor Constraint Settings according to the specified object references.
Retrieve Labor Constraint Settings by IDretrieveLaborConstraintSettingsByIDGETThis operation returns Labor Constraint Settings by ID.
Retrieve Labor Forecast Distribution Method TypesretrieveLaborForecastDistributionMethodTypesGETThis operation returns Labor Forecast Distribution Method Types.
Retrieve Period DistributionsretrievePeriodDistributionsGETThis operation returns Period Distributions.
Update Labor Constraint Settings by IDupdateLaborConstraintSettingsByIDPUTThis operation updates Labor Constraint Settings by ID.
Update Multiple Labor Constraint SettingsupdateMultipleLaborConstraintSettingsPOSTThis operation updates one or more Labor Constraint Settings.
Labor Distribution Group Profiles10
Create Labor Distribution Group ProfilecreateLaborDistributionGroupProfilePOSTThis operation creates a labor distribution group profile.
Create Labor Distribution Group ProfilescreateLaborDistributionGroupProfilesPOSTThis operation creates one or more labor distribution group profiles.
Delete Labor Distribution Group Profile by IDdeleteLaborDistributionGroupProfileByIDDELETEThis operation deletes a labor distribution group profile by ID.
Delete Labor Distribution Group ProfilesdeleteLaborDistributionGroupProfilesPOSTThis operation deletes one or more labor distribution group profiles.
Retrieve All Labor Distribution Group Profiles or by NameretrieveAllLaborDistributionGroupProfilesOrByNameGETThis operation returns all labor distribution group profiles or a particular labor distribution group profile if a name is provided.
Retrieve Labor Distribution Group Profile by IDretrieveLaborDistributionGroupProfileByIDGETThis operation returns a labor distribution group profile by ID.
Retrieve Labor Distribution Group Profile by LocationretrieveLaborDistributionGroupProfileByLocationPOSTThis operation returns a labor distribution group profile by location.
Retrieve Labor Distribution Group ProfilesretrieveLaborDistributionGroupProfilesPOSTThis operation returns one or more labor distribution group profiles.
Update Labor Distribution Group Profile by IDupdateLaborDistributionGroupProfileByIDPUTThis operation updates a labor distribution group profile by ID.
Update Labor Distribution Group ProfilesupdateLaborDistributionGroupProfilesPOSTThis operation updates one or more labor distribution group profiles.
Labor Distribution Groups11
Create Labor Distribution GroupcreateLaborDistributionGroupPOSTThis operation creates a labor distribution group.
Create Labor Distribution GroupscreateLaborDistributionGroupsPOSTThis operation creates one or more labor distribution groups.
Delete Labor Distribution Group by IDdeleteLaborDistributionGroupByIDDELETEThis operation deletes a labor distribution group by ID.
Delete Labor Distribution GroupsdeleteLaborDistributionGroupsPOSTThis operation deletes one or more labor distribution groups.
Retrieve All Allocation Method TypesretrieveAllAllocationMethodTypesGETThis operation returns all allocation method types.
Retrieve All Borrow Hours TypesretrieveAllBorrowHoursTypesGETThis operation returns all borrow hours types.
Retrieve All Labor Distribution Groups or by NameretrieveAllLaborDistributionGroupsOrByNameGETThis operation returns all labor distribution groups or a particular set of labor distribution groups if a name is provided.
Retrieve Labor Distribution Group by IDretrieveLaborDistributionGroupByIDGETThis operation returns a labor distribution group by ID.
Retrieve Labor Distribution GroupsretrieveLaborDistributionGroupsPOSTThis operation returns one or more labor distribution group profiles.
Update Labor Distribution Group by IDupdateLaborDistributionGroupByIDPUTThis operation updates a labor distribution group by ID.
Update Labor Distribution GroupsupdateLaborDistributionGroupsPOSTThis operation updates one or more Labor Distribution Groups.
Labor Entry Lists1
Retrieve Labor Entry ListsretrieveLaborEntryListsPOSTThis operation returns a list of labor category entry lists by employee, orgNode, and effective date.
Labor Forecast6
Create Labor ForecastscreateLaborForecastsPOSTThis operation creates (imports) labor forecasts and replaces the deprecated Import Labor Forecasts (POST /v1/forecasting/labor forecast/import) API operation.
Import Labor Forecasts (Deprecated)importLaborForecastsDeprecatedPOSTThis operation is deprecated; instead use POST /v1/forecasting/labor forecast/multi create.
Retrieve Labor ForecastsretrieveLaborForecastsPOSTThis operation returns labor forecasts.
Retrieve Labor Forecasts for Multiple LocationsretrieveLaborForecastsForMultipleLocationsPOSTThis operation returns labor forecasts for a list of orgjobs, which are nodes on the Business Structure.
Update Labor ForecastupdateLaborForecastPOSTThis operation updates a labor forecast.
Update Labor ForecastsupdateLaborForecastsPOSTThis operation updates labor forecasts.
Labor Forecast Analyzer1
Execute Labor Forecast AnalyzerexecuteLaborForecastAnalyzerPOSTThis operation executes the labor forecast analyzer and returns the results.
Labor Forecast Engine1
Execute Labor Forecast EngineexecuteLaborForecastEnginePOSTThis operation executes the labor forecast engine.
Labor Forecast Limit Assignments3
Create or Update Labor Forecast Limit AssignmentscreateOrUpdateLaborForecastLimitAssignmentsPOSTThis operation creates or updates labor forecast limit assignments for multiple jobs and labor forecast limits.
Delete Labor Forecast Limit AssignmentsdeleteLaborForecastLimitAssignmentsPOSTThis operation deletes labor forecast limit assignments for multiple jobs and labor forecast limits.
Retrieve Labor Forecast Limit AssignmentsretrieveLaborForecastLimitAssignmentsPOSTThis operation returns labor forecast limit assignments by multiple jobs or labor forecast limits.
Labor Forecast Limits19
Create Labor Forecast LimitcreateLaborForecastLimitPOSTThis operation creates a labor forecast limit with effective versions.
Create Labor Forecast Limit (Deprecated)createLaborForecastLimitDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/labor forecast limits.
Create Labor Forecast LimitscreateLaborForecastLimitsPOSTThis operation creates one or more labor forecast limits with effective versions.
Create Labor Forecast Limits (Deprecated)createLaborForecastLimitsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/labor forecast limits/multi create.
Delete Labor Forecast Limit by IDdeleteLaborForecastLimitByIDDELETEThis operation deletes a labor forecast limit with effective versions by ID.
Delete Labor Forecast Limit by ID (Deprecated)deleteLaborForecastLimitByIDDeprecatedDELETEThis operation is deprecated; instead use DELETE /v2/forecasting/labor forecast limits/{id}.
Delete Labor Forecast Limit Effective VersiondeleteLaborForecastLimitEffectiveVersionPOSTThis operation deletes a labor forecast limit effective version by ID and effective date.
Delete Labor Forecast LimitsdeleteLaborForecastLimitsPOSTThis operation deletes one or more labor forecast limits with effective versions.
Delete Labor Forecast Limits (Deprecated)deleteLaborForecastLimitsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/labor forecast limits/multi delete.
Retrieve Labor Forecast Limit by IDretrieveLaborForecastLimitByIDGETThis operation returns a labor forecast limit with effective versions by ID.
Retrieve Labor Forecast Limit by ID (Deprecated)retrieveLaborForecastLimitByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/labor forecast limits/{id}.
Retrieve Labor Forecast Limit by NameretrieveLaborForecastLimitByNameGETThis operation returns a labor forecast limit with effective versions by name.
Retrieve Labor Forecast Limit by Name (Deprecated)retrieveLaborForecastLimitByNameDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/labor forecast limits.
Retrieve Labor Forecast Limits (Deprecated)retrieveLaborForecastLimitsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/labor forecast limits/apply read.
Retrieve Labor Forecast Limits by CriteriaretrieveLaborForecastLimitsByCriteriaPOSTThis operation returns labor forecast limits by search criteria.
Update Labor Forecast Limit by IDupdateLaborForecastLimitByIDPUTThis operation updates a labor forecast limit with effective versions by ID.
Update Labor Forecast Limit by ID (Deprecated)updateLaborForecastLimitByIDDeprecatedPUTThis operation is deprecated; instead use PUT /v2/forecasting/labor forecast limits/{id}.
Update Labor Forecast LimitsupdateLaborForecastLimitsPOSTThis operation updates labor forecast limits with effective versions.
Update Labor Forecast Limits (Deprecated)updateLaborForecastLimitsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/labor forecast limits/multi update.
Labor Period Overrides4
Create or Update Labor Period OverridescreateOrUpdateLaborPeriodOverridesPOSTThis operation creates or updates one or more labor period overrides.
Delete Labor Period OverridesdeleteLaborPeriodOverridesPOSTThis operation deletes one or more labor period overrides.
Retrieve Labor Period OverridesretrieveLaborPeriodOverridesPOSTThis operation returns one or more labor period overrides.
Retrieve Overridable Tasks by DepartmentretrieveOverridableTasksByDepartmentPOSTThis operation returns one or more tasks by department.
Labor Standards10
Create Labor StandardcreateLaborStandardPOSTThis operation creates a labor standard.
Create Labor StandardscreateLaborStandardsPOSTThis operation creates one or more Labor Standards.
Delete Labor Standard by IDdeleteLaborStandardByIDDELETEThis operation deletes a Labor Standard by ID.
Delete Labor StandardsdeleteLaborStandardsPOSTThis operation deletes one or more Labor Standards.
Retrieve All Labor Standards or by Specification (Deprecated)retrieveAllLaborStandardsOrBySpecificationDeprecatedGETThis operation is deprecated; instead use POST /v1/forecasting/labor standards/multi read.
Retrieve Labor Driver Adjustment OperationsretrieveLaborDriverAdjustmentOperationsGETThis operation returns all labor driver adjustment operations.
Retrieve Labor Standard by IDretrieveLaborStandardByIDGETThis operation returns a labor standard by ID.
Retrieve Labor StandardsretrieveLaborStandardsPOSTThis operation returns labor standards according to the specified object references and generic department or returns all labor standards associated with a generic department if only a...
Update Labor StandardupdateLaborStandardPOSTThis operation updates a labor standard.
Update Labor StandardsupdateLaborStandardsPOSTThis operation updates one or more Labor Standards.
Labor Standards, Tasks, and Task Groups4
Import Labor Standards, Tasks, and Task GroupsimportLaborStandardsTasksAndTaskGroupsPOSTThis operation imports multiple labor standards specific to a single store, generic department, and generic job, associates the imported labor standards with automatically-created...
Import Labor Standards, Tasks, and Task Groups (Deprecated)importLaborStandardsTasksAndTaskGroupsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/labor standard tasks/import.
Purge Labor StandardspurgeLaborStandardsPOSTThis operation purges a batch of outdated labor standard versions.
Purge Labor Standards (Deprecated)purgeLaborStandardsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/labor standard tasks/purge.
Labor Tasks19
Create Labor TaskcreateLaborTaskPOSTThis operation creates a labor task.
Create Labor Task (Deprecated)createLaborTaskDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/tasks.
Create Labor TaskscreateLaborTasksPOSTThis operation creates one or more labor tasks.
Create Labor Tasks (Deprecated)createLaborTasksDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/tasks/multi create.
Delete Labor Task by IDdeleteLaborTaskByIDDELETEThis operation deletes a labor task by ID.
Delete Labor Task by ID (Deprecated)deleteLaborTaskByIDDeprecatedDELETEThis operation is deprecated; instead use DELETE /v2/forecasting/tasks/{id}.
Delete Labor Task Effective Version by CriteriadeleteLaborTaskEffectiveVersionByCriteriaPOSTThis operation deletes a labor task effective version by ID and effective date and returns the labor task along with the remaining effective versions.
Delete Labor TasksdeleteLaborTasksPOSTThis operation deletes labor tasks.
Delete Labor Tasks (Deprecated)deleteLaborTasksDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/tasks/multi delete.
Retrieve All Labor Tasks or by Specification (Deprecated)retrieveAllLaborTasksOrBySpecificationDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/tasks.
Retrieve Labor Task by IDretrieveLaborTaskByIDGETThis operation returns a labor task by ID.
Retrieve Labor Task by ID (Deprecated)retrieveLaborTaskByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/tasks/{id}.
Retrieve Labor TasksretrieveLaborTasksPOSTThis operation returns Labor Tasks according to the specified object references and generic department.
Retrieve Labor Tasks (Deprecated)retrieveLaborTasksDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/tasks/multi read.
Retrieve Labor Tasks by Name and DepartmentretrieveLaborTasksByNameAndDepartmentGETThis operation returns a labor task by name and generic department or returns all labor tasks associated with a generic department if only a generic department is passed.
Update Labor Task by IDupdateLaborTaskByIDPUTThis operation updates a labor task object by ID.
Update Labor Task by ID (Deprecated)updateLaborTaskByIDDeprecatedPUTThis operation is deprecated; instead use PUT /v2/forecasting/tasks/{id}.
Update Labor TasksupdateLaborTasksPOSTThis operation updates one or more labor tasks.
Update Labor Tasks (Deprecated)updateLaborTasksDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/tasks/multi update.
Labor Type Agency Recalculation2
Recalculate Agency AsynchronouslyrecalculateAgencyAsynchronouslyPOSTThis operation performs agency recalculation asynchronously according to the specified date range.
Retrieve Agency Recalculation Asynchronous Request Status by Execution KeyretrieveAgencyRecalculationAsynchronousRequestStatusByExecutionKeyGETThis operation returns the status of an asynchronous agency employee recalc request by execution key.
Leave Administrator Assignment7
Delete Leave AdmindeleteLeaveAdminDELETEThis operation deletes the assignment of an administrator to a Leave employee.
Delete Leave Admin for Multiple EmployeesdeleteLeaveAdminForMultipleEmployeesPOSTThis operation deletes the assignment of an administrator to one or more Leave employees.
Retrieve Leave Admin by Person IDretrieveLeaveAdminByPersonIDGETThis operation returns the administrator assigned to a Leave employee by person ID.
Retrieve Leave Admin by Person NumberretrieveLeaveAdminByPersonNumberGETThis operation returns the administrator assigned to a Leave employee by person number.
Retrieve Leave Admin for Multiple EmployeesretrieveLeaveAdminForMultipleEmployeesPOSTThis operation returns the administrators assigned to one or more Leave employees.
Update Leave AdminupdateLeaveAdminPUTThis operation updates the assignment of an administrator to a Leave employee.
Update Leave Admin for Multiple EmployeesupdateLeaveAdminForMultipleEmployeesPOSTThis operation updates the assignment of an administrator to one or more Leave employees.
Leave Audit Records1
Retrieve Leave Audit RecordsretrieveLeaveAuditRecordsPOSTThis operation returns auditing records for the specified auditing entities and employees within a date range.
Leave Case Certifications2
Create Leave Case CertificationcreateLeaveCaseCertificationPOSTThis operation creates and returns a certification for a Leave case, including frequency and duration.
Retrieve Leave Case Certification HistoryretrieveLeaveCaseCertificationHistoryGETThis operation returns the certification history of a Leave case, including frequency and duration.
Leave Case Custom Fields2
Retrieve Custom FieldsretrieveCustomFieldsGETThis operation returns custom fields associated to a Leave case.
Update Custom FieldsupdateCustomFieldsPOSTThis operation updates custom fields associated with a Leave case.
Leave Case Defaults3
Retrieve Leave Case DefaultsretrieveLeaveCaseDefaultsGETThis operation returns details about Leave case defaults by ID.
Retrieve Leave Case Defaults by IDretrieveLeaveCaseDefaultsByIDGETThis operation returns details about Leave case defaults by ID.
Update Leave Case DefaultsupdateLeaveCaseDefaultsPUTThis operation updates Leave case defaults and returns the updated Leave case defaults.
Leave Case Documents3
Generate DocumentsgenerateDocumentsPOSTThis operation generates documents for a Leave case.
Retrieve DocumentsretrieveDocumentsGETThis operation returns generated documents for a Leave case.
Update DocumentsupdateDocumentsPOSTThis operation updates attributes of a document associated with a Leave case.
Leave Case Eligibility Requirements2
Retrieve Eligibility RequirementsretrieveEligibilityRequirementsGETThis operation returns eligibility requirements associated with a Leave case.
Update Eligibility RequirementsupdateEligibilityRequirementsPOSTThis operation updates eligibility answers, recalculates qualifiers, or bypasses eligibility for a Leave case.
Leave Case Notes5
Create Leave Case NotecreateLeaveCaseNotePOSTThis operation creates and returns a Note for a Leave case.
Delete Leave Case Note by IDdeleteLeaveCaseNoteByIDDELETEThis operation deletes a Note associated with a Leave case by ID.
Retrieve Leave Case Note by IDretrieveLeaveCaseNoteByIDGETThis operation returns a Note associated with a Leave case by ID.
Retrieve Leave Case NotesretrieveLeaveCaseNotesGETThis operation returns a list of Notes associated with a Leave case.
Update Leave Case Note by IDupdateLeaveCaseNoteByIDPOSTThis operation updates a Note associated with a Leave case by ID.
Leave Case Notifications8
Activate Leave Case Notification by IDactivateLeaveCaseNotificationByIDPOSTThis operation activates a notification associated with a Leave case by ID.
Copy Leave Case Notification by IDcopyLeaveCaseNotificationByIDPOSTThis operation creates a copy of an existing Leave case notification by ID.
Create Leave Case NotificationcreateLeaveCaseNotificationPOSTThis operation creates a notification for a Leave case.
Deactivate Leave Case Notification by IDdeactivateLeaveCaseNotificationByIDPOSTThis operation deactivates a notification associated with a Leave case by ID.
Delete Leave Case Notification by IDdeleteLeaveCaseNotificationByIDDELETEThis operation deletes a notification associated with a Leave case by ID.
Retrieve Leave Case Notification by IDretrieveLeaveCaseNotificationByIDGETThis operation returns a notification associated with a Leave case by ID.
Retrieve Leave Case NotificationsretrieveLeaveCaseNotificationsGETThis operation returns a sorted list of notifications associated with a Leave case.
Update Leave Case Notification by IDupdateLeaveCaseNotificationByIDPOSTThis operation updates a notification associated with a Leave case by ID.
Leave Case Rules5
Create Rule AssignmentcreateRuleAssignmentPOSTThis operation creates and returns a rule assignment for a Leave case.
Delete Rule AssignmentdeleteRuleAssignmentDELETEThis operation deletes a rule assignment for a Leave case.
Retrieve Rule AssignmentretrieveRuleAssignmentGETThis operation returns a rule assignment for a Leave case rule.
Retrieve Rule AssignmentsretrieveRuleAssignmentsGETThis operation returns rule assignments for a Leave case.
Update Rule AssignmentupdateRuleAssignmentPOSTThis operation updates a rule assignment for a Leave case.
Leave Case Statuses2
Retrieve Leave Case StatusesretrieveLeaveCaseStatusesGETThis operation returns a list of Leave case statuses currently supported by the system.
Retrieve Leave Case Statuses (Deprecated)retrieveLeaveCaseStatusesDeprecatedGETThis operation is deprecated; instead use GET /v2/leave/case statuses.
Leave Cases11
Create Leave CasecreateLeaveCasePOSTThis operation creates a new Leave case according to the data provided.
Create Multiple Leave CasescreateMultipleLeaveCasesPOSTThis operation creates one or more Leave cases.
Delete Leave CasedeleteLeaveCaseDELETEThis operation deletes a Leave case.
Execute Grant LeaveexecuteGrantLeavePOSTThis operation processes a grant leave request and produces an accrual balance reset based on the Leave configuration.
Retrieve Grant DataretrieveGrantDataGETThis operation returns on-demand grant configuration data, qualifiers, information about the last grant, calculated grant amount, and unit average for a Leave case.
Retrieve Leave Case DetailsretrieveLeaveCaseDetailsGETThis operation returns details about a Leave case.
Retrieve Leave Case Details by IDretrieveLeaveCaseDetailsByIDGETThis operation returns details about a Leave case based on an identifier.
Retrieve Leave CasesretrieveLeaveCasesPOSTThis operation returns Leave cases by IDs or for a list of employees within a date range.
Retrieve Total Taking AmountretrieveTotalTakingAmountGETThis operation returns the total number of hours taken against the accrual code from the specified Leave type for the tracking period.
Update Leave CaseupdateLeaveCasePUTThis operation updates a Leave case and returns the updated Leave case.
Update Leave Types for Leave CaseupdateLeaveTypesForLeaveCasePUTThis operation updates leave types for leave case based on Leave Setup configuration.
Leave Categories3
Retrieve All Leave Categories or by NameretrieveAllLeaveCategoriesOrByNameGETThis operation returns a list of all Leave categories or returns a single Leave category by name.
Retrieve Leave CategoriesretrieveLeaveCategoriesPOSTThis operation returns a list of Leave categories by object references.
Retrieve Leave Category by IDretrieveLeaveCategoryByIDGETThis operation returns a Leave category by ID.
Leave Custom Fields1
Retrieve Leave Custom Fields by TyperetrieveLeaveCustomFieldsByTypeGETThis operation returns a list of Leave custom fields by type.
Leave Edits3
Create Leave EditscreateLeaveEditsPOSTThis operation creates Leave edits according to the provided data.
Delete Leave EditsdeleteLeaveEditsPOSTThis operation deletes Leave edits for a Leave case according to IDs, dates, or starting from a date.
Retrieve Leave EditsretrieveLeaveEditsPOSTThis operation returns Leave edits along with their total paid and tracking amounts according to a list of employees and a date range.
Leave Edits for Scheduling7
Create Leave EditcreateLeaveEditPOSTThis operation creates a leave edit according to the specified leave edit data.
Create Scheduling Leave Edits with OptionscreateSchedulingLeaveEditsWithOptionsPOSTThis operation creates one or more leave edits and allows the following to be specified: bypass accruals warning and shiftOverrideType.
Delete Leave Edit by IDdeleteLeaveEditByIDDELETEThis operation deletes a leave edit by ID.
Delete Scheduling Leave EditsdeleteSchedulingLeaveEditsPOSTThis operation deletes one or more leave edits.
Retrieve Scheduling Leave Edit by IDretrieveSchedulingLeaveEditByIDGETThis operation returns a leave edit by ID.
Update Scheduling Leave Edit by IDupdateSchedulingLeaveEditByIDPOSTThis operation updates a leave edit by ID and according to the specified leave edit data.
Update Scheduling Leave Edit with Bypass for Accrual WarningsupdateSchedulingLeaveEditWithBypassForAccrualWarningsPOSTThis operation updates a leave edit with bypass for accrual warnings by allowing the following to be altered: bypassAccrualWarning.
Leave Events1
Retrieve Leave EventsretrieveLeaveEventsPOSTThis operation returns Leave events.
Leave Profile Assignments7
Delete Leave Profile AssignmentdeleteLeaveProfileAssignmentDELETEThis operation deletes the assignment of a Leave profile to an employee.
Delete Leave Profile AssignmentsdeleteLeaveProfileAssignmentsPOSTThis operation deletes the assignment of a Leave profile to one or more employees.
Retrieve Leave Profile Assignment by Person IDretrieveLeaveProfileAssignmentByPersonIDGETThis operation returns the Leave profile assigned to an employee by person ID.
Retrieve Leave Profile Assignment by Person NumberretrieveLeaveProfileAssignmentByPersonNumberGETThis operation returns the Leave profile assigned to an employee by person number.
Retrieve Leave Profile AssignmentsretrieveLeaveProfileAssignmentsPOSTThis operation returns the Leave profiles assigned to one or more employees.
Update Leave Profile AssignmentupdateLeaveProfileAssignmentPUTThis operation updates the assignment of a Leave profile to an employee.
Update Leave Profile AssignmentsupdateLeaveProfileAssignmentsPOSTThis operation updates the assignment of a Leave profile to one or more employees.
Leave Profiles2
Retrieve All Leave ProfilesretrieveAllLeaveProfilesGETThis operation returns a list of all Leave Profiles.
Retrieve Leave Profile by IDretrieveLeaveProfileByIDGETThis operation returns a Leave Profile by ID.
Leave Reasons3
Retrieve All Leave Reasons or by NameretrieveAllLeaveReasonsOrByNameGETThis operation returns a list of all Leave reasons or returns a single Leave reason by name.
Retrieve Leave Reason by IDretrieveLeaveReasonByIDGETThis operation returns a Leave reason by ID.
Retrieve Leave ReasonsretrieveLeaveReasonsPOSTThis operation returns a list of Leave reasons by object references.
Leave Request Configuration2
Retrieve Leave Request ConfigurationretrieveLeaveRequestConfigurationGETThis operation returns configuration data for a Leave request based on employee, Leave case category, and reason.
Retrieve Leave Request SubtypesretrieveLeaveRequestSubtypesGETThis operation returns subtypes for an employee's Leave request.
Leave Requests5
Create Leave Case RequestscreateLeaveCaseRequestsPOSTThis operation creates one or more Leave case requests.
Create Leave RequestcreateLeaveRequestPOSTThis operation creates a Leave case request.
Process Leave Request by IDprocessLeaveRequestByIDPOSTThis operation processes an existing Leave case request by ID according to a specified action.
Process Leave RequestsprocessLeaveRequestsPOSTThis operation processes one or more existing Leave case requests by ID according to the specified actions.
Retrieve Leave Case RequestsretrieveLeaveCaseRequestsPOSTThis operation returns one or more Leave case requests according to a list of IDs.
Leave Rules1
Retrieve Available RulesretrieveAvailableRulesGETThis operation returns a list of available rules for a Leave case.
Linked Categories5
Create Linked CategoriescreateLinkedCategoriesPOSTThis operation creates linked categories.
Delete Linked CategoriesdeleteLinkedCategoriesPOSTThis operation deletes linked categories.
Retrieve All Linked Categories or by SpecificationretrieveAllLinkedCategoriesOrBySpecificationGETThis operation returns linked categories by category ID, category qualifier, and effective date.
Retrieve Linked CategoriesretrieveLinkedCategoriesPOSTThis operation returns linked categories.
Update Linked CategoriesupdateLinkedCategoriesPOSTThis operation updates linked categories.
Linked Category Action Types1
Retrieve Linked Category Action TypesretrieveLinkedCategoryActionTypesGETThis operation returns all Linked Category Action Types.
Locale Policies10
Create Locale PoliciescreateLocalePoliciesPOSTThis operation creates new locale policies.
Create Locale PolicycreateLocalePolicyPOSTThis operation creates a locale policy.
Delete Locale PoliciesdeleteLocalePoliciesPOSTThis operation deletes a list of locale policies.
Delete Locale Policy by IDdeleteLocalePolicyByIDDELETEThis operation deletes a locale policy by ID.
Retrieve Locale PolicyretrieveLocalePolicyGETThis operation returns a locale policy by name, display name, or sdmKey.
Retrieve Locale Policy by IDretrieveLocalePolicyByIDGETThis operation returns a locale policy by ID.
Retrieve LocalesretrieveLocalesPOSTThis operation returns locales according to the provided request.
Set Default Locale PolicysetDefaultLocalePolicyPOSTThis operation sets the locale policy as default for a tenant.
Update Locale PoliciesupdateLocalePoliciesPOSTThis operation updates a list of locale policies.
Update Locale Policy by IDupdateLocalePolicyByIDPOSTThis operation updates a locale policy by ID.
Location Attribute Assignments1
Retrieve Location Attribute ValueretrieveLocationAttributeValuePOSTThis operation returns a location attribute value.
Location Attribute Start Day Of Week1
Retrieve a Location Attribute Week SpanretrieveALocationAttributeWeekSpanPOSTThis operation returns a location attribute week span.
Location Attributes8
Create Location AttributecreateLocationAttributePOSTThis operation creates a location attribute.
Create or Update Location AttributescreateOrUpdateLocationAttributesPOSTThis operation creates or updates one or more location attributes.
Delete Location Attribute by IDdeleteLocationAttributeByIDDELETEThis operation deletes a location attribute by ID.
Delete Location AttributesdeleteLocationAttributesPOSTThis operation deletes one or more location attributes.
Retrieve Location Attribute by CriteriaretrieveLocationAttributeByCriteriaGETThis operation returns a location attribute by ID, qualifier, and effective date.
Retrieve Location Attribute by IDretrieveLocationAttributeByIDGETThis operation returns a location attribute by ID.
Retrieve Location AttributesretrieveLocationAttributesPOSTThis operation returns one or more location attributes by object references.
Update Location Attribute by IDupdateLocationAttributeByIDPUTThis operation updates a location attribute by ID.
Location Profiles Option Sets5
Retrieve All Location Profiles Option Sets or by NameretrieveAllLocationProfilesOptionSetsOrByNameGETThis operation returns a list of all location profiles option sets or a single set by name.
Retrieve Location Profile Option Set AssignmentretrieveLocationProfileOptionSetAssignmentGETThis operation returns a location profiles option set assignment by org node ID or PATH.
Retrieve Location Profiles Option Set AssignmentsretrieveLocationProfilesOptionSetAssignmentsPOSTThis operation returns a collection of location profiles option setassignments by org node references.
Retrieve Location Profiles Option Set by IDretrieveLocationProfilesOptionSetByIDGETThis operation returns a location profiles option set by ID.
Retrieve Location Profiles Option SetsretrieveLocationProfilesOptionSetsPOSTThis operation returns a collection of location profiles option sets by object references, or a collection of all location profiles option sets if no references are passed.
Location Sets10
Create Location SetcreateLocationSetPOSTThis operation creates an Organizational Map group (location set).
Create or Update Location SetcreateOrUpdateLocationSetPOSTThis operation creates or updates a location set.
Delete Location Set by IDdeleteLocationSetByIDDELETEThis operation deletes an Organizational Map group (location set) by its ID.
Delete Location SetsdeleteLocationSetsPOSTThis operation deletes one or more location sets.
Retrieve Location Set by IDretrieveLocationSetByIDGETThis operation returns an Organizational Map group (location set) by ID.
Retrieve Location Set by NameretrieveLocationSetByNameGETThis operation returns an Organizational Map group (location set) by name and system.
Retrieve Location SetsretrieveLocationSetsGETThis operation retrieves Organizational Map groups (location sets) based on query parameters.
Retrieve Location Sets by List (Deprecated)retrieveLocationSetsByListDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/location sets/multi read.
Retrieve Paginated List of Location SetsretrievePaginatedListOfLocationSetsPOSTThis operation returns a paginated list of Organizational Map groups (location sets) according to an array of group identifiers or a query on group names.
Update Location Set by IDupdateLocationSetByIDPOSTThis operation updates an existing Organizational Map group (location set) by group ID.
Location Types11
Create Location TypecreateLocationTypePOSTThis operation creates a location type according to the provided data.
Delete Location TypedeleteLocationTypeDELETEThis operation deletes a location type according to the provided data.
Delete Location Type by IDdeleteLocationTypeByIDDELETEThis operation deletes a location type by ID and according to the provided data.
Retrieve Location Type by External IDretrieveLocationTypeByExternalIDGETThis operation returns location (node) type information by external ID and date.
Retrieve Location Type by IDretrieveLocationTypeByIDGETThis operation returns location (node) type information by ID and date.
Retrieve Location Types by ContextretrieveLocationTypesByContextPOSTThis operation returns location (node) types by context and date.
Retrieve Location Types by External IDsretrieveLocationTypesByExternalIDsPOSTThis operation returns location (node) types by external IDs and date.
Retrieve Location Types by LocationretrieveLocationTypesByLocationPOSTThis operation returns location (node) types by location.
Retrieve Location Types by NameretrieveLocationTypesByNameGETThis operation returns location (node) types by name and date.
Retrieve Location Types by Persistent IDsretrieveLocationTypesByPersistentIDsPOSTThis operation returns location (node) types by persistent IDs and date.
Update Location Type by IDupdateLocationTypeByIDPOSTThis operation updates a location type by ID and according to the provided data.
Locations18
Copy LocationcopyLocationPOSTThis operation copies an Organizational Map location and its descendants.
Create Location NodecreateLocationNodePOSTThis operation creates an Organizational Map location node.
Create LocationscreateLocationsPOSTThis operation creates Organizational Map locations.
Create Locations AsynchronouslycreateLocationsAsynchronouslyPOSTThis operation creates Organizational Map locations asynchronously.
Delete LocationsdeleteLocationsPOSTThis operation deletes Organizational Map locations.
Move LocationmoveLocationPOSTThis operation moves an Organizational Map location and its descendants.
Move Locations AsynchronouslymoveLocationsAsynchronouslyPOSTThis operation moves Organizational Map locations asynchronously.
Retrieve Asynchronous Locations Request Status by IDretrieveAsynchronousLocationsRequestStatusByIDGETThis operation returns status of an asynchronous Create, Move, or Update Locations Asynchronously request by request ID.
Retrieve Location by External IDretrieveLocationByExternalIDGETThis operation returns a location by external ID and date.
Retrieve Location by IDretrieveLocationByIDGETThis operation returns Organizational Map location (node) information by ID.
Retrieve Location by PathretrieveLocationByPathGETThis operation returns Organizational Map location information by location (node) path and date.
Retrieve Location Mappings by Persistent IDsretrieveLocationMappingsByPersistentIDsPOSTThis operation returns mappings between nodeId and persistentId by persistent IDs.
Retrieve LocationsretrieveLocationsPOSTThis operation returns Organizational Map locations.
Retrieve Locations by External IDsretrieveLocationsByExternalIDsPOSTThis operation returns locations by external IDs and date.
Retrieve Paginated List of LocationsretrievePaginatedListOfLocationsPOSTThis operation returns a paginated list of Organizational Map locations according to the parameters specified in the descendantsOfDuring property.
Update Location by IDupdateLocationByIDPOSTThis operation updates an Organizational Map location.
Update LocationsupdateLocationsPOSTThis operation updates Organizational Map locations.
Update Locations AsynchronouslyupdateLocationsAsynchronouslyPOSTThis operation updates Organizational Map locations asynchronously.
Lost Time Events2
Retrieve All Lost Time EventsretrieveAllLostTimeEventsGETThis operation returns a list of all lost time events in the system.
Retrieve Lost Time Event by IDretrieveLostTimeEventByIDGETThis operation returns a lost time event by ID.
Machine Learning Model Features2
Retrieve All Machine Learning Model Features or by NameretrieveAllMachineLearningModelFeaturesOrByNameGETThis operation returns all machine Learning model features if no parameter is specified or a particular feature if name is provided.
Retrieve Machine Learning Model Feature by IDretrieveMachineLearningModelFeatureByIDGETThis operation returns a machine learning model feature by ID along with its localized name.
Machine Learning Models10
Create Machine Learning ModelcreateMachineLearningModelPOSTThis operation creates a Machine Learning Model.
Create Machine Learning ModelscreateMachineLearningModelsPOSTThis operation creates Machine Learning Models.
Delete Machine Learning Model by IDdeleteMachineLearningModelByIDDELETEThis operation deletes a Machine Learning Model by ID.
Delete Machine Learning Model by NamedeleteMachineLearningModelByNameDELETEThis operation deletes a Machine Learning Model by name.
Delete Machine Learning ModelsdeleteMachineLearningModelsPOSTThis operation deletes Machine Learning Models according to the specified object references.
Retrieve All Machine Learning Models or by NameretrieveAllMachineLearningModelsOrByNameGETThis operation returns all Machine Learning Models if no parameter is specified or a particular Machine Learning Model if a name is provided.
Retrieve Machine Learning Model by IDretrieveMachineLearningModelByIDGETThis operation returns a Machine Learning Model by ID.
Retrieve Machine Learning ModelsretrieveMachineLearningModelsPOSTThis operation returns Machine Learning Models according to the specified object references.
Update Machine Learning Model by IDupdateMachineLearningModelByIDPUTThis operation updates a Machine Learning Model by ID.
Update Machine Learning ModelsupdateMachineLearningModelsPOSTThis operation updates Machine Learning Models.
Manager Announcements3
Create Announcement as ManagercreateAnnouncementAsManagerPOSTThis operation creates an announcement as a manager.
Retrieve Announcement Message Response by ID as ManagerretrieveAnnouncementMessageResponseByIDAsManagerGETThis operation returns an announcement message response by message ID.
Retrieve Announcement Messages as ManagerretrieveAnnouncementMessagesAsManagerPOSTThis operation returns a list of announcements and associated responses as a manager.
Manager Availability Pattern Requests2
Retrieve Availability Pattern Requests as ManagerretrieveAvailabilityPatternRequestsAsManagerPOSTThis operation returns all availability pattern requests for the given criteria.
Update Availability Pattern Request State as ManagerupdateAvailabilityPatternRequestStateAsManagerPOSTThis operation updates the state of an availability pattern request by transitioning the request from one state to another.
Manager Availability Requests2
Retrieve Availability Requests as ManagerretrieveAvailabilityRequestsAsManagerPOSTThis operation returns all availability requests for the given criteria.
Update Availability Request State as ManagerupdateAvailabilityRequestStateAsManagerPOSTThis operation updates the state of an availability request by transitioning the request from one state to another.
Manager Cover Requests4
Retrieve Rule Violations for Shift Cover RequestretrieveRuleViolationsForShiftCoverRequestGETThis operation returns a list of rule violations related to a shift cover request.
Retrieve Shift Cover Request by ID as ManagerretrieveShiftCoverRequestByIDAsManagerGETThis operation returns a shift cover request by ID.
Retrieve Shift Cover Requests as ManagerretrieveShiftCoverRequestsAsManagerPOSTThis operation returns one or more shift cover requests matching specified search criteria corresponding to a set of cover request IDs, managers, or current state.
Update Shift Cover Request as ManagerupdateShiftCoverRequestAsManagerPOSTThis operation updates the state of a shift cover request by transitioning the request from one state to another.
Manager Open Shift Requests4
Retrieve Open Shift Request by IDretrieveOpenShiftRequestByIDGETReturns an open shift request.
Retrieve Open Shift Requests as ManagerretrieveOpenShiftRequestsAsManagerPOSTThis operation returns one or more open shift requests by request IDs, employee IDs, or current state.
Retrieve Similar Open Shift Requests by IDretrieveSimilarOpenShiftRequestsByIDGETReturns similar open shift requests.
Update Open Shift RequestupdateOpenShiftRequestPOSTThis operation updates an open shift request.
Manager Role Assignments5
Create, Update, or Delete Manager Role AssignmentscreateUpdateOrDeleteManagerRoleAssignmentsPOSTThis operation creates, updates, or deletes one or more manager role assignments.
Retrieve Manager Role AssignmentsretrieveManagerRoleAssignmentsPOSTThis operation returns one or more manager role assignments by object references.
Retrieve Manager Role Assignments by IDretrieveManagerRoleAssignmentsByIDGETThis operation returns a person's manager role assignments by person ID.
Retrieve Manager Role Assignments by Person NumberretrieveManagerRoleAssignmentsByPersonNumberGETThis operation returns a person's manager role assignments by person number.
Update Manager Role AssignmentsupdateManagerRoleAssignmentsPOSTThis operation updates one or more manager role assignments.
Manager Schedule Actions4
Post or Unpost SchedulepostOrUnpostSchedulePOSTThis operation posts or unposts scheduling periods, shifts, or paycode edits.
Retrieve Posted Schedule with CriterionretrievePostedScheduleWithCriterionPOSTThis operation returns posted schedule records for the specified posting periods.
Send Combined Schedule NotificationssendCombinedScheduleNotificationsPOSTThis operation posts or unposts scheduling period combined notifications.
Send Schedule Change NotificationssendScheduleChangeNotificationsPOSTThis operation sends shift, paycode edit, schedule tag, and leave edit schedule change notifications.
Manager Schedules6
Retrieve Employee Schedule ChangesretrieveEmployeeScheduleChangesPOSTThis operation returns schedule changes pertaining to a collection of employees that occurred within a specified date and time range.
Retrieve Employee Schedule StatusesretrieveEmployeeScheduleStatusesPOSTThis operation returns one or more schedule statuses pertaining to a collection of employees within a specified date range.
Retrieve ScheduleretrieveSchedulePOSTThis operation returns a schedule pertaining to a set of employees or locations within a specified date range.
Retrieve Schedule with CriterionretrieveScheduleWithCriterionGETThis operation returns a schedule pertaining to one employee, Hyperfind, or location.
Update ScheduleupdateSchedulePOSTThis operation performs a single update to a schedule pertaining to a shift, paycode edit, holiday, day lock, or schedule tag.
Update Schedule for Multiple EmployeesupdateScheduleForMultipleEmployeesPOSTThis operation performs multiple updates to an employee schedule (for one or more employees) pertaining to shifts, paycode edits, day locks, or schedule tags.
Manager Self-Schedule Requests1
Retrieve Self-Schedule Requests as ManagerretrieveSelfScheduleRequestsAsManagerPOSTThis operation returns one or more self-schedule requests by request IDs, employee IDs, or current state.
Manager Swap Requests4
Retrieve Rule Violations for Shift Swap RequestretrieveRuleViolationsForShiftSwapRequestPOSTThis operation returns a list of rule violations related to a shift swap request.
Retrieve Shift Swap Request by ID as ManagerretrieveShiftSwapRequestByIDAsManagerGETThis operation returns a shift swap request by ID.
Retrieve Shift Swap Requests as ManagerretrieveShiftSwapRequestsAsManagerPOSTThis operation returns one or more shift swap requests matching specified search criteria corresponding to a set of swap request IDs, managers, or current state.
Update Shift Swap Request as ManagerupdateShiftSwapRequestAsManagerPOSTThis operation updates the state of a shift swap request by transitioning the request from one state to another.
Manager Time Off Requests10
Create Time Off Request as ManagercreateTimeOffRequestAsManagerPOSTThis operation creates a time off request according to the specified parameters.
Create Time Off Request as Manager for Overridden ShiftscreateTimeOffRequestAsManagerForOverriddenShiftsPOSTThis operation creates a time off request according to the specified parameters.
Retrieve Accrual Balance as ManagerretrieveAccrualBalanceAsManagerGETThis operation returns an accrual balance.
Retrieve Request Period as ManagerretrieveRequestPeriodAsManagerGETThis operation returns a request period.
Retrieve Request Subtype as ManagerretrieveRequestSubtypeAsManagerGETThis operation returns a request subtype.
Retrieve Symbolic Value as ManagerretrieveSymbolicValueAsManagerGETThis operation returns a symbolic value.
Retrieve Time Off Request by ID as ManagerretrieveTimeOffRequestByIDAsManagerGETThis operation returns a time off request by ID.
Retrieve Time Off Requests as ManagerretrieveTimeOffRequestsAsManagerPOSTThis operation returns one or more time off requests matching specified search criteria, corresponding to a set of time off request IDs or employees.
Update Time Off Request as ManagerupdateTimeOffRequestAsManagerPOSTThis operation updates the state of a time off request by transitioning a time off request from one state to another.
Update Time Off Request by ID as ManagerupdateTimeOffRequestByIDAsManagerPUTThis operation updates a time off request according to the passed ID.
Manual Time Entry Workflows1
Retrieve Manual Time Entry WorkflowsretrieveManualTimeEntryWorkflowsPOSTThis operation returns a list of Manual Time Entry workflows to execute.
Mapping Categories4
Create Mapping CategorycreateMappingCategoryPOSTThis operation creates a mapping category.
Retrieve All Mapping CategoriesretrieveAllMappingCategoriesGETThis operation returns a list of all mapping categories based on the name of a mapping category definition, the ID and name of a domain function, the ID and name of a mapping category...
Retrieve Mapping Category by IDretrieveMappingCategoryByIDGETThis operation returns a mapping category by ID.
Update Mapping Category by IDupdateMappingCategoryByIDPUTThis operation updates a mapping category by ID.
Mapping Category Types2
Retrieve All Mapping Category Types or by NameretrieveAllMappingCategoryTypesOrByNameGETThis operation returns all mapping category types or a single mapping category type by name.
Retrieve Mapping Category Type by IDretrieveMappingCategoryTypeByIDGETThis operation returns a mapping category type by ID.
Markers3
Create or Update Ignore MarkerscreateOrUpdateIgnoreMarkersPOSTThis operation creates or updates Ignore History Markers or Ignore Timecard Markers for a list of employees.
Remove Ignore MarkersremoveIgnoreMarkersPOSTThis operation removes Ignore History Markers or Ignore Timecard Markers for a list of employees.
Retrieve MarkersretrieveMarkersPOSTThis operation returns history and Timecard data markers for a list of employees.
Menu Items1
Retrieve All Menu ItemsretrieveAllMenuItemsGETThis operation returns a list of all Menu Items available to the current user.
Messaging Notifications9
Delete Multiple NotificationsdeleteMultipleNotificationsPOSTThis operation deletes notifications asynchronously based on the list of message UUIDs provided.
Retrieve Bulk NotificationsretrieveBulkNotificationsPOSTThis operation returns a list of all new or reviewed notifications according to the access privileges of the logged-in user.
Retrieve Control Center ConfigurationretrieveControlCenterConfigurationGETThis operation returns the Control Center configuration for the logged-in user.
Retrieve Notification CountretrieveNotificationCountGETThis operation returns the category-based count along with the total count of new notifications for the logged-in user.
Retrieve Notification DetailsretrieveNotificationDetailsGETThis operation returns details about a particular notification based on the provided message UUID.
Retrieve NotificationsretrieveNotificationsGETThis operation returns a list of all new or reviewed notifications according to the access privileges of the logged-in user.
Retrieve Notifications by Item IDretrieveNotificationsByItemIDGETThis operation returns a list of notifications associated with the provided item ID, which is the reference ID of the entity associated with the notification.
Retrieve Notifications by Item IDsretrieveNotificationsByItemIDsPOSTThis operation returns a list of all new and reviewed notifications associated with the list of item IDs provided.
Review Notifications by IDreviewNotificationsByIDPOSTThis operation reviews and acknowledges notifications asynchronously based on the list of message UUIDs provided.
Messaging with Generic Notifications4
Retrieve Generic Notification by ID for MessagingretrieveGenericNotificationByIDForMessagingGETThis operation returns a generic notification according to the provided reference ID.
Retrieve Generic Notifications for MessagingretrieveGenericNotificationsForMessagingGETThis operation returns a list of all available generic notifications, including the corresponding generic notification if a specific name is provided.
Send Notification by Event TypesendNotificationByEventTypePOSTThis operation sends a generic notification according to the provided event type.
Send Notification by IDsendNotificationByIDPOSTThis operation sends a generic notification according to the provided reference ID of the generic notification.
Metrics for Scheduling1
Evaluate Metrics for SchedulingevaluateMetricsForSchedulingPOSTEvaluate Metrics for Scheduling
Minor Rule and School Calendar Assignments10
Retrieve Minor Rule and School Calendar AssignmentsretrieveMinorRuleAndSchoolCalendarAssignmentsPOSTThis operation returns the minor rule and school calendar assignments for one or more persons.
Retrieve Minor Rule and School Calendar Assignments (Deprecated)retrieveMinorRuleAndSchoolCalendarAssignmentsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/persons/minor rules/multi read.
Retrieve Minor Rule and School Calendar Assignments by IDretrieveMinorRuleAndSchoolCalendarAssignmentsByIDGETThis operation returns a person's minor rule and school calendar assignments by person ID.
Retrieve Minor Rule and School Calendar Assignments by ID (Deprecated)retrieveMinorRuleAndSchoolCalendarAssignmentsByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/persons/minor rules/{personId}.
Retrieve Minor Rule and School Calendar Assignments by Person NumberretrieveMinorRuleAndSchoolCalendarAssignmentsByPersonNumberGETThis operation returns a person's minor rule and school calendar assignments by person number.
Retrieve Minor Rule and School Calendar Assignments by Person Number (Deprecated)retrieveMinorRuleAndSchoolCalendarAssignmentsByPersonNumberDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/persons/minor rules.
Update Minor Rule and School Calendar AssignmentsupdateMinorRuleAndSchoolCalendarAssignmentsPOSTThis operation the minor rule and school calendar assignments for one or more persons.
Update Minor Rule and School Calendar Assignments (Deprecated)updateMinorRuleAndSchoolCalendarAssignmentsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/persons/minor rules/multi upsert.
Update Minor Rule and School Calendar Assignments by IDupdateMinorRuleAndSchoolCalendarAssignmentsByIDPUTThis operation updates a person's minor rule and school calendar assignments by ID.
Update Minor Rule and School Calendar Assignments by ID (Deprecated)updateMinorRuleAndSchoolCalendarAssignmentsByIDDeprecatedPUTThis operation is deprecated; instead use PUT /v2/commons/persons/minor rules/{person id}.
Minor Rule Sets3
Retrieve All Minor Rules or by NameretrieveAllMinorRulesOrByNameGETThis operation returns all minor rules if no parameter is specified or a particular minor rule if a name is provided.
Retrieve Minor Rule by IDretrieveMinorRuleByIDGETThis operation returns a minor rule by ID.
Retrieve Minor RulesretrieveMinorRulesPOSTThis operation returns one or more minor rules.
Notification Profiles4
Retrieve All Notification ProfilesretrieveAllNotificationProfilesGETThis operation returns a list of all Notification Profiles.
Retrieve Available Notification Profile by IDretrieveAvailableNotificationProfileByIDGETThis operation returns an available Notification Profile by ID.
Retrieve Notification Profile by IDretrieveNotificationProfileByIDGETThis operation returns a Notification Profile by ID.
Retrieve Notification ProfilesretrieveNotificationProfilesPOSTThis operation returns one or more notification profiles by IDs, Qualifiers or Refs.
Occurrence Definitions9
Create Occurrence DefinitioncreateOccurrenceDefinitionPOSTThis operation creates an occurrence definition.
Create Occurrence DefinitionscreateOccurrenceDefinitionsPOSTThis operation creates one or more occurrence definitions.
Delete Occurrence Definition by IDdeleteOccurrenceDefinitionByIDDELETEThis operation deletes an occurrence definition by ID.
Delete Occurrence DefinitionsdeleteOccurrenceDefinitionsPOSTThis operation deletes one or more occurrence definitions.
Retrieve All Occurrence Definitions or by NameretrieveAllOccurrenceDefinitionsOrByNameGETThis operation returns all occurrence definitions if no parameter is specified or a particular definition if a name is provided.
Retrieve Occurrence Definition by IDretrieveOccurrenceDefinitionByIDGETThis operation returns an occurrence definition by ID.
Retrieve Occurrence DefinitionsretrieveOccurrenceDefinitionsPOSTThis operation returns one or more occurrence definitions by object references or assignment contexts.
Update Occurrence Definition by IDupdateOccurrenceDefinitionByIDPUTThis operation updates an occurrence definition by ID.
Update Occurrence DefinitionsupdateOccurrenceDefinitionsPOSTThis operation updates one or more occurrence definitions.
OneView Employee Assignments4
Create or Update OneView AssignmentcreateOrUpdateOneViewAssignmentPOSTThis operation creates or updates a OneView employee assignment for a person.
Create or Update OneView AssignmentscreateOrUpdateOneViewAssignmentsPOSTThis operation creates or updates multiple OneView employee assignments in bulk.
Retrieve OneView AssignmentsretrieveOneViewAssignmentsPOSTThis operation retrieves one or more OneView employee assignments based on the specified criteria.
Retrieve OneView Assignments by Person Key or NumberretrieveOneViewAssignmentsByPersonKeyOrNumberGETThis operation returns OneView assignments for a person by person ID or person number.
Open Shifts1
Retrieve Calculated Open ShiftsretrieveCalculatedOpenShiftsPOSTThis operation produces an estimate of the hours and cost of multiple groupings of shifts.
Overtime Approvals1
Create Overtime ReviewscreateOvertimeReviewsPOSTThis operation creates overtime reviews according to the data provided.
Overtime Tax Deductions1
Retrieve Overtime Tax DeductionsretrieveOvertimeTaxDeductionsPOSTThis operation returns overtime tax deduction wages optionally rolled up for an employee.
Partial Shift Settings9
Create Multiple Partial Shift SettingscreateMultiplePartialShiftSettingsPOSTThis operation creates one or more sets of partial shift settings.
Create Partial Shift SettingscreatePartialShiftSettingsPOSTThis operation creates a set of partial shift settings.
Delete Multiple Partial Shift SettingsdeleteMultiplePartialShiftSettingsPOSTThis operation deletes one or more sets of partial shift settings.
Delete Partial Shift Settings by IDdeletePartialShiftSettingsByIDDELETEThis operation deletes a set of partial shift settings by ID.
Retrieve Multiple Partial Shift SettingsretrieveMultiplePartialShiftSettingsPOSTThis operation returns one or more sets of partial shift settings by object references.
Retrieve Partial Shift Settings by IDretrievePartialShiftSettingsByIDGETThis operation returns a set of partial shift settings by ID.
Retrieve Partial Shift Settings by NameretrievePartialShiftSettingsByNameGETThis operation returns a set of partial shift settings by name.
Update Multiple Partial Shift SettingsupdateMultiplePartialShiftSettingsPOSTThis operation updates one or more sets of partial shift settings.
Update Partial Shift Settings by IDupdatePartialShiftSettingsByIDPUTThis operation updates the state of a set of partial shift settings by ID.
Pattern Template Profile Assignments7
Delete Pattern Template Profile Assignment by Person IDdeletePatternTemplateProfileAssignmentByPersonIDDELETEThis operation deletes a pattern template profile assignment by person ID.
Delete Pattern Template Profile AssignmentsdeletePatternTemplateProfileAssignmentsPOSTThis operation deletes one or more pattern template profile assignments.
Retrieve Pattern Template Profile AssignmentsretrievePatternTemplateProfileAssignmentsPOSTThis operation returns one or more pattern template profile assignments by object references.
Retrieve Pattern Template Profile Assignments by Person IDretrievePatternTemplateProfileAssignmentsByPersonIDGETThis operation returns pattern template profile assignments by person ID.
Retrieve Pattern Template Profile Assignments by Person NumberretrievePatternTemplateProfileAssignmentsByPersonNumberGETThis operation returns pattern template profile assignments by person number.
Update Pattern Template Profile Assignment by Person IDupdatePatternTemplateProfileAssignmentByPersonIDPUTThis operation updates a pattern template profile assignment by person ID.
Update Pattern Template Profile AssignmentsupdatePatternTemplateProfileAssignmentsPOSTThis operation updates one or more pattern template profile assignments.
Pattern Template Profiles1
Retrieve All Pattern Template ProfilesretrieveAllPatternTemplateProfilesGETThis operation returns all pattern template profiles.
Pay Code Tags5
Create Pay Code TagcreatePayCodeTagPOSTThis operation creates a pay code tag.
Delete Pay Code Tag by IDdeletePayCodeTagByIDDELETEThis operation deletes a pay code tag by ID.
Retrieve All Pay Code TagsretrieveAllPayCodeTagsGETThis operation returns a list of all pay code tags.
Retrieve Pay Code Tag by IDretrievePayCodeTagByIDGETThis operation returns a pay code tag by ID.
Update Pay Code Tag by IDupdatePayCodeTagByIDPUTThis operation updates a pay code tag by ID.
Pay Period Timespans1
Retrieve Pay Period TimespansretrievePayPeriodTimespansGETThis resource returns a pay period timespan based on the pay period ID, pay rule ID, employee ID, date, and period type.
Paycode Data Access Profiles11
Add Paycodes to or Remove Paycodes from Paycode Data Access ProfilesaddPaycodesToOrRemovePaycodesFromPaycodeDataAccessProfilesPOSTThis operation adds paycodes to or remove paycodes from a list of Paycode Data Access Profiles.
Create or Update Paycode Data Access ProfilescreateOrUpdatePaycodeDataAccessProfilesPOSTThis operation creates or updates a list of Timekeeping Setup Paycode Data Access Profiles by object references.
Create Paycode Data Access ProfilescreatePaycodeDataAccessProfilesPOSTCreates one or more Paycode Data Access Profiles.
Delete Paycode Data Access Profile by IDdeletePaycodeDataAccessProfileByIDDELETEThis operation deletes a Timekeeping Setup Paycode Data Access Profile by ID.
Delete Paycode Data Access ProfilesdeletePaycodeDataAccessProfilesPOSTThis operation deletes a list of Timekeeping Setup Paycode Data Access Profiles by object references.
Retrieve All Paycode Data Access ProfilesretrieveAllPaycodeDataAccessProfilesGETThis operation returns a list of all Paycode Data Access Profiles.
Retrieve GDAP-filtered Paycode Data Access Profile by IDretrieveGDAPFilteredPaycodeDataAccessProfileByIDGETThis operation returns a Paycode Data Access Profile by ID and only includes GDAP-filtered available paycodes.
Retrieve Paycode Data Access Profile by IDretrievePaycodeDataAccessProfileByIDGETThis operation returns a Paycode Data Access Profile by ID.
Retrieve Paycode Data Access ProfilesretrievePaycodeDataAccessProfilesPOSTThis operation returns a list of Paycode Data Access Profiles by object references.
Retrieve Paycode Data Access Profiles by PaycodesretrievePaycodeDataAccessProfilesByPaycodesPOSTThis operation returns a list of Paycode Data Access Profiles by paycodes.
Update Paycode Data Access Profile by IDupdatePaycodeDataAccessProfileByIDPUTThis operation updates a Paycode Data Access Profile by ID.
Paycode Distributions10
Create or Update Paycode DistributionscreateOrUpdatePaycodeDistributionsPOSTThis operation creates or updates one or more paycode distributions.
Create Paycode DistributioncreatePaycodeDistributionPOSTThis operation creates a paycode distribution.
Create Paycode DistributionscreatePaycodeDistributionsPOSTThis operation creates one or more paycode distributions.
Delete Paycode Distribution by IDdeletePaycodeDistributionByIDDELETEThis operation deletes a paycode distribution by ID.
Delete Paycode DistributionsdeletePaycodeDistributionsPOSTThis operation deletes one or more paycode distributions by object references.
Retrieve All Paycode Distributions or by NameretrieveAllPaycodeDistributionsOrByNameGETThis operation returns a list of all paycode distributions or a single paycode distribution by name.
Retrieve Paycode Distribution by IDretrievePaycodeDistributionByIDGETThis operation returns a paycode distribution by ID.
Retrieve Paycode DistributionsretrievePaycodeDistributionsPOSTThis operation returns one or more paycode distributions by object references.
Update Paycode Distribution by IDupdatePaycodeDistributionByIDPUTThis operation updates a paycode distribution by ID.
Update Paycode DistributionsupdatePaycodeDistributionsPOSTThis operation updates one or more paycode distributions.
Paycode Edits for Scheduling11
Create Paycode EditscreatePaycodeEditsPOSTThis operation creates one or more paycode edits.
Create Paycode Edits with OptionscreatePaycodeEditsWithOptionsPOSTThis operation creates one or more paycode edits.
Create Paycode Edits with Options (Deprecated)createPaycodeEditsWithOptionsDeprecatedPOSTThis operation is deprecated and should not be used; instead use POST /v1/scheduling/schedule/pay code edits/apply import.
Create PCEcreatePCEPOSTThis operation creates a paycode edit according to the specified data.
Create PCE with OptionscreatePCEWithOptionsPOSTThis operation creates a paycode edit and allows the following to be specified: the number of days to which the paycode edit applies, create open shift, bypass accruals warning, and...
Delete Paycode Edits by IDdeletePaycodeEditsByIDPOSTThis operation deletes one or more paycode edits by ID.
Delete PCE by IDdeletePCEByIDDELETEThis operation deletes a paycode edit by ID.
Retrieve PCE by IDretrievePCEByIDGETThis operation returns a paycode edit by ID.
Update Paycode EditsupdatePaycodeEditsPOSTThis operation updates one or more paycode edits.
Update PCE by IDupdatePCEByIDPOSTThis operation updates a paycode edit by ID and according to the specified data.
Update PCE with Bypass for Accrual WarningsupdatePCEWithBypassForAccrualWarningsPOSTThis operation updates a paycode edit with bypass for accrual warnings by allowing the following to be altered: bypassAccrualWarning.
Paycode Value Profile Assignments14
Delete Paycode Value Profile Assignment by IDdeletePaycodeValueProfileAssignmentByIDDELETEThis operation deletes a person's paycode value profile assignment by person ID.
Delete Paycode Value Profile Assignment by ID (Deprecated)deletePaycodeValueProfileAssignmentByIDDeprecatedDELETEThis operation is deprecated; instead use DELETE /v2/commons/persons/pay code value profiles/{personId}.
Delete Paycode Value Profile AssignmentsdeletePaycodeValueProfileAssignmentsPOSTThis operation deletes paycode value profile assignments for one or more persons.
Delete Paycode Value Profile Assignments (Deprecated)deletePaycodeValueProfileAssignmentsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/persons/paycode value profiles/multi delete.
Retrieve All Paycode Value Profile Assignments (Deprecated)retrieveAllPaycodeValueProfileAssignmentsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/persons/paycode value profiles/multi read.
Retrieve Paycode Value Profile Assignment by IDretrievePaycodeValueProfileAssignmentByIDGETThis operation returns a person's paycode value profile assignment by person ID.
Retrieve Paycode Value Profile Assignment by ID (Deprecated)retrievePaycodeValueProfileAssignmentByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/persons/paycode value profiles/{personId}.
Retrieve Paycode Value Profile Assignment by Person NumberretrievePaycodeValueProfileAssignmentByPersonNumberGETThis operation returns a person's paycode value profile assignment by person number.
Retrieve Paycode Value Profile Assignment by Person Number (Deprecated)retrievePaycodeValueProfileAssignmentByPersonNumberDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/persons/paycode value profiles.
Retrieve Paycode Value Profile AssignmentsretrievePaycodeValueProfileAssignmentsPOSTThis operation returns paycode value profile assignments by object references.
Update Paycode Value Profile Assignment (Deprecated)updatePaycodeValueProfileAssignmentDeprecatedPUTThis operation is deprecated; instead use PUT /v2/commons/persons/pay code value profiles/{personId}.
Update Paycode Value Profile Assignment by IDupdatePaycodeValueProfileAssignmentByIDPUTThis operation updates one paycode value profile assignment for a person by ID.
Update Paycode Value Profile AssignmentsupdatePaycodeValueProfileAssignmentsPOSTThis operation updates paycode value profile assignments for one or more persons.
Update Paycode Value Profile Assignments (Deprecated)updatePaycodeValueProfileAssignmentsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/persons/paycode value profiles/multi read.
Paycode Value Profiles9
Create Paycode Value ProfilecreatePaycodeValueProfilePOSTThis operation creates a paycode value profile.
Create Paycode Value ProfilescreatePaycodeValueProfilesPOSTThis operation creates multiple paycode value profiles.
Delete Paycode Value Profile by IDdeletePaycodeValueProfileByIDDELETEThis operation deletes a paycode value profile by ID.
Delete Paycode Value ProfilesdeletePaycodeValueProfilesPOSTThis operation deletes one or more paycode value profiles.
Retrieve All Paycode Value ProfilesretrieveAllPaycodeValueProfilesPOSTThis operation returns all paycode value profiles.
Retrieve Paycode Value Profile by IDretrievePaycodeValueProfileByIDGETThis operation returns a paycode value profile by ID.
Retrieve Paycode Value Profile by NameretrievePaycodeValueProfileByNameGETThis operation returns a paycode value profile by name.
Update Paycode Value Profile by IDupdatePaycodeValueProfileByIDPUTThis operation updates a paycode value profile by ID.
Update Paycode Value ProfilesupdatePaycodeValueProfilesPOSTThis operation updates one or more paycode value profiles.
Paycodes for Timekeeping25
Create or Update PaycodescreateOrUpdatePaycodesPOSTThis operation creates or updates one or more paycodes.
Create PaycodecreatePaycodePOSTThis operation creates a paycode.
Create PaycodescreatePaycodesPOSTThis operation creates one or more paycodes.
Delete Paycode by IDdeletePaycodeByIDDELETEThis operation deletes a paycode by ID.
Delete PaycodesdeletePaycodesPOSTThis operation deletes one or more paycodes by object references.
Retrieve Full Paycode by ID as ManagerretrieveFullPaycodeByIDAsManagerGETThis operation returns a full paycode by ID.
Retrieve Full Paycodes as ManagerretrieveFullPaycodesAsManagerGETThis operation returns a list of full paycodes available to a manager.
Retrieve Paycode by ID as EmployeeretrievePaycodeByIDAsEmployeeGETThis operation returns a partial paycode by ID.
Retrieve Paycode by ID as Employee (Deprecated)retrievePaycodeByIDAsEmployeeDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/employee pay codes/{id}.
Retrieve Paycode by ID as ManagerretrievePaycodeByIDAsManagerGETThis operation returns a partial paycode by ID.
Retrieve Paycode Symbolic Value as Manager (Deprecated)retrievePaycodeSymbolicValueAsManagerDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/pay code symbolic values/{id}.
Retrieve Paycode Symbolic Value by ID as EmployeeretrievePaycodeSymbolicValueByIDAsEmployeeGETThis operation returns a paycode symbolic value by ID to an employee.
Retrieve Paycode Symbolic Value by ID as ManagerretrievePaycodeSymbolicValueByIDAsManagerGETThis operation returns a paycode symbolic value by ID to a manager.
Retrieve Paycode Symbolic Values as EmployeeretrievePaycodeSymbolicValuesAsEmployeeGETThis operation returns a list of paycode symbolic values available to an employee.
Retrieve Paycode Symbolic Values as Employee (Deprecated)retrievePaycodeSymbolicValuesAsEmployeeDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/employee pay code symbolic values.
Retrieve Paycode Symbolic Values as ManagerretrievePaycodeSymbolicValuesAsManagerGETThis operation returns a list of paycode symbolic values available to a manager.
Retrieve Paycode Symbolic Values as Manager (Deprecated)retrievePaycodeSymbolicValuesAsManagerDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/pay code symbolic values.
Retrieve Paycode Symbolic Values by ID as Employee (Deprecated)retrievePaycodeSymbolicValuesByIDAsEmployeeDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/employee pay code symbolic values/{id}.
Retrieve PaycodesretrievePaycodesPOSTThis operation returns one or more paycodes available to the logged-in manager by object references.
Retrieve Paycodes as EmployeeretrievePaycodesAsEmployeeGETThis operation returns a list of paycodes available to an employee.
Retrieve Paycodes as Employee (Deprecated)retrievePaycodesAsEmployeeDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/employee pay codes.
Retrieve Paycodes as ManagerretrievePaycodesAsManagerGETThis operation returns a list of paycodes available to a manager.
Retrieve Paycodes as Manager (Deprecated)retrievePaycodesAsManagerDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/pay codes.
Update Paycode by IDupdatePaycodeByIDPUTThis operation updates a paycode by ID.
Update PaycodesupdatePaycodesPOSTThis operation updates one or more paycodes by object references.
Payroll Data Enrichment1
Enrich Payroll DataenrichPayrollDataPOSTThis operation transforms raw payroll data into enriched payroll data.
Payroll Department to Work Unit Maps2
Create or Update Payroll Department to Work Unit MapscreateOrUpdatePayrollDepartmentToWorkUnitMapsPOSTThis operation creates or updates payroll department to work unit maps.
Retrieve Payroll Department to Work Unit MapsretrievePayrollDepartmentToWorkUnitMapsGETThis operation returns a filtered list of all payroll department to work unit maps.
Payroll Employment Status to Labor Type Maps2
Create or Update Payroll Employment Status to Labor Type MapscreateOrUpdatePayrollEmploymentStatusToLaborTypeMapsPOSTThis operation creates or updates payroll employment status to labor type maps.
Retrieve Payroll Employment Status to Labor Type MapsretrievePayrollEmploymentStatusToLaborTypeMapsGETThis operation returns a filtered list of all payroll employment status to labor type maps.
Payroll Export5
Export Payroll AsynchronouslyexportPayrollAsynchronouslyPOSTThis operation exports payroll asynchronously and returns an execution key.
Export Small Batch PayrollexportSmallBatchPayrollPOSTThis operation streams a small batch payroll response in CSV format.
Retrieve Payroll Export Asynchronous Request Status by KeyretrievePayrollExportAsynchronousRequestStatusByKeyGETThis operation returns the status of an asynchronous payroll export request by execution key.
Retrieve Payroll Export Asynchronous Response Payload by KeyretrievePayrollExportAsynchronousResponsePayloadByKeyGETThis operation streams the CSV response payload for an asynchronous operation by execution key.
Retrieve Summary of Asynchronous Payroll Export JobsretrieveSummaryOfAsynchronousPayrollExportJobsGETThis operation returns a summary of asynchronous payroll export jobs.
Payroll Job Maps2
Create or Update Payroll Job MapscreateOrUpdatePayrollJobMapsPOSTThis operation creates or updates payroll job maps.
Retrieve Payroll Job MapsretrievePayrollJobMapsGETThis operation returns a filtered list of all payroll job maps.
Payroll Staging3
Retrieve Asynchronous Payroll Staging Details by IDretrieveAsynchronousPayrollStagingDetailsByIDGETThis operation returns the details for an asynchronous payroll staging operation by ID.
Retrieve Payroll Staging Asynchronous Request Status by IDretrievePayrollStagingAsynchronousRequestStatusByIDGETThis operation returns the status of an asynchronous Stage Payroll request by request ID.
Stage Payroll AsynchronouslystagePayrollAsynchronouslyPOSTThis operation stages payroll asynchronously and returns a request ID.
Payroll Tables5
Create or Update Payroll TablecreateOrUpdatePayrollTablePOSTThis operation creates or updates a payroll table.
Create Payroll TablecreatePayrollTablePOSTThis operation creates a payroll table by uploading custom files and schemas.
Delete Payroll Table by NamedeletePayrollTableByNameDELETEThis operation deletes a payroll table by name.
Retrieve All Payroll TablesretrieveAllPayrollTablesGETThis operation returns reference information for all payroll tables in the system.
Retrieve Payroll Table by NameretrievePayrollTableByNameGETThis operation returns a payroll table by name.
Peak Hours1
Retrieve Peak HoursretrievePeakHoursPOSTThis operation calculates and returns Forecasting peak hours.
Pending Historical Corrections8
Compute Pending Historical CorrectionscomputePendingHistoricalCorrectionsPOSTThis operation computes historical corrections asynchronously.
Retrieve Asynchronous Computed Pending Historical Corrections by KeyretrieveAsynchronousComputedPendingHistoricalCorrectionsByKeyGETThis operation returns the results of an asynchronous compute operation by execution key.
Retrieve Asynchronous Saved Pending Historical Corrections by KeyretrieveAsynchronousSavedPendingHistoricalCorrectionsByKeyGETThis operation returns the results of an asynchronous save operation by execution key.
Retrieve Compute Pending Historical Corrections Asynchronous Request Status by KeyretrieveComputePendingHistoricalCorrectionsAsynchronousRequestStatusByKeyGETThis operation returns the status of an asynchronous Compute Pending Historical Corrections request by execution key.
Retrieve Save Pending Historical Corrections Asynchronous Request Status by KeyretrieveSavePendingHistoricalCorrectionsAsynchronousRequestStatusByKeyGETThis operation returns the status of an asynchronous Save Pending Historical Corrections request by execution key.
Retrieve Summary of Asynchronous Pending Historical Compute Corrections JobsretrieveSummaryOfAsynchronousPendingHistoricalComputeCorrectionsJobsGETThis operation returns a summary of asynchronous Pending Historical Compute Corrections jobs.
Retrieve Summary of Asynchronous Save Pending Historical Corrections JobsretrieveSummaryOfAsynchronousSavePendingHistoricalCorrectionsJobsGETThis operation returns a summary of asynchronous Save Pending Historical Corrections jobs.
Save Pending Historical CorrectionssavePendingHistoricalCorrectionsPOSTThis operation saves pending historical corrections asynchronously.
People Information Profiles3
Retrieve All People Information ProfilesretrieveAllPeopleInformationProfilesGETThis operation returns a list of People Information Profiles.
Retrieve People Information Profile by IDretrievePeopleInformationProfileByIDGETThis operation returns a People Information Profile by ID.
Retrieve People Information ProfilesretrievePeopleInformationProfilesPOSTThis operation returns a list of People Information Profiles by object references.
People Profiles3
Retrieve All People ProfilesretrieveAllPeopleProfilesGETThis operation returns all people profiles.
Retrieve People Profile by IDretrievePeopleProfileByIDGETThis operation returns a people profile by ID.
Retrieve People ProfilesretrievePeopleProfilesPOSTThis operation returns a list of people profiles by object references.
Percentage Allocation Rule Assignments10
Assign Percentage Allocation RuleassignPercentageAllocationRulePOSTThis operation assigns a percentage allocation rule to an employee.
Assign Percentage Allocation Rule to Multiple EmployeesassignPercentageAllocationRuleToMultipleEmployeesPOSTThis operation assigns a percentage allocation rule to one or more employees.
Delete Percentage Allocation RuledeletePercentageAllocationRuleDELETEThis operation deletes the assignment of a percentage allocation rule to an employee.
Delete Percentage Allocation Rule AssignmentsdeletePercentageAllocationRuleAssignmentsPOSTThis operation deletes percentage allocation rule assignments for one or more employees.
Retrieve All Percentage Allocation Rule AssignmentsretrieveAllPercentageAllocationRuleAssignmentsGETThis operation returns a list of all percentage allocation rule assignments.
Retrieve Percentage Allocation Rule Assignments by Person NumberretrievePercentageAllocationRuleAssignmentsByPersonNumberGETThis operation returns a list of an employee's percentage allocation rule assignments by person number.
Retrieve Percentage Allocation Rules AssignmentsretrievePercentageAllocationRulesAssignmentsPOSTThis operation returns a list of percentage allocation rule assignments for multiple employees.
Retrieve Percentage Allocation Rules Assignments by IDretrievePercentageAllocationRulesAssignmentsByIDGETThis operation returns a list of an employee's percentage allocation rule assignments by person ID.
Update Percentage Allocation Rule Assignment by IDupdatePercentageAllocationRuleAssignmentByIDPUTThis operation updates the assignment of a percentage allocation rule to an employee.
Update Percentage Allocation Rule AssignmentsupdatePercentageAllocationRuleAssignmentsPOSTThis operation updates the assignment of a percentage allocation rule to one or more employees.
Percentage Allocation Rules6
Add Rule Version to Percentage Allocation Rule by IDaddRuleVersionToPercentageAllocationRuleByIDPOSTThis operation returns a list of all fixed percentage allocation rules.
Create Percentage Allocation RulecreatePercentageAllocationRulePOSTThis operation creates a fixed percentage allocation rule.
Delete Percentage Allocation Rule by IDdeletePercentageAllocationRuleByIDDELETEThis operation deletes a fixed percentage allocation rule by ID.
Retrieve All Percentage Allocation RulesretrieveAllPercentageAllocationRulesGETThis operation returns a list of all fixed percentage allocation rules.
Retrieve Percentage Allocation RulesretrievePercentageAllocationRulesPOSTThis operation returns a list of people profiles by object references.
Update Percentage Allocation Rule by IDupdatePercentageAllocationRuleByIDPUTThis operation updates a fixed percentage allocation rule by ID.
Perfect Attendance1
Retrieve Perfect Attendance TransactionsretrievePerfectAttendanceTransactionsPOSTThis operation returns Perfect Attendance awards and violations for a list of employees within a date range.
Perfect Attendance Deductions1
Retrieve Perfect Attendance DeductionsretrievePerfectAttendanceDeductionsPOSTThis operation returns Perfect Attendance deductions for a list of employees within a date range.
Perfect Attendance Definitions2
Retrieve All Perfect Attendance DefinitionsretrieveAllPerfectAttendanceDefinitionsGETThis operation returns a list of all Perfect Attendance Definitions.
Retrieve Perfect Attendance Definition by IDretrievePerfectAttendanceDefinitionByIDGETThis operation returns a Perfect Attendance Definition by ID.
Perfect Attendance Policies2
Retrieve All Perfect Attendance PoliciesretrieveAllPerfectAttendancePoliciesGETThis operation returns a list of all Perfect Attendance Policies.
Retrieve Perfect Attendance Policy by IDretrievePerfectAttendancePolicyByIDGETThis operation returns a Perfect Attendance Policy by ID.
Period Definitions9
Create Period DefinitioncreatePeriodDefinitionPOSTThis operation creates a period definition.
Create Period DefinitionscreatePeriodDefinitionsPOSTThis operation creates one or more period definitions.
Delete Period Definition by IDdeletePeriodDefinitionByIDDELETEThis operation deletes a period definition by ID.
Delete Period DefinitionsdeletePeriodDefinitionsPOSTThis operation deletes one or more period definitions.
Retrieve All Period Definitions or by NameretrieveAllPeriodDefinitionsOrByNameGETThis operation returns all period definitions if no parameter is specified or a particular definition if a name is provided.
Retrieve Period Definition by IDretrievePeriodDefinitionByIDGETThis operation returns a period definition by ID.
Retrieve Period DefinitionsretrievePeriodDefinitionsPOSTThis operation returns one or more period definitions by object references or assignment contexts.
Update Period Definition by IDupdatePeriodDefinitionByIDPUTThis operation updates a period definition by ID.
Update Period DefinitionsupdatePeriodDefinitionsPUTThis operation updates one or more period definitions.
Period of Application Types1
Retrieve Period of Application TypesretrievePeriodOfApplicationTypesGETThis operation returns all period of application types.
Person Common ID8
Add or Update AOID and COIDaddOrUpdateAOIDAndCOIDPUTThis operation adds or updates AOID and COID assignments for an employee.
Delete AOID and COIDdeleteAOIDAndCOIDDELETEThis operation deletes AOID and COID assignments for an employee.
Delete AOID and COID for Multiple EmployeesdeleteAOIDAndCOIDForMultipleEmployeesPOSTThis operation deletes AOID and COID assignments for one or more employees.
Retrieve AOID and COID by Person IDretrieveAOIDAndCOIDByPersonIDGETThis operation returns AOID and COID assignments for an employee by person ID.
Retrieve AOID and COID by Person NumberretrieveAOIDAndCOIDByPersonNumberGETThis operation returns AOID and COID assignments for an employee by person number.
Retrieve AOID and COID for Multiple EmployeesretrieveAOIDAndCOIDForMultipleEmployeesPOSTThis operation returns AOID and COID assignments for one or more employees by employee reference.
Retrieve Persons without an Assigned AOIDretrievePersonsWithoutAnAssignedAOIDPOSTThis operation returns a list of persons that do not have an assigned AOID.
Update AOID and COID for Multiple EmployeesupdateAOIDAndCOIDForMultipleEmployeesPOSTThis operation updates AOID and COID assignments for one or more employees.
Person TeleStaff Assignments9
Create Person TeleStaff Assignment by Person NumbercreatePersonTeleStaffAssignmentByPersonNumberPOSTThis operation creates a person TeleStaff assignment for an employee.
Create Person TeleStaff Assignments by Person Number for Multiple EmployeescreatePersonTeleStaffAssignmentsByPersonNumberForMultipleEmployeesPOSTThis operation creates person TeleStaff assignments for one or more employees by person number.
Delete Person TeleStaff Assignment by IDdeletePersonTeleStaffAssignmentByIDDELETEThis operation deletes an employee's person TeleStaff assignment by person ID.
Delete Person TeleStaff Assignments for Multiple EmployeesdeletePersonTeleStaffAssignmentsForMultipleEmployeesPOSTThis operation deletes the person TeleStaff assignments for one or more employees.
Retrieve Person TeleStaff Assignment by IDretrievePersonTeleStaffAssignmentByIDGETThis operation returns an employee's person TeleStaff assignment by person ID.
Retrieve Person TeleStaff Assignment by Person NumberretrievePersonTeleStaffAssignmentByPersonNumberGETThis operation returns an employee's person TeleStaff assignment by person number.
Retrieve Person TeleStaff Assignments for Multiple EmployeesretrievePersonTeleStaffAssignmentsForMultipleEmployeesPOSTThis operation returns person TeleStaff assignments for one or more employees.
Update Person TeleStaff Assignment by IDupdatePersonTeleStaffAssignmentByIDPUTThis operation updates the person TeleStaff assignment of an employee by person ID.
Update Person TeleStaff Assignments for Multiple EmployeesupdatePersonTeleStaffAssignmentsForMultipleEmployeesPOSTThis operation updates the person TeleStaff assignments for one or more employees.
Persons17
Create Multiple PersonscreateMultiplePersonsPOSTThis operation creates one or more person records.
Create or Update PersonscreateOrUpdatePersonsPOSTThis operation updates one or more existing person records or creates new person records.
Create PersoncreatePersonPOSTThis operation creates and saves a new person record.
Delete Multiple PersonsdeleteMultiplePersonsPOSTThis operation deletes one or more person records.
Delete Person by IDdeletePersonByIDDELETEThis operation deletes a person record by ID.
Retrieve All ExtensionsretrieveAllExtensionsGETThis operation returns all extensions data for a person record.
Retrieve All PersonsretrieveAllPersonsPOSTThis customizable operation returns all persons in the system according to the specified parameters.
Retrieve Base PersonretrieveBasePersonPOSTThis operation returns a base summary of person information for all person records that match search criteria.
Retrieve Current UserretrieveCurrentUserGETThis operation returns information about the currently logged-in user.
Retrieve Current User's DelegationsretrieveCurrentUserSDelegationsGETThis operation returns delegation roles of the currently logged-in user.
Retrieve Employee ReferencesretrieveEmployeeReferencesPOSTThis operation returns only the employee references for all person records that match search criteria.
Retrieve Person by ExtensionretrievePersonByExtensionGETThis operation returns person information based on person number and extension type: employee, timekeeping, scheduling, accrual, or device.
Retrieve Person by IDretrievePersonByIDGETThis operation returns a person record by ID.
Retrieve PersonsretrievePersonsPOSTThis operation returns multiple person records based on search criteria.
Retrieve Punch Interpretation RuleretrievePunchInterpretationRuleGETThis operation returns a punch interpretation rule by direct pay rule or employement terms.
Update Multiple PersonsupdateMultiplePersonsPOSTThis operation updates or edits one or more person records.
Update Person by IDupdatePersonByIDPUTThis operation updates a person record by ID.
Predictive Scheduling2
Retrieve Predictive Scheduling ViolationsretrievePredictiveSchedulingViolationsPOSTThis operation returns predictive Scheduling violations by analyzing a list of Worked Shifts and determining if any predictive scheduling violations occurred.
Retrieve Predictive Scheduling Violations, Hours, and CostsretrievePredictiveSchedulingViolationsHoursAndCostsPOSTThis operation returns predictive Scheduling violations, hours, and costs by analyzing a list of shifts.
Predictive Scheduling Bonus9
Create Multiple Predictive Scheduling BonusescreateMultiplePredictiveSchedulingBonusesPOSTThis operation creates a set of new predictive scheduling bonuses.
Create Predictive Scheduling BonuscreatePredictiveSchedulingBonusPOSTThis operation creates a predictive scheduling bonus.
Delete Multiple Predictive Scheduling BonusesdeleteMultiplePredictiveSchedulingBonusesPOSTThis operation deletes one or more predictive scheduling bonuses according to the parameters provided.
Delete Predictive Scheduling Bonus by IDdeletePredictiveSchedulingBonusByIDDELETEThis operation deletes a predictive scheduling bonus by ID.
Retrieve Predictive Scheduling Bonus by IDretrievePredictiveSchedulingBonusByIDGETThis operation returns a predictive scheduling bonus by ID.
Retrieve Predictive Scheduling Bonus by nameretrievePredictiveSchedulingBonusByNameGETThis operation returns a predictive scheduling bonus by name.
Retrieve Predictive Scheduling BonusesretrievePredictiveSchedulingBonusesPOSTThis operation returns one or more predictive scheduling bonuses matching specified search criteria.
Update Multiple Predictive Scheduling BonusesupdateMultiplePredictiveSchedulingBonusesPOSTThis operation updates a set of predictive scheduling bonuses.
Update Predictive Scheduling Bonus by IDupdatePredictiveSchedulingBonusByIDPUTThis operation updates the state of a predictive scheduling bonus by ID.
Predictive Scheduling Rules9
Create Multiple Predictive Scheduling RulescreateMultiplePredictiveSchedulingRulesPOSTThis operation creates a set of new predictive scheduling rules.
Create Predictive Scheduling RulecreatePredictiveSchedulingRulePOSTThis operation creates a predictive scheduling rule.
Delete Multiple Predictive Scheduling RulesdeleteMultiplePredictiveSchedulingRulesPOSTThis operation deletes one or more predictive scheduling rules according to the parameters provided.
Delete Predictive Scheduling Rule by IDdeletePredictiveSchedulingRuleByIDDELETEThis operation deletes a predictive scheduling rule by ID.
Retrieve Predictive Scheduling Rule by IDretrievePredictiveSchedulingRuleByIDGETThis operation returns a predictive scheduling rule by ID.
Retrieve Predictive Scheduling Rule by nameretrievePredictiveSchedulingRuleByNameGETThis operation returns a predictive scheduling rule by name.
Retrieve Predictive Scheduling RulesretrievePredictiveSchedulingRulesPOSTThis operation returns one or more predictive scheduling rules matching specified search criteria.
Update Multiple Predictive Scheduling RulesupdateMultiplePredictiveSchedulingRulesPOSTThis operation updates a set of predictive scheduling rules.
Update Predictive Scheduling Rule by IDupdatePredictiveSchedulingRuleByIDPUTThis operation updates the state of a predictive scheduling rule by ID.
Prevailing Wages2
Create or Update Prevailing WagescreateOrUpdatePrevailingWagesPOSTThis operation creates or updates one or more prevailing wages, which are utilized by the totalizer for wage calculations.
Retrieve Prevailing WagesretrievePrevailingWagesGETThis operation returns prevailing wages filtered by an as of date.
Previous Action Policies2
Retrieve All Previous Action PoliciesretrieveAllPreviousActionPoliciesGETThis operation returns a list of all Previous Action Policies.
Retrieve Previous Action Policy by IDretrievePreviousActionPolicyByIDGETThis operation returns a Previous Action Policy by ID.
Proactively Guide Employees - Behaviors Configuration3
Retrieve All PGE Behaviors ConfigurationsretrieveAllPGEBehaviorsConfigurationsGETThis operation returns all Proactively Guide Employees (PGE) setup behaviors configurations.
Retrieve PGE Behaviors Configuration by IDretrievePGEBehaviorsConfigurationByIDGETThis operation returns a Proactively Guide Employees (PGE) setup behaviors configuration by ID.
Update PGE Behaviors Configuration by IDupdatePGEBehaviorsConfigurationByIDPUTThis operation updates a Proactively Guide Employees (PGE) setup behaviors configuration by ID.
Proactively Guide Employees - Behaviors Configuration Items5
Create PGE Behaviors Configuration ItemcreatePGEBehaviorsConfigurationItemPOSTThis operation creates a Proactively Guide Employees (PGE) setup behaviors configuration item according to the data provided.
Delete PGE Behaviors Configuration Item by IDdeletePGEBehaviorsConfigurationItemByIDDELETEThis operation deletes a Proactively Guide Employees (PGE) setup behaviors configuration item by ID.
Retrieve PGE Behaviors Configuration Item by IDretrievePGEBehaviorsConfigurationItemByIDGETThis operation returns a Proactively Guide Employees (PGE) setup behaviors configuration item by ID.
Retrieve PGE Behaviors Configuration ItemsretrievePGEBehaviorsConfigurationItemsGETThis operation returns Proactively Guide Employees (PGE) setup behaviors configuration items.
Update PGE Behaviors Configuration Item by IDupdatePGEBehaviorsConfigurationItemByIDPUTThis operation updates a Proactively Guide Employees (PGE) setup behaviors configuration item by ID.
Procedure Set Engine1
Retrieve Sorted or Eligible EmployeesretrieveSortedOrEligibleEmployeesPOSTThis operation returns a sorted list of employees by using a procedure set or a list of employees eligible for a given open shift.
Procedure Sets3
Retrieve Procedure Set by IDretrieveProcedureSetByIDGETThis operation returns a single procedure set by ID.
Retrieve Procedure Set by NameretrieveProcedureSetByNameGETThis operation returns a single procedure set by name.
Retrieve Procedure SetsretrieveProcedureSetsPOSTThis operation returns a list of procedure sets filtered by object reference or procedure type.
Process Profile Assignments5
Retrieve Process Profile by Person IDretrieveProcessProfileByPersonIDGETThis operation returns the process profile assigned to an employee by person ID.
Retrieve Process Profile by Person NumberretrieveProcessProfileByPersonNumberGETThis operation returns the process profile assigned to an employee by person number.
Retrieve Process Profiles for Multiple EmployeesretrieveProcessProfilesForMultipleEmployeesPOSTThis operation returns the process profiles assigned to one or more employees.
Update Process ProfileupdateProcessProfilePUTThis operation updates the assignment of a process profile to an employee.
Update Process Profile for Multiple EmployeesupdateProcessProfileForMultipleEmployeesPOSTThis operation updates the assignment of a process profile to one or more employees.
Process Profiles4
Retrieve All Process ProfilesretrieveAllProcessProfilesGETThis operation returns a list of all Process Profiles.
Retrieve Available Process Profile by IDretrieveAvailableProcessProfileByIDGETThis operation returns an available Process Profile by ID.
Retrieve Process Profile by IDretrieveProcessProfileByIDGETThis operation returns a Process Profile by ID.
Retrieve Process ProfilesretrieveProcessProfilesPOSTThis operation returns one or more process profiles by IDs, Qualifiers or Refs.
Processor Requests5
Create Attendance Processor RequestcreateAttendanceProcessorRequestPOSTThis operation creates an Attendance Processor request.
Delete Attendance Processor Request by IDdeleteAttendanceProcessorRequestByIDDELETEThis operation deletes an Attendance Processor request by ID.
Retrieve Attendance Processor Request by IDretrieveAttendanceProcessorRequestByIDGETThis operation returns an Attendance Processor request by ID.
Retrieve Attendance Processor RequestsretrieveAttendanceProcessorRequestsGETThis operation returns all Attendance Processor requests.
Update Attendance Processor Request by IDupdateAttendanceProcessorRequestByIDPUTThis operation updates an existing Attendance Processor request by ID.
Proficiency Levels9
Create Proficiency LevelcreateProficiencyLevelPOSTThis operation creates a proficiency level.
Create Proficiency LevelscreateProficiencyLevelsPOSTThis operation creates multiple proficiency levels.
Delete Proficiency Level by IDdeleteProficiencyLevelByIDDELETEThis operation deletes a proficiency level by ID.
Delete Proficiency LevelsdeleteProficiencyLevelsPOSTThis operation deletes multiple proficiency levels.
Retrieve Proficiency Level by IDretrieveProficiencyLevelByIDGETThis operation returns a proficiency level by ID.
Retrieve Proficiency Level by NameretrieveProficiencyLevelByNameGETThis operation returns a proficiency level.
Retrieve Proficiency LevelsretrieveProficiencyLevelsPOSTThis operation returns a list of proficiency levels.
Update Proficiency Level by IDupdateProficiencyLevelByIDPUTThis operation updates a proficiency level by ID.
Update Proficiency LevelsupdateProficiencyLevelsPOSTThis operation updates multiple proficiency levels.
Profile Assignments1
Retrieve Profile AssignmentsretrieveProfileAssignmentsPOSTThis operation returns profile assignments for a list of employees within a date range.
Profile Field Maps3
Create or Update Profile Field MapscreateOrUpdateProfileFieldMapsPOSTThis operation creates or updates one or more profile field maps.
Retrieve All Profile Field MapsretrieveAllProfileFieldMapsGETThis operation returns all profile field maps.
Retrieve Profile Field MapsretrieveProfileFieldMapsPOSTThis operation returns a list of profile template fields with profile template maps by object references.
Profile Templates3
Retrieve All Profile TemplatesretrieveAllProfileTemplatesGETThis operation returns all profile templates.
Retrieve Profile Template by IDretrieveProfileTemplateByIDGETThis operation returns a profile template by ID.
Retrieve Profile TemplatesretrieveProfileTemplatesPOSTThis operation returns a list of profile templates by object references.
Publish and Run Reports9
Delete ReportdeleteReportDELETEThis operation deletes the report that corresponds to the identifier (ID).
Retrieve Payroll Staging Asynchronous Request Status by KeyretrievePayrollStagingAsynchronousRequestStatusByKeyGETThis operation returns the status of an asynchronous Save Report request by execution key.
Retrieve Published ReportsretrievePublishedReportsGETThis operation returns a list of all published reports.
Retrieve Report by IDretrieveReportByIDGETThis operation returns a report by ID.
Retrieve Report by NameretrieveReportByNameGETThis operation returns a report file by name.
Run Report by NamerunReportByNamePOSTThis operation runs a report by name.
Save ReportsaveReportPOSTThis operation saves a report along with the saved report's metadata.
Save Report AsynchronouslysaveReportAsynchronouslyPOSTThis operation saves a report asynchronously and returns an execution key.
Update Report by IDupdateReportByIDPOSTThis operation updates a report by ID.
Punch Interpretation Rules4
Add or Update Multiple Punch Interpretation RulesaddOrUpdateMultiplePunchInterpretationRulesPOSTThis operation adds or updates multiple punch interpretation rules by multiple ids, qualifiers and/or refs.
Delete Multiple Punch Interpretation RulesdeleteMultiplePunchInterpretationRulesPOSTThis operation deletes multiple punch interpretation rules by multiple ids, qualifiers and/or refs.
Delete Punch Interpretation RuledeletePunchInterpretationRuleDELETEThis operation deletes a punch interpretation rule by ID.
Retrieve All Punch Interpretation RulesretrieveAllPunchInterpretationRulesGETThis operation returns a list containing the ID, name and other details of all punch interpretation rules in the system.
Raw Volume1
Create or Update Raw VolumecreateOrUpdateRawVolumePOSTThis operation creates or updates raw volume.
Raw Volume Data Errors2
Create or Update Raw Volume Error RecordscreateOrUpdateRawVolumeErrorRecordsPOSTThis operation creates or updates raw volume error records.
Retrieve All Raw Volume Error RecordsretrieveAllRawVolumeErrorRecordsGETThis operation returns all error records associated with raw volume data.
Report Categories2
Get All Report CategoriesgetAllReportCategoriesGETThis operation returns all report categories with associated reports.
Get Report Category By NamegetReportCategoryByNameGETThis operation returns the report category, with associated reports, that corresponds to the name.
Report Data Objects7
Create Report Data ObjectcreateReportDataObjectPOSTThis operation creates a reporting data object, which represents a reporting dataview, data object metadata, and publishes the corresponding data design file to the Reporting system.
Generate Report Data Object Batched Requests by NamegenerateReportDataObjectBatchedRequestsByNamePOSTThis operation generates and returns batches of Retrieve Report Data Object requests by name.
Retrieve All Report Data Objects or by NameretrieveAllReportDataObjectsOrByNameGETThis operation returns all report data objects or a single report data object by name.
Retrieve Report Data Element DefinitionsretrieveReportDataElementDefinitionsPOSTThis operation returns data element definitions by Data Dictionary keys.
Retrieve Report Data Object by IDretrieveReportDataObjectByIDGETThis operation returns a report data object by ID.
Retrieve Report Data Object by NameretrieveReportDataObjectByNamePOSTThis operation returns a reporting data object, which represents a reporting dataview, data object metadata, and data design file, by name.
Update Report Data Object by IDupdateReportDataObjectByIDPUTThis operation updates a reporting data object, which represents a reporting dataview, data object metadata, and data design file by ID.
Report Designs4
Delete Unpublished Report Design by IDdeleteUnpublishedReportDesignByIDDELETEThis operation deletes an unpublished report design by ID.
Retrieve a Report Design by NameretrieveAReportDesignByNameGETThis operation returns a single report design by name.
Retrieve All Report DesignsretrieveAllReportDesignsGETThis operation returns all report designs.
Retrieve Report Design ParametersretrieveReportDesignParametersGETThis operation returns report design parameters that correspond to the identifier ReportName .
Report Executions4
Retrieve Executed Report Output by IDretrieveExecutedReportOutputByIDGETThis operation returns an executed report by ID as an attachment.
Retrieve Report Execution Status by IDretrieveReportExecutionStatusByIDGETThis operation returns the report execution status for a specific report execution ID.
Retrieve Report History (Deprecated)retrieveReportHistoryDeprecatedGETThis operation is deprecated; instead use POST /v1/platform/report executions/apply read.
Retrieve Report History by CriteriaretrieveReportHistoryByCriteriaPOSTThis operation returns the report run history for the current user based on specified criteria.
Report Profiles5
Create Report ProfilecreateReportProfilePOSTThis operation creates and saves a report profile.
Delete Report Profile by IDdeleteReportProfileByIDDELETEThis operation deletes a report profile by ID.
Retrieve All Report ProfilesretrieveAllReportProfilesGETThis operation returns all report profiles.
Retrieve Report Profile by IDretrieveReportProfileByIDGETThis operation returns a report profile by ID.
Update Report Profile by IDupdateReportProfileByIDPUTThis operation updates a report profile by ID.
Report Requests5
Create Report RequestcreateReportRequestPOSTThis operation creates and saves a new report request.
Delete Report Request by IDdeleteReportRequestByIDDELETEThis operation deletes a report request by ID.
Retrieve Paginated List of Scheduled Report RequestsretrievePaginatedListOfScheduledReportRequestsPOSTThis operation returns a paginated list of all scheduled report requests in the system or for the current user.
Retrieve Scheduled Report Requests (Deprecated)retrieveScheduledReportRequestsDeprecatedGETThis operation is deprecated; instead use POST /v1/platform/scheduled reports/apply read.
Update Report Request by IDupdateReportRequestByIDPUTThis operation updates a report request by ID and returns the updated report request.
Request Submission Periods2
Open Next Submission PeriodopenNextSubmissionPeriodPOSTThis operation opens the submission period for the next employee in the group.
Verify Request Item PeriodsverifyRequestItemPeriodsPOSTThis operation tests, or verifies, whether or not a submission period is open for a specified date and time or whether or not an open request period includes a specified start date and...
Request Subtypes3
Retrieve Request Subtype by IDretrieveRequestSubtypeByIDGETThis operation returns a request subtype by ID.
Retrieve Request Subtype by NameretrieveRequestSubtypeByNameGETThis operation returns a request subtype by name.
Retrieve Request SubtypesretrieveRequestSubtypesPOSTThis operation returns request subtypes by search criteria.
Result Code Profiles9
Create Result Code ProfilecreateResultCodeProfilePOSTThis operation creates a result code profile.
Create Result Code ProfilescreateResultCodeProfilesPOSTThis operation creates one or more result code profiles.
Delete Result Code Profile by IDdeleteResultCodeProfileByIDDELETEThis operation deletes a result code profile by ID.
Delete Result Code ProfilesdeleteResultCodeProfilesPOSTThis operation deletes one or more result code profiles.
Retrieve All Result Code Profiles by NameretrieveAllResultCodeProfilesByNameGETThis operation returns all result code profiles without associated assignments if no parameter is specified or a particular result code profile with assignments if a name is provided,...
Retrieve Result Code Profile by IDretrieveResultCodeProfileByIDGETThis operation returns a result code profile by ID.
Retrieve Result Code ProfilesretrieveResultCodeProfilesPOSTThis operation returns one or more result code profiles by object references.
Update Result Code Profile by IDupdateResultCodeProfileByIDPUTThis operation updates a result code profile by ID.
Update Result Code ProfilesupdateResultCodeProfilesPOSTThis operation updates one or more result code profiles.
Result Codes10
Create or Update Result CodescreateOrUpdateResultCodesPOSTThis operation creates or updates one or more result codes.
Create Result CodecreateResultCodePOSTThis operation creates a result code.
Create Result CodescreateResultCodesPOSTThis operation creates one or more result codes.
Delete Result Code by IDdeleteResultCodeByIDDELETEThis operation deletes a result code by ID.
Delete Result CodesdeleteResultCodesPOSTThis operation deletes one or more result codes.
Retrieve All Result CodesretrieveAllResultCodesGETThis operation returns all result codes, including both active and inactive.
Retrieve Result Code by IDretrieveResultCodeByIDGETThis operation returns a result code by ID.
Retrieve Result CodesretrieveResultCodesPOSTThis operation returns one or more result codes.
Update Result Code by IDupdateResultCodeByIDPUTThis operation updates a result code by ID.
Update Result CodesupdateResultCodesPOSTThis operation updates one or more result codes.
Reviewer Lists9
Create Reviewer ListcreateReviewerListPOSTThis operation creates a reviewer list.
Create Reviewer ListscreateReviewerListsPOSTThis operation creates one or more reviewer lists.
Delete Reviewer List by IDdeleteReviewerListByIDDELETEThis operation deletes a reviewer list by ID.
Delete Reviewer ListsdeleteReviewerListsPOSTThis operation deletes one or more reviewer lists.
Retrieve Reviewer List by CriteriaretrieveReviewerListByCriteriaGETThis operation returns a reviewer list by name, type, and active status.
Retrieve Reviewer List by IDretrieveReviewerListByIDGETThis operation returns a reviewer list by ID.
Retrieve Reviewers for Reviewer ListsretrieveReviewersForReviewerListsGETThis operation returns all reviewers for reviewer lists.
Update Reviewer List by IDupdateReviewerListByIDPUTThis operation updates a reviewer list by ID.
Update Reviewer ListsupdateReviewerListsPOSTThis operation updates one or more reviewer lists.
Reviewer Purposes5
Create Reviewer PurposecreateReviewerPurposePOSTThis operation creates a reviewer purpose.
Delete Reviewer Purpose by IDdeleteReviewerPurposeByIDDELETEThis operation deletes a reviewer purpose by ID.
Retrieve All Reviewer Purposes or by Name (Deprecated)retrieveAllReviewerPurposesOrByNameDeprecatedGETThis operation is deprecated; instead use Retrieve All Symbolic Purposes or by Name or Type (GET /v1/commons/symbolic purposes).
Retrieve Reviewer Purpose by IDretrieveReviewerPurposeByIDGETThis operation returns a reviewer purpose by ID.
Update Reviewer Purpose by IDupdateReviewerPurposeByIDPUTThis operation updates a reviewer purpose by ID.
Role Profiles7
Create or Update Role ProfilescreateOrUpdateRoleProfilesPOSTThis operation creates or updates one or more role profiles.
Create Role ProfilecreateRoleProfilePOSTThis operation creates a new role profile.
Delete Role Profile by IDdeleteRoleProfileByIDDELETEThis operation deletes a role profile by ID.
Delete Role ProfilesdeleteRoleProfilesPOSTThis operation deletes one or more role profiles.
Retrieve All Role Profiles or by NameretrieveAllRoleProfilesOrByNameGETThis operation returns all role profiles if no parameter is specified or a particular role profile if a name is provided.
Retrieve Role Profile by IDretrieveRoleProfileByIDGETThis operation returns a role profile by ID.
Update Role Profile by IDupdateRoleProfileByIDPUTThis operation updates a role profile by ID.
Rotation Schedule2
Create and Retrieve Employee ReportcreateAndRetrieveEmployeeReportPOSTThis operation creates and returns a report containing assignment and unassignment data for an employee within the specified date range.
Create and Retrieve Job ReportcreateAndRetrieveJobReportPOSTThis operation creates and returns a report containing assignment and unassignment data for specified locations or jobs within the specified date range.
Rule Violations3
Evaluate Employee Rule ViolationsevaluateEmployeeRuleViolationsPOSTThis operation evaluates a set of employee rule violations according to a hypothetical scenario defined in the request payload.
Evaluate Employee Rule Violations and Save ScheduleevaluateEmployeeRuleViolationsAndSaveSchedulePOSTThis operation evaluates a set of employee rule violations according to a hypothetical scenario defined in the request payload and saves the schedule along with explanations for the...
Retrieve Employee Rule ViolationsretrieveEmployeeRuleViolationsPOSTThis operation returns rule violations along with explanations for the specified employees.
Rules1
Execute Attendance Rules for EmployeesexecuteAttendanceRulesForEmployeesPOSTThis operation executes Attendance rules for a list of employees within a date range.
Schedule Audits1
Retrieve Schedule AuditsretrieveScheduleAuditsPOSTThis operation returns a set of audits according to the specified criteria.
Schedule Builder Settings3
Retrieve Schedule Builder SettingsretrieveScheduleBuilderSettingsGETThis operation returns a list of Schedule Builder Settings.
Retrieve Schedule Builder Settings by IDretrieveScheduleBuilderSettingsByIDGETThis operation returns Schedule Builder Settings by ID.
Update Schedule Builder Settings by IDupdateScheduleBuilderSettingsByIDPUTThis operation updates Schedule Builder Settings by ID.
Schedule Change Criteria9
Create Multiple Schedule Change CriteriacreateMultipleScheduleChangeCriteriaPOSTThis operation creates one or more schedule change criteria.
Create Schedule Change CriteriacreateScheduleChangeCriteriaPOSTThis operation creates a schedule change criteria.
Delete Multiple Schedule Change CriteriadeleteMultipleScheduleChangeCriteriaPOSTThis operation deletes one or more schedule change criteria according to the parameters provided.
Delete Schedule Change Criteria by IDdeleteScheduleChangeCriteriaByIDDELETEThis operation deletes a schedule change criteria by ID.
Retrieve Multiple Schedule Change CriteriaretrieveMultipleScheduleChangeCriteriaPOSTThis operation returns one or more schedule change criteria matching specified search criteria.
Retrieve Schedule Change Criteria by IDretrieveScheduleChangeCriteriaByIDGETThis operation returns a schedule change criteria by ID.
Retrieve Schedule Change Criteria by NameretrieveScheduleChangeCriteriaByNameGETThis operation returns a schedule change criteria by name.
Update Multiple Schedule Change CriteriaupdateMultipleScheduleChangeCriteriaPOSTThis operation updates one or more schedule change criteria.
Update Schedule Change Criteria by IDupdateScheduleChangeCriteriaByIDPOSTThis operation updates the state of a schedule change criteria by ID.
Schedule Event Rules9
Create Schedule Event RulecreateScheduleEventRulePOSTThis operation creates a Schedule Event Rule.
Create Schedule Event RulescreateScheduleEventRulesPOSTThis operation creates one or more Schedule Event Rules.
Delete Schedule Event Rule by IDdeleteScheduleEventRuleByIDDELETEThis operation deletes a Schedule Event Rule by ID.
Delete Schedule Event RulesdeleteScheduleEventRulesPOSTThis operation deletes one or more Schedule Event Rules.
Retrieve All Schedule Event Rules or by NameretrieveAllScheduleEventRulesOrByNameGETThis operation returns all schedule event rules if no parameter is specified or a particular schedule event rule if a name is provided.
Retrieve Schedule Event Rule by IDretrieveScheduleEventRuleByIDGETThis operation returns a Schedule Event Rule by ID.
Retrieve Schedule Event RulesretrieveScheduleEventRulesPOSTThis operation returns one or more Schedule Event Rules.
Update Schedule Event Rule by IDupdateScheduleEventRuleByIDPUTThis operation updates a Schedule Event Rule by ID.
Update Schedule Event RulesupdateScheduleEventRulesPOSTThis operation updates one or more Schedule Event Rules.
Schedule Events9
Create Schedule EventcreateScheduleEventPOSTThis operation creates and returns a schedule event.
Create Schedule EventscreateScheduleEventsPOSTThis operation creates one or more schedule events.
Delete Schedule Event by IDdeleteScheduleEventByIDDELETEThis operation deletes a schedule event by ID.
Delete Schedule EventsdeleteScheduleEventsPOSTThis operation deletes a collection of schedule events.
Retrieve Schedule Event by IDretrieveScheduleEventByIDGETThis operation returns a schedule event by ID.
Retrieve Schedule Event by NameretrieveScheduleEventByNameGETThis operation returns a schedule event by name.
Retrieve Schedule EventsretrieveScheduleEventsPOSTThis operation returns one or more schedule events.
Update Schedule Event by IDupdateScheduleEventByIDPUTThis operation updates a schedule event by ID.
Update Schedule EventsupdateScheduleEventsPOSTThis operation updates one or more schedule events.
Schedule Generation Engine Strategies15
Create StrategiescreateStrategiesPOSTThis operation creates one or more schedule generation engine strategies.
Create StrategycreateStrategyPOSTThis operation creates a schedule generation engine strategy.
Delete StrategiesdeleteStrategiesPOSTThis operation deletes one or more schedule generation engine strategies.
Delete Strategy by IDdeleteStrategyByIDDELETEThis operation deletes a a schedule generation engine strategy by ID.
Retrieve All Parameter Definitions for Strategies or by NameretrieveAllParameterDefinitionsForStrategiesOrByNameGETThis operation returns all schedule generation engine strategy parameters, or returns a particular strategy parameter by name.
Retrieve All Strategies or by NameretrieveAllStrategiesOrByNameGETThis operation returns all strategies or a single strategy by name.
Retrieve Locations Assigned to StrategiesretrieveLocationsAssignedToStrategiesPOSTThis operation returns the locations assigned to one or more strategies.
Retrieve Locations Assigned to Strategy by IDretrieveLocationsAssignedToStrategyByIDGETThis operation returns the locations assigned to a strategy by strategy ID.
Retrieve StrategiesretrieveStrategiesPOSTThis operation returns one or more strategies by object references.
Retrieve Strategies Assigned to Location by IDretrieveStrategiesAssignedToLocationByIDGETThis operation returns the strategies assigned to a location by location ID.
Retrieve Strategies Assigned to LocationsretrieveStrategiesAssignedToLocationsPOSTThis operation returns the strategies assigned to one or more locations.
Retrieve Strategy by IDretrieveStrategyByIDGETThis operation returns a strategy by ID.
Update StrategiesupdateStrategiesPOSTThis operation updates one or more schedule generation engine strategies by object references.
Update Strategy Assignments to LocationsupdateStrategyAssignmentsToLocationsPOSTThis operation updates the assignment of strategies to locations.
Update Strategy by IDupdateStrategyByIDPUTThis operation updates a schedule generation engine strategy by ID.
Schedule Generation Profiles9
Create Schedule Generation ProfilecreateScheduleGenerationProfilePOSTThis operation creates a schedule generation profile.
Create Schedule Generation ProfilescreateScheduleGenerationProfilesPOSTThis operation creates one or more schedule generation profiles.
Delete Schedule Generation Profile by IDdeleteScheduleGenerationProfileByIDDELETEThis operation deletes a schedule generation profile by ID.
Delete Schedule Generation ProfilesdeleteScheduleGenerationProfilesPOSTThis operation deletes one or more schedule generation profiles.
Retrieve All Schedule Generation Profiles or by NameretrieveAllScheduleGenerationProfilesOrByNameGETRetrieve All Schedule Generation Profiles or by Name
Retrieve Schedule Generation Profile by IDretrieveScheduleGenerationProfileByIDGETThis operation returns a schedule generation profile by ID.
Retrieve Schedule Generation ProfilesretrieveScheduleGenerationProfilesPOSTThis operation returns one or more schedule generation profiles.
Update Schedule Generation Profile by IDupdateScheduleGenerationProfileByIDPUTThis operation updates a schedule generation profile by ID.
Update Schedule Generation ProfilesupdateScheduleGenerationProfilesPOSTThis operation updates one or more schedule generation profiles.
Schedule Generation Setup15
Create Schedule Generation SetupcreateScheduleGenerationSetupPOSTThis operation creates a Schedule Generation Setup.
Create Schedule Generation SetupscreateScheduleGenerationSetupsPOSTThis operation creates one or more Schedule Generation Setups.
Delete Schedule Generation Setup by IDdeleteScheduleGenerationSetupByIDDELETEThis operation deletes a Schedule Generation Setup by ID.
Delete Schedule Generation SetupsdeleteScheduleGenerationSetupsPOSTThis operation deletes one or more Schedule Generation Setups.
Retrieve All Schedule Generation Setup ParametersretrieveAllScheduleGenerationSetupParametersGETThis operation returns all Schedule Generation Setup parameters.
Retrieve All Schedule Generation Setups or by NameretrieveAllScheduleGenerationSetupsOrByNameGETThis operation returns all Schedule Generation Setups or returns a single Schedule Generation Setup by name.
Retrieve Locations Assigned to Schedule Generation Setup by IDretrieveLocationsAssignedToScheduleGenerationSetupByIDGETThis operation returns locations assigned to a Schedule Generation Setup by ID.
Retrieve Locations Assigned to Schedule Generation SetupsretrieveLocationsAssignedToScheduleGenerationSetupsPOSTThis operation returns one or more locations assigned to Schedule Generation Setups.
Retrieve Schedule Generation Setup Assignments by LocationretrieveScheduleGenerationSetupAssignmentsByLocationGETThis operation returns all Schedule Generation Setup assignments by location.
Retrieve Schedule Generation Setup Assignments for Multiple LocationsretrieveScheduleGenerationSetupAssignmentsForMultipleLocationsPOSTThis operation returns one or more Schedule Generation Setup assignments for one or more locations.
Retrieve Schedule Generation Setup by IDretrieveScheduleGenerationSetupByIDGETThis operation returns a Schedule Generation Setup by ID.
Retrieve Schedule Generation Setup Parameter ValuesretrieveScheduleGenerationSetupParameterValuesGETThis operation returns all Schedule Generation Setup parameter values.
Retrieve Schedule Generation SetupsretrieveScheduleGenerationSetupsPOSTThis operation returns one or more Schedule Generation Setups.
Update Schedule Generation Setup by IDupdateScheduleGenerationSetupByIDPUTUpdate Schedule Generation Setup by ID
Update Schedule Generation SetupsupdateScheduleGenerationSetupsPOSTThis operation updates one or more Schedule Generation Setups.
Schedule Group Assignments9
Add Group Memberships-Multiple EmployeesaddGroupMembershipsMultipleEmployeesPOSTThis operation creates and returns group assignments for multiple employees according to the specified parameters.
Add Group Memberships-One EmployeeaddGroupMembershipsOneEmployeePOSTThis operation creates and returns group assignments for one employee according to the specified parameters.
Remove Group Memberships-Multiple EmployeesremoveGroupMembershipsMultipleEmployeesPOSTThis operation removes group assignments for multiple employees according to the specified parameters.
Remove Group Memberships-One EmployeeremoveGroupMembershipsOneEmployeePOSTThis operation removes group assignments for one employee according to the specified parameters.
Retrieve Group Memberships by IDretrieveGroupMembershipsByIDGETThis operation returns group assignments for one employee by person ID.
Retrieve Group Memberships by Person NumberretrieveGroupMembershipsByPersonNumberGETThis operation returns group assignments for one employee by person number.
Retrieve Group Memberships-Multiple EmployeesretrieveGroupMembershipsMultipleEmployeesPOSTThis operation returns group assignments for multiple employees according to the specified parameters.
Update Group Memberships-Multiple EmployeesupdateGroupMembershipsMultipleEmployeesPOSTThis operation updates and returns group assignments for multiple employees according to the specified parameters.
Update Group Memberships-One EmployeeupdateGroupMembershipsOneEmployeePUTThis operation updates and returns group assignments for one employee according to the specified parameters.
Schedule Group Patterns6
Create Schedule Group PatterncreateScheduleGroupPatternPOSTThis operation creates a group schedule pattern.
Delete Schedule Group Pattern by IDdeleteScheduleGroupPatternByIDDELETEThis operation deletes a group schedule pattern by ID.
Retrieve Schedule Group Pattern by IDretrieveScheduleGroupPatternByIDGETThis operation returns a group schedule pattern by ID.
Retrieve Schedule Group Pattern ConfigurationretrieveScheduleGroupPatternConfigurationGETThis operation returns an abridged list of the group schedule pattern builder's public settings and configuration data.
Retrieve Schedule Group PatternsretrieveScheduleGroupPatternsPOSTThis operation returns group schedule pattern entities based on the specified search criteria.
Update or Remove Schedule Group PatternsupdateOrRemoveScheduleGroupPatternsPOSTThis operation updates or removes multiple group schedule patterns.
Schedule Group Profile Assignments7
Delete Schedule Group Profile AssignmentsdeleteScheduleGroupProfileAssignmentsPOSTThis operation deletes one or more schedule group profile assignments for one or more persons.
Delete Schedule Group Profile Assignments by Person IDdeleteScheduleGroupProfileAssignmentsByPersonIDDELETEThis operation deletes schedule group profile assignments by person ID.
Retrieve Schedule Group Profile AssignmentsretrieveScheduleGroupProfileAssignmentsPOSTThis operation returns one or more schedule group profile assignments.
Retrieve Schedule Group Profile Assignments by Person IDretrieveScheduleGroupProfileAssignmentsByPersonIDGETThis operation returns schedule group profile assignments by person ID.
Retrieve Schedule Group Profile Assignments by Person NumberretrieveScheduleGroupProfileAssignmentsByPersonNumberGETThis operation returns schedule group profile assignments by person number.
Update Schedule Group Profile Assignment by Person IDupdateScheduleGroupProfileAssignmentByPersonIDPUTThis operation updates a schedule group profile assignment by person ID.
Update Schedule Group Profile AssignmentsupdateScheduleGroupProfileAssignmentsPOSTThis operation updates one or more schedule group profile assignments.
Schedule Group Profiles1
Retrieve All Schedule Group ProfilesretrieveAllScheduleGroupProfilesGETThis operation returns all schedule group profiles.
Schedule Groups12
Create Schedule GroupcreateScheduleGroupPOSTThis operation creates a schedule group.
Create Schedule GroupscreateScheduleGroupsPOSTThis operation creates one or more schedule groups.
Delete Schedule Group by IDdeleteScheduleGroupByIDDELETEThis operation deletes a schedule group by ID.
Delete Schedule GroupsdeleteScheduleGroupsPOSTThis operation deletes one or more schedule groups.
Retrieve All Schedule Groups or by NameretrieveAllScheduleGroupsOrByNameGETThis operation returns all schedule groups or a particular schedule group if a name is provided.
Retrieve All Schedule Groups or by Name (Deprecated)retrieveAllScheduleGroupsOrByNameDeprecatedGETThis operation is deprecated; instead use GET /v2/scheduling/setup/schedule groups.
Retrieve Schedule Group by IDretrieveScheduleGroupByIDGETThis operation returns a schedule group by ID.
Retrieve Schedule Group by ID (Deprecated)retrieveScheduleGroupByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/scheduling/setup/schedule groups/{id}.
Retrieve Schedule GroupsretrieveScheduleGroupsPOSTThis operation returns one or more schedule groups by object references.
Retrieve Schedule Groups (Deprecated)retrieveScheduleGroupsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/scheduling/setup/schedule groups/multi read.
Update Schedule Group by IDupdateScheduleGroupByIDPUTThis operation updates a schedule group by ID.
Update Schedule GroupsupdateScheduleGroupsPOSTThis operation updates one or more schedule groups.
Schedule Override Employee Preferences5
Create or Update Schedule Override Employee PreferencescreateOrUpdateScheduleOverrideEmployeePreferencesPOSTThis operation creates or updates and returns a list of Schedule Override Employee Preferences.
Retrieve Schedule Override Employee PreferencesretrieveScheduleOverrideEmployeePreferencesPOSTThis operation returns one or more schedule override employee preferences.
Retrieve Schedule Override Employee Preferences by Person IDretrieveScheduleOverrideEmployeePreferencesByPersonIDGETThis operation returns schedule override employee preferences by person ID.
Retrieve Schedule Override Employee Preferences by Person NumberretrieveScheduleOverrideEmployeePreferencesByPersonNumberGETThis operation returns schedule override employee preferences by person number.
Update Schedule Override Employee Preferences by Person IDupdateScheduleOverrideEmployeePreferencesByPersonIDPUTThis operation updates schedule override employee preferences by person ID.
Schedule Patterns11
Create Schedule PatterncreateSchedulePatternPOSTThis operation creates a new Schedule pattern.
Create Schedule PatternscreateSchedulePatternsPOSTThis operation creates a set of Schedule patterns.
Delete Schedule Pattern by IDdeleteSchedulePatternByIDDELETEThis operation deletes a Schedule pattern by ID.
Delete Schedule Pattern by NamedeleteSchedulePatternByNameDELETEThis operation deletes a Schedule pattern by name.
Delete Schedule PatternsdeleteSchedulePatternsPOSTThis operation deletes one or more Schedule patterns according to the parameters provided.
Retrieve Schedule Pattern by IDretrieveSchedulePatternByIDGETThis operation returns a Schedule pattern by ID.
Retrieve Schedule Pattern by NameretrieveSchedulePatternByNameGETThis operation returns a Schedule pattern by name.
Retrieve Schedule PatternsretrieveSchedulePatternsPOSTThis operation returns specific Schedule patterns by object references or all Schedule patterns if no references are provided.
Update Schedule Pattern by IDupdateSchedulePatternByIDPUTThis operation updates a Schedule pattern by ID.
Update Schedule Pattern by NameupdateSchedulePatternByNamePUTThis operation updates a Schedule pattern by name.
Update Schedule PatternsupdateSchedulePatternsPUTThis operation updates one or more Schedule patterns.
Schedule Periods3
Retrieve All Schedule PeriodsretrieveAllSchedulePeriodsGETThis operation returns all schedule periods.
Retrieve Schedule Period by IDretrieveSchedulePeriodByIDGETThis operation returns a Schedule Period by ID.
Retrieve Schedule PeriodsretrieveSchedulePeriodsPOSTThis operation returns a list of schedule periods by object references.
Schedule Planner Profiles3
Retrieve All Schedule Planner Profiles or by NameretrieveAllSchedulePlannerProfilesOrByNameGETThis operation returns all Schedule Planner Profiles or a particular Schedule Planner Profile if a name is provided.
Retrieve Schedule Planner Profile by IDretrieveSchedulePlannerProfileByIDGETThis operation returns a Schedule Planner Profile by ID.
Retrieve Schedule Planner ProfilesretrieveSchedulePlannerProfilesPOSTThis operation returns Schedule Planner Profiles by object references.
Schedule Rule Overrides12
Create Schedule Rule OverridecreateScheduleRuleOverridePOSTThis operation creates and returns a schedule rule override.
Create Schedule Rule OverridescreateScheduleRuleOverridesPOSTThis operation creates and returns a collection of schedule rule overrides.
Delete Schedule Rule Override by IDdeleteScheduleRuleOverrideByIDDELETEThis operation deletes a schedule rule override by ID.
Delete Schedule Rule OverridesdeleteScheduleRuleOverridesPOSTThis operation deletes a collection of schedule rule overrides.
Retrieve All Schedule Rule Overrides or by Person NumberretrieveAllScheduleRuleOverridesOrByPersonNumberGETThis operation returns a list of all schedule rule overrides or returns a single schedule rule override set by person number.
Retrieve All Schedule Rule Overrides or by Person Number (Deprecated)retrieveAllScheduleRuleOverridesOrByPersonNumberDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/persons/schedule rule overrides.
Retrieve Schedule Rule Override by IDretrieveScheduleRuleOverrideByIDGETThis operation returns a schedule rule override by person ID.
Retrieve Schedule Rule Override by ID (Deprecated)retrieveScheduleRuleOverrideByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/persons/schedule rule overrides/{person id}.
Retrieve Schedule Rule OverridesretrieveScheduleRuleOverridesPOSTThis operation returns a list of schedule rule overrides by object references.
Retrieve Schedule Rule Overrides (Deprecated)retrieveScheduleRuleOverridesDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/persons/schedule rule overrides/multi read.
Update Schedule Rule OverrideupdateScheduleRuleOverridePUTThis operation updates and returns a schedule rule override.
Update Schedule Rule OverridesupdateScheduleRuleOverridesPOSTThis operation updates and returns a collection of schedule rule overrides.
Schedule Rule Set Assignments4
Retrieve Rule Set AssignmentsretrieveRuleSetAssignmentsGETThis operation returns a list of rules set assignments for a single employee, date, and context.
Retrieve Rule Set Assignments for Multiple EmployeesretrieveRuleSetAssignmentsForMultipleEmployeesPOSTThis operation returns a list of rule set assignments for multiple employees, a date, and a context.
Update Rule Set Assignments by IDupdateRuleSetAssignmentsByIDPUTThis operation updates rule set assignments for a single employee by ID.
Update Rule Set Assignments for Multiple EmployeesupdateRuleSetAssignmentsForMultipleEmployeesPOSTThis operation updates rules set assignments for multiple employees, a date, and a context.
Schedule Rule Set Location Assignments7
Create or Update Rule Set Location AssignmentcreateOrUpdateRuleSetLocationAssignmentPUTThis operation creates or updates a rule set location assignment.
Create or Update Rule Set Location AssignmentscreateOrUpdateRuleSetLocationAssignmentsPOSTThis operation creates or updates rule set location assignments by object references.
Delete Rule Set Location Assignment by IDdeleteRuleSetLocationAssignmentByIDDELETEThis operation deletes a rule set location assignment by ID.
Delete Rule Set Location AssignmentsdeleteRuleSetLocationAssignmentsPOSTThis operation deletes rule set location assignments.
Delete Rule Set Location Assignments by Rule SetdeleteRuleSetLocationAssignmentsByRuleSetPOSTThis operation deletes all rule set location assignments associated with the specified rule set.
Retrieve All Rule Set Location AssignmentsretrieveAllRuleSetLocationAssignmentsGETThis operation returns a list of all rule set location assignments.
Retrieve Rule Set Location Assignment by IDretrieveRuleSetLocationAssignmentByIDGETThis operation returns the rule set assignments associated to the given ID.
Schedule Rule Sets6
Create Rule SetcreateRuleSetPOSTThis operation creates a Schedule rule set.
Delete Rule Set by IDdeleteRuleSetByIDDELETEThis operation deletes a Schedule rule set by ID.
Retrieve All Rule Sets or by NameretrieveAllRuleSetsOrByNameGETThis operation returns a list of all Schedule rule sets or returns a particular rule set by name.
Retrieve Rule Set by IDretrieveRuleSetByIDGETThis operation returns a Schedule rule set.
Retrieve Rule SetsretrieveRuleSetsPOSTThis operation returns multiple Schedule rule sets.
Update Rule Set by IDupdateRuleSetByIDPUTThis operation updates a Schedule rule set by ID.
Schedule Rules3
Retrieve All Schedule Rules or by NameretrieveAllScheduleRulesOrByNameGETThis operation returns a list of all Schedule rules or returns a particular rule by name.
Retrieve Schedule Rule by IDretrieveScheduleRuleByIDGETThis operation returns a Schedule rule by ID.
Retrieve Schedule RulesretrieveScheduleRulesPOSTReturns a collection of rules.
Schedule Score Definitions9
Create Schedule Score DefinitioncreateScheduleScoreDefinitionPOSTThis operation creates a schedule score definition.
Create Schedule Score DefinitionscreateScheduleScoreDefinitionsPOSTThis operation create one or more schedule score definitions.
Delete Schedule Score Definition by IDdeleteScheduleScoreDefinitionByIDDELETEThis operation deletes a schedule score definition by ID.
Delete Schedule Score DefinitionsdeleteScheduleScoreDefinitionsPOSTThis operation delete one or more existing schedule score definitions.
Retrieve All Schedule Score Definitions or by NameretrieveAllScheduleScoreDefinitionsOrByNameGETThis operation returns all schedule score definitions or a single schedule score definitions by name.
Retrieve Schedule Score Definition by IDretrieveScheduleScoreDefinitionByIDGETThis operation returns a schedule score definitions by ID.
Retrieve Schedule Score DefinitionsretrieveScheduleScoreDefinitionsPOSTThis operation returns one or more schedule score definitions.
Update Schedule Score Definition by IDupdateScheduleScoreDefinitionByIDPUTThis operation updates a schedule score definition by ID.
Update Schedule Score DefinitionsupdateScheduleScoreDefinitionsPOSTThis operation update one or more existing schedule score definitions.
Schedule Score Factors3
Retrieve All Schedule Score FactorsretrieveAllScheduleScoreFactorsGETThis operation returns all schedule score factors.
Retrieve Schedule Score Factor by IDretrieveScheduleScoreFactorByIDGETThis operation returns a schedule score factor by ID.
Update Schedule Score Factor by IDupdateScheduleScoreFactorByIDPUTThis operation updates a schedule score factor by ID.
Schedule Scores1
Retrieve Schedule ScoresretrieveScheduleScoresPOSTThis operation returns one or more schedule scores according to the specified criteria.
Schedule Tags8
Create Schedule TagcreateScheduleTagPOSTThis operation creates a Schedule tag according to the specified parameters.
Create Schedule TagscreateScheduleTagsPOSTThis operation creates one or more Schedule tags according to the IDs provided.
Delete Schedule Tag by IDdeleteScheduleTagByIDDELETEThis operation deletes a Schedule tag by ID.
Delete Schedule TagsdeleteScheduleTagsPOSTThis operation deletes one or more Schedule tags according to the specified parameters.
Retrieve Schedule Tag by IDretrieveScheduleTagByIDGETThis operation returns a Schedule tag by ID.
Retrieve Schedule Tags by IDretrieveScheduleTagsByIDPOSTThis operation returns one or more Schedule tags by ID.
Update Schedule Tag by IDupdateScheduleTagByIDPOSTThis operation updates a Schedule tag by ID.
Update Schedule TagsupdateScheduleTagsPOSTThis operation updates one or more Schedule tags according to the IDs provided.
Schedule Zone Sets4
Retrieve All Schedule Zone Sets or by NameretrieveAllScheduleZoneSetsOrByNameGETThis operation returns all schedule zone sets or a particular schedule zone set if a name is provided.
Retrieve Schedule Zone Set AssignmentsretrieveScheduleZoneSetAssignmentsPOSTThis operation returns a collection of schedule zone set assignments.
Retrieve Schedule Zone Set by IDretrieveScheduleZoneSetByIDGETThis operation returns a schedule zone set by ID.
Retrieve Schedule Zone SetsretrieveScheduleZoneSetsPOSTThis operation returns a collection of schedule zone sets by object references.
Scheduling Employee Preferences8
Retrieve Employee PreferencesretrieveEmployeePreferencesPOSTThis operation returns the employee preferences assigned to one or more persons.
Retrieve Employee Preferences (Deprecated)retrieveEmployeePreferencesDeprecatedPOSTThis operation is deprecated; instead use POST /v2/commons/persons/scheduling employee preferences/multi read.
Retrieve Employee Preferences by IDretrieveEmployeePreferencesByIDGETThis operation returns a person's employee preferences by person ID.
Retrieve Employee Preferences by ID (Deprecated)retrieveEmployeePreferencesByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/persons/scheduling employee preferences/{personId}.
Retrieve Employee Preferences by Person NumberretrieveEmployeePreferencesByPersonNumberGETThis operation returns a person's employee preferences by person number.
Retrieve Employee Preferences by Person Number (Deprecated)retrieveEmployeePreferencesByPersonNumberDeprecatedGETThis operation is deprecated; instead use GET /v2/commons/persons/scheduling employee preferences.
Update Employee PreferencesupdateEmployeePreferencesPOSTThis operation updates the employee preferences assigned to one or more persons.
Update Employee Preferences by IDupdateEmployeePreferencesByIDPUTThis operation updates employee preferences by person ID.
Scheduling Engines4
Execute Scheduling Engine AsynchronouslyexecuteSchedulingEngineAsynchronouslyPOSTThis operation asynchronously executes the Schedule Generation Engine or the Priority Scheduling Engine and returns a status with an execution key.
Retrieve Scheduling Engine Asynchronous Request Status by KeyretrieveSchedulingEngineAsynchronousRequestStatusByKeyGETThis operation returns the status of an asynchronous Schedule Generation Engine or Priority Scheduling Engine request by execution key.
Retrieve Scheduling Engine Asynchronous Response Payload by KeyretrieveSchedulingEngineAsynchronousResponsePayloadByKeyGETThis operation returns the response payload for an asynchronous scheduling engine operation by execution key.
Retrieve Summary of Scheduling Engine Asynchronous Delegate Profile JobsretrieveSummaryOfSchedulingEngineAsynchronousDelegateProfileJobsGETThis operation returns a summary of asynchronous Schedule Generation Engine or Priority Scheduling Engine jobs.
School Calendar Profile Assignments7
Delete School Calendar Profile Assignment by Person IDdeleteSchoolCalendarProfileAssignmentByPersonIDDELETEThis operation deletes a school calendar profile assignment by person ID.
Delete School Calendar Profile AssignmentsdeleteSchoolCalendarProfileAssignmentsPOSTThis operation deletes one or more school calendar profile assignments.
Retrieve School Calendar Profile Assignment by Person IDretrieveSchoolCalendarProfileAssignmentByPersonIDGETThis operation returns a school calendar profile assignment by person ID.
Retrieve School Calendar Profile Assignment by Person NumberretrieveSchoolCalendarProfileAssignmentByPersonNumberGETThis operation returns a school calendar profile assignment by person number.
Retrieve School Calendar Profile AssignmentsretrieveSchoolCalendarProfileAssignmentsPOSTThis operation returns one or more school calendar profile assignments.
Update School Calendar Profile Assignment by Person IDupdateSchoolCalendarProfileAssignmentByPersonIDPUTThis operation updates a school calendar profile assignment by person ID.
Update School Calendar Profile AssignmentsupdateSchoolCalendarProfileAssignmentsPOSTThis operation updates one or more school calendar profile assignments.
School Calendar Profiles1
Retrieve All Active School Calendar ProfilesretrieveAllActiveSchoolCalendarProfilesGETThis operation returns all active school calendar profiles.
School Calendars3
Retrieve All School Calendars or by NameretrieveAllSchoolCalendarsOrByNameGETThis operation returns a list of all school calendars or a single school calendar by name.
Retrieve School Calendar by IDretrieveSchoolCalendarByIDGETThis operation returns a school calendar by ID.
Retrieve School CalendarsretrieveSchoolCalendarsPOSTThis operation returns school calendars.
Setup Zone Categories5
Create or Update Zone CategoriescreateOrUpdateZoneCategoriesPOSTThis operation creates or updates zone categories according to the specified parameters.
Delete Zone CategoriesdeleteZoneCategoriesPOSTThis operation deletes one or more zone categories according to the specified parameters.
Delete Zone Category by IDdeleteZoneCategoryByIDDELETEThis operation deletes a zone category by ID.
Retrieve All Zone CategoriesretrieveAllZoneCategoriesGETThis operation retrieves all zone categories according to the query parameters.
Retrieve Zone Categories for SetupretrieveZoneCategoriesForSetupPOSTThis operation returns one or more zone categories according to the specified parameters.
SFTP Connections4
Retrieve All SFTP ConnectionsretrieveAllSFTPConnectionsGETThis operation returns all SFTP connection definitions.
Retrieve SFTP Connection by IDretrieveSFTPConnectionByIDGETThis operation returns an SFTP connection definition by ID.
Test SFTP Connection by IDtestSFTPConnectionByIDGETThis operation tests an SFTP connection by iHub connection definition ID.
Update SFTP Connections for IntegrationsupdateSFTPConnectionsForIntegrationsPOSTThis operation updates all installed integrations with the specified connection ID for the same integration process ID.
SHAP Value Metrics3
Calculate Feature DependencecalculateFeatureDependencePOSTThis operation returns pairs (SHAP value, feature value) for a given feature.
Calculate Feature ImportancecalculateFeatureImportancePOSTThis operation returns the mean of absolute SHAP values for all corresponding feature object references.
Extract Local ExplainerextractLocalExplainerPOSTThis operation returns the feature object reference, feature value, and SHAP value for a given date.
Shift Groups6
Create Shift GroupcreateShiftGroupPOSTThis operation creates a shift group.
Delete Shift Group by IDdeleteShiftGroupByIDDELETEThis operation deletes a shift group by ID.
Retrieve Shift Group by IDretrieveShiftGroupByIDGETThis operation returns a shift group by ID.
Retrieve Shift Group by NameretrieveShiftGroupByNameGETThis operation returns a shift group by name.
Retrieve Shift GroupsretrieveShiftGroupsPOSTThis operation returns one or more shift groups according to the specified properties.
Update Shift GroupupdateShiftGroupPOSTThis operation updates a shift group, including information such as name, shifts to be added and shifts to be removed.
Shift Profile Sets9
Create Shift Profile SetcreateShiftProfileSetPOSTThis operation creates a shift profile set.
Create Shift Profile SetscreateShiftProfileSetsPOSTThis operation creates one or more shift profile sets.
Delete Shift Profile Set by IDdeleteShiftProfileSetByIDDELETEThis operation deletes a shift profile set by ID.
Delete Shift Profile SetsdeleteShiftProfileSetsPOSTThis operation deletes one or more shift profile sets.
Retrieve All Shift Profile Sets or by NameretrieveAllShiftProfileSetsOrByNameGETThis operation returns all shift profile sets or one by name.
Retrieve Shift Profile Set by IDretrieveShiftProfileSetByIDGETThis operation returns a shift profile set by ID.
Retrieve Shift Profile SetsretrieveShiftProfileSetsPOSTThis operation returns one or more shift profile sets by object references.
Update Shift Profile Set by IDupdateShiftProfileSetByIDPUTThis operation updates a shift profile set by ID.
Update Shift Profile SetsupdateShiftProfileSetsPOSTThis operation updates one or more shift profile sets.
Shift Profiles9
Create Shift ProfilecreateShiftProfilePOSTThis operation creates a shift profile.
Create Shift ProfilescreateShiftProfilesPOSTThis operation creates one or more shift profiles.
Delete Shift Profile by IDdeleteShiftProfileByIDDELETEThis operation deletes a shift profile by ID.
Delete Shift ProfilesdeleteShiftProfilesPOSTThis operation deletes one or more shift profiles.
Retrieve All Shift Profiles or by NameretrieveAllShiftProfilesOrByNameGETThis operation returns all shift profiles or one by name.
Retrieve Shift Profile by IDretrieveShiftProfileByIDGETThis operation returns a shift profile by ID.
Retrieve Shift ProfilesretrieveShiftProfilesPOSTThis operation returns one or more shift profiles by object references.
Update Shift Profile by IDupdateShiftProfileByIDPUTThis operation updates a shift profile by ID.
Update Shift ProfilesupdateShiftProfilesPOSTThis operation updates one or more shift profiles.
Shift Template Profile Assignments7
Delete Shift Template Profile Assignment by Person IDdeleteShiftTemplateProfileAssignmentByPersonIDDELETEThis operation deletes a shift template profile assignment by person ID.
Delete Shift Template Profile AssignmentsdeleteShiftTemplateProfileAssignmentsPOSTThis operation deletes one or more shift template profile assignments.
Retrieve Shift Template Profile AssignmentsretrieveShiftTemplateProfileAssignmentsPOSTThis operation returns one or more shift template profile assignments by object references.
Retrieve Shift Template Profile Assignments by Person IDretrieveShiftTemplateProfileAssignmentsByPersonIDGETThis operation returns shift template profile assignments by person ID.
Retrieve Shift Template Profile Assignments by Person NumberretrieveShiftTemplateProfileAssignmentsByPersonNumberGETThis operation returns shift template profile assignments by person number.
Update Shift Template Profile Assignment by Person IDupdateShiftTemplateProfileAssignmentByPersonIDPUTThis operation updates a shift template profile assignment by person ID.
Update Shift Template Profile AssignmentsupdateShiftTemplateProfileAssignmentsPOSTThis operation updates shift template profile assignments for one or more persons.
Shift Template Profiles9
Create Shift Template ProfilecreateShiftTemplateProfilePOSTThis operation creates a shift template profile.
Create Shift Template ProfilescreateShiftTemplateProfilesPOSTThis operation creates one or more shift template profiles.
Delete Shift Template Profile by IDdeleteShiftTemplateProfileByIDDELETEThis operation deletes a shift template profile by ID.
Delete Shift Template ProfilesdeleteShiftTemplateProfilesPOSTThis operation deletes one or more shift template profiles.
Retrieve All Shift Template Profiles or by NameretrieveAllShiftTemplateProfilesOrByNameGETThis operation returns a list of all shift template profiles or returns a single shift template profile by name.
Retrieve Shift Template Profile by IDretrieveShiftTemplateProfileByIDGETThis operation returns a shift template profile by ID.
Retrieve Shift Template ProfilesretrieveShiftTemplateProfilesPOSTThis operation returns one or more shift template profiles by object references.
Update Shift Template Profile by IDupdateShiftTemplateProfileByIDPUTThis operation updates a shift template profile by ID.
Update Shift Template ProfilesupdateShiftTemplateProfilesPOSTThis operation updates one or more shift template profiles.
Shift Templates10
Create Shift TemplatecreateShiftTemplatePOSTThis operation creates a Shift Template.
Create Shift TemplatescreateShiftTemplatesPOSTThis operation creates a set of Shift Templates.
Delete Shift Template by IDdeleteShiftTemplateByIDDELETEThis operation deletes a Shift Template by ID.
Delete Shift TemplatesdeleteShiftTemplatesPOSTThis operation deletes one or more Shift Templates according to the parameters provided.
Retrieve or Create Shift TemplatesretrieveOrCreateShiftTemplatesPOSTThis operation returns or creates a set of Shift Templates given an equivalent Shift Template.
Retrieve Shift Template by IDretrieveShiftTemplateByIDGETThis operation returns a Shift Template by ID.
Retrieve Shift Template by NameretrieveShiftTemplateByNameGETThis operation returns a Shift Template by name.
Retrieve Shift TemplatesretrieveShiftTemplatesPOSTThis operation returns specific Shift Templates by object references or all Shift Templates if no references are given.
Update Shift Template by IDupdateShiftTemplateByIDPUTThis operation updates a Shift Template by ID.
Update Shift TemplatesupdateShiftTemplatesPUTThis operation updates one or more Shift Templates.
Shifts10
Create ShiftcreateShiftPOSTThis operation creates a shift according to the parameters provided.
Create ShiftscreateShiftsPOSTThis operation creates one or more shifts.
Create Shifts from PatternscreateShiftsFromPatternsPOSTThis operation creates one or more shifts according to the parameters provided.
Delete Shift by IDdeleteShiftByIDDELETEThis operation deletes a shift by ID.
Delete ShiftsdeleteShiftsPOSTThis operation deletes one or more shifts according to the parameters provided.
Retrieve Shift by IDretrieveShiftByIDGETThis operation returns a shift by ID.
Retrieve ShiftsretrieveShiftsPOSTThis operation returns one or more shifts according to the parameters provided.
Update Shift by IDupdateShiftByIDPOSTThis operation updates a shift by ID.
Update ShiftsupdateShiftsPOSTThis operation updates one or more shifts according to the IDs provided.
Update Shifts with CriteriaupdateShiftsWithCriteriaPOSTThis operation updates one or more shifts according to the parameters provided.
Sign-off Preparation6
Bulk Disable Sign-off PreparationbulkDisableSignOffPreparationPOSTThis operation disables sign-off preparation for one or more the employees.
Bulk Enable Sign-off PreparationbulkEnableSignOffPreparationPOSTThis operation enables sign-off preparation for one or more employees.
Bulk Retrieve Sign-off Preparation StatusbulkRetrieveSignOffPreparationStatusPOSTThis operation returns the sign-off preparation status of one or more employees.
Disable Sign-off Preparation by IDdisableSignOffPreparationByIDDELETEThis operation disables sign-off preparation for an employee by employee ID or person number.
Enable Sign-off Preparation by IDenableSignOffPreparationByIDPOSTThis operation enables sign-off preparation for an employee by employee ID or person number.
Retrieve Sign-off Preparation Status by IDretrieveSignOffPreparationStatusByIDGETThis operation returns the sign-off preparation status of an employee by employee ID or person number.
Signoffs for Employee3
Delete Employee Timecard Signoff as EmployeedeleteEmployeeTimecardSignoffAsEmployeeDELETEThis operation deletes (removes) an employee timecard sign-off.
Retrieve Signoffs as EmployeeretrieveSignoffsAsEmployeeGETThis operation returns a list of all timecard sign-off information for the specified date range.
Sign Off Employee Timecard as EmployeesignOffEmployeeTimecardAsEmployeePOSTThis operation signs off an employee timecard for a specified timeframe.
Signoffs for Manager4
Delete Employee Timecard Signoff as ManagerdeleteEmployeeTimecardSignoffAsManagerDELETEThis operation deletes (removes) an employee timecard sign-off.
Retrieve Automatic Signoff StatusretrieveAutomaticSignoffStatusGETThis operation returns a list of all timecard sign-off information for the specified date range.
Retrieve Signoffs as ManagerretrieveSignoffsAsManagerGETThis operation returns a list of all timecard sign-off information for the specified date range.
Sign Off Employee Timecard as ManagersignOffEmployeeTimecardAsManagerPOSTThis operation signs off an employee timecard for a specified timeframe.
Skill and Certificate Profiles9
Create Skill and Certification ProfilecreateSkillAndCertificationProfilePOSTThis operation creates a Skill and Certification Profile.
Create Skill and Certification ProfilescreateSkillAndCertificationProfilesPOSTThis operation creates one or more Skill and Certification Profiles.
Delete Skill and Certification Profile by IDdeleteSkillAndCertificationProfileByIDDELETEThis operation deletes a Skill and Certification Profile by ID.
Delete Skill and Certification ProfilesdeleteSkillAndCertificationProfilesPOSTThis operation deletes one or more Skill and Certification Profiles.
Retrieve All Skill and Certification Profiles or by NameretrieveAllSkillAndCertificationProfilesOrByNameGETThis operation returns all Skill and Certification Profiles if no parameter is specified or a particular Skill and Certification Profile if a name is provided.
Retrieve Skill and Certification Profile by IDretrieveSkillAndCertificationProfileByIDGETThis operation returns a Skill and Certification Profile by ID.
Retrieve Skill and Certification ProfilesretrieveSkillAndCertificationProfilesPOSTThis operation returns one or more Skill and Certification Profiles.
Update Skill and Certification ProfileupdateSkillAndCertificationProfilePUTThis operation updates a Skill and Certification Profile by ID.
Update Skill and Certification ProfilesupdateSkillAndCertificationProfilesPOSTThis operation updates one or more Skill and Certification Profiles.
Skill Assignments6
Delete Skill AssignmentsdeleteSkillAssignmentsPOSTThis operation deletes one or more skill assignments for a person.
Retrieve All Skill AssignmentsretrieveAllSkillAssignmentsPOSTThis operation returns all of a person's skill assignments.
Retrieve Skill Assignments by IDretrieveSkillAssignmentsByIDGETThis operation returns a person's skill assignments by person ID.
Retrieve Skill Assignments by Person NumberretrieveSkillAssignmentsByPersonNumberGETThis operation returns a person's skill assignments by person number.
Update Skill Assignment by IDupdateSkillAssignmentByIDPUTThis operation updates one skill assignment by person ID.
Update Skill AssignmentsupdateSkillAssignmentsPOSTThis operation updates multiple skill assignments for one or more persons.
Skills Setup9
Create SkillcreateSkillPOSTThis operation creates a skill.
Create SkillscreateSkillsPOSTThis operation creates multiple skills.
Delete Skill by IDdeleteSkillByIDDELETEThis operation deletes a skill by ID.
Delete SkillsdeleteSkillsPOSTThis operation deletes multiple skills.
Retrieve All Skills or by NameretrieveAllSkillsOrByNameGETThis operation returns a list of all skills or a single skill by name.
Retrieve Skill by IDretrieveSkillByIDGETThis operation returns a skill by ID.
Retrieve SkillsretrieveSkillsPOSTThis operation returns multiple skills.
Update Skill by IDupdateSkillByIDPUTThis operation updates a skill by ID.
Update SkillsupdateSkillsPOSTThis operation updates multiple skills.
Special Event Assignments4
Create Special Event AssignmentscreateSpecialEventAssignmentsPOSTThis operation creates special event assignments for multiple categories and special events.
Delete Special Event AssignmentsdeleteSpecialEventAssignmentsPOSTThis operation deletes special event assignments for multiple categories and special events.
Retrieve Special Event AssignmentsretrieveSpecialEventAssignmentsPOSTThis operation returns special event assignments by references to categories.
Retrieve Special Event Assignments by CategoryretrieveSpecialEventAssignmentsByCategoryGETThis operation returns special event assignments by category and date span.
Special Events9
Create a Special EventcreateASpecialEventPOSTThis operation creates a special event.
Create Special EventscreateSpecialEventsPOSTThis operation creates special events.
Delete Special Event by IDdeleteSpecialEventByIDDELETEThis operation deletes a Special Event object by ID.
Delete Special EventsdeleteSpecialEventsPOSTThis operation deletes a list of Special Event objects.
Retrieve a Special Event by IDretrieveASpecialEventByIDGETThis operation returns a special event by ID.
Retrieve All Special EventsretrieveAllSpecialEventsGETThis operation returns all special events.
Retrieve Special EventsretrieveSpecialEventsPOSTThis operation returns special events.
Update Special Event by IDupdateSpecialEventByIDPUTThis operation updates and returns a Special Event object by ID.
Update Special EventsupdateSpecialEventsPOSTThis operation updates and returns a list of Special Event objects.
Staffing Dashboard Settings15
Create Multiple Staffing Dashboard SettingscreateMultipleStaffingDashboardSettingsPOSTThis operation creates one or more Staffing Dashboard Settings.
Create Staffing Dashboard SettingscreateStaffingDashboardSettingsPOSTThis operation creates a Staffing Dashboard Settings.
Delete Staffing Dashboard SettingsdeleteStaffingDashboardSettingsPOSTThis operation deletes one or more Staffing Dashboard Settings.
Delete Staffing Dashboard Settings by IDdeleteStaffingDashboardSettingsByIDDELETEThis operation deletes a Staffing Dashboard Settings by ID.
Retrieve All Colorized EntitiesretrieveAllColorizedEntitiesGETThis operation returns a list of all Colorized Entities.
Retrieve All Employee Pool Additional Data EntitiesretrieveAllEmployeePoolAdditionalDataEntitiesGETThis operation returns a list of all Employee Pool Additional Data Entities.
Retrieve All Staffing Dashboard Settings or by NameretrieveAllStaffingDashboardSettingsOrByNameGETThis operation returns a list of all Staffing Dashboard Settings or a single Staffing Dashboard Settings by name.
Retrieve All Summary View ColumnsretrieveAllSummaryViewColumnsGETThis operation returns a list of all Summary View Columns.
Retrieve All Summary View ModesretrieveAllSummaryViewModesGETThis operation returns a list of all Summary View Modes.
Retrieve All Unit Panel Additional Data EntitiesretrieveAllUnitPanelAdditionalDataEntitiesGETThis operation returns a list of all Unit Panel Additional Data Entities.
Retrieve Schedule Change Notification OptionsretrieveScheduleChangeNotificationOptionsGETThis operation returns the 'Notify employees of changes to posted schedule' drop-down values from the Staffing Dashboard setup menu.
Retrieve Staffing Dashboard SettingsretrieveStaffingDashboardSettingsPOSTThis operation returns one or more Staffing Dashboard Settings.
Retrieve Staffing Dashboard Settings by IDretrieveStaffingDashboardSettingsByIDGETThis operation returns a Staffing Dashboard Settings by ID.
Update Staffing Dashboard SettingsupdateStaffingDashboardSettingsPOSTThis operation updates one or more Staffing Dashboard Settings.
Update Staffing Dashboard Settings by IDupdateStaffingDashboardSettingsByIDPUTThis operation updates a Staffing Dashboard Settings by ID.
Staffing Matrices9
Create Staffing MatricescreateStaffingMatricesPOSTThis operation creates and returns a collection of staffing matrices.
Create Staffing MatrixcreateStaffingMatrixPOSTThis operation creates and returns a staffing matrix.
Delete Staffing MatricesdeleteStaffingMatricesPOSTThis operation deletes a collection of staffing matrices.
Delete Staffing Matrix by IDdeleteStaffingMatrixByIDDELETEThis operation deletes a staffing matrix by ID.
Retrieve All Staffing Matrices or by NameretrieveAllStaffingMatricesOrByNameGETThis operation returns all staffing matrices or a particular staffing matrix if a name is provided.
Retrieve Staffing MatricesretrieveStaffingMatricesPOSTThis operation returns a collection of staffing matrices by object references or references to locations.
Retrieve Staffing Matrix by IDretrieveStaffingMatrixByIDGETThis operation returns a staffing matrix by ID.
Update Staffing MatricesupdateStaffingMatricesPOSTThis operation updates and returns a collection of staffing matrices.
Update Staffing Matrix by IDupdateStaffingMatrixByIDPUTThis operation updates and returns a staffing matrix by ID.
Staffing Profiles9
Create Staffing ProfilecreateStaffingProfilePOSTThis operation creates a staffing profile.
Create Staffing ProfilescreateStaffingProfilesPOSTThis operation creates one or more staffing profiles.
Delete Staffing Profile by IDdeleteStaffingProfileByIDDELETEThis operation deletes a staffing profile by ID.
Delete Staffing ProfilesdeleteStaffingProfilesPOSTThis operation deletes one or more staffing profiles.
Retrieve All Staffing Profiles or by NameretrieveAllStaffingProfilesOrByNameGETThis operation returns a list of all staffing profiles or a single staffing profile by name.
Retrieve Staffing Profile by IDretrieveStaffingProfileByIDGETThis operation returns a staffing profile by ID.
Retrieve Staffing ProfilesretrieveStaffingProfilesPOSTThis operation returns one or more staffing profiles.
Update Staffing Profile by IDupdateStaffingProfileByIDPUTThis operation updates a staffing profile by ID.
Update Staffing ProfilesupdateStaffingProfilesPOSTThis operation updates one or more staffing profiles.
Standard Shift Set Assignments5
Create or Update Standard Shift Set Location AssignmentscreateOrUpdateStandardShiftSetLocationAssignmentsPOSTThis operation creates or updates standard shift set location assignments by object references.
Delete Standard Shift Set Location AssignmentsdeleteStandardShiftSetLocationAssignmentsPOSTThis operation deletes standard shift set location assignments.
Delete Standard Shift Set Location Assignments by Shift SetdeleteStandardShiftSetLocationAssignmentsByShiftSetPOSTThis operation deletes all standard shift set location assignments associated with the specified standard shift set.
Retrieve Shift Set AssignmentsretrieveShiftSetAssignmentsPOSTThis operation returns a list of shift set assignments by references to locations.
Retrieve Standard Shift Set Location Assignments with LocationsretrieveStandardShiftSetLocationAssignmentsWithLocationsPOSTThis operation returns a list of shift set assignments (including the associated location sets) by references to locations.
Standard Shift Sets9
Create Standard Shift SetcreateStandardShiftSetPOSTThis operation creates a standard shift set.
Create Standard Shift SetscreateStandardShiftSetsPOSTThis operation creates one or more standard shift sets.
Delete Standard Shift Set by IDdeleteStandardShiftSetByIDDELETEThis operation deletes a standard shift set by ID.
Delete Standard Shift SetsdeleteStandardShiftSetsPOSTThis operation deletes one or more standard shift sets.
Retrieve All Standard Shift Sets or by NameretrieveAllStandardShiftSetsOrByNameGETThis operation returns a list of all standard shift sets or a single standard shift set by name.
Retrieve Standard Shift SetsretrieveStandardShiftSetsPOSTThis operation returns a list of shift sets by references to locations.
Retrieve Standard Shift Sets by IDretrieveStandardShiftSetsByIDGETThis operation returns a standard shift set by ID.
Update Standard Shift Set by IDupdateStandardShiftSetByIDPUTThis operation updates a standard shift set by ID.
Update Standard Shift SetsupdateStandardShiftSetsPOSTThis operation updates one or more standard shift sets.
Start Attestation Process1
Start an Attestation ProcessstartAnAttestationProcessPOSTThis operation processes an Attestation request.
Start Offline Attestation Process1
Start an Offline Attestation ProcessstartAnOfflineAttestationProcessPOSTThis operation processes an Attestation request offline.
Static Driver Assignments5
Create Static Driver AssignmentscreateStaticDriverAssignmentsPOSTThis operation creates Static Driver Assignments.
Delete Static Driver AssignmentsdeleteStaticDriverAssignmentsPOSTThis operation deletes Static Driver Assignments.
Retrieve Static Driver AssignmentsretrieveStaticDriverAssignmentsPOSTThis operation returns Static Driver Assignments.
Retrieve Static Driver Assignments by CategoryretrieveStaticDriverAssignmentsByCategoryGETThis operation returns Static Driver Assignments for a category and defined start and end dates.
Update Static Driver AssignmentsupdateStaticDriverAssignmentsPOSTThis operation updates Static Driver Assignments.
Static Drivers4
Retrieve All Static Drivers or by NameretrieveAllStaticDriversOrByNameGETThis operation returns all Static Drivers or a particular Static Driver if Name is provided.
Retrieve All Static Drivers or by Name (Deprecated)retrieveAllStaticDriversOrByNameDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/static drivers.
Retrieve Static Driver by IDretrieveStaticDriverByIDGETThis operation returns a Static Driver by ID.
Retrieve Static Driver by ID (Deprecated)retrieveStaticDriverByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/static drivers/{id}.
Supervisor Assignments3
Add or Update Supervisor Assignment for Multiple EmployeesaddOrUpdateSupervisorAssignmentForMultipleEmployeesPOSTThis operation updates the assignment of a supervisor (or 'reports to' employee) to one or more employees.
Retrieve Supervisor Assignments by Person IDretrieveSupervisorAssignmentsByPersonIDGETThis operation returns the supervisor (or 'reports to' employee) assigned to an employee by person ID.
Retrieve Supervisor Assignments for Multiple EmployeesretrieveSupervisorAssignmentsForMultipleEmployeesPOSTThis operation returns the supervisors (or 'reports to' employees) assigned to one or more employees.
Swap Recommendation Messages3
Retrieve Swap Recommendation Message by IDretrieveSwapRecommendationMessageByIDGETThis operation returns a swap recommendation message by ID.
Retrieve Swap Recommendation Message by NameretrieveSwapRecommendationMessageByNameGETThis operation returns a swap recommendation message by name.
Retrieve Swap Recommendation MessagesretrieveSwapRecommendationMessagesPOSTThis operation returns one or more swap recommendation messages by object references.
Swap Recommendations Settings Profiles6
Create Swap Recommendations Settings ProfilecreateSwapRecommendationsSettingsProfilePOSTThis operation creates a swap recommendations settings profile.
Delete Swap Recommendations Settings ProfiledeleteSwapRecommendationsSettingsProfileDELETEThis operation deletes a swap recommendations settings profile.
Retrieve All Swap Recommendations Settings Profiles or by NameretrieveAllSwapRecommendationsSettingsProfilesOrByNameGETThis operation returns a list of all swap recommendations settings profiles or a single profile by name.
Retrieve Swap Recommendations Settings Profile by IDretrieveSwapRecommendationsSettingsProfileByIDGETThis operation returns a swap recommendations settings profile by ID.
Retrieve Swap Recommendations Settings ProfilesretrieveSwapRecommendationsSettingsProfilesPOSTThis operation returns a list of swap recommendations settings profiles by object references.
Update Swap Recommendations Settings ProfileupdateSwapRecommendationsSettingsProfilePUTThis operation updates a swap recommendations settings profile.
Switch Employment1
Switch EmploymentswitchEmploymentPOSTThis operation switches between different employments for an employee.
Symbolic Periods6
Retrieve Date Span Grouped by Symbol TyperetrieveDateSpanGroupedBySymbolTypePOSTThis operation returns a map of date spans grouped by symbol type.
Retrieve Locale Date SpanretrieveLocaleDateSpanPOSTThis operation returns a locale date span, or symbolic period, according to the data provided.
Retrieve Symbolic Period TypesretrieveSymbolicPeriodTypesGETThis operation returns all period types in the system.
Retrieve Symbolic PeriodsretrieveSymbolicPeriodsGETThis operation returns all symbolic periods in the system.
Retrieve Symbolic Periods by Period Type IDretrieveSymbolicPeriodsByPeriodTypeIDGETThis operation returns a list of all symbolic periods for the period type specified by the provided ID.
Retrieve Symbolic Periods Grouped by TyperetrieveSymbolicPeriodsGroupedByTypePOSTThis operation returns a map of symbolic periods grouped by type for the requested period types list.
Symbolic Purposes5
Create Symbolic PurposecreateSymbolicPurposePOSTThis operation creates a symbolic purpose.
Delete Symbolic Purpose by IDdeleteSymbolicPurposeByIDDELETEThis operation deletes a symbolic purpose by ID.
Retrieve All Symbolic Purposes or by Name or TyperetrieveAllSymbolicPurposesOrByNameOrTypeGETThis operation returns all symbolic purposes if the fetch all query parameter is passed as true, a filtered list of symbolic purposes if name or type is specified, or a filtered list of...
Retrieve Symbolic Purpose by IDretrieveSymbolicPurposeByIDGETThis operation returns a symbolic purpose by ID.
Update Symbolic Purpose by IDupdateSymbolicPurposeByIDPUTThis operation updates a symbolic purpose by ID.
Symbolic Reviewers and Listeners1
Retrieve Symbolic Reviewers and ListenersretrieveSymbolicReviewersAndListenersPOSTThis operations returns symbolic reviewers and listeners.
Symbolic Source Types3
Retrieve All Symbolic Source Types or by NameretrieveAllSymbolicSourceTypesOrByNameGETThis operation returns a list of all symbolic source types or a single type by name.
Retrieve Symbolic Source Type by IDretrieveSymbolicSourceTypeByIDGETThis operation returns a symbolic source type by ID.
Retrieve Symbolic Source TypesretrieveSymbolicSourceTypesPOSTThis operation returns symbolic source types.
Tag Definitions7
Create Tag DefinitioncreateTagDefinitionPOSTThis operation creates a tag definition according to the data provided.
Delete Tag Definition by IDdeleteTagDefinitionByIDDELETEThis operation deletes a tag definition by ID.
Retrieve Tag Definition by IDretrieveTagDefinitionByIDGETThis operation returns a tag definition by ID.
Retrieve Tag Definition by NameretrieveTagDefinitionByNameGETThis operation returns a tag definition by name.
Retrieve Tag Definitions with CriterionretrieveTagDefinitionsWithCriterionPOSTThis operation returns tag definitions by references, by assignment context, or returns all tag definitions.
Update (Replace) Tag Definition by IDupdateReplaceTagDefinitionByIDPOSTThis operation updates a tag definition by ID.
Update Tag Definition by IDupdateTagDefinitionByIDPUTThis operation updates a tag definition by ID.
Target Threshold Evaluation Period1
Retrieve Target Threshold Evaluation PeriodretrieveTargetThresholdEvaluationPeriodGETThis operation returns the target threshold evaluation period.
Target Threshold Indicator Texts1
Retrieve All Target Threshold Indicator TextsretrieveAllTargetThresholdIndicatorTextsGETThis operation returns all target threshold indicator texts.
Target Threshold Metric Sets1
Retrieve All Target Threshold Metric SetsretrieveAllTargetThresholdMetricSetsGETThis operation returns all target threshold metric sets.
Target Threshold Operators1
Retrieve All Target Threshold OperatorsretrieveAllTargetThresholdOperatorsGETThis operation returns all target threshold operators.
Target Thresholds9
Create or Update Target ThresholdscreateOrUpdateTargetThresholdsPOSTThis operation creates or updates one or more target thresholds.
Create Target ThresholdcreateTargetThresholdPOSTThis operation creates a target threshold.
Delete an expired HCA Target Threshold by IDdeleteAnExpiredHCATargetThresholdByIDDELETEThis operation deletes an expired HCA target threshold by ID.
Export Target Threshold DataexportTargetThresholdDataGETThis operation exports target threshold data.
Retrieve Target Short NamesretrieveTargetShortNamesGETThis operation returns target short names based on the target type specified in the query parameter.
Retrieve Target Threshold by IDretrieveTargetThresholdByIDGETThis operation returns a target threshold by ID.
Retrieve Target ThresholdsretrieveTargetThresholdsPOSTThis operation returns one or more target thresholds by object references.
Retrieve Target Thresholds by CriteriaretrieveTargetThresholdsByCriteriaGETThis operation returns target thresholds by name, type, and starting and ending index values.
Update a Target Threshold by IDupdateATargetThresholdByIDPUTThis operation updates a target threshold by ID.
Task Groups20
Create Task GroupcreateTaskGroupPOSTThis operation creates a task group.
Create Task Group (Deprecated)createTaskGroupDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/task groups.
Create Task GroupscreateTaskGroupsPOSTThis operation creates one or more task groups.
Create Task Groups (Deprecated)createTaskGroupsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/task groups/multi create.
Delete Task Group by IDdeleteTaskGroupByIDDELETEThis operation deletes a task group by ID.
Delete Task Group by ID (Deprecated)deleteTaskGroupByIDDeprecatedDELETEThis operation is deprecated; instead use DELETE /v2/forecasting/task groups/{id}.
Delete Task Group Effective Version by CriteriadeleteTaskGroupEffectiveVersionByCriteriaPOSTThis operation deletes a task group effective version by ID and effective date and returns the task group along with the remaining effective versions.
Delete Task GroupsdeleteTaskGroupsPOSTThis operation deletes one or more task groups.
Delete Task Groups (Deprecated)deleteTaskGroupsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/task groups/multi delete.
Retrieve a Task Group by IDretrieveATaskGroupByIDGETThis operation returns a Task Group by ID.
Retrieve a Task Group by ID (Deprecated)retrieveATaskGroupByIDDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/task groups/{id}.
Retrieve All Task Groups or by Name or Generic DepartmentretrieveAllTaskGroupsOrByNameOrGenericDepartmentGETThis operation returns task groups by name or generic department.
Retrieve Task GroupsretrieveTaskGroupsPOSTThis operation returns one or more task groups by generic department or object references.
Retrieve Task Groups (Deprecated)retrieveTaskGroupsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/task groups/multi read.
Retrieve Task Groups by CriteriaretrieveTaskGroupsByCriteriaPOSTThis operation returns task groups with a single effective version that intersects the specified effective date and have at least one job assigned from the list of jobs specified in the...
Retrieve Task Groups by Name or Generic Department (Deprecated)retrieveTaskGroupsByNameOrGenericDepartmentDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/task groups.
Update Task Group by IDupdateTaskGroupByIDPUTThis operation updates a task group by ID.
Update Task Group by ID (Deprecated)updateTaskGroupByIDDeprecatedPUTThis operation is deprecated; instead use PUT /v2/forecasting/task groups/{id}.
Update Task GroupsupdateTaskGroupsPOSTThis operation updates one or more task groups.
Update Task Groups (Deprecated)updateTaskGroupsDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/task groups/multi update.
Team Definitions6
Create Team DefinitioncreateTeamDefinitionPOSTThis operation creates a team definition according to the data provided.
Delete Team Definition by IDdeleteTeamDefinitionByIDDELETEThis operation deletes a team definition by ID.
Retrieve Team Definition By IDretrieveTeamDefinitionByIDGETThis operation returns a team definition by ID.
Retrieve Team Definition by NameretrieveTeamDefinitionByNameGETThis operation returns a team definition by name.
Retrieve Team Definitions with CriterionretrieveTeamDefinitionsWithCriterionPOSTThis operation returns team definitions by team definition references or by employee references within a date range.
Update Team Definition by IDupdateTeamDefinitionByIDPUTThis operation updates a team definition by ID.
Team Segments Net Changes1
Retrieve Net Changes for Team SegmentsretrieveNetChangesForTeamSegmentsPOSTThis operation returns Team Segments.
Team Transactions1
Retrieve Team TransactionsretrieveTeamTransactionsPOSTThis operation returns a list of team transactions for the specified team.
TeleTime IP User Profiles1
Retrieve TeleTime IP User ProfilesretrieveTeleTimeIPUserProfilesGETThis operation returns a list of all TeleTime IP User Profiles in the system.
Tenant Information1
Retrieve Tenant InformationretrieveTenantInformationGETThis operation returns tenant information, including the authentication type of the tenant, based on the current logged-in user.
Tiles5
Create Admin TilecreateAdminTilePOSTThis operation creates an Admin Tile.
Delete Admin Tile by IDdeleteAdminTileByIDDELETEThis operation deletes an Admin Tile by ID.
Retrieve Tile by IDretrieveTileByIDGETThis operation returns a tile by ID.
Retrieve TilesretrieveTilesGETThis operation returns all tiles.
Update Admin Tile by IDupdateAdminTileByIDPUTThis operation updates an Admin Tile by ID.
Time Increment Resolver1
Resolve Time IncrementsresolveTimeIncrementsPOSTThis operation resolves the start and end dates of a specified time increment.
Time Off Request Guided Recommendations1
Retrieve Guided RecommendationsretrieveGuidedRecommendationsPOSTThis operation returns guided recommendations records based on the specified criteria.
Time-Off Rules1
Retrieve All Time-Off RulesretrieveAllTimeOffRulesGETThis operation returns all time-off rules according to the current user's access rights.
Timecard Add-On Columns1
Retrieve Timecard Add-On ColumnsretrieveTimecardAddOnColumnsGETThis operation returns Timecard Add-On columns by Timecard Add-On type.
Timecard Add-On Group Options1
Retrieve Timecard Add-On Group OptionsretrieveTimecardAddOnGroupOptionsGETThis operation returns Timecard Add-On group options by Timecard Add-On type.
Timecard Add-On Profiles5
Create Timecard Add-On ProfilecreateTimecardAddOnProfilePOSTThis operation creates a Timecard Add-On profile.
Delete Timecard Add-On Profile by IDdeleteTimecardAddOnProfileByIDDELETEThis operation deletes a Timecard Add-On profile by ID.
Retrieve All Timecard Add-On ProfilesretrieveAllTimecardAddOnProfilesGETThis operation returns a list of all Timecard Add-On profiles.
Retrieve Timecard Add-On Profile by IDretrieveTimecardAddOnProfileByIDGETThis operation returns a Timecard Add-On profile by ID.
Update Timecard Add-On Profile by IDupdateTimecardAddOnProfileByIDPUTThis operation updates a Timecard Add-On profile by ID.
Timecard Add-On Types1
Retrieve Timecard Add-On TypesretrieveTimecardAddOnTypesGETThis operation returns Timecard Add-On types.
Timecard Annotations3
Create Timecard AnnotationcreateTimecardAnnotationPOSTThis operation adds a timecard annotation.
Delete Timecard AnnotationdeleteTimecardAnnotationDELETEThis operation deletes a timecard annotation for an employee within a date range.
Retrieve Timecard AnnotationretrieveTimecardAnnotationGETThis operation returns a timecard annotation for an employee within a date range.
Timecard Approval Methods1
Retrieve Timecard Approval MethodsretrieveTimecardApprovalMethodsGETThis operation returns a list of available timecard approval methods.
Timecard Approvals for Employee3
Approve Timecard as EmployeeapproveTimecardAsEmployeePOSTThis operation adds employee timecard approval for the logged-in employee and given date range.
Remove Timecard Approvals as EmployeeremoveTimecardApprovalsAsEmployeeDELETEThis operation deletes/removes timecard approvals for the logged-in employee and given date range.
Retrieve Timecard Approvals as EmployeeretrieveTimecardApprovalsAsEmployeeGETThis operation returns a list of timecard approvals within a date range.
Timecard Approvals for Manager3
Approve Timecard as ManagerapproveTimecardAsManagerPOSTThis operation adds manager timecard approval for the given employee and date range.
Remove Timecard Approvals as ManagerremoveTimecardApprovalsAsManagerDELETEThis operation deletes/removes manager timecard approvals for the given employee and date range.
Retrieve Timecard Approvals as ManagerretrieveTimecardApprovalsAsManagerGETThis operation returns a list of timecard approvals within a date range.
Timecard Changes4
Retrieve Timecard Change by IDretrieveTimecardChangeByIDGETThis operation returns a timecard change by ID.
Retrieve Timecard ChangesretrieveTimecardChangesGETThis operation returns a list of timecard changes for the specified search criteria.
Update Timecard Change StatusupdateTimecardChangeStatusPUTThis operation updates the status of a timecard change.
Update Timecard Change StatusesupdateTimecardChangeStatusesPOSTThis operation updates the statuses associated with one or more timecard changes.
Timecard Changes for Reports1
Retrieve Timecard Changes for ReportsretrieveTimecardChangesForReportsPOSTThis operation returns a list of timecard changes designed to use in Reports for the specified search criteria.
Timecard Metrics1
Retrieve Timecard Data for Multiple EmployeesretrieveTimecardDataForMultipleEmployeesPOSTThis operation returns timecard data for a set of employees.
Timecard Settings6
Create Timecard SettingcreateTimecardSettingPOSTThis operation creates a Timecard setting.
Delete Timecard Setting by IDdeleteTimecardSettingByIDDELETEThis operation deletes a Timecard setting by ID.
Retrieve All Timecard SettingsretrieveAllTimecardSettingsGETThis operation returns a list of all Timecard settings.
Retrieve Timecard Setting by IDretrieveTimecardSettingByIDGETThis operation returns a Timecard setting by ID.
Retrieve Timecard SettingsretrieveTimecardSettingsPOSTThis operation returns a list of Timecard settings by object references.
Update Timecard Setting by IDupdateTimecardSettingByIDPUTThis operation updates a Timecard setting by ID.
Timecards6
Retrieve Timecard as EmployeeretrieveTimecardAsEmployeeGETThis operation returns an employee timecard.
Retrieve Timecard as ManagerretrieveTimecardAsManagerGETThis operation returns a manager timecard.
Retrieve Timecards as EmployeeretrieveTimecardsAsEmployeePOSTThis operation returns a list of timecards based on the employees or Hyperfind details provided.
Retrieve Timecards as ManagerretrieveTimecardsAsManagerPOSTThis operation returns a list of timecards based on the employees or Hyperfind details provided.
Update Timecard as EmployeeupdateTimecardAsEmployeePOSTThis operation updates a timecard for an employee as an employee.
Update Timecard as ManagerupdateTimecardAsManagerPOSTThis operation updates a timecard for an employee as a manager.
Timekeeping Alert Profiles3
Retrieve All Timekeeping Alert ProfilesretrieveAllTimekeepingAlertProfilesGETThis operation returns a list of all Timekeeping alert profiles.
Retrieve Timekeeping Alert Profile by IDretrieveTimekeepingAlertProfileByIDGETThis operation returns a Timekeeping alert profile by ID.
Retrieve Timekeeping Alert ProfilesretrieveTimekeepingAlertProfilesPOSTThis operation returns a list of Timekeeping alert profiles by object references.
Timekeeping Fixed Rules10
Create Fixed RulecreateFixedRulePOSTThis operation creates and returns a fixed rule.
Create Fixed RulescreateFixedRulesPOSTThis operation creates and returns fixed rules.
Create or Update Fixed RulescreateOrUpdateFixedRulesPOSTThis operation creates or updates one or more fixed rules.
Delete Fixed Rule by IDdeleteFixedRuleByIDDELETEThis operation deletes a fixed rule by ID.
Delete Fixed RulesdeleteFixedRulesPOSTThis operation deletes fixed rules by IDs, qualifiers, or object references.
Retrieve All Fixed RulesretrieveAllFixedRulesGETThis operation returns all fixed rules.
Retrieve Fixed Rule by IDretrieveFixedRuleByIDGETThis operation returns a fixed rule by ID.
Retrieve Fixed RulesretrieveFixedRulesPOSTThis operation returns fixed rules by IDs, qualifiers, or object references.
Update Fixed Rule by IDupdateFixedRuleByIDPUTThis operation updates and returns a fixed rule by ID.
Update Fixed RulesupdateFixedRulesPOSTThis operation updates and returns fixed rules.
Timekeeping Holidays3
Add or Remove HolidaysaddOrRemoveHolidaysPOSTThis operation adds or removes one or more holidays in the system.
Add or Update HolidaysaddOrUpdateHolidaysPOSTThis operation adds or updates one or more holidays in the system.
Retrieve All HolidaysretrieveAllHolidaysGETThis operation retrieves a list of holidays for the specified year.
Timekeeping Overtime Rules9
Create Overtime RulecreateOvertimeRulePOSTThis operation creates an Overtime Rule.
Create Overtime RulescreateOvertimeRulesPOSTThis operation creates one or more Overtime Rules.
Delete Overtime Rule by IDdeleteOvertimeRuleByIDDELETEThis operation deletes an Overtime Rule by ID.
Delete Overtime RulesdeleteOvertimeRulesPOSTThis operation deletes one or more Overtime Rules.
Retrieve All Overtime RulesretrieveAllOvertimeRulesGETReturns all of the Overtime Rules in the system.
Retrieve Overtime Rule by IDretrieveOvertimeRuleByIDGETThis operation returns a single Overtime Rule by ID.
Retrieve Overtime RulesretrieveOvertimeRulesPOSTThis operation returns a list of Overtime Rules by object references.
Update Overtime Rule by IDupdateOvertimeRuleByIDPUTThis operation updates an Overtime Rule by ID.
Update Overtime RulesupdateOvertimeRulesPOSTThis operation updates one or more Overtime Rules.
Timekeeping Pay Rules10
Create Timekeeping Pay RulecreateTimekeepingPayRulePOSTThis operation creates a Pay Rule.
Create Timekeeping Pay Rule (Deprecated)createTimekeepingPayRuleDeprecatedPOSTThis operation is deprecated; instead use POST /v2/timekeeping/setup/payrules.
Create Timekeeping Pay RulescreateTimekeepingPayRulesPOSTThis operation creates one or more Pay Rules.
Delete Timekeeping Pay Rule by IDdeleteTimekeepingPayRuleByIDDELETEThis operation deletes a Timekeeping Setup Pay Rule by ID.
Delete Timekeeping Pay RulesdeleteTimekeepingPayRulesPOSTThis operation deletes a list of Timekeeping Setup Pay Rules by object references.
Retrieve All Timekeeping Pay RulesretrieveAllTimekeepingPayRulesGETThis operation returns a list of all Timekeeping pay rules.
Retrieve All Timekeeping Pay Rules (Deprecated)retrieveAllTimekeepingPayRulesDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/payrules.
Retrieve Timekeeping Pay RulesretrieveTimekeepingPayRulesPOSTThis operation returns a list of pay rules by object references.
Update Timekeeping Pay Rule by IDupdateTimekeepingPayRuleByIDPUTThis operation updates a Pay Rule by ID.
Update Timekeeping Pay RulesupdateTimekeepingPayRulesPOSTThis operation updates one or more Pay Rules.
Timekeeping Setup1
Delete Break Rule by IDdeleteBreakRuleByIDDELETEThis operation deletes a break rule by ID.
Timestamps3
Add TimestampaddTimestampPOSTThis operation adds (or records) a timestamp for a punch transaction.
Retrieve MRU TransfersretrieveMRUTransfersGETThis operation returns a list of the most recently used (MRU) transfers for the current user.
Retrieve TimestampretrieveTimestampGETThis operation returns the last recorded timestamp.
Timezones3
Retrieve TimezoneretrieveTimezoneGETThis operation returns timezone details for the logged-in user or according to one of the following qualifiers: Timezone name Employee ID Person number Location ID
Retrieve Timezone by IDretrieveTimezoneByIDGETThis operation returns a timezone by ID.
Set TimezonesetTimezonePUTThis operation sets the timezone for a tenant.
Total Balance Policies2
Retrieve All Total Balance PoliciesretrieveAllTotalBalancePoliciesGETThis operation returns a list of all Total Balance Policies.
Retrieve Total Balance Policy by IDretrieveTotalBalancePolicyByIDGETThis operation returns a Total Balance Policy by ID.
Tracking Periods2
Retrieve All Tracking PeriodsretrieveAllTrackingPeriodsGETThis operation returns a list of all tracking periods in the system.
Retrieve Tracking Period by IDretrieveTrackingPeriodByIDGETThis operation returns a tracking period by ID.
Traffic Pattern Engine1
Execute Traffic Pattern EngineexecuteTrafficPatternEnginePOSTThis operation executes the traffic pattern engine.
Traffic Patterns3
Create Traffic PatternscreateTrafficPatternsPOSTThis operation creates one or more traffic patterns.
Delete Traffic PatternsdeleteTrafficPatternsPOSTThis operation deletes one or more traffic patterns.
Retrieve Traffic PatternsretrieveTrafficPatternsPOSTThis operation returns one or more traffic patterns.
Transaction Assistant1
Retrieve All Transaction Assistant RecordsretrieveAllTransactionAssistantRecordsPOSTThis operation returns a list of all transaction assistant records.
Transfer Display Profiles5
Create Transfer Display ProfilecreateTransferDisplayProfilePOSTThis operation creates a transfer display profile.
Delete Transfer Display Profile by IDdeleteTransferDisplayProfileByIDDELETEThis operation deletes a transfer display profile by ID.
Retrieve All Transfer Display ProfilesretrieveAllTransferDisplayProfilesGETThis operation returns a list of all transfer display profiles.
Retrieve Transfer Display Profile by IDretrieveTransferDisplayProfileByIDGETThis operation returns a transfer display profile by ID.
Update Transfer Display Profile by IDupdateTransferDisplayProfileByIDPUTThis operation updates a transfer display profile by ID.
UDM Device Actions5
Delete Device Action by IDdeleteDeviceActionByIDDELETEThis operation deletes a single device action by ID.
Delete Device Actions By StatusdeleteDeviceActionsByStatusPOSTThis operation allows you to delete actions for the specified devices or device groups based on action status.
Execute Device Action for Devices or Device GroupsexecuteDeviceActionForDevicesOrDeviceGroupsPOSTThis operation executes a device action for one or more devices or device groups in the system.
Retrieve Device Action by IDretrieveDeviceActionByIDGETThis operation returns a single device action by ID.
Retrieve Device Actions for a Set of Devices or GroupsretrieveDeviceActionsForASetOfDevicesOrGroupsPOSTThis operation allows you to retrieve all device actions for a set of devices or device groups.\n\nThe associated Access Control Point is UDM MONITORING.
UDM Device Actions Options1
Get Device Action OptionsgetDeviceActionOptionsGETThis operation allows you to get all action or troubleshooting options for supported device types.
UDM Device Configuration Profiles2
Retrieve All Device Configuration ProfilesretrieveAllDeviceConfigurationProfilesGETThis operation returns a list of all device configuration profiles in the system.
Retrieve Device Configuration Profile and Selected BlocksretrieveDeviceConfigurationProfileAndSelectedBlocksPOSTThis operation applies a filter to a configuration profile and returns the selected blocks.
UDM Device Groups4
Create Device GroupcreateDeviceGroupPOSTThis operation creates a device group.
Delete Device Group by IDdeleteDeviceGroupByIDDELETEThis operation deletes a device group by ID.
Retrieve All Device GroupsretrieveAllDeviceGroupsGETThis operation returns a list of all device groups in the system.
Update Device Group by IDupdateDeviceGroupByIDPUTThis operation updates a device group by ID.
UDM Device Statuses2
Retrieve a Device StatusretrieveADeviceStatusGETThis operation will return a single device status in the system.
Retrieve All Device StatusesretrieveAllDeviceStatusesGETThis operation retrieves device statuses for all devices configured in Universal Device Manager.
UDM Devices1
Retrieve All DevicesretrieveAllDevicesGETThis operation returns a list of all devices in the system.
Units of Measure9
Create Unit of MeasurecreateUnitOfMeasurePOSTThis operation creates a unit of measure.
Create Units of MeasurecreateUnitsOfMeasurePOSTThis operation creates one or more units of measure.
Delete Unit of Measure by IDdeleteUnitOfMeasureByIDDELETEThis operation deletes a unit of measure by ID.
Delete Units of MeasuredeleteUnitsOfMeasurePOSTThis operation deletes units of measure.
Retrieve All Units of Measure or by NameretrieveAllUnitsOfMeasureOrByNameGETThis operation returns all units of measure if no parameter is specified or a particular unit of measure if a name is provided.
Retrieve Unit of Measure by IDretrieveUnitOfMeasureByIDGETThis operation returns a unit of measure by ID.
Retrieve Units of MeasureretrieveUnitsOfMeasurePOSTThis operation returns one or more units of measure by object references.
Update Unit of Measure by IDupdateUnitOfMeasureByIDPUTThis operation updates a unit of measure by ID.
Update Units of MeasureupdateUnitsOfMeasurePOSTThis operation updates one or more units of measure.
User Preferences2
Retrieve User PreferencesretrieveUserPreferencesGETThis operation returns user preferences.
Retrieve User Preferences for Current UserretrieveUserPreferencesForCurrentUserGETThis operation returns user preferences for the current user or tenant.
Variance Advisor2
Retrieve AuditsretrieveAuditsPOSTThis operation returns one or more audits according to the specified parameters.
Retrieve VariancesretrieveVariancesPOSTThis operation returns one or more variances according to the specified parameters.
Visibility Period Actions9
Create Visibility Period ActioncreateVisibilityPeriodActionPOSTThis operation creates a single visibility period action.
Create Visibility Period ActionscreateVisibilityPeriodActionsPOSTThis operation creates one or more visibility period actions.
Delete Visibility Period Action by IDdeleteVisibilityPeriodActionByIDDELETEThis operation deletes a visibility period action.
Delete Visibility Period ActionsdeleteVisibilityPeriodActionsPOSTThis operation deletes one or more visibility period actions.
Retrieve All Visibility Period Actions or by NameretrieveAllVisibilityPeriodActionsOrByNameGETThis operation returns a visibility period action by name or all visibility period actions if no name is provided.
Retrieve Visibility Period Action by IDretrieveVisibilityPeriodActionByIDGETThis operation returns a visibility period action by ID.
Retrieve Visibility Period ActionsretrieveVisibilityPeriodActionsPOSTThis operation returns one or more visibility period actions.
Update Visibility Period Action by IDupdateVisibilityPeriodActionByIDPUTThis operation updates a visibility period action.
Update Visibility Period ActionsupdateVisibilityPeriodActionsPOSTThis operation updates one or more visibility period actions.
Volume Analyzer4
Execute Volume AnalyzerexecuteVolumeAnalyzerPOSTThis operation executes the volume analyzer and returns the results.
Retrieve Analysis Data Sample SizesretrieveAnalysisDataSampleSizesGETThis operation returns analysis data sample sizes for the volume analyzer.
Retrieve Anomaly ScoresretrieveAnomalyScoresGETThis operation returns anomaly scores for the volume analyzer.
Retrieve History YearsretrieveHistoryYearsGETThis operation returns history years for the volume analyzer.
Volume Budget2
Import Volume BudgetsimportVolumeBudgetsPOSTThis operation imports volume budgets.
Retrieve Volume BudgetsretrieveVolumeBudgetsPOSTThis operation returns volume budgets.
Volume Copy Maps2
Create or Update Volume Copy MapscreateOrUpdateVolumeCopyMapsPOSTThis operation creates or updates volume copy maps.
Retrieve All Volume Copy MapsretrieveAllVolumeCopyMapsGETThis operation returns all volume copy maps.
Volume Copy Override Maps2
Create or Update Volume Copy Override MapscreateOrUpdateVolumeCopyOverrideMapsPOSTThis operation creates or updates volume copy override maps.
Retrieve All Volume Copy Override MapsretrieveAllVolumeCopyOverrideMapsGETThis operation returns all volume copy override maps.
Volume Driver Assignments3
Create or Update Volume Driver AssignmentscreateOrUpdateVolumeDriverAssignmentsPOSTThis operation creates or updates existing Volume Driver Assignments.
Retrieve a Volume Driver AssignmentretrieveAVolumeDriverAssignmentGETThis operation returns a Volume Driver Assignment by Category and forecast week date.
Retrieve Volume Driver AssignmentsretrieveVolumeDriverAssignmentsPOSTThis operation returns Volume Driver Assignments.
Volume Drivers9
Create Volume DrivercreateVolumeDriverPOSTThis operation creates and returns a Volume Driver.
Create Volume DriverscreateVolumeDriversPOSTThis operation creates and returns Volume Drivers.
Delete Volume Driver by IDdeleteVolumeDriverByIDDELETEThis operation deletes a Volume Driver by ID.
Delete Volume DriversdeleteVolumeDriversPOSTThis operation deletes a list of volume drivers.
Retrieve All Volume Drivers or by NameretrieveAllVolumeDriversOrByNameGETThis operation returns all Volume Drivers if no parameter is specified or a particular Volume Driver if a name is provided.
Retrieve Volume Driver by IDretrieveVolumeDriverByIDGETThis operation returns a Volume Driver by ID.
Retrieve Volume DriversretrieveVolumeDriversPOSTThis operation returns Volume Drivers according to the specified object references.
Update Volume Driver by IDupdateVolumeDriverByIDPUTThis operation updates and returns a Volume Driver by ID.
Update Volume DriversupdateVolumeDriversPOSTThis operation updates and returns a list of Volume Drivers.
Volume Forecast5
Import Volume ForecastimportVolumeForecastPOSTThis operation imports multiple volume forecasts to the system and consolidates them.
Import Volume Forecast (Deprecated)importVolumeForecastDeprecatedPOSTThis operation is deprecated; instead use POST /v2/forecasting/volume forecast/import.
Restore Volume ForecastrestoreVolumeForecastPOSTThis operation restores volume forecasts to previously generated values.
Retrieve Volume ForecastsretrieveVolumeForecastsPOSTThis operation returns volume forecasts.
Update Volume ForecastupdateVolumeForecastPUTThis operation updates and returns a volume forecast.
Volume Forecast Engine2
Execute Volume Forecast EngineexecuteVolumeForecastEnginePOSTThis operation executes the volume forecast engine.
Retrieve Volume Forecast Engine StatusretrieveVolumeForecastEngineStatusPOSTThis operation returns the status of a volume forecast engine execution.
Volume Forecast Intervals Engine1
Execute Volume Forecast Intervals EngineexecuteVolumeForecastIntervalsEnginePOSTThis operation executes the volume forecast intervals engine.
Volume Forecast Model Types2
Retrieve All Volume Forecast Model TypesretrieveAllVolumeForecastModelTypesGETThis operation returns all Volume Forecast Model Types.
Retrieve All Volume Forecast Model Types (Deprecated)retrieveAllVolumeForecastModelTypesDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/volume forecast model types.
Volume Forecasts1
Retrieve Multiple Volume ForecastsretrieveMultipleVolumeForecastsPOSTThis operation returns volume forecasts.
Volume Process Status1
Retrieve Volume Process Status by KeyretrieveVolumeProcessStatusByKeyGETThis operation returns the current status of recalculation processing by execution key.
Volume Recalculation1
Recalculate VolumerecalculateVolumePOSTThis operation recalculates volume by date range.
Week Symbolic Periods2
Retrieve Week Symbolic Period TypesretrieveWeekSymbolicPeriodTypesGETThis operation returns all Week Symbolic Period Types.
Retrieve Week Symbolic Period Types (Deprecated)retrieveWeekSymbolicPeriodTypesDeprecatedGETThis operation is deprecated; instead use GET /v2/forecasting/week symbolic periods.
WiFi Access Points7
Create or Update WiFi Access PointscreateOrUpdateWiFiAccessPointsPOSTThis operation creates or updates one or more WiFi Access Points.
Create WiFi Access PointcreateWiFiAccessPointPOSTThis operation creates a WiFi Access Point.
Delete WiFi Access Point by IDdeleteWiFiAccessPointByIDDELETEThis operation deletes a WiFi Access Point by ID.
Delete WiFi Access PointsdeleteWiFiAccessPointsPOSTThis operation deletes one or more WiFi Access Points.
Retrieve All WiFi Access PointsretrieveAllWiFiAccessPointsGETThis operation returns a list of WiFi Access Points.
Retrieve WiFi Access Point by IDretrieveWiFiAccessPointByIDGETThis operation returns a WiFi Access Point by ID.
Update WiFi Access Point by IDupdateWiFiAccessPointByIDPUTThis operation updates a WiFi Access Point by ID.
WiFi Networks7
Create or Update WiFi NetworkscreateOrUpdateWiFiNetworksPOSTThis operation creates or updates one or more WiFi Networks.
Create WiFi NetworkcreateWiFiNetworkPOSTThis operation creates a WiFi Network.
Delete WiFi Network by IDdeleteWiFiNetworkByIDDELETEThis operation deletes a WiFi Network by ID.
Delete WiFi NetworksdeleteWiFiNetworksPOSTThis operation deletes one or more WiFi Networks.
Retrieve All WiFi NetworksretrieveAllWiFiNetworksGETThis operation returns a list of WiFi Networks.
Retrieve WiFi Network by IDretrieveWiFiNetworkByIDGETThis operation returns a WiFi Network by ID.
Update WiFi Network by IDupdateWiFiNetworkByIDPUTThis operation updates a WiFi Network by ID.
Work Rule Data Access Profiles4
Retrieve All Work Rule Data Access ProfilesretrieveAllWorkRuleDataAccessProfilesGETThis operation returns a list of all Work Rule Data Access Profiles and only includes GDAP-filtered selected Work Rules.
Retrieve Available Work Rule Data Access Profile by IDretrieveAvailableWorkRuleDataAccessProfileByIDGETThis operation returns an available Work Rule Data Access Profile by ID and only includes GDAP-filtered available Work Rules.
Retrieve Work Rule Data Access Profile by IDretrieveWorkRuleDataAccessProfileByIDGETThis operation returns a Work Rule Data Access Profile by ID and only includes GDAP-filtered selected Work Rules.
Retrieve Work Rule Data Access ProfilesretrieveWorkRuleDataAccessProfilesPOSTThis operation returns a list of Work Rule Data Access Profiles based on object reference and only includes GDAP-filtered selected Work Rules.
Work Rules17
Create Work RulecreateWorkRulePOSTThis operation creates a work rule.
Create Work RulescreateWorkRulesPOSTThis operation creates one or more work rules.
Delete Work Rule by IDdeleteWorkRuleByIDDELETEThis operation deletes a work rule by ID.
Delete Work RulesdeleteWorkRulesPOSTThis operation deletes one or more work rules.
Retrieve All Work RulesretrieveAllWorkRulesGETThis operation returns all work rules.
Retrieve Work Rule by IDretrieveWorkRuleByIDGETThis operation returns a work rule by ID.
Retrieve Work Rule by ID as EmployeeretrieveWorkRuleByIDAsEmployeeGETThis operation returns a work rule by ID to an employee.
Retrieve Work Rule by ID as Employee (Deprecated)retrieveWorkRuleByIDAsEmployeeDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/employee work rules/{id}.
Retrieve Work Rule by ID as ManagerretrieveWorkRuleByIDAsManagerGETThis operation returns a work rule by ID to a manager.
Retrieve Work Rule by ID as Manager (Deprecated)retrieveWorkRuleByIDAsManagerDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/work rules/{id}.
Retrieve Work RulesretrieveWorkRulesPOSTThis operation returns one or more work rules by object references.
Retrieve Work Rules as EmployeeretrieveWorkRulesAsEmployeeGETThis operation returns a list of work rules available to an employee.
Retrieve Work Rules as Employee (Deprecated)retrieveWorkRulesAsEmployeeDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/employee work rules.
Retrieve Work Rules as ManagerretrieveWorkRulesAsManagerGETThis operation returns a list of work rules available to a manager.
Retrieve Work Rules as Manager (Deprecated)retrieveWorkRulesAsManagerDeprecatedGETThis operation is deprecated; instead use GET /v2/timekeeping/setup/work rules.
Update Work Rule by IDupdateWorkRuleByIDPUTThis operation updates a work rule by ID.
Update Work RulesupdateWorkRulesPOSTThis operation updates one or more work rules.
Work Unit Hyperfind Profiles2
Create or Update Work Unit Hyperfind ProfilescreateOrUpdateWorkUnitHyperfindProfilesPOSTThis operation creates or updates one or more work unit Hyperfind Profiles.
Retrieve All Work Unit Hyperfind ProfilesretrieveAllWorkUnitHyperfindProfilesGETThis operation returns all work unit Hyperfind Profiles.
Work Unit Hyperfinds3
Create or Update Work Unit HyperfindscreateOrUpdateWorkUnitHyperfindsPOSTThis operation creates or updates one or more work unit Hyperfinds.
Execute Work Unit HyperfindexecuteWorkUnitHyperfindPOSTThis operation executes a work unit Hyperfind and returns work units constrained by a date range.
Retrieve Work Unit HyperfindsretrieveWorkUnitHyperfindsGETThis operation returns standard or custom work unit Hyperfinds and their associated work units.
Work Unit Locations1
Retrieve Work Unit LocationsretrieveWorkUnitLocationsPOSTThis operation retrieves the details of the given Work Units, definitions of the given Healthcare Targets, pay period date spans and days of operation of the given symbolic time periods...
Work Units2
Create or Update Work UnitscreateOrUpdateWorkUnitsPOSTThis operation creates or updates one or more work units.
Retrieve All Work UnitsretrieveAllWorkUnitsGETThis operation returns all work units and includes pagination support with the optional parameters start, index, and count.
Worker Type Assignments7
Delete Worker Type Assignment by Person IDdeleteWorkerTypeAssignmentByPersonIDDELETEThis operation deletes a worker type assignment by person ID.
Delete Worker Type AssignmentsdeleteWorkerTypeAssignmentsPOSTThis operation deletes one or more worker type assignments by object references.
Retrieve Worker Type Assignment by Person IDretrieveWorkerTypeAssignmentByPersonIDGETThis operation returns a worker type assignment by person ID.
Retrieve Worker Type Assignment by Person NumberretrieveWorkerTypeAssignmentByPersonNumberGETThis operation returns a worker type assignment by person number.
Retrieve Worker Type AssignmentsretrieveWorkerTypeAssignmentsPOSTThis operation returns one or more worker type assignments by object references.
Update Worker Type Assignment by Person IDupdateWorkerTypeAssignmentByPersonIDPUTThis operation updates a worker type assignment by person ID.
Update Worker Type AssignmentsupdateWorkerTypeAssignmentsPOSTThis operation updates one or more worker type assignments by object references.
Worker Types5
Create Worker TypecreateWorkerTypePOSTThis operation creates a worker type.
Delete Worker Type by IDdeleteWorkerTypeByIDDELETEThis operation deletes a worker type by worker type ID.
Retrieve All Worker TypesretrieveAllWorkerTypesGETThis operation returns all worker types.
Retrieve Worker Type by IDretrieveWorkerTypeByIDGETThis operation returns the details of a worker type by worker type ID.
Update Worker Type by IDupdateWorkerTypeByIDPUTThis operation updates the details of a worker type by worker type ID.
Workflow Business Processes3
Execute Business ProcessexecuteBusinessProcessPOSTThis operation executes a workflow business process by ID or qualifier.
Retrieve Business ProcessretrieveBusinessProcessGETThis operation retrieves a workflow business process by category or name.
Submit Business Process Form DatasubmitBusinessProcessFormDataPOSTThis operation submits form data and completes the current task.
Workload Coverage6
Evaluate CoverageevaluateCoveragePOSTThis operation returns coverage results for the criteria specified.
Evaluate Coverage DetailsevaluateCoverageDetailsPOSTThis operation returns coverage detail results for the criteria specified.
Evaluate Coverage SpansevaluateCoverageSpansPOSTThis operation returns coverage span results for the criteria specified.
Evaluate WorkloadevaluateWorkloadPOSTThis operation returns workload results for the criteria specified.
Evaluate Workload Coverage DetailsevaluateWorkloadCoverageDetailsPOSTThis operation returns workload coverage detail results for the specified criteria.
Evaluate Workload DetailsevaluateWorkloadDetailsPOSTThis operation returns workload detail results for the criteria specified.
Workload Generator1
Generate a WorkloadgenerateAWorkloadPOSTThis operation generates a workload from a staffing matrix and according to a date range and three Boolean indicators.
Workload Overrides3
Create or Update Workload OverridescreateOrUpdateWorkloadOverridesPOSTThis operation creates or updates one or more workload overrides.
Delete Workload OverridesdeleteWorkloadOverridesPOSTThis operation deletes one or more workload overrides.
Retrieve Workload OverridesretrieveWorkloadOverridesPOSTThis operation returns one or more workload overrides by object references.
Workload Patterns3
Bulk Create or Update Workload PatternsbulkCreateOrUpdateWorkloadPatternsPOSTThis operation creates or updates workload patterns in bulk.
Bulk Delete Workload PatternsbulkDeleteWorkloadPatternsPOSTThis operation deletes workload patterns in bulk.
Bulk Retrieve Workload PatternsbulkRetrieveWorkloadPatternsPOSTThis operation returns workload patterns in bulk.
Workload Planner Profiles3
Retrieve All Workload Planner ProfilesretrieveAllWorkloadPlannerProfilesGETThis operation returns a list of all Workload Planner Profiles.
Retrieve Workload Planner Profile by IDretrieveWorkloadPlannerProfileByIDGETThis operation returns a Workload Planner Profile by ID.
Retrieve Workload Planner ProfilesretrieveWorkloadPlannerProfilesPOSTThis operation returns a list of Workload Planner Profiles by object references.
Workload Volume2
Retrieve Workload VolumesretrieveWorkloadVolumesPOSTThis operation returns workload volumes matching specified search criteria.
Update Workload Weights or Update, Lock, or Unlock Workload VolumesupdateWorkloadWeightsOrUpdateLockOrUnlockWorkloadVolumesPOSTThis operation updates workload weights or updates, locks, or unlocks workload volumes.
Zone Categories3
Retrieve All Zone Categories or by NameretrieveAllZoneCategoriesOrByNameGETThis operation returns a list of all zone categories or a single category by name.
Retrieve Zone CategoriesretrieveZoneCategoriesPOSTThis operation returns zone categories.
Retrieve Zone Category by IDretrieveZoneCategoryByIDGETThis operation returns a zone category by ID.