Oracle HCM API Integration

These are the list of integration use cases supported by Knit for Oracle HCM API as part of the HRIS category

Add identification information

• ID: add_identification_information
• Operation: write
• Entities: employee, identificstionData, employeeDetails
• Summary: The 'Add identification information' API allows you to add national identification details for a worker. It requires an Authorization header for Basic Auth, unless accessed through knit. The API endpoint includes a path parameter 'employeeId' to specify the worker. The request body must include 'legislationCode', 'identifierType', and 'identifierNumber'. The response includes details of the national identifier such as 'NationalIdentifierId', 'LegislationCode', 'NationalIdentifierType', and 'NationalIdentifierNumber', along with metadata like 'CreatedBy', 'CreationDate', and 'links' to related resources.
• Input Fields: Input Fields
• Output Fields: Output Fields

Create an employee

• ID: create_employee
• Operation: write
• Entities: employee, create, employeeDetails
• Summary: The Create an employee API allows you to create a new employee record in the system. It requires a POST request to the specified URL with the necessary headers, including an Authorization header for Basic Auth. The request body must include the employee's first name, last name, present address, work email, and metadata such as legislation code, business unit ID, and legal employer name. The response includes a success flag, a message body with details of the created employee, including their person ID, person number, addresses, names, and work relationships. The response also includes metadata about the creation and last update of the record.
• Input Fields: Input Fields
• Output Fields: Output Fields

Creates leave request for an employee

• ID: create_leave_request
• Operation: write
• Entities: employee, leave, absences
• Summary: This API creates a leave request for an employee. It requires the employee ID, leave type ID, start and end dates, unit of leave, and amount. Additional metadata such as person number, employer, leave type, and legal entity ID must also be provided. The API returns a detailed response including the absence entry details, status, creation and update information, and other relevant data.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get compensation information of an employee

• ID: get_all_compensation_information_of_an_employee
• Operation: read
• Entities: employee, compensation, salary
• Summary: The 'Get compensation information of an employee' API retrieves detailed salary information for a specified employee. The API requires an Authorization header for Basic Authentication, unless accessed through knit. It accepts optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of salary details such as AssignmentId, SalaryId, SalaryAmount, CurrencyCode, and more, along with metadata like count, hasMore, limit, and offset. The API provides comprehensive salary data including frequency, basis, and range details, as well as action and person-related information.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get benefit enrollments of an employee

• ID: get_benefit_enrollments_of_an_employee
• Operation: read
• Entities: employee, benefits, employeeDetails
• Summary: The 'Get benefit enrollments of an employee' API retrieves the benefit enrollment details of a specified employee. It requires an Authorization header for Basic Authentication unless accessed through knit. The request body includes the employee's first and last name, present address, work email, and metadata such as legislation code, business unit ID, position ID, and legal employer name. The response includes detailed information about the employee, such as person ID, person number, addresses, names, and work relationships, along with metadata like creation and update details. The API returns a success flag and a UI version.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get documents of an employee

• ID: get_documents_of_an_employee
• Operation: read
• Entities: employee, documents, documentRecords
• Summary: The 'Get documents of an employee' API retrieves document records associated with an employee. It requires a Basic Authorization header unless accessed through knit. The API supports query parameters 'offset' and 'limit' to paginate results. The response includes detailed information about each document, such as document type, person details, and creation metadata. The response body contains an array of document records, each with attributes like 'DocumentsOfRecordId', 'DocumentType', 'PersonId', and more. The API also indicates if more records are available with the 'hasMore' flag.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get employee details by employee id

• ID: get_employee_details_by_employee_id
• Operation: read
• Entities: employee, personalInfo, employeeDetails
• Summary: The 'Get employee details by employee id' API retrieves detailed information about an employee using their unique employee ID. The request requires an Authorization header for Basic Authentication unless accessed through knit. The path parameter 'employeeId' is mandatory and specifies the employee's unique identifier. The response includes headers detailing the response metadata and a body containing employee details such as PersonId, PersonNumber, DateOfBirth, and more. The response also includes metadata about the collection, such as count, limit, and offset, along with links for navigation.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get employee locations by employee id

• ID: get_employee_locations
• Operation: read
• Entities: employee, locations, employeeDetails
• Summary: The 'Get employee locations by employee id' API retrieves the address details of an employee based on their unique employee ID. The request requires an Authorization header for Basic Authentication unless accessed through knit. The API accepts path parameters for the employee ID, and optional query parameters for pagination such as offset and limit. The response includes detailed address information such as AddressId, EffectiveStartDate, TownOrCity, Country, and more, along with metadata like count and hasMore to indicate pagination status.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get identification information of an employee

• ID: get_identification_information_of_an_employee
• Operation: read
• Entities: employee, identificationInfo, identifiers
• Summary: This API retrieves the identification information of an employee using their unique worker ID. The request requires an Authorization header for Basic Auth, unless accessed through knit. The API accepts optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of national identifiers with details such as NationalIdentifierId, LegislationCode, NationalIdentifierType, and more. The response also indicates if there are more items to fetch with 'hasMore'.
• Input Fields: Input Fields
• Output Fields: Output Fields

Get leave requests of an employee

• ID: get_leave_requests
• Operation: Read
• Entities: employee, leaveRequests, absences
• Summary: The 'Get leave requests of an employee' API retrieves the leave requests for a specific employee. It requires an Authorization header for Basic Authentication unless accessed through knit. The API accepts optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of leave requests with detailed information such as absence type, status, duration, and associated metadata. The response body contains an array of leave request items, each with attributes like absenceTypeId, approvalStatusCd, startDate, endDate, and more, providing comprehensive details about each leave request.
• Input Fields: Input Fields
• Output Fields: Output Fields

List all employees

• ID: list_all_employees
• Operation: read
• Entities: employee, personalInfo, employeeDetails
• Summary: The 'List all employees' API retrieves a list of employees from the specified server URL. It requires an Authorization header with a Bearer token unless accessed through knit. The API supports optional query parameters 'offset' and 'limit' to paginate the results. The response includes a list of employee objects with details such as PersonId, PersonNumber, and metadata like CreatedBy and LastUpdateDate. The response also contains links for navigation and indicates if more employees are available with the 'hasMore' field.
• Input Fields: Input Fields
• Output Fields: Output Fields

Update compensation information

• ID: update_compensation_information
• Operation: write
• Entities: employee, compensationData, salaryInformation
• Summary: The Update compensation information API allows updating the salary details for a specific employee. It requires the employeeId and salaryId as path parameters, and the effectiveDate, fixed compensation details, and metadata as part of the request body. The Authorization header is required unless working through knit. The response includes detailed information about the updated salary, including assignment and salary identifiers, salary amounts, frequency, and other related details.
• Input Fields: Input Fields
• Output Fields: Output Fields

Update identification information

• ID: update_identification_information
• Operation: write
• Entities: employee, identificationData, employeeDetails
• Summary: The Update identification information API allows updating the national identifier details for a specific worker. It requires the worker's unique ID and the identifier's unique ID as path parameters. The request must include an Authorization header unless accessed through knit. The body of the request should contain metadata with legislation code, identifier type, and identifier number. The response includes the updated national identifier details, including creation and update metadata, and related links.
• Input Fields: Input Fields
• Output Fields: Output Fields

Upload document for an employee

• ID: upload_document_for_an_employee
• Operation: write
• Entities: employee, documents, documentRecords
• Summary: The 'Upload document for an employee' API allows users to upload documents for a specific employee. The API requires a Basic Authorization header for authentication, which includes a username and password. The employee ID must be provided as a path parameter. The API does not require any query parameters or request body. Upon successful upload, the API returns a response containing details of the uploaded document, including its ID, type, associated person details, and any attachments. The response also includes metadata such as creation and update timestamps, and flags indicating if editing or deletion is allowed.
• Input Fields: Input Fields
• Output Fields: Output Fields