ITimeOffApprovalService1

Operations

NameSignatureDescription
Approvevoid Approve(Uri timeOffUri, String unitOfWorkId, String comments)Approve the specified time off
BulkDeleteApprovalPathsTimeOffApprovalPathBulkDeleteResults1 BulkDeleteApprovalPaths(Uri[] approvalPathUris, Uri timeOffApprovalPathBulkDeleteOptionUri)Delete the specified approval paths
BulkGetApprovalHistoryDetailsBulkGetTimeOffApprovalHistoryDetailsResult1[] BulkGetApprovalHistoryDetails(Uri[] timeOffUris)Gets the list of approval actions for the supplied time off.
BulkGetCurrentlyWaitingOnApproversBulkGetTimeOffApproversResult1[] BulkGetCurrentlyWaitingOnApprovers(Uri[] timeOffUris)Gets the list of approvers whose approval is currently needed for the supplied time offs.
CreateApproveBatchUri CreateApproveBatch(Uri[] timeOffUris, String comments)Create a batch of time offs to perform the 'approve' approval action upon
CreateEditApprovalPathDraftUri CreateEditApprovalPathDraft(Uri approvalPathUri)Create an edit draft of a time off approval path.
CreateForcedApproveBatchUri CreateForcedApproveBatch(Uri[] timeOffUris, String comments)Create a batch of time offs to perform the 'forced approve' approval action upon
CreateNewApprovalPathDraftUri CreateNewApprovalPathDraft()Create a new time off approval path draft.
CreateRejectBatchUri CreateRejectBatch(Uri[] timeOffUris, String comments)Create a batch of time offs to perform the 'reject' approval action upon
CreateReopenBatchUri CreateReopenBatch(Uri[] timeOffUris, String comments)Create a batch of time offs to perform the 'reopen' approval action upon
CreateSubmitBatchUri CreateSubmitBatch(Uri[] timeOffUris, String comments)Create a batch of time offs to perform the 'submit' approval action upon
DeleteApprovalPathvoid DeleteApprovalPath(Uri approvalPathUri)Delete an approval path
DisableApprovalPathvoid DisableApprovalPath(Uri approvalPathUri)Disable a time off approval path.
EnableApprovalPathvoid EnableApprovalPath(Uri approvalPathUri)Enable a time off approval path.
ExecuteTimeOffApprovalBatchTimeOffApprovalBatchResults1 ExecuteTimeOffApprovalBatch(Uri timeOffApprovalBatchUri)Execute the specified time offs approval batch
ForceApprovevoid ForceApprove(Uri timeOffUri, String unitOfWorkId, String comments)Force approve the specified time off
GetAllApprovalPathsTimeOffApprovalPathReference1[] GetAllApprovalPaths()Get all time off approval paths.
GetApprovalHistoryDetailsTimeOffApprovalHistoryDetails1 GetApprovalHistoryDetails(Uri timeOffUri)Gets the list of approval actions for the supplied time off.
GetApprovalPathDetailsTimeOffApprovalPathDetails1 GetApprovalPathDetails(Uri approvalPathUri)Get the details of a time off approval path.
GetApprovalPathForNewUsersTimeOffApprovalPathReference1 GetApprovalPathForNewUsers()Get the default approval path
GetApprovalPathForUserTimeOffApprovalPathReference1 GetApprovalPathForUser(Uri userUri)Get the approval path for the specified user
GetCurrentlyWaitingOnApproversApproverReference1[] GetCurrentlyWaitingOnApprovers(Uri timeOffUri)Gets the list of approvers whose approval is currently needed for the supplied time off.
GetEligibleTimeOffApproverRolesUri[] GetEligibleTimeOffApproverRoles()Get the list of eligible time off approval roles
GetExpectedApproversApproverReference1[] GetExpectedApprovers(Uri timeOffUri)Gets the list of approvers expected in the future for this time off.
GetExpectedApproversForProposedTimeOffApproverReference1[] GetExpectedApproversForProposedTimeOff(TimeOffParameter1 timeOff)Get the list of approvers expected if the proposed time off is submitted for approval
GetTeamApprovalStatusSummaryTimeOffTeamApprovalStatusSummary1 GetTeamApprovalStatusSummary(Uri userUri, DateRangeParameter1 dateRange)Get the count of the time offs for the given user's team by approval status. Excludes time offs falling outside of the daterange.
GetTimeOffApprovalBatchResultsTimeOffApprovalBatchResults1 GetTimeOffApprovalBatchResults(Uri timeOffApprovalBatchUri)Retrieve results of a completed ExecuteTimeOffApprovalBatch operation. Returns null if the batch has not completed.
GetUriFromApprovalPathSlugUri GetUriFromApprovalPathSlug(String approvalPathSlug)Get Uri from a time off approval path slug.
GetUserApprovalStatusSummaryTimeOffUserApprovalStatusSummary1 GetUserApprovalStatusSummary(Uri userUri)Get the count of time offs for the given user by approval status
GetUserPermittedApprovalActionsForTimeOffApprovalActionReference1[] GetUserPermittedApprovalActionsForTimeOff(Uri userUri, Uri timeOffUri)Get the permitted approval actions for the given user and time off
GetUserPermittedApprovalActionSummaryForTimeOffTimeOffApprovalPermittedActionSummary1 GetUserPermittedApprovalActionSummaryForTimeOff(Uri userUri, Uri timeOffUri)Get the permitted approval action summary for the given user and time off
PublishAndSubmitTimeOffTimeOffReference1 PublishAndSubmitTimeOff(Uri timeOffUri, String comments, String unitOfWorkId)Publish the specified open time off and submit it. The time off URI must refer to a draft object.
PublishApprovalPathDraftTimeOffApprovalPathReference1 PublishApprovalPathDraft(Uri approvalPathUri)Publish a draft approval path
PutAndSubmitTimeOffTimeOffReference1 PutAndSubmitTimeOff(TimeOffParameter3 timeOff, String comments, String unitOfWorkId)Puts and submits a timeoff in a single service call. Supports script based time off validation.
PutApprovalPathApprovalRulesvoid PutApprovalPathApprovalRules(Uri approvalPathUri, TimeOffApprovalPathRuleParameter1[] rules)Put time off approval path rules.
Rejectvoid Reject(Uri timeOffUri, String unitOfWorkId, String comments)Reject the specified time off
Reopenvoid Reopen(Uri timeOffUri, String unitOfWorkId, String comments)Reopen the specified time off
ReopenPutAndSubmitTimeOff2TimeOffReference1 ReopenPutAndSubmitTimeOff2(TimeOffParameter2 timeOff, String comments, String unitOfWorkId)Put the specified non-open time off. The time off must exist already: you cannot create a new one with this service.
ReopenPutAndSubmitTimeOff3TimeOffReference1 ReopenPutAndSubmitTimeOff3(TimeOffParameter3 timeOff, String comments, String unitOfWorkId)Put the specified non-open time off. The time off must exist already: you cannot create a new one with this service. Caution: This service will delete the timeoff if the operation fails currently. A fix to this is currently behind a feature flag.
Submitvoid Submit(Uri timeOffUri, String unitOfWorkId, String comments)Submit the specified time off for approval
UpdateApprovalPathDescriptionvoid UpdateApprovalPathDescription(Uri approvalPathUri, String description)Update a time off approval path description.
UpdateApprovalPathForNewUsersvoid UpdateApprovalPathForNewUsers(Uri approvalPathUri)Sets the default approval path
UpdateApprovalPathForUservoid UpdateApprovalPathForUser(Uri userUri, Uri approvalPathUri)Update the approval path for the specified user
UpdateApprovalPathNamevoid UpdateApprovalPathName(Uri approvalPathUri, String name)Update a time off approval path name.
ValidateValidationResultsSummary1 Validate(Uri approvalPathUri)Validate the time off approval path
ValidateApprovalActionForUserValidationResultsSummary1 ValidateApprovalActionForUser(Uri timeOffUri, Uri userUri, Uri approvalActionUri)Ensure whether it would be valid for the supplied user to take the specified approval action with respect to the given time off.