Module workday.absencemanagement
ballerinax/workday.absencemanagement Ballerina library
1.5.1
Overview
This is a generated connector for WorkDay AbsenceManagement REST API v1 OpenAPI specification.
The Absence Management service enables applications to access worker information about leaves of absence and time off details.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a workday application in the Credential Administrator console
- Obtain tokens by following this guide
Clients
workday.absencemanagement: Client
Isolated
This is a generated connector for WorkDay AbsenceManagement REST API v1 OpenAPI specification. The Absence Management service enables applications to access worker information about leaves of absence and time off details.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Follow [this guide] https://credentials.workday.com/docs/authentication/ and obtain tokens.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
retrieveWorkerLeaveOfAbsence
Isolated FunctionRemote Function
function retrieveWorkerLeaveOfAbsence(string id, string subresourceID) returns LeavesOfAbsenceView|errorRetrieves the leave of absence for the specified worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- LeavesOfAbsenceView|error - Successful response. A successful response can return no matched data.
retrievesInstanceAsValuesForEndpointParameters
Isolated FunctionRemote Function
function retrievesInstanceAsValuesForEndpointParameters() returns MultipleInstanceModelReference|errorRetrieves instances that can be used as values for other endpoint parameters in this service.
Return Type
- MultipleInstanceModelReference|error - Successful response. A successful response can return no matched data.
retrieveAbsencePlaneBalance
Isolated FunctionRemote Function
function retrieveAbsencePlaneBalance(string id) returns AbsenceBalanceView|errorRetrieves the specified balance of all absence plan and leave of absence types.
Parameters
- id string - The Workday ID of the resource.
Return Type
- AbsenceBalanceView|error - Successful response. A successful response can return no matched data.
retrievesTimeOffInstancesForEndpointParameters
Isolated FunctionRemote Function
function retrievesTimeOffInstancesForEndpointParameters() returns MultipleInstanceModelReference|errorRetrieves instances that can be used as values for other endpoint parameters in this service.
Return Type
- MultipleInstanceModelReference|error - Successful response. A successful response can return no matched data.
retrievesCollectionOfAbsenceTypes
Isolated FunctionRemote Function
function retrievesCollectionOfAbsenceTypes(string id, string? category, string? effective, int? 'limit, int? offset) returns InlineResponse200|errorRetrieves a collection of eligible absence types for the specified worker.
Parameters
- id string - The Workday ID of the resource.
- category string? (default ()) - The Workday ID of the absence type category. Valid values: * Leave of Absence Type: 17bd6531c90c100016d74f8dfae007d0 * Absence Table: 17bd6531c90c100016da3f5b554007d2 * Time Off: 17bd6531c90c100016d4b06f2b8a07ce
- effective string? (default ()) - The effective date for which eligible absence types need to be returned for the worker.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
Return Type
- InlineResponse200|error - Successful response. A successful response can return no matched data.
retrievesLeavesOfAbsenceByWorkerID
Isolated FunctionRemote Function
function retrievesLeavesOfAbsenceByWorkerID(string id, string? fromDate, string[]? leaveType, int? 'limit, int? offset, string[]? status, string? toDate) returns InlineResponse2001|errorRetrieves the Leaves Of Absence for a specified worker ID.
Parameters
- id string - The Workday ID of the resource.
- fromDate string? (default ()) - The start of a date range filter using the yyyy-mm-dd format.
- leaveType string[]? (default ()) - The Workday ID of the type of Leave Of Absence. You can specify multiple leaveType query parameters.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
- status string[]? (default ()) - The Workday ID of the status of the Leave Of Absence. The valid statuses are Successfully Completed, In Progress, Canceled, Rescinded, and Process Terminated. To get the Workday ID of a status, call the GET /values/leave/status endpoint. You can specify multiple status query parameters.
- toDate string? (default ()) - The end of a date range filter using the yyyy-mm-dd format.
Return Type
- InlineResponse2001|error - Successful response. A successful response can return no matched data.
retrievesBalanacesAllAbasencePalnbyWorkerID
Isolated FunctionRemote Function
function retrievesBalanacesAllAbasencePalnbyWorkerID(string? category, string? effective, int? 'limit, int? offset, string? 'worker) returns InlineResponse2002|errorRetrieves the balance of all absence plan and leave of absence type for the specified worker ID.
Parameters
- category string? (default ()) - The Workday ID of the Time Off, Leave Type, or Absence Table.
- effective string? (default ()) - Absence balances as of the specified date using the yyyy-mm-dd format.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
- 'worker string? (default ()) - The Workday ID of the worker for which balances are returned.
Return Type
- InlineResponse2002|error - Successful response. A successful response can return no matched data.
createsTimeOffRequest
Isolated FunctionRemote Function
function createsTimeOffRequest(string id, TimeOffRequestEventView payload) returns TimeOffRequestEventView|errorCreates a time off request for the specified worker ID and initiates the business process.
Parameters
- id string - The Workday ID of the resource.
- payload TimeOffRequestEventView - Request payload
Return Type
- TimeOffRequestEventView|error - Resource created.
retrievesValidTimeOffDates
Isolated FunctionRemote Function
function retrievesValidTimeOffDates(string id, string subresourceID) returns DailyQuantityView|errorRetrieves the valid time off dates for the specified worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- DailyQuantityView|error - Successful response. A successful response can return no matched data.
retrievesWorkersInfo
Isolated FunctionRemote Function
function retrievesWorkersInfo(string id) returns WorkerData|errorRetrieves a collection of workers and current staffing information.
Parameters
- id string - The Workday ID of the resource.
Return Type
- WorkerData|error - Successful response. A successful response can return no matched data.
retrievesWorkerTimeOffDetails
Isolated FunctionRemote Function
function retrievesWorkerTimeOffDetails(string id, string? fromDate, int? 'limit, int? offset, string[]? status, string[]? timeOffType, string? toDate) returns InlineResponse2003|errorRetrieves a collection of time off details for the specified worker.
Parameters
- id string - The Workday ID of the resource.
- fromDate string? (default ()) - The start of a date range filter using the yyyy-mm-dd format.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
- status string[]? (default ()) - The Workday ID of the time off status. You can specify multiple status query parameters. This method returns the most recent instance of a time off entry based on this query parameter. The valid statuses are Approved, Submitted, Not Submitted, and Sent Back. This method does not return Canceled and Denied Time Off Entries. To get the Workday ID of a status, call the GET /values/timeOff/status endpoint. You can specify multiple status query parameters. Example: An approved Time Off Entry for Vacation 8 hours was corrected to Vacation 4 hours and is not in submitted status. If the query parameter is status = approved, the Time Off Entry of Vacation, 8 hours, Approved is returned. If query parameter status = submitted, the Time Off Entry of Vacation, 4 hours, Submitted is returned. If no query parameter is passed, the Time Off Entry of Vacation, 4 hours, Submitted is returned.
- timeOffType string[]? (default ()) - The Workday ID of the Time Off Type. You can specify multiple timeOffType query parameters.
- toDate string? (default ()) - The end of a date range filter using the yyyy-mm-dd format.
Return Type
- InlineResponse2003|error - Successful response. A successful response can return no matched data.
retrievesTimeOffDateByWorkerId
Isolated FunctionRemote Function
function retrievesTimeOffDateByWorkerId(string id, string? date, int? 'limit, int? offset, string? position, string? timeOff) returns InlineResponse2004|errorRetrieves the valid time off dates for the specified worker ID for the given dates.
Parameters
- id string - The Workday ID of the resource.
- date string? (default ()) - The dates being requested for which to validate using the yyyy-mm-dd format.
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
- position string? (default ()) - The Workday ID of the Position.
- timeOff string? (default ()) - The Workday ID of the Time Off.
Return Type
- InlineResponse2004|error - Successful response. A successful response can return no matched data.
retrievesStaffAndWorkersInfo
Isolated FunctionRemote Function
function retrievesStaffAndWorkersInfo(int? 'limit, int? offset, string? search) returns InlineResponse2005|errorRetrieves a collection of workers and current staffing information.
Parameters
- 'limit int? (default ()) - The maximum number of objects in a single response. The default is 20. The maximum is 100.
- offset int? (default ()) - The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
- search string? (default ()) - Searches workers by name. The search is case-insensitive. You can include space-delimited search strings for an OR search.
Return Type
- InlineResponse2005|error - Successful response. A successful response can return no matched data.
retrievesWorkerEligibleAbsenceType
Isolated FunctionRemote Function
function retrievesWorkerEligibleAbsenceType(string id, string subresourceID) returns EligibleAbsenceTypeView|errorRetrieves the eligible absence type for the specified worker.
Parameters
- id string - The Workday ID of the resource.
- subresourceID string - The Workday ID of the subresource.
Return Type
- EligibleAbsenceTypeView|error - Successful response. A successful response can return no matched data.
Records
workday.absencemanagement: AbsenceBalanceView
Fields
- unit Unit? -
- position Position? -
- quantity int? - The balance for the time off, absence table or leave type.
- absencePlan AbsencePlan? -
- dateOfFirstAbsence string? - The first day of leave for the corresponding leave type for which the balance is returned.
- effectiveDate string? - The date for which the balance is returned.
- category Category? -
- 'worker Worker? -
workday.absencemanagement: AbsenceContainerViewForBalance
Fields
- timeoffs string? - The Time Off name for which the balance is returned.
- descriptor string? - Descriptor for Absence Container based on Calendar Display Option
- absenceTable AbsenceTable[]? - Returns the Absence Table for the Absence Balance.
- id string? - ID for Absence Container.
workday.absencemanagement: AbsencePlan
Fields
- Fields Included from * AbsenceContainerViewForBalance
- timeoffs string
- descriptor string
- absenceTable AbsenceTable[]
- id string
- anydata...
workday.absencemanagement: AbsenceReasonView
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.absencemanagement: AbsenceTable
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.absencemanagement: AbsenceTypeGroup
Fields
- Fields Included from * AbsenceTypeGroupView
workday.absencemanagement: AbsenceTypeGroupView
Fields
- displayOrder string? - Absence Type Group display order.
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.absencemanagement: Action
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: AdditionalFields
Fields
- Fields Included from * AdditionalFieldsLeavesOfAbsenceView
- stillbirthBabyDeceased boolean
- stopPaymentDate string
- singleParentIndicator boolean
- childsDateOfDeath string
- multipleChildIndicator boolean
- locationDuringLeave string
- numberOfBabiesAdoptedChildren int
- dateChildEnteredCountry string
- caesareanSectionBirth boolean
- dateOfRecall string
- expectedDueDate string
- lastDateForWhichPaid string
- childsBirthDate string
- numberOfPreviousMaternityLeaves int
- workRelated boolean
- weekOfConfinement string
- adoptionNotificationDate string
- dateBabyArrivedHomeFromHospital string
- leavePercentage int
- numberOfPreviousBirths int
- dependent Dependent
- leaveEntitlementOverride int
- numberOfChildDependents int
- socialSecurityDisabilityCode string
- adoptionPlacementDate string
- ageOfDependent int
- anydata...
workday.absencemanagement: AdditionalFieldsLeavesOfAbsenceView
Fields
- stillbirthBabyDeceased boolean? - If true, the Leave Of Absence indicates a stillbirth or baby deceased, which may impact ~worker's~ leave entitlements.
- stopPaymentDate string? - The Stop Payment Date additional field for the Leave Of Absence using the yyyy-mm-dd format.
- singleParentIndicator boolean? - If true, the Leave Of Absence indicates a single parent, which may impact ~worker's~ leave entitlements.
- childsDateOfDeath string? - The Child's Date Of Death additional field for the Leave Of Absence using the yyyy-mm-dd format.
- multipleChildIndicator boolean? - If true, the Leave Of Absence indicates multiple children, which may impact ~worker's~ leave entitlements.
- locationDuringLeave string? - The Location During Leave text additional field for the Leave Of Absence.
- numberOfBabiesAdoptedChildren int? - The Number Of Babies Or Adopted Children numerical additional field for the Leave Of Absence.
- dateChildEnteredCountry string? - The Date Child Entered ~Country~ additional field for the Leave Of Absence using the yyyy-mm-dd format.
- caesareanSectionBirth boolean? - If true, the Leave Of Absence indicates a caesarean section birth, which may impact ~worker's~ leave entitlements.
- dateOfRecall string? - The Date Of Recall additional field for the Leave Of Absence using the yyyy-mm-dd format.
- expectedDueDate string? - The Expected Due Date additional field for the Leave Of Absence using the yyyy-mm-dd format.
- lastDateForWhichPaid string? - The Last Date For Which Paid additional field for the Leave Of Absence using the yyyy-mm-dd format.
- childsBirthDate string? - The Child's Birth Date additional field for the Leave Of Absence using the yyyy-mm-dd format.
- numberOfPreviousMaternityLeaves int? - The Number Of Previous Maternity Leaves numerical additional field for the Leave Of Absence.
- workRelated boolean? - If true, the Leave Of Absence is work related, which may impact Record Of Employment in Canada.
- weekOfConfinement string? - The Week Of Confinement Date additional field for the Leave Of Absence using the yyyy-mm-dd format.
- adoptionNotificationDate string? - The Adoption Notification Date additional field for the Leave Of Absence using the yyyy-mm-dd format.
- dateBabyArrivedHomeFromHospital string? - The Date Baby Arrived Home From Hospital additional field for the Leave Of Absence using the yyyy-mm-dd format.
- leavePercentage int? - The Leave Percentage numerical additional field for the Leave Of Absence.
- numberOfPreviousBirths int? - The Number Of Previous Births numerical additional field for the Leave Of Absence.
- dependent Dependent? -
- leaveEntitlementOverride int? - The Leave Entitlement Override numerical additional field for the Leave Of Absence.
- numberOfChildDependents int? - The Number Of Child Dependents numerical additional field for the Leave Of Absence.
- adoptionPlacementDate string? - The Adoption Placement Date additional field for the Leave Of Absence using the yyyy-mm-dd format.
- ageOfDependent int? - The Age Of Dependent numerical additional field for the Leave Of Absence.
workday.absencemanagement: BusinessProcessParameters
Fields
- Fields Included from * BusinessProcessParameters2
- overallBusinessProcess OverallBusinessProcess
- action Action
- comment string
- comments Comments[]
- warningValidations string
- attachments EventAttachmentsForToolbar[]
- overallStatus string
- criticalValidations string
- for For
- anydata...
workday.absencemanagement: BusinessProcessParameters2
Fields
- overallBusinessProcess OverallBusinessProcess? -
- action Action -
- comment string? - Returns a null.
- comments Comments[]? - Returns the comments for the current business process.
- warningValidations string? - Warning message for an action event triggered by a condition.
- attachments EventAttachmentsForToolbar[]? - Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met.
- overallStatus string? - The current status of the business process. For example: Successfully Completed, Denied, Terminated.
- criticalValidations string? - Validation message for an action event triggered by a condition.
- for For? -
workday.absencemanagement: Category
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
workday.absencemanagement: Comments
Fields
- commentDate string? - Gives the moment at which the instance was originally created.
- comment string? - Comment
- person PersonInstanceModelRef? -
workday.absencemanagement: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
workday.absencemanagement: ContentType
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: CoordinatedTimeOffTypeView
Fields
- descriptor string? - The Time Off Type Name or Absence Table Name for Coordinated Time Off Entry.
- id string? - Id of the instance
workday.absencemanagement: Country
Fields
- Fields Included from * CountryDataForLocationData
- descriptor string
- anydata...
workday.absencemanagement: CountryDataForLocationData
Fields
- descriptor string? - A preview of the instance
workday.absencemanagement: DailyQuantityView
Fields
- date string? - The dates of the time off entry.
- unit UnitTimeView? -
- dailyDefaultQuantity int? - The daily default quantity configured on the Time Off Plan or as an override on the Time Off.
workday.absencemanagement: Dependent
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: EligibleAbsenceTypesAdditionalFieldView
Fields
- required boolean? - True if Leave Additional Fields are required.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.absencemanagement: EligibleAbsenceTypeView
Fields
- unitOfTime UnitOfTime? -
- positionBased boolean? - If true, the time off type or leave type is position based.
- position PositionView[]? - The position associated to the time off or leave of absence.
- absenceReasons AbsenceReasonView[]? - The reason for the time off, absence table, or leave of absence.
- reasonRequired boolean? - If true, the time off type, absence table, or leave type requires a reason.
- displayStartAndEndTime boolean? - If true, the time off type has start and end times enabled.
- id string? - Workday ID
- category Category? -
- additionalFields EligibleAbsenceTypesAdditionalFieldView[]? - The additional field associated with a leave of absence type.
- dailyDefaultQuantity int? - Daily default quantity
- absenceTypeGroup AbsenceTypeGroup? -
- calculateQuantityBasedOnStartAndEndTime boolean? - If true, the quantity is based on the start and end times for the time off type.
- descriptor string? - Descriptor for Coordinated Absence Type
- entryOption EntryOption? -
- startAndEndTimeRequired boolean? - If true, the start and end times are required for the time off type.
workday.absencemanagement: EntryOption
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: ErrorModelReference
Fields
- 'error string - A description of the error
workday.absencemanagement: EventAttachmentsForToolbar
Fields
- description string? - Event attachment description
- contentType ContentType? -
- fileLength int? - File length of the attachment
- uploadDate string? - Returns Date the Business Process Attachment was updated.
- fileName string? - File name of the attachment
- uploadedBy UploadedBy? -
- category Category? -
- id string? - Id of the instance
workday.absencemanagement: FacetsModelReferenceInner
This object represents the possible facets for this resource
Fields
- descriptor string? - A description of the facet
- facetParameter string? - The alias used to select the facet
workday.absencemanagement: For
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: InlineResponse200
collection something or other
Fields
- data EligibleAbsenceTypeView[]? -
- total int? -
workday.absencemanagement: InlineResponse2001
collection something or other
Fields
- data LeavesOfAbsenceView[]? -
- total int? -
workday.absencemanagement: InlineResponse2002
collection something or other
Fields
- data AbsenceBalanceView[]? -
- total int? -
workday.absencemanagement: InlineResponse2003
collection something or other
Fields
- data TimeOffDetailsView[]? -
- total int? -
workday.absencemanagement: InlineResponse2004
collection something or other
Fields
- data DailyQuantityView[]? -
- total int? -
workday.absencemanagement: InlineResponse2005
collection something or other
Fields
- data WorkerData[]? -
- total int? -
workday.absencemanagement: InstanceModelReference
Fields
- id string - wid / id / reference id
- descriptor string? - A description of the instance
- href string? - A link to the instance
workday.absencemanagement: JobDataForWorker
Fields
- businessTitle string? - The business title for the position.
- supervisoryOrganization SupervisoryOrganization? -
- jobType JobType? -
- jobProfile JobProfile? -
- location Location? -
- workSpace WorkSpace? -
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.absencemanagement: JobProfile
Fields
- Fields Included from * JobProfileJobView
workday.absencemanagement: JobProfileJobView
Fields
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.absencemanagement: JobType
Fields
- Fields Included from * JobTypeData
- descriptor string
- anydata...
workday.absencemanagement: JobTypeData
Fields
- descriptor string? - A preview of the instance
workday.absencemanagement: JobWorkspaceData
Fields
- locationChain string? - Location chain including bread crumbs for location.
- descriptor string? - A preview of the instance
- id string? - Id of the instance
workday.absencemanagement: LeaveImpactFields
Fields
- Fields Included from * LeaveImpactFieldsLeavesOfAbsenceView
workday.absencemanagement: LeaveImpactFieldsLeavesOfAbsenceView
Fields
- payrollEffect boolean? - If true, the Leave Of Absence event has an effect on payroll.
- professionalLeaveEffect boolean? - If true, the Leave Of Absence event has a Professional Leave Effect leave impact field.
- stockVestingEffect boolean? - If true, the Leave Of Absence event has an effect on the ~worker's~ stock vesting schedule. It may require a change to the vesting schedule of any stock grants that the ~worker~ holds.
- schedulingEffect boolean? - True if the leave event is for a leave type that is configured to allow a ~worker~ to be scheduled to work when placed on leave.
- inactivateWorker boolean? - If true, the ~worker~ on leave will be inactivated in the Workday system. If the leave type is position-based, the ~worker~ will not be inactive unless the ~worker~ is on leave for all positions with this effect.
- sabbaticalEffect boolean? - If true, the Leave Of Absence event has an effect on sabbatical eligibility. It may require a manual change to a ~worker's~ sabbatical records.
- continuousServiceAccrualEffect boolean? - If true, it has an impact on the ~worker's~ service accrual. It may need a manual change to the ~worker's~ service accrual.
- benefitEffect boolean? - If true, it may require a change to the ~worker's~ benefits.
- talentEffect boolean? - If true, Workday removes the ~worker~ on this type of leave from the ~Worker~ prompt of select ~worker~ reviews and feedback in talent.
- tenureEffect boolean? - If true, the Leave Of Absence event has an effect on tenure eligibility. It may require a manual change to a ~worker's~ tenure records.
- absenceAccrualEffect boolean? - If true, it impacts the ~worker's~ absence accrual.
workday.absencemanagement: LeavesOfAbsenceView
Fields
- businessProcessStepStatus string? - The Business Process Step Status of the Leave Of Absence.
- reason Reason? -
- additionalFields AdditionalFields? -
- actualLastDayOfLeave string? - The Actual Last Day Of Work for the Leave Of Absence using the yyyy-mm-dd format.
- latestLeaveComment string? - The Latest Leave Comment of the Leave Of Absence.
- 'worker Worker? -
- estimatedLastDayOfLeave string? - The Estimated Last Day Of Leave of the Leave Of Absence using the yyyy-mm-dd format.
- lastDayOfWork string? - The Last Day Of Work of the Leave Of Absence using the yyyy-mm-dd format.
- leaveImpactFields LeaveImpactFields? -
- position PositionInstanceModelRef? -
- priorLeaveEvent PriorLeaveEvent? -
- status Status? -
- firstDayOfLeave string? - The First Day Of Leave of the Leave Of Absence using the yyyy-mm-dd format.
- leaveType LeaveType? -
- id string? - Id of the instance
workday.absencemanagement: LeaveType
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: Location
Fields
- Fields Included from * LocationDataJobView
workday.absencemanagement: LocationDataJobView
Fields
- country Country? -
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.absencemanagement: MultipleInstanceModelReference
Fields
- total int? -
- data InstanceModelReference[]? -
workday.absencemanagement: OverallBusinessProcess
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: Person
Fields
- Fields Included from * PersonDataView
workday.absencemanagement: PersonDataView
Fields
- phone string? - Returns the primary public work phone number for the worker.
- email string? - Returns the public primary work email address for the worker.
- id string? - Id of the instance
workday.absencemanagement: PersonInstanceModelRef
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: Position
Fields
- Fields Included from * PositionView
workday.absencemanagement: PositionInstanceModelRef
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: PositionView
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.absencemanagement: PrimaryJob
Fields
- Fields Included from * JobDataForWorker
- businessTitle string
- supervisoryOrganization SupervisoryOrganization
- jobType JobType
- jobProfile JobProfile
- location Location
- workSpace WorkSpace
- descriptor string
- id string
- anydata...
workday.absencemanagement: PriorLeaveEvent
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
workday.absencemanagement: Reason
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: Status
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: SupervisoryOrganization
Fields
- Fields Included from * SupervisoryOrganizationJobView
workday.absencemanagement: SupervisoryOrganizationJobView
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.absencemanagement: TimeOffDetailsView
Fields
- position PositionInstanceModelRef? -
- comment string? - The comment on the time off entry.
- reason Reason? -
- timeOffType TimeOffType? -
- quantity int? - The Quantity of the Time Off Entry in the units specified by the Unit response field.
- status Status? -
- date string? - The Date of the Time Off Entry using the format yyyy-mm-dd.
- unit Unit? -
- 'worker Worker? -
workday.absencemanagement: TimeOffRequestAbsenceTypeView
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.absencemanagement: TimeOffRequestEntryView
Fields
- 'start string? - The start time of the time off entry.
- date string? - Time Off Entry date
- position Position? -
- end string? - The end time of the time off entry.
- reason Reason? -
- dailyQuantity int? - Time Off Entry hours
- timeOffType TimeOffTypeAbsenceTypeView? -
- comment string? - The comment on the time off entry.
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.absencemanagement: TimeOffRequestEventView
Fields
- businessProcessParameters BusinessProcessParameters? -
- days TimeOffRequestEntryView[]? - Time Off Entries
workday.absencemanagement: TimeOffType
Fields
- Fields Included from * CoordinatedTimeOffTypeView
workday.absencemanagement: TimeOffTypeAbsenceTypeView
Fields
- Fields Included from * TimeOffRequestAbsenceTypeView
workday.absencemanagement: Unit
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: UnitOfTime
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: UnitOfTimeView
Fields
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.absencemanagement: UnitTimeView
Fields
- Fields Included from * UnitOfTimeView
workday.absencemanagement: UploadedBy
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: ValidationErrorModelReference
Fields
- Fields Included from * ErrorModelReference
- error string
- anydata...
- errors ErrorModelReference[]? - An array of validation errors
workday.absencemanagement: Worker
Fields
- Fields Included from * InstanceModelReference
workday.absencemanagement: WorkerData
Fields
- primaryJob PrimaryJob? -
- person Person? -
- additionalJobs JobDataForWorker[]? - The employee’s additional jobs and international assignments.
- id string? - Id of the instance
- descriptor string? - A preview of the instance
workday.absencemanagement: WorkSpace
Fields
- Fields Included from * JobWorkspaceData