All REST Endpoints

Absences
The absences resource includes the absence service used to record, view, update, and withdraw absences for employees.
Create an absence record
Method: post
Path: /hcmRestApi/resources/11.13.18.05/absences
Get all absence records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences
Get an absence record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}
Update an absence record
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}
Absences/Absence Attachments
The attachments resource is a child of the absences resource. It is used to add, edit, view and delete attachments of an absence record for a person.
Create an absence attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments
Delete an absence attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}
Get all absence attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments
Get an absence attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}
Update an absence attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}
Absences/Absence Descriptive Flexfields
The absenceRecordingDFF resource includes descriptive flexfields associated with the absence entry.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingDFF/{PerAbsenceEntryId}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingDFF/{PerAbsenceEntryId}
Absences/Absence Developer Descriptive Flexfields
The absenceRecordingsDDF resource includes developer descriptive flexfields associated with the absence entry.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingsDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingsDDF/{absenceRecordingsDDFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingsDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingsDDF/{absenceRecordingsDDFUniqID}
Absences/Absence Entitlements
The absenceEntitlements resource is a child of the absences resource. It includes a list of all the entitlements consumed by an absence.
Get all entitlement summary records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements
Get an entitlement summary record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements/{absenceEntitlementsUniqID}
Absences/Absence Entitlements/Absence Entitlement Details
The absenceEntitlementDetails resource is a child of the absences resource. It includes a list of all the entitlements consumed by an absence each day of the absence.
Get all entitlement detail records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements/{absenceEntitlementsUniqID}/child/absenceEntitlementDetails
Get an entitlement detail record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements/{absenceEntitlementsUniqID}/child/absenceEntitlementDetails/{entitlementDetailId}
Absences/Absence Maternity Details
The absenceMaternity resource is a child of the absences resource. It includes details of maternity attributes when absence type is maternity.
Create a maternity absence record
Method: post
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceMaternity
Get a maternity absence record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceMaternity/{personAbsenceMaternityId}
Get all maternity absence records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceMaternity
Update a maternity absence record
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceMaternity/{personAbsenceMaternityId}
Actions in Opportunity Marketplace
The recruitingOppMktActions resource provides actions in opportunity marketplace.
Create an action in opportunity marketplace
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktActions
Get all actions in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktActions
Get an action in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktActions/{ActionType}
Allocated Checklists
The allocatedchecklists resource includes all the checklists allocated to a person. It is used to view, allocate, and modify checklist details for a person.
Allocate a checklist
Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists
Allocate a new task
Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
Allocate a task from the task library
Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
Delete an allocated checklist
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
Force close an incomplete checklist
Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
Get all allocated checklists
Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists
Get an allocated checklist
Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
Update an allocated checklist
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
Allocated Checklists/Allocated Tasks
The allocatedtasks resource is a child of the allocatedChecklists resource. It includes details of all the allocated tasks.
Delete an allocated task
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
Get all allocated tasks
Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks
Get an allocated task
Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
Reopen a task
Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
Update an allocated task
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
Update the task status
Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
Allocated Checklists/Allocated Tasks/Allocated Tasks FlexFields
The allocatedChecklistTaskFlex resource is a child of the allocatedChecklists resource. It includes details of all the allocated tasks flexfields.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/allocatedChecklistTaskFlex/{AllocatedTaskId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/allocatedChecklistTaskFlex
Allocated Checklists/Allocated Tasks/Attachments
The attachments resources is a child of the allocatedChecklists resource. It is used to to view, create, and update attachments for a task.
Create a task attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments
Delete a task attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{AttachedDocumentId}
Get a task attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{AttachedDocumentId}
Get all task attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments
Update a task attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{AttachedDocumentId}
Allocated Checklists/Allocated Tasks/Documents
The documents resource is a child of the allocatedChecklists resource. It is used to view, create, and update attachments for a document task type.
Create a document task type attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents
Delete a document task type attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{AttachedDocumentId}
Get a document task type attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{AttachedDocumentId}
Get all document task type attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents
Update a document task type attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{AttachedDocumentId}
Application Details in Opportunity Marketplace
The recruitingOppMktApplicationDetails resource provides details on an application in opportunity marketplace.
Get a detail on an opportunity marketplace gig application
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktApplicationDetails/{ApplicationId}
Get all details on an opportunity marketplace gig application
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktApplicationDetails
Application Details in Opportunity Marketplace/Completed Gigs
The CompletedGigs resource is the child of the recruitingOppMktApplicationDetails resource and provides details on completed gigs in opportunity marketplace.
Get a completed gig for an opportunity marketplace application
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktApplicationDetails/{ApplicationId}/child/completedGigs/{GigId}
Get all completed gigs for an opportunity marketplace application
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktApplicationDetails/{ApplicationId}/child/completedGigs
Areas of Responsibility
The areas of responsibility resource includes all the areas of responsibility as of the specified date. By default, the current date is retained.
Create an area of responsibility
Method: post
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility
Delete an area of responsibility
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}
Get all areas of responsibility
Method: get
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility
Get an area of responsibility
Method: get
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}
Reassign an area of responsibility
Method: post
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}
Update an area of responsibility
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}
Availability Patterns
The availabilityPatterns resource includes the availability pattern service used to create, view, update, and delete availability patterns for employees. This resource is currently under controlled availability.
Create an availability pattern
Method: post
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns
Delete an availability pattern
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}
Get all availability patterns
Method: get
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns
Get an availability pattern
Method: get
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}
Update an availability pattern
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}
Availability Patterns/Shifts
The shifts resource is a child of the availabilityPatterns resource. It includes a list of all of the shifts that constitute the availability pattern.
Create a shift
Method: post
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts
Delete a shift
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}
Get a shift
Method: get
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}
Get all shifts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts
Update a shift
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}
Availability Patterns/Shifts/Breaks
The breaks resource is a child of the shifts resource. It includes a list of all of the breaks that an employee can take during a shift.
Create a break
Method: post
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks
Delete a break
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks/{breaksUniqID}
Get a break
Method: get
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks/{breaksUniqID}
Get all breaks
Method: get
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks
Update a break
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/availabilityPatterns/{availabilityPatternsUniqID}/child/shifts/{shiftsUniqID}/child/breaks/{breaksUniqID}
Benefit Enrollment Opportunities
The benefitEnrollmentOpportunities resource identifies the benefits that are available as electable choices for a person as a result of a life event. It identifies the programs or plans in which a participant can enroll in a given enrollment window. The resource also identifies the life event that provides these opportunities. In this context, the enrollment window might be due to open enrollment or any other life event excluding unrestricted events.
Get all enrollment opportunities
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunities
Get an enrollment opportunity
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunities/{PersonNumber}
Benefit Enrollments
The benefitEnrollments resource includes a list of all active enrollments. It identifies the plans or options-in-plans in which a participant is enrolled, either through explicit elections or due to default or automatic enrollments. The resource always identifies a plan and the life event reason. In this context, the enrollment might be due to open enrollment. Where applicable, the elected program and option are identified.
Get all enrollments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollments
Get an enrollment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}
Benefit Enrollments/Costs
The costs resource is a child of the benefitEnrollments resource. It includes amounts, tax consequences and other information about standard rates, total flex credits, and imputed income calculated for a participant enrolled in a plan or option-in-plan.
Get a cost
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/costs/{RateValueId}
Get all costs
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/costs
Benefit Enrollments/Dependents
The dependents resource is a child of the benefitEnrollments resource. It includes person records that a participant designated as dependents in the context of a program, plan type in program, or plan. The level at which dependent designations occur is defined at the program level for plans-in-program or at the plan level for plans-not-in-program.
Get a covered dependent
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/dependents/{CoveredDependentId}
Get all covered dependents
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/dependents
Benefit Enrollments/Providers
The providers resource is a child of the benefitEnrollments resource. It includes the external or internal organizations responsible for providing goods or services to the participants of the enrolled plan, such as third party agents and self-insured companies.
Get a plan provider
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/providers/{ProviderOrganizationId}
Get all plan providers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/providers
Benefit Enrollments/Providers/Provider Roles
The providerRoles resource is a child of the providers resource. It includes the services or functions performed by an organization to the participants of the enrolled plan.
Get a role
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/providers/{ProviderOrganizationId}/child/providerRoles/{ProviderOrganizationRoleId}
Get all roles
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/providers/{ProviderOrganizationId}/child/providerRoles
Benefit Groups
The benefitGroups resource is used to view, create, modify, or delete a benefits group. It is a setup-side entity in the Benefits product, used to group persons or employees for the participation, election, or maintenance processes. You also use this resource to include or exclude people in benefit plans, options, or rate values through eligibility profile criteria.
Create a benefit group
Method: post
Path: /hcmRestApi/resources/11.13.18.05/benefitGroups
Delete a benefit group
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/benefitGroups/{BenefitGroupName}
Get a benefit group
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitGroups/{BenefitGroupName}
Get all benefit groups
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitGroups
Update a benefit group
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/benefitGroups/{BenefitGroupName}
Benefits Comparison Plans
The benefitPlansComparison resource includes all the benefit plans for comparison based on person eligibility. You must use finders with this resource to get results.
Get a benefit plan for comparison
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}
Get all benefit plans for comparison
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison
Benefits Comparison Plans/Estimated Costs
The estimatedCosts resource is a child of the benefitPlansComparison resource. This resource provides all estimated costs of the benefit plan.
Get all estimated costs
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/estimatedCosts
Get an estimated cost
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/estimatedCosts/{InstanceValueId}
Benefits Comparison Plans/Feature Values
The featureValues resource is a child of the benefitPlansComparison resource. This resource provides all the values that are associated with the features of the benefit plan.
Get a feature value
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/featureValues/{InstanceValueId}
Get all feature values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/featureValues
Benefits Comparison Plans/Feature Values/Footnote References
The footnoteReferences resource is a child of the featureValues resource. This resource provides all the footnote references that are associated with the particular feature value of the benefit plan.
Get a footnote reference
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/featureValues/{InstanceValueId}/child/footnoteReferences/{ItemId}
Get all footnote references
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/featureValues/{InstanceValueId}/child/footnoteReferences
Benefits Comparison Plans/Footnotes
The footnotes resource is a child of the benefitPlansComparison resource. This resource provides all the footnotes that are associated with the plan template.
Get a footnote
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/footnotes/{ItemId}
Get all footnotes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/footnotes
Benefits Comparison Plans/Highlights
The highlights resource is a child of the benefitPlansComparison resource. This resource provides all the highlights of the benefit plan.
Get a highlight
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/highlights/{InstanceValueId}
Get all highlights
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/highlights
Benefits Comparison Plans/Images
The images resource is a child of the benefitPlansComparison resource. This resource provides the image of the benefit plan.
Get all images
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/images
Get an image
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/images/{ImageId}
Candidate URL for Background Check
The recruitingCEBackgroundChecks resource is a child of recruitingCEJobApplications. It provides the links to go to background check partner sites. Note that the service endpoints in this resource category are only for Oracle internal use.
Create a background check
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEBackgroundChecks
Get a background check
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEBackgroundChecks/{ProvisioningId}
Get all background checks
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEBackgroundChecks
Channel Messages
The hcmChannelMessages resource includes the from, to, date, subject, body and is used to view, create, update, and delete channel messages.
Create a channel message
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmChannelMessages
Delete a channel message
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmChannelMessages/{MessageId}
Get a channel message
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmChannelMessages/{MessageId}
Get all channel messages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmChannelMessages
Update a channel message
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmChannelMessages/{MessageId}
Channel Messages/Message Attachments
The messageAttachments resource includes attachments for channel messages. It is used to view, create, and update attachments.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmChannelMessages/{MessageId}/child/messageAttachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmChannelMessages/{MessageId}/child/messageAttachments/{AttachedDocumentId}
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmChannelMessages/{MessageId}/child/messageAttachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmChannelMessages/{MessageId}/child/messageAttachments/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmChannelMessages/{MessageId}/child/messageAttachments/{AttachedDocumentId}
Check-In Documents
The checkInDocuments resource is used to create, view, and update check-in documents that are used in Talent Management. You can filter based on a check-in document ID or list all the check-in documents for a specific worker.
Create a document
Method: post
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments
Get a document
Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}
Get all documents
Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments
Update a document
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}
Check-In Documents/Questionnaire Responses
The questionnaireResponses resource is child of the check-in documents resource. It includes the responses to questionnaires provided by a person on a specific subject. The parent resource is required and contains the complete context of the questionnaire.
Get a response
Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all responses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses
Check-In Documents/Questionnaire Responses/Question Responses
The questionResponses resource is a child of the questionnaire responses resource. The Question Responses resource includes the responses to the questions from the respondents. A questionnaire may have one or more question responses.
Create a response
Method: post
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a response
Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Get all responses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a response
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Check-In Documents/Questionnaire Responses/Question Responses/Attachments
The responseAttachments resource is a child of the question responses resource. The Response Attachments resource includes the attachments for the responses provided by the respondents to the questions in questionnaires. A question may have none or one or many response attachments.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/responseAttachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/responseAttachments/{AttachedDocumentId}
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/responseAttachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/responseAttachments/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{CheckInDocumentId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/responseAttachments/{AttachedDocumentId}
Dependent Care FSA Calculators
The dependentCareFsaCalculator resource provides estimates on how much more the employee can save by enrolling in a flexible spending account.
Create an estimate
Method: post
Path: /hcmRestApi/resources/11.13.18.05/dependentCareFsaCalculator
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/dependentCareFsaCalculator
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/dependentCareFsaCalculator/{dependentCareFsaCalculatorUniqID}
Document Delivery Preferences
The documentDeliveryPreferences resource provides a person's delivery preferences for document records.
Get a delivery preference for a document record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentDeliveryPreferences/{documentDeliveryPreferencesUniqID}
Get all delivery preferences for document records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentDeliveryPreferences
Document Records
The documentRecords resource includes all the document records for a person. It is used to create and view the document records for a person.
Create a document record
Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentRecords
Delete a document record
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}
Get a document record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}
Get all document records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords
Update a document record
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}
Document Records/Attachments
The attachments resource is a child of the documentRecords resource. It is used to add and view the attachments to a document record for a person.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{AttachedDocumentId}
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{AttachedDocumentId}
Document Records/Document Records Descriptive Flexfields
The documentRecordsDFF resource is a child of the documentRecords resource. It represents the extensible structure (descriptive flexfields) of a document record.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDFF/{DocumentsOfRecordId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDFF/{DocumentsOfRecordId2}
Document Records/Document Records Developer Descriptive Flexfields
The documentRecordsDDF resource is a child of the documentRecords resource. It is used to capture the legislative information of a document record.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDDF/{DocumentsOfRecordId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDDF/{DocumentsOfRecordId2}
Element Entries
The elementEntries resource includes salary, benefits, or any other recurring or non-recurring entries, such as bonus for a worker.
Create an element entry
Method: post
Path: /hcmRestApi/resources/11.13.18.05/elementEntries
Delete an element entry
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}
Get all element entries
Method: get
Path: /hcmRestApi/resources/11.13.18.05/elementEntries
Get an element entry
Method: get
Path: /hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}
Update an element entry
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}
Element Entries/Element Entry Values
The elementEntryValues resource is a child of the elementEntries resource.It includes values entered for an element, such as amount, periodicity, or rate.
Create an element entry value
Method: post
Path: /hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/elementEntryValues
Get all element entry values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/elementEntryValues
Get an element entry value
Method: get
Path: /hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/elementEntryValues/{elementEntryValuesUniqID}
Update an element entry value
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/elementEntryValues/{elementEntryValuesUniqID}
Eligibility Object Results
The eligibilityObjectResults resource provides the list of eligibility results for a worker.
Create an eligibility object result
Method: post
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjectResults
Delete an eligibility object result
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjectResults/{eligibilityObjectResultsUniqID}
Get all eligibility object results
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjectResults
Get an eligibility object result
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjectResults/{eligibilityObjectResultsUniqID}
Update an eligibility object result
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjectResults/{eligibilityObjectResultsUniqID}
Eligibility Objects
The eligibilityObjects resource provides the list of eligibility objects for a worker.
Create an eligibility object
Method: post
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjects
Delete an eligibility object
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}
Get all eligibility objects
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjects
Get an eligibility object
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}
Update an eligibility object
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}
Eligibility Objects/Eligibility Object Profiles
The eligibilityObjectProfiles resource provides the list of eligibility profiles for a worker.
Create an eligibility object profile
Method: post
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles
Delete an eligibility object profile
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles/{eligibilityObjectProfilesUniqID}
Get all eligibility object profiles
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles
Get an eligibility object profile
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles/{eligibilityObjectProfilesUniqID}
Update an eligibility object profile
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles/{eligibilityObjectProfilesUniqID}
Email Address Migrations
The emailAddrMigrations resource allows the application to add configuration values (email addresses) to the configuration table.
Create an email address migration
Method: post
Path: /hcmRestApi/resources/11.13.18.05/emailAddrMigrations
Get all email address migrations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emailAddrMigrations
Get an email address migration
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emailAddrMigrations/{ConfigId}
Update an email address migration
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/emailAddrMigrations/{ConfigId}
Employees
The emps resource includes all employees as of the specified date. By default, the current date is retained.
This controlled availability resource will be deprecated in the future releases. For implementing new integrations, you're advised to use the workers resource instead.
Create an employee
Method: post
Path: /hcmRestApi/resources/11.13.18.05/emps
Get all employees
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps
Get an employee
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}
Update an employee
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}
Employees/Assignments
The assignments resource is a child of the emps resource. It includes all employee assignments as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Create an assignment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments
Get all assignments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments
Get an assignment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}
Update an assignment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}
Employees/Assignments/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the assignments resource. It includes all employee assignment key flexfields as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentDFF/{assignmentDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentDFF/{assignmentDFFUniqID}
Employees/Assignments/Assignment Extra Information Extensible FlexFields
The assignmentExtraInformation resource is a child of the emps resource. It includes all the extensible flexfields for additional assignment information as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentExtraInformation
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentExtraInformation/{assignmentExtraInformationUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentExtraInformation
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentExtraInformation/{assignmentExtraInformationUniqID}
Employees/Assignments/Employee Representatives
The empreps resource is a child of the assignments resource. It includes all employee representatives as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Get a representative
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/empreps/{emprepsUniqID}
Get all representatives
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/empreps
Employees/Assignments/People Group Key Flexfields
The peopleGroupKeyFlexfield resource is a child of the assignments resource. It includes all employee assignment key flexfields as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/peopleGroupKeyFlexfield/{_PEOPLE_GROUP_ID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/peopleGroupKeyFlexfield
Employees/Direct Reports
The directReports resource is a child of the emps resource. It includes all employee direct reports as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Get a direct report
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/directReports/{directReportsUniqID}
Get all direct reports
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/directReports
Employees/Person Descriptive Flexfields
The personDFF resource is a child of the emps resource. It includes all employee descriptive flexfields as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personDFF/{PersonId}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personDFF/{PersonId}
Employees/Person Extra Information Extensible FlexFields
The personExtraInformation resource is a child of the emps resource. It includes all the extensible flexfields for additional person information as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personExtraInformation
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personExtraInformation/{personExtraInformationUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personExtraInformation
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personExtraInformation/{personExtraInformationUniqID}
Employees/Photos
The photo resource is a child of the emps resource. It includes all employee primary photos as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Create a photo
Method: post
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo
Delete a photo
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}
Get a photo
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}
Get all photos
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo
Update a photo
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}
Employees/Roles
The roles resource is a child of the emps resource. It includes all employee roles as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Create a role
Method: post
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/roles
Delete a role
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/roles/{RoleGUID}
Get a role
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/roles/{RoleGUID}
Get all roles
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/roles
Update a role
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/roles/{RoleGUID}
Employees/Visas
The visas resource is a child of the emps resource. It includes all employee visas as of the specified date. By default, the current date is retained.
This resource is currently under controlled availability.
Get a visa
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/visas/{visasUniqID}
Get all visas
Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/visas
Flow Instances
The flowInstances resource provides a list of all submitted payroll flows.
Get a payroll flow instance
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}
Get all payroll flow instances
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowInstances
Get available corrective actions
Method: post
Path: /hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}
Perform a corrective action
Method: post
Path: /hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}
Flow Instances/Checklists
The checklists resource is a child of the flowInstances resource and provides a list of all the tasks and actions from a submitted payroll flow.
Get a payroll flow checklist
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/child/checklists/{FlowTaskInstanceId}
Get all payroll flow checklists
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/child/checklists
Get corrective actions for a checklist
Method: post
Path: /hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/child/checklists/{FlowTaskInstanceId}
Perform a corrective action for a checklist
Method: post
Path: /hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/child/checklists/{FlowTaskInstanceId}
Flow Patterns
The flowPatterns resource provides the ability for submission of payroll flows.
Get a flow pattern
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowPatterns/{FlowId}
Get all flow patterns
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowPatterns
Submit a flow
Method: post
Path: /hcmRestApi/resources/11.13.18.05/flowPatterns/{FlowId}
Flow Patterns/Flow Parameters
The flowParameters resource is the child of the flowPatterns resource and provides the ability to define and maintain user-defined payroll flows.
Get a flow parameter
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowPatterns/{FlowId}/child/flowParameters/{FlowParameterId}
Get all flow parameters
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowPatterns/{FlowId}/child/flowParameters
Gig Details
The recruitingOppMktGigDetails resource provides details on a gig in opportunity marketplace.
Create gig details in opportunity marketplace
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails
Delete a detail on a gig in opportunity marketplace
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}
Get a detail on an opportunity marketplace gig
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}
Get all details on an opportunity marketplace gig
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails
Update a detail on a gig in opportunity marketplace
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}
Gig Details/Gig Applications
The gigApplications resource is the child of the recruitingOppMktGigDetails resource and provides the list of applications for a gig in opportunity marketplace.
Get all applications for a gig in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigApplications
Get an application for a gig in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigApplications/{ApplicationId}
Gig Details/Gig Benefits
The benefits resource is the child of the recruitingOppMktGigDetails resource and provides the benefits of a gig in opportunity marketplace.
Create a benefit for a gig in opportunity marketplace
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits
Delete a benefit of a gig in opportunity marketplace
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}
Get a benefit of a gig in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}
Get all benefits of a gig in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits
Update a benefit of a gig in opportunity marketplace
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}
Gig Details/Gig Classifications
The gigClassifications resource is the child of the recruitingOppMktGigDetails resource and provides the list of classifications for a gig in opportunity marketplace.
Create a classification for a gig in opportunity marketplace
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications
Delete a classification for a gig in opportunity marketplace
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications/{gigClassificationsUniqID}
Get a classification for a gig in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications/{gigClassificationsUniqID}
Get all classifications for a gig in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications
Update a classification for a gig in opportunity marketplace
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications/{gigClassificationsUniqID}
Gig Details/Gig Media Links
The gigMediaLinks resource is the child of the recruitingOppMktGigDetails resource and provides the list of media for a gig in opportunity marketplace.
Create a media link for a gig in opportunity marketplace
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigMediaLinks
Delete a media link for a gig in opportunity marketplace
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigMediaLinks/{GigMediaLinkId}
Get a media link for a gig in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigMediaLinks/{GigMediaLinkId}
Get all media links for a gig in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigMediaLinks
Update a media link for a gig in opportunity marketplace
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigMediaLinks/{GigMediaLinkId}
Gig Details/Gig Skills
The skills resource is the child of the recruitingOppMktGigDetails resource and provides the skills of a gig in opportunity marketplace.
Create a skill for a gig in opportunity marketplace
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigSkills
Delete a skill on a gig in opportunity marketplace
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigSkills/{SkillId}
Get a skill on an opportunity marketplace gig
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigSkills/{SkillId}
Get all skills on an opportunity marketplace gig
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigSkills
Gig Details/Gig Team Members
The teamMembers resource is the child of the recruitingOppMktGigDetails resource and provides the list of team members working on a gig in opportunity marketplace.
Create a team member for a gig in opportunity marketplace
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/teamMembers
Delete a team member for a gig in opportunity marketplace
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/teamMembers/{TeamMemberId}
Get a team member for a gig in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/teamMembers/{TeamMemberId}
Get all team members for a gig in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/teamMembers
Update a team member for a gig in opportunity marketplace
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/teamMembers/{TeamMemberId}
Grade Ladders
The gradeLadders resource includes a hierarchy of grades and steps used to identify the progression order for a grade, as of the specified date. It is also includes compensation rates associated to the hierarchy for career grade step progressions. By default, the current date is retained.
Get a grade ladder
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}
Get all grade ladders
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders
Grade Ladders/Grade Ladder Descriptive Flexfields
The gradeLadderDFF resource is a child of the gradeLadders resource. It includes descriptive flexfields for a grade ladder, identified by PER_GRADE_LADDERS_DF code.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/gradeLadderDFF/{gradeLadderDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/gradeLadderDFF
Grade Ladders/Grades
The grades resource is a child of the gradeLadders resource. It includes all the grades that are attached to the grade ladder and the order in which they are attached.
Get a grade
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/grades/{gradesUniqID}
Get all grades
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/grades
Grade Ladders/Step Rates
The stepRates resource is a child of the gradeLadders resource. It includes step rates, representing pay rate that is defined for the grade steps, as of the specified date.
Get a step rate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates/{stepRatesUniqID}
Get all step rates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates
Grade Ladders/Step Rates/Step Rate Values
The stepRateValues resource is a child of the stepRates resource. It includes monetary values defined for the grade steps and the given step rate, as of the specified date.
Get a value
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates/{stepRatesUniqID}/child/stepRateValues/{stepRateValuesUniqID}
Get all values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates/{stepRatesUniqID}/child/stepRateValues
Grade Rates
The gradeRates resource includes pay rates for all the grades as of the specified date. By default, the current date is retained.
Get a grade rate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}
Get all grade rates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeRates
Grade Rates/Rate Values
The rateValues resource is a child of the gradeRates resource. It includes monetary values or ranges of values for all grades assigned to the grade rate, as of the specified date.
Get a rate value
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}/child/rateValues/{rateValuesUniqID}
Get all rate values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}/child/rateValues
Grades
The grades resource includes all grades as of the specified date. By default, the current date is retained.
Get a grade
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}
Get all grades
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades
Grades/Grade Customer Flexfields
The GradeCustomerFlex resource is a child of the grades resource. It includes all grade flexfields as of the specified date. By default, the current date is retained.
Get a grade flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}/child/GradeCustomerFlex/{GradeCustomerFlexUniqID}
Get all grade flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}/child/GradeCustomerFlex
Grades/Grade Steps
The steps resource is a child of the grades resource. It includes all steps, that is, incremental points within the grade as of the specified date.
Get a grade step
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}/child/steps/{stepsUniqID}
Get all grade steps
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}/child/steps
HCM Contacts
The hcmContacts resource provides all the contacts of various workers as of the specified date. By default, the current date is retained.
Create a contact
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts
Get a contact
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}
Get all contacts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts
Update a contact
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}
HCM Contacts/Addresses
The addresses resource is a child of the hcmContacts resource. It provides all the addresses of worker contacts as of the specified date. By default, the current date is retained.
Create an address
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses
Delete an address
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}
Get all addresses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses
Get an address
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}
Update an address
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}
HCM Contacts/Addresses/Address Descriptive Flexfields
The addressesDFF resource is a child of the addresses resource. It provides all the address descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF/{addressesDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF/{addressesDFFUniqID}
HCM Contacts/Citizenships
The citizenships resource is a child of the hcmContacts resource. It provides all the citizenships of worker contacts as of the specified date. By default, the current date is retained.
Create a citizenship
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships
Delete a citizenship
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}
Get a citizenship
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}
Get all citizenships
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships
Update a citizenship
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}
HCM Contacts/Citizenships/Citizenship Descriptive Flexfields
The citizenshipsDFF resource is a child of the citizenships resource. It provides all the citizenship descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF/{CitizenshipId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF/{CitizenshipId2}
HCM Contacts/Contact Descriptive Flexfields
The contactsDFF resource is a child of the hcmContacts resource. It provides all descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF
Delete a flexfield
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF/{PersonId}
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF/{PersonId}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF/{PersonId}
HCM Contacts/Contact Relationships
The contactRelationships resource is a child of the hcmContacts resource. It provides all the contact relationships of workers as of the specified date. By default, the current date is retained.
Create a contact relationship
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships
Delete a contact relationship
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}
Get a contact relationship
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}
Get all contact relationships
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships
Update a contact relationship
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}
HCM Contacts/Contact Relationships/Contact Relationships Descriptive Flexfields
The contactRelationshipsDFF resource is a child of the contactRelationships resource. It provides all the descriptive flexfields for contact relationships as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF/{contactRelationshipsDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF/{contactRelationshipsDFFUniqID}
HCM Contacts/Contact Relationships/Contact Relationships Developer Flexfields
The contactRelationshipsDDF resource is a child of the contactRelationships resource. It provides all the developer flexfields for contact relationships as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF/{contactRelationshipsDDFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF/{contactRelationshipsDDFUniqID}
HCM Contacts/Driver Licenses
The driverLicenses resource is a child of the hcmContacts resource. It provides all the driver licenses of worker contacts as of the specified date. By default, the current date is retained.
Create a drivers license
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses
Delete a drivers license
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}
Get a drivers license
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}
Get all drivers licenses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses
Update a drivers license
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}
HCM Contacts/Driver Licenses/Driver License Descriptive Flexfields
The driverLicensesDDF resource is a child of the driverLicenses resource. It provides all the driver license descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF/{DriversLicenseTypeId}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF/{DriversLicenseTypeId}
HCM Contacts/Driver Licenses/Driver License Developer Flexfields
The driverLicensesDDF resource is a child of the driverLicenses resource. It provides all the driver license developer flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF/{DriversLicenseId}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF/{DriversLicenseId}
HCM Contacts/Emails
The emails resource is a child of the hcmContacts resource. It provides all the email addresses of worker contacts as of the specified date. By default, the current date is retained.
Create an email
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails
Delete an email
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}
Get all emails
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails
Get an email
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}
Update an email
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}
HCM Contacts/Emails/Email Descriptive Flexfields
The emailsDFF resource is a child of the emails resource. It provides all the email descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF/{EmailAddressId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF/{EmailAddressId2}
HCM Contacts/Ethnicities
The ethnicities resource is a child of the hcmContacts resource. It provides all the ethnicities of worker contacts as of the specified date. By default, the current date is retained.
Create an ethnicity
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities
Delete an ethnicity
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}
Get all ethnicities
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities
Get an ethnicity
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}
Update an ethnicity
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}
HCM Contacts/Ethnicities/Ethnicity Descriptive Flexfields
The ethnicitiesDFF resource is a child of the ethnicities resource. It provides all the ethnicity descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF/{EthnicityId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF/{EthnicityId2}
HCM Contacts/Legislative Information
The legislativeInfo resource is a child of the hcmContacts resource. It provides all the legislative informaton of worker contacts as of the specified date. By default, the current date is retained.
Create a legislative record
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo
Delete a legislative record
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
Get a legislative record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
Get all legislative records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo
Update a legislative record
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
HCM Contacts/Legislative Information/Legislative Information Descriptive Flexfields
The legislativeInfoDFF resource is a child of the legislativeInfo resource. It provides all the legislative informaton descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF/{legislativeInfoDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF/{legislativeInfoDFFUniqID}
HCM Contacts/Legislative Information/Legislative Information Developer Flexfields
The legislativeInfoDDF resource is a child of the legislativeInfo resource. It provides all the legislative informaton developer flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF/{legislativeInfoDDFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF/{legislativeInfoDDFUniqID}
HCM Contacts/Names
The names resource is a child of the hcmContacts resource. It provides all the names of worker contacts as of the specified date. By default, the current date is retained.
Create a name
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names
Delete a name
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names/{namesUniqID}
Get a name
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names/{namesUniqID}
Get all names
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names
Update a name
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names/{namesUniqID}
HCM Contacts/National Identifiers
The nationalIdentifiers resource is a child of the hcmContacts resource. It provides all the national identifiers of worker contacts as of the specified date. By default, the current date is retained.
Create a national identifier
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers
Delete a national identifier
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
Get a national identifier
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
Get all national identifiers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers
Update a national identifier
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
HCM Contacts/National Identifiers/National Identifier Descriptive Flexfields
The nationalIdentifiersDFF resource is a child of the nationalIdentifiers resource. It provides all the national identifier descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF/{NationalIdentifierId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF/{NationalIdentifierId2}
HCM Contacts/Other Communication Accounts
The otherCommunicationAccounts resource is a child of the hcmContacts resource. It provides all the other communication accounts of worker contacts as of the specified date. By default, the current date is retained.
Create a communication account
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts
Delete a communication account
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
Get a communication account
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
Get all communication accounts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts
Update a communication account
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
HCM Contacts/Other Communication Accounts/Other Communication Account Descriptive Flexfields
The otherCommunicationAccountsDFF resource is a child of the contacts resource. It provides all the other communication account descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF/{DeliveryMethodId2}
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF/{DeliveryMethodId2}
HCM Contacts/Passports
The passports resource is a child of the hcmContacts resource. It provides all the passports of worker contacts as of the specified date. By default, the current date is retained.
Create a passport
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports
Delete a passport
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}
Get a passport
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}
Get all passports
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports
Update a passport
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}
HCM Contacts/Passports/Passport Developer Flexfields
The passportsDFF resource is a child of the passports resource. It provides all the passport descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF/{PassportId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF/{PassportId2}
HCM Contacts/Phones
The phones resource is a child of the hcmContacts resource. It provides all the phones of worker contacts as of the specified date. By default, the current date is retained.
Create a phone
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones
Delete a phone
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}
Get a phone
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}
Get all phones
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones
Update a phone
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}
HCM Contacts/Phones/Phone Descriptive Flexfields
The phonesDFF resource is a child of the phones resource. It provides all the phone descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}/child/phonesDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}/child/phonesDFF/{PhoneId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}/child/phonesDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}/child/phonesDFF/{PhoneId2}
HCM Contacts/Religions
The religions resource is a child of the hcmContacts resource. It provides all the religions of worker contacts as of the specified date. By default, the current date is retained.
Create a religion
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions
Delete a religion
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}
Get a religion
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}
Get all religions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions
Update a religion
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}
HCM Contacts/Religions/Religion Descriptive Flexfields
The religionsDFF resource is a child of the contacts resource. It provides all the religion descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}/child/religionsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}/child/religionsDFF/{ReligionId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}/child/religionsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}/child/religionsDFF/{ReligionId2}
HCM Contacts/Visa Permits
The visasPermits resource is a child of the hcmContacts resource. It provides all the visas and permits of worker contacts as of the specified date. By default, the current date is retained.
Create a visa permit
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits
Delete a visa permit
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}
Get a visa permit
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}
Get all visas permits
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits
Update a visa permit
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}
HCM Contacts/Visa Permits/Visa Permit Descriptive Flexfields
The visasPermitsDFF resource is a child of the visasPermits resource. It provides all the visa permit developer flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF/{visasPermitsDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF/{visasPermitsDFFUniqID}
HCM Contacts/Visa Permits/Visa Permit Developer Flexfields
The visasPermitsDDF resource is a child of the visasPermits resource. It provides all the visa permit descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF/{visasPermitsDDFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF/{visasPermitsDDFUniqID}
Health Care FSA Calculators
The healthCareFsaCalculator resource provides estimates on the annual health care costs of the employee and how much the employee can save by enrolling in a flexible spending account.
Create an estimate
Method: post
Path: /hcmRestApi/resources/11.13.18.05/healthCareFsaCalculator
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthCareFsaCalculator
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthCareFsaCalculator/{healthCareFsaCalculatorUniqID}
Health Savings Account Calculators
The healthSavingsAccountCalculator resource provides estimates on the future value, earnings, and tax savings for the employee's health savings account.
Calculate health savings
Method: post
Path: /hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator
Create an estimate
Method: post
Path: /hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator/{healthSavingsAccountCalculatorUniqID}
Health Surveys
The healthSurveys resource includes the health survey events submitted by employees to record health and related details.
Create a health survey
Method: post
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys
Get a health survey
Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}
Get all health surveys
Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys
Health Surveys/Questionnaire Responses
The QuestionnaireResponses resource provides questions and responses to use in a health survey incident.
Create a questionnaire response
Method: post
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses
Get a questionnaire response
Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}
Get all questionnaire responses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses
Health Surveys/Questionnaire Responses/Attachments
The Attachments resource provides attachments that are included with a response in a health survey incident.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachedDocumentId}
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachedDocumentId}
Incident Kiosks
The incidentKiosks resource provides a kiosk version of incidents. This resource allows a simple GET and POST operation on incidents.
Create an incident
Method: post
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks
Get all incidents
Method: get
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks
Get an incident
Method: get
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}
Incident Kiosks/Incident Detail Kiosks
The incidentDetailKiosk is a child resource of incidentKiosks. It provides information about incident events. This resource allows a simple GET and POST operation on incidents events.
Create an incident event
Method: post
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/IncidentDetailKiosk
Get all incident events
Method: get
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/IncidentDetailKiosk
Get an incident event
Method: get
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/IncidentDetailKiosk/{IncidentDetailId}
Job Application Grid View Fields
The recruitingGridViewFields root resource provides the grid view fields.
Get a grid view field.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingGridViewFields/{recruitingGridViewFieldsUniqID}
Get all grid view fields.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingGridViewFields
Job Details in Opportunity Marketplace
The recruitingOppMktJobDetails resource provides details on a job in opportunity marketplace.
Get a job detail in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}
Get all job details in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails
Job Details in Opportunity Marketplace/Job Contacts in Opportunity Marketplace
The contacts resource is the child of the recruitingOppMktJobDetails and provides contacts for a job in opportunity marketplace.
Get a contact for a job in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/contacts/{PersonId}
Get all contacts for a job in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/contacts
Job Details in Opportunity Marketplace/Job Secondary Locations in Opportunity Marketplace
The secondaryLocations resource is the child of the recruitingOppMktJobDetails and provides secondary locations of a job in opportunity marketplace.
Get a secondary location for a job in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/secondaryLocations/{RequisitionLocationId}
Get all secondary locations for a job in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/secondaryLocations
Job Details in Opportunity Marketplace/Job Secondary Work Locations in Opportunity Marketplace
The secondaryWorkLocations resource is the child of the recruitingOppMktJobDetails and provides secondary work locations of a job in opportunity marketplace.
Get a secondary work location for a job in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/secondaryWorkLocations/{RequisitionWorkLocationId}
Get all secondary work locations for a job in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/secondaryWorkLocations
Job Details in Opportunity Marketplace/Media in Job in Opportunity Marketplace
The medias resource is the child of the recruitingOppMktJobDetails and provides media for a job in opportunity marketplace.
Get a media for a job in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/medias/{MediaLinkId}
Get all media for a job in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/medias
Job Families
The jobFamilies resource includes all job families as of the specified date. By default, the current date is retained.
Get a job family
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobFamilies/{jobFamiliesUniqID}
Get all job families
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobFamilies
Job Families/Job Family Descriptive Flexfields
The JobFamilyDFF resource is a child of the jobFamilies resource. It includes all job family flexfields as of the specified date. By default, the current date is retained.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobFamilies/{jobFamiliesUniqID}/child/JobFamilyDFF/{JobFamilyDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobFamilies/{jobFamiliesUniqID}/child/JobFamilyDFF
Job Requisition Details
The recruitingCEJobRequisitionDetails resource includes the details about an external, published job. You need to provide path parameters for these requests. Requests without parameters aren't allowed and will return an error. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a job requisition details pertaining to a published job
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}
Get all job requisition details pertaining to a published job
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails
Job Requisition Details/Job Requisition Flexfields
The requisitionFlexFields resource is a child of recruitingCEJobRequisitionDetails. It includes details of requisition flexfields. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a requisition flexfield for the requisition details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/requisitionFlexFields/{ColumnName}
Get all requisition flexfields for the requisition details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/requisitionFlexFields
Job Requisition Details/Media
The media resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of the media used. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a media used in the requisition template details preview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/media/{Id}
Get all media used in the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/media
Job Requisition Details/Other Work Locations
The otherWorkLocations resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of other work locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all other work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/otherWorkLocations
Get other work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/otherWorkLocations/{RequisitionWorkLocationId}
Job Requisition Details/Primary Location Coordinates
The primaryLocationCoordinates resource is a child of recruitingCEJobRequisitionDetails. It includes details of primary location coordinates. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a primary location coordinates for the requisition details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/primaryLocationCoordinates/{primaryLocationCoordinatesUniqID}
Get all primary location coordinates for the requisition details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/primaryLocationCoordinates
Job Requisition Details/Secondary Locations
The secondaryLocations resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of the secondary locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a secondary location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/secondaryLocations/{RequisitionLocationId}
Get all secondary locations for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/secondaryLocations
Job Requisition Details/Skills
The skills resource is a child of recruitingCEJobRequisitionDetails. It includes details of skills mentioned in the requisition.
Get the details of a skill
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/skills/{ProfileId}
Get the details of all the skills
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/skills
Job Requisition Details/Work Locations
The workLocation resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of other work locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/workLocation/{LocationId}
Get all work locations for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{RequisitionId}/child/workLocation
Jobs
The jobs resource includes all jobs as of the specified date. By default, the current date is retained.
Get a job
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobs/{jobsUniqID}
Get all jobs
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobs
Jobs/Job Customer Flexfields
The JobCustomerFlex resource is a child of the jobs resource. It includes all job flexfields as of the specified date. By default, the current date is retained.
Get a job flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobs/{jobsUniqID}/child/JobCustomerFlex/{JobCustomerFlexUniqID}
Get all job flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobs/{jobsUniqID}/child/JobCustomerFlex
Jobs/Valid Grades
The validGrades resource is a child of the jobs resource. It includes all valid grades for the job, as of the specified date.
Get a valid grade
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobs/{jobsUniqID}/child/validGrades/{validGradesUniqID}
Get all valid grades
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobs/{jobsUniqID}/child/validGrades
Journey
The journeys resource includes all assignable journey templates.
Create a default property for a task type in a journey
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys
Create a journey template
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys
Create action for a contextual journey
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys
Create default property of a journey
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys
Delete a journey template
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}
Get a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}
Get all journey templates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys
Update a journey template
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}
Journey Assignment
Journey Assignment
Create a journey assignment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations
Get a journey assignment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}
Get all journey assignments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations
Journey Assignment/Journey Assignees
Journey Assignees
Get a worker with assigned journey
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workers/{JourneyAllocationWorkerId}
Get all workers with assigned journeys
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workers
Journey Assignment/Journey Assignees Count
Journey Assignees Count
Get a count of assigned journey
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workerCounts/{JourneyAllocationId}
Get all counts of assigned journey
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workerCounts
Journey Assignment/Journey Assignment Criteria
Journey Assignment Criteria
Create a journey assignment based on criteria
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/criteria
Get all assigned journeys based on criteria
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/criteria
Get an assigned journey based on criteria
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/criteria/{criteriaUniqID}
Journey Counts
The journeyCounts resource provides counts of a worker journey.
Get a journey count
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}
Get all journey counts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyCounts
Journey Counts/Facets
The facets resource is a child of the journeyCounts resource and includes all the search filters in the worker journey.
Get a facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}/child/facets/{FacetId}
Get all facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}/child/facets
Journey Counts/Facets/Values
The values resource is a child of the journeyCounts resource and includes all the values for the search filters in the worker journey.
Get a value
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}/child/facets/{FacetId}/child/values/{ValueId}
Get all values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}/child/facets/{FacetId}/child/values
Journey Tasks Library
The resource includes all global library tasks and personal library tasks of the signed in user.
Create personal library tasks
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary
Delete a personal library task
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}
Get a library task
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}
Get all library tasks
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary
Update a personal library task
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}
Journey Tasks Library/Attachments
The attachments resource is used to view, create, and update attachments.
Create an attachment.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents
Delete an attachment.
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{AttachedDocumentId}
Get all attachments.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents
Get an attachment.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{AttachedDocumentId}
Update an attachment.
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{AttachedDocumentId}
Journey Tasks Library/Journey Task Library Notifications
The notifications resource is a child of the tasks resource. It includes a list of notification settings for the task performer and owner.
Get a task notification override
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/notifications/{LibraryJourneyTaskNotificationId}
Get all notification overrides
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/notifications
Update a task notification override
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/notifications/{LibraryJourneyTaskNotificationId}
Journey Tasks Library/Journey Task Library Properties
The properties resource is a child of the tasks resource. It provides a list of properties settings for the task performer and owner.
Create a library task property
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/properties
Get a library task property
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/properties/{Code}
Get all library task properties
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/properties
Update a library task property
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/properties/{Code}
Journey/Contact
The contacts resource is a child of the journeys resource. It includes a list of contacts associated with the parent journey template.
Create a contact in a journey template
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts
Get a contact in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts/{JourneyContactId}
Get all contacts in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts
Journey/Event
The events resource is a child of the journeys resource. It includes all events associated with the parent journey template.
Create an event in a journey template
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/events
Get all events in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/events
Get an event in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/events/{JourneyEventId}
Journey/Journey Property
The properties resource is the child of the journeys resource. It includes all the journey properties associated with the parent journey template.
Create a property in a journey template
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties
Create all properties in a journey template
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties/{Code}
Get a property in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties/{Code}
Get all properties in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties
Journey/Journey Task Type
The taskTypes resource is the child of the journeys resource. It includes all the task types associated with the parent journey template.
Create a task type in a journey template
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes
Create all task types in a journey template
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}
Get a task type in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}
Get all task types in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes
Journey/Journey Task Type/Journey Task Type Property
The properties resource is the child of the taskTypes resource. It includes all the journey task type properties associated with the parent journey template.
Create a task type property in a journey template
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties
Get a task type property in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties/{Code2}
Get all task type properties in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties
Update a task type property in a journey template
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties/{Code2}
Journey/Note
The notes resource is a child of the journeys resource. It includes all the notes associated with the parent journey template.
Create a note in a journey template
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/notes
Get a note in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/notes/{JourneyNoteId}
Get all notes in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/notes
Journey/Step Task
The allStepTasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.
Get a step task in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/allStepTasks/{JourneyTaskId}
Get all step tasks in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/allStepTasks
Journey/Task
The tasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.
Create a task in a journey template
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks
Delete a task in a journey template
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}
Get a task in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}
Get all tasks in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks
Update a task in a journey template
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}
Journey/Task/Attachments
The attachments resource is used to view, create, and update attachments.
Create an attachment.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents
Delete an attachment.
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{AttachedDocumentId}
Get all attachments.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents
Get an attachment.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{AttachedDocumentId}
Update an attachment.
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{AttachedDocumentId}
Journey/Task/Journey Task Property
The properties resource is the child of the journeys resource. It includes all the task type properties associated with the parent journey template.
Create a task property in a journey template
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/properties
Create all task properties in a journey template
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/properties/{Code}
Get a task property in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/properties/{Code}
Get all task properties in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/properties
Journey/Task/Task Notification
The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.
Create a notification in a journey template
Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/notifications
Get a notification in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/notifications/{JourneyTaskNotificationId}
Get all notifications in a journey template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/notifications
Update a notification in a journey template
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/notifications/{JourneyTaskNotificationId}
Learner Learning Records
The learnerLearningRecords resource includes a collection of assignment records or a single assignment record when queried with assignment record ID for a learner. This is a functional user REST resource and applies to a learner and not a learning specialist. The assignment records are included for learning item types - Course, Specialization, Video and Tutorial. The assignment records include Voluntary and Required assignments and not recommended.
Create an assignment record
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords
Get all assignment records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords
Get an assignment record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}
Update an assignment record
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}
Learner Learning Records/Active Learner Comments
The activeLearnerComments resource is a child of the learnerLearningRecords resource. It provides details of all comments of active and completed learners for the learning item associated to a learner's assignment record.
Create an active learner comment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments
Get all active learner comments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments
Get an active learner comment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Update an active learner comment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Learner Learning Records/Active Learner Comments/Likes
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a like
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Get a like
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes/{likeId}
Get all likes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Update a like
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes/{likeId}
Learner Learning Records/Active Learner Comments/Replies
The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a reply
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Get a reply
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}
Get all replies
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Update a reply
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}
Learner Learning Records/Active Learner Comments/Replies/Likes
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a like
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes
Get a like
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes/{likeId}
Get all likes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes
Update a like
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes/{likeId}
Learner Learning Records/Approval Details
The approvalDetails resource is a child of the learnerLearningRecords resource. It provides the approval details information associated with the learning record.
Get all approval details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/approvalDetails
Get an approval detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/approvalDetails/{approvalDetailsUniqID}
Learner Learning Records/Assigned To Person Details
The assignedToPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assignee of the assignment records.
Get all assignee to person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignedToPersonDetails
Get an assignee to person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignedToPersonDetails/{personId}
Learner Learning Records/Assigner Person Details
The assignerPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assigner of the learner's assignment records.
Get all assigner person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignerPersonDetails
Get an assigner person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignerPersonDetails/{personId}
Learner Learning Records/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Create a completion detail
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}
Get all completion details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails
Update a completion detail
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}
Learner Learning Records/Completion Details/Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity when sequencing is enabled.
Get a hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint/{assignmentTaskId}
Get all hints
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint
Learner Learning Records/Completion Details/Activity Content Attempts
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
Get a content attempt detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{attemptId}
Get all content attempt details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Learner Learning Records/Completion Details/Activity Section Completion Predecessor Hints
The activitySectionCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity section when sequencing is enabled.
Get a hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint/{assignmentTaskId}
Get all hints
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint
Learner Learning Records/Completion Details/Classrooms
The classrooms resource is a child of the completionDetails resource. It provides classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}
Get all classroom details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms
Learner Learning Records/Completion Details/Classrooms/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Completion Details/Classrooms/Classroom Descriptive Flexfields
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/classroomDFFs
Learner Learning Records/Completion Details/Instructors
The instructors resource is a child of the learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors
Get an instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}
Learner Learning Records/Completion Details/Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}/child/instructorDFF
Get an instructor flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}/child/instructorDFF/{ResourceId}
Learner Learning Records/Completion Details/Learning Item Talent Profile Summaries
The learningItemTalentProfileSummary resource is a child of the completionDetails resource. It provides talent profile summary for the learner's assignment records for specialization course activities.
Get a talent profile summary
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/learningItemTalentProfileSummary/{learningItemId}
Get all talent profile summaries
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/learningItemTalentProfileSummary
Learner Learning Records/Completion Details/Offered Languages
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
Get an offered language
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages/{courseLearningItemId}
Learner Learning Records/Completion Details/Offered Locations
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
Get an offering location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings
The otherSelectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings other than the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Get a single other selected course offering
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
Get all other selected course offerings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings
Update single other selected course offering
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}
Get all completion details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Content Attempts
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
Get a content attempt detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{attemptId}
Get all content attempt details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms
The classrooms resource is a child of the completionDetails resource. It provides classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}
Get all classroom details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/classroomDFFs
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Instructors
The instructors resource is a child of the learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors
Get an instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorId}/child/instructorDFF
Get an instructor flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorId}/child/instructorDFF/{ResourceId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Offered Languages
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages
Get an offered language
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages/{courseLearningItemId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Offered Locations
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations
Get an offering location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Related Materials
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{relatedMaterialsUniqID}
Get all related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials
Learner Learning Records/Completion Details/Other Selected Course Offerings/Learning Item Descriptive Flexfields
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Get a learning item flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF/{LearningItemId}
Get all learning item flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF
Learner Learning Records/Completion Details/Other Selected Course Offerings/Learning Item Rating Details
The learningItemRatingDetails resource is a child of the learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner's assignment record.
Create a learning item rating
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
Get a learning item rating
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{ratingId}
Get all learning item ratings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
Update a learning item rating
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{ratingId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Descriptive Flexfields
The offeringDFF resource is a child of the selectedCourseOfferings resource. It provides additional offering information stored in flexfields.
Get all offering flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF
Get an offering flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF/{offeringDFFUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Transaction Histories
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Get a transaction history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory/{transactionId}
Get all transaction histories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory
Learner Learning Records/Completion Details/Primary Selected Course Offerings
The primarySelectedCourseOffering resource is a child of the learnerLearningRecords resource. It provides the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Get a primary selected course offering
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}
Get all primary selected course offerings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering
Update a primary selected course offering
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}
Get all completion details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Activity Content Attempts
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
Get a content attempt detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{attemptId}
Get all content attempt details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Classrooms
The classrooms resource is a child of the completionDetails resource. It provides classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}
Get all classroom details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Classrooms/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/classroomDFFs
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Instructors
The instructors resource is a child of the learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors
Get an instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorId}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorId}/child/instructorDFF
Get an instructor flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorId}/child/instructorDFF/{ResourceId}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Offered Languages
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages
Get an offered language
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages/{courseLearningItemId}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Offered Locations
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations
Get an offering location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Related Materials
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{relatedMaterialsUniqID}
Get all related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Learning Item Descriptive Flexfields
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Get a learning item flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemDFF/{LearningItemId}
Get all learning item flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemDFF
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Learning Item Rating Details
The learningItemRatingDetails resource is a child of the learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner's assignment record.
Create a learning item rating
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails
Get a learning item rating
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails/{ratingId}
Get all learning item ratings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails
Update a learning item rating
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails/{ratingId}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Offering Descriptive Flexfields
The offeringDFF resource is a child of the selectedCourseOfferings resource. It provides additional offering information stored in flexfields.
Get all offering flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/offeringDFF
Get an offering flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/offeringDFF/{offeringDFFUniqID}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Transaction Histories
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Get a transaction history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/transactionHistory/{transactionId}
Get all transaction histories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/transactionHistory
Learner Learning Records/Completion Details/Related Materials
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{relatedMaterialsUniqID}
Get all related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials
Learner Learning Records/Completion Details/Selected Course Offerings
The selectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Create a selected course offering
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings
Get a selected course offering
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}
Get all selected course offerings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings
Update a selected course offering
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments
The activeLearnerComments resource is a child of the learnerLearningRecords resource. It provides details of all comments of active and completed learners for the learning item associated to a learner's assignment record.
Create an active learner comment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments
Get all active learner comments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments
Get an active learner comment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Update an active learner comment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Likes
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a like
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Get a like
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes/{likeId}
Get all likes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Update a like
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes/{likeId}
Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Replies
The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a reply
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Get a reply
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}
Get all replies
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Update a reply
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}
Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Replies/Likes
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a like
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes
Get a like
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes/{likeId}
Get all likes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes
Update a like
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes/{likeId}
Learner Learning Records/Completion Details/Selected Course Offerings/Approval Details
The approvalDetails resource is a child of the learnerLearningRecords resource. It provides the approval details information associated with the learning record.
Get all approval details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/approvalDetails
Get an approval detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/approvalDetails/{approvalDetailsUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Assigner Person Details
The assignerPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assigner of the learner's assignment records.
Get all assigner person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignerPersonDetails
Get an assigner person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignerPersonDetails/{personId}
Learner Learning Records/Completion Details/Selected Course Offerings/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}
Get all completion details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Content Attempts
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
Get a content attempt detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{attemptId}
Get all content attempt details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Classrooms
The classrooms resource is a child of the completionDetails resource. It provides classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}
Get all classroom details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Classrooms/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomId}/child/classroomDFFs
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Instructors
The instructors resource is a child of the learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors
Get an instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorId}
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorId}/child/instructorDFF
Get an instructor flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorId}/child/instructorDFF/{ResourceId}
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Offered Languages
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages
Get an offered language
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages/{courseLearningItemId}
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Offered Locations
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations
Get an offering location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Related Materials
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{relatedMaterialsUniqID}
Get all related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials
Learner Learning Records/Completion Details/Selected Course Offerings/Enrollment Related Materials
The enrollmentRelatedMaterials resource a child of the learnerLearningRecords resource. It provides related materials associated to a learner's assignment record.
Get all enrollment related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
Get an enrollment related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{enrollmentRelatedMaterialsUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Learning Item Descriptive Flexfields
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Get a learning item flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemDFF/{LearningItemId}
Get all learning item flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemDFF
Learner Learning Records/Completion Details/Selected Course Offerings/Learning Item Rating Details
The learningItemRatingDetails resource is a child of the learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner's assignment record.
Create a learning item rating
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails
Get a learning item rating
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{ratingId}
Get all learning item ratings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails
Update a learning item rating
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{ratingId}
Learner Learning Records/Completion Details/Selected Course Offerings/Learning Item Related Materials
The learningItemRelatedMaterials resource is a child of the learnerLearningRecords resource. It provides related materials for the learning item associated to a learner's assignment record.
Get a learning item related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{learningItemRelatedMaterialsUniqID}
Get all learning item related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials
Learner Learning Records/Completion Details/Selected Course Offerings/Offering Descriptive Flexfields
The offeringDFF resource is a child of the selectedCourseOfferings resource. It provides additional offering information stored in flexfields.
Get all offering flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringDFF
Get an offering flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringDFF/{offeringDFFUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Classrooms
The offeringPrimaryClassroom resource is a child of the selectedCourseOfferings resource. It provides primary classroom details for the Instructor-Led activity of the Instructor-Led and Blended offering.
Get all offering primary classrooms
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom
Get an offering primary classroom
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}
Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Classrooms/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Classrooms/Classroom Descriptive Flexfields
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/classroomDFFs
Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Instructors
The offeringPrimaryInstructor resource is a child of the selectedCourseOfferings resource. It provides the primary instructor details associated with the offering learning record.
Get all offering primary instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor
Get an offering primary instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}
Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF
Get an instructor flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF/{ResourceId}
Learner Learning Records/Completion Details/Selected Course Offerings/Transaction Histories
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Get a transaction history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/transactionHistory/{transactionId}
Get all transaction histories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/transactionHistory
Learner Learning Records/Completion Details/Selected Course Offerings/User Action Hints
The userActionHints resource is a child of the learnerLearningRecords resource. It provides hints for possible actions on learner's assignment records.
Get a user action hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/userActionHints/{learningItemId}
Get all user action hints
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/userActionHints
Learner Learning Records/Completion Details/User Action Hints
The userActionHints resource is a child of the learnerLearningRecords resource. It provides hints for possible actions on learner's assignment records.
Get a user action hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/userActionHints/{learningItemId}
Get all user action hints
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/userActionHints
Learner Learning Records/Completion Summaries
The completionSummary resource is a child of the learnerLearningRecords resource. It provides completion summary for assignment records as a collection or a single assignment record when queried with Assignment Record Id. It provides completion requirement and completion progress of a course offering associated to assignment record. The completion summary includes details like passing score and actual score, expected number of activities and effort for completion and completion progress of course offering associated with an assignment record.
Get a completion summary
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionSummary/{completionSummaryUniqID}
Get all completion summaries
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionSummary
Learner Learning Records/Course Descriptive Flexfields
The courseDFF resource is a child of the learnerLearningRecords resource. It provides additional course information stored in flexfields.
Get a course flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/courseDFF/{CourseId}
Get all course flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/courseDFF
Learner Learning Records/Enrollment Related Materials
The enrollmentRelatedMaterials resource a child of the learnerLearningRecords resource. It provides related materials associated to a learner's assignment record.
Get all enrollment related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials
Get an enrollment related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{enrollmentRelatedMaterialsUniqID}
Learner Learning Records/Learning Item Descriptive Flexfields
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Get a learning item flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDFF/{LearningItemId}
Get all learning item flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDFF
Learner Learning Records/Learning Item Publisher Person Details
The learningItemPublisherPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the publisher of the learning items associated to a learner's assignment records.
Get a learning item publisher person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemPublisherPersonDetails/{personId}
Get all learning item publisher person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemPublisherPersonDetails
Learner Learning Records/Learning Item Rating Details
The learningItemRatingDetails resource is a child of the learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner's assignment record.
Create a learning item rating
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails
Get a learning item rating
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails/{ratingId}
Get all learning item ratings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails
Update a learning item rating
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails/{ratingId}
Learner Learning Records/Learning Item Related Materials
The learningItemRelatedMaterials resource is a child of the learnerLearningRecords resource. It provides related materials for the learning item associated to a learner's assignment record.
Get a learning item related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials/{learningItemRelatedMaterialsUniqID}
Get all learning item related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials
Learner Learning Records/Learning Outcomes
The learningOutcomes resource is a child of the learnerLearningRecords resource. It provides the learning outcomes for the learning items associated to a learner's assignment records. This is applicable for course and specialization learning items.
Get a learning outcome
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningOutcomes/{profileItemId}
Get all learning outcomes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningOutcomes
Learner Learning Records/Learning Prerequisites
The learningPrerequisites resource is a child of the learnerLearningRecords resource. It provides the learning prerequisites for the learning items associated to learner's assignment records. This is applicable for course and specialization learning items.
Get a learning prerequisite
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningPrerequisites/{profileItemId}
Get all learning prerequisites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningPrerequisites
Learner Learning Records/Other Selected Course Offerings
The otherSelectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings other than the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Get a single other selected course offering
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
Get all other selected course offerings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings
Update single other selected course offering
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
Learner Learning Records/Other Selected Course Offerings/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Other Selected Course Offerings/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}
Get all completion details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
Get a content attempt detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{attemptId}
Get all content attempt details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms
The classrooms resource is a child of the completionDetails resource. It provides classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}
Get all classroom details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms
Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/classroomDFFs
Learner Learning Records/Other Selected Course Offerings/Completion Details/Instructors
The instructors resource is a child of the learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors
Get an instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}/child/instructorDFF
Get an instructor flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}/child/instructorDFF/{ResourceId}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Offered Languages
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
Get an offered language
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages/{courseLearningItemId}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Offered Locations
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
Get an offering location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Related Materials
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{relatedMaterialsUniqID}
Get all related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials
Learner Learning Records/Other Selected Course Offerings/Learning Item Descriptive Flexfields
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Get a learning item flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF/{LearningItemId}
Get all learning item flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF
Learner Learning Records/Other Selected Course Offerings/Learning Item Rating Details
The learningItemRatingDetails resource is a child of the learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner's assignment record.
Create a learning item rating
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
Get a learning item rating
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{ratingId}
Get all learning item ratings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
Update a learning item rating
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{ratingId}
Learner Learning Records/Other Selected Course Offerings/Offering Descriptive Flexfields
The offeringDFF resource is a child of the selectedCourseOfferings resource. It provides additional offering information stored in flexfields.
Get all offering flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF
Get an offering flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF/{offeringDFFUniqID}
Learner Learning Records/Other Selected Course Offerings/Transaction Histories
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Get a transaction history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory/{transactionId}
Get all transaction histories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory
Learner Learning Records/Past Renewals
The pastRenewals resource is a child of the learnerLearningRecords resource.
Get a past renewal
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals/{pastRenewalsUniqID}
Get all past renewals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals
Learner Learning Records/Past Renewals/Related Learning Records
The relatedLearningRecords resource is a child of the learnerLearningRecords resource. It provides details of the related learning records associated with a learner's assignment record.
Get a related assignment record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals/{pastRenewalsUniqID}/child/relatedLearningRecords/{assignmentRelationId}
Get all related assignment records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals/{pastRenewalsUniqID}/child/relatedLearningRecords
Learner Learning Records/Primary Selected Course Offerings
The primarySelectedCourseOffering resource is a child of the learnerLearningRecords resource. It provides the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Get a primary selected course offering
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}
Get all primary selected course offerings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering
Update a primary selected course offering
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}
Learner Learning Records/Primary Selected Course Offerings/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Primary Selected Course Offerings/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}
Get all completion details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails
Learner Learning Records/Primary Selected Course Offerings/Completion Details/Activity Content Attempts
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
Get a content attempt detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{attemptId}
Get all content attempt details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Learner Learning Records/Primary Selected Course Offerings/Completion Details/Classrooms
The classrooms resource is a child of the completionDetails resource. It provides classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}
Get all classroom details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms
Learner Learning Records/Primary Selected Course Offerings/Completion Details/Classrooms/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Primary Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/classroomDFFs
Learner Learning Records/Primary Selected Course Offerings/Completion Details/Instructors
The instructors resource is a child of the learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors
Get an instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}
Learner Learning Records/Primary Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}/child/instructorDFF
Get an instructor flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}/child/instructorDFF/{ResourceId}
Learner Learning Records/Primary Selected Course Offerings/Completion Details/Offered Languages
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
Get an offered language
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages/{courseLearningItemId}
Learner Learning Records/Primary Selected Course Offerings/Completion Details/Offered Locations
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
Get an offering location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Primary Selected Course Offerings/Completion Details/Related Materials
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{relatedMaterialsUniqID}
Get all related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials
Learner Learning Records/Primary Selected Course Offerings/Learning Item Descriptive Flexfields
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Get a learning item flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemDFF/{LearningItemId}
Get all learning item flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemDFF
Learner Learning Records/Primary Selected Course Offerings/Learning Item Rating Details
The learningItemRatingDetails resource is a child of the learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner's assignment record.
Create a learning item rating
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails
Get a learning item rating
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails/{ratingId}
Get all learning item ratings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails
Update a learning item rating
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails/{ratingId}
Learner Learning Records/Primary Selected Course Offerings/Offering Descriptive Flexfields
The offeringDFF resource is a child of the selectedCourseOfferings resource. It provides additional offering information stored in flexfields.
Get all offering flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/offeringDFF
Get an offering flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/offeringDFF/{offeringDFFUniqID}
Learner Learning Records/Primary Selected Course Offerings/Transaction Histories
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Get a transaction history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/transactionHistory/{transactionId}
Get all transaction histories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/transactionHistory
Learner Learning Records/Related Learning Records
The relatedLearningRecords resource is a child of the learnerLearningRecords resource. It provides details of the related learning records associated with a learner's assignment record.
Get a related assignment record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/relatedLearningRecords/{assignmentRelationId}
Get all related assignment records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/relatedLearningRecords
Learner Learning Records/Selected Course Offerings
The selectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Create a selected course offering
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings
Get a selected course offering
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}
Get all selected course offerings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings
Update a selected course offering
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}
Learner Learning Records/Selected Course Offerings/Active Learner Comments
The activeLearnerComments resource is a child of the learnerLearningRecords resource. It provides details of all comments of active and completed learners for the learning item associated to a learner's assignment record.
Create an active learner comment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments
Get all active learner comments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments
Get an active learner comment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Update an active learner comment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Learner Learning Records/Selected Course Offerings/Active Learner Comments/Likes
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a like
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Get a like
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes/{likeId}
Get all likes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Update a like
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes/{likeId}
Learner Learning Records/Selected Course Offerings/Active Learner Comments/Replies
The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a reply
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Get a reply
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}
Get all replies
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Update a reply
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}
Learner Learning Records/Selected Course Offerings/Active Learner Comments/Replies/Likes
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a like
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes
Get a like
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes/{likeId}
Get all likes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes
Update a like
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes/{likeId}
Learner Learning Records/Selected Course Offerings/Approval Details
The approvalDetails resource is a child of the learnerLearningRecords resource. It provides the approval details information associated with the learning record.
Get all approval details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/approvalDetails
Get an approval detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/approvalDetails/{approvalDetailsUniqID}
Learner Learning Records/Selected Course Offerings/Assigner Person Details
The assignerPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assigner of the learner's assignment records.
Get all assigner person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignerPersonDetails
Get an assigner person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignerPersonDetails/{personId}
Learner Learning Records/Selected Course Offerings/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Selected Course Offerings/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}
Get all completion details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails
Learner Learning Records/Selected Course Offerings/Completion Details/Activity Content Attempts
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
Get a content attempt detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{attemptId}
Get all content attempt details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Learner Learning Records/Selected Course Offerings/Completion Details/Classrooms
The classrooms resource is a child of the completionDetails resource. It provides classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}
Get all classroom details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms
Learner Learning Records/Selected Course Offerings/Completion Details/Classrooms/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomId}/child/classroomDFFs
Learner Learning Records/Selected Course Offerings/Completion Details/Instructors
The instructors resource is a child of the learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors
Get an instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}
Learner Learning Records/Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}/child/instructorDFF
Get an instructor flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorId}/child/instructorDFF/{ResourceId}
Learner Learning Records/Selected Course Offerings/Completion Details/Offered Languages
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
Get an offered language
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages/{courseLearningItemId}
Learner Learning Records/Selected Course Offerings/Completion Details/Offered Locations
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
Get an offering location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Selected Course Offerings/Completion Details/Related Materials
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{relatedMaterialsUniqID}
Get all related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials
Learner Learning Records/Selected Course Offerings/Enrollment Related Materials
The enrollmentRelatedMaterials resource a child of the learnerLearningRecords resource. It provides related materials associated to a learner's assignment record.
Get all enrollment related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
Get an enrollment related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{enrollmentRelatedMaterialsUniqID}
Learner Learning Records/Selected Course Offerings/Learning Item Descriptive Flexfields
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Get a learning item flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemDFF/{LearningItemId}
Get all learning item flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemDFF
Learner Learning Records/Selected Course Offerings/Learning Item Rating Details
The learningItemRatingDetails resource is a child of the learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner's assignment record.
Create a learning item rating
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails
Get a learning item rating
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{ratingId}
Get all learning item ratings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails
Update a learning item rating
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{ratingId}
Learner Learning Records/Selected Course Offerings/Learning Item Related Materials
The learningItemRelatedMaterials resource is a child of the learnerLearningRecords resource. It provides related materials for the learning item associated to a learner's assignment record.
Get a learning item related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{learningItemRelatedMaterialsUniqID}
Get all learning item related materials
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials
Learner Learning Records/Selected Course Offerings/Offering Descriptive Flexfields
The offeringDFF resource is a child of the selectedCourseOfferings resource. It provides additional offering information stored in flexfields.
Get all offering flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringDFF
Get an offering flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringDFF/{offeringDFFUniqID}
Learner Learning Records/Selected Course Offerings/Offering Primary Classrooms
The offeringPrimaryClassroom resource is a child of the selectedCourseOfferings resource. It provides primary classroom details for the Instructor-Led activity of the Instructor-Led and Blended offering.
Get all offering primary classrooms
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom
Get an offering primary classroom
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}
Learner Learning Records/Selected Course Offerings/Offering Primary Classrooms/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Selected Course Offerings/Offering Primary Classrooms/Classroom Descriptive Flexfields
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/classroomDFFs
Learner Learning Records/Selected Course Offerings/Offering Primary Instructors
The offeringPrimaryInstructor resource is a child of the selectedCourseOfferings resource. It provides the primary instructor details associated with the offering learning record.
Get all offering primary instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor
Get an offering primary instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}
Learner Learning Records/Selected Course Offerings/Offering Primary Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF
Get an instructor flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF/{ResourceId}
Learner Learning Records/Selected Course Offerings/Transaction Histories
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Get a transaction history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/transactionHistory/{transactionId}
Get all transaction histories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/transactionHistory
Learner Learning Records/Selected Course Offerings/User Action Hints
The userActionHints resource is a child of the learnerLearningRecords resource. It provides hints for possible actions on learner's assignment records.
Get a user action hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/userActionHints/{learningItemId}
Get all user action hints
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/userActionHints
Learner Learning Records/Specialization Descriptive Flexfields
The specializationDFF resource is a child of the learnerLearningRecords resource. It provides additional specialization information stored in flexfields.
Get a specialization flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/specializationDFF/{SpecializationId}
Get all specialization flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/specializationDFF
Learner Learning Records/Transaction Histories
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Get a transaction history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/transactionHistory/{transactionId}
Get all transaction histories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/transactionHistory
Learner Learning Records/User Action Hints
The userActionHints resource is a child of the learnerLearningRecords resource. It provides hints for possible actions on learner's assignment records.
Get a user action hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/userActionHints/{learningItemId}
Get all user action hints
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/userActionHints
Learning Content Items
The learningContentItems resource includes learning content such as SCORM or AICC packages, PDF files, video files, and web links. This resource supports POST, PATCH, and GET operations on a single learning content item.
Create a learning content item
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learningContentItems
Get a learning content item
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learningContentItems/{ContentId}
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learningContentItems
Update a learning content item
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learningContentItems/{ContentId}
List of Values/Absence Business Titles List of Values
The absencesBusinessTitlesLOV resource is used for the client-side LOV component in responsive UIs. It enables you to search for business titles or assignments of a worker, and absence type for which you can add an absence.

This resource is currently under controlled availability.
Get a business title of a worker
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absenceBusinessTitlesLOV/{AssignmentPk}
Get all business titles of a worker
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absenceBusinessTitlesLOV
List of Values/Absence Plans List of Values
The absencePlansLOV provides a list of values for absence plans. It lets you search for absence plans.
Get all absence plans
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absencePlansLOV
Get an absence plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absencePlansLOV/{absencePlansLOVUniqID}
List of Values/Absence Type Reasons List of Values
The absenceTypeReasonsLOV resource provides the list of values for the applicable absence reasons. It lets you search for absence reasons that are applicable when entering absences using a specific absence type.
Get all absence reasons
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absenceTypeReasonsLOV
Get an absence reason
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absenceTypeReasonsLOV/{absenceTypeReasonsLOVUniqID}
List of Values/Absence Types List of Values
The absenceTypesLOV resource is used for the client-side LOV component in responsive UIs. It enables you to search for absence types that can be used to add an absence for a worker.
Get all absence types for a worker
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absenceTypesLOV
Get an absence type for a worker
Method: get
Path: /hcmRestApi/resources/11.13.18.05/absenceTypesLOV/{CompositeKey}
List of Values/Action Reasons List of Values
The actionReasonsLOV resource provides the list of values for the employment action reasons.
Get all action reasons
Method: get
Path: /hcmRestApi/resources/11.13.18.05/actionReasonsLOV
Get an action reason
Method: get
Path: /hcmRestApi/resources/11.13.18.05/actionReasonsLOV/{ActionReasonId}
List of Values/Actions List of Values
The actionsLOV resource provides the list of values for employment actions.
Get all actions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/actionsLOV
Get an action
Method: get
Path: /hcmRestApi/resources/11.13.18.05/actionsLOV/{ActionId}
List of Values/Assignment Status Types List of Values
The assignmentStatusTypesLOV resource provides the list of values for the user-defined status of the assignment.
Get a status type
Method: get
Path: /hcmRestApi/resources/11.13.18.05/assignmentStatusTypesLov/{AssignmentStatusTypeId}
Get all status types
Method: get
Path: /hcmRestApi/resources/11.13.18.05/assignmentStatusTypesLov
List of Values/Bargaining Units List of Values
The bargainingUnitsLov resource includes the list of values for bargaining units.
Get a bargaining unit
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bargainingUnitsLov/{BargainingUnitCode}
Get all bargaining units
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bargainingUnitsLov
List of Values/Benefit Groups List of Values
The benefitGroupsLOV resource provides the list of all benefit groups. It is a setup-side entity in the Benefits product to group persons or employees for the participation, election, or maintenance processes. You also use this resource to include or exclude people in benefit plans, options, or rate values through eligibility profile criteria.
Get a benefit group
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitGroupsLOV/{BenefitGroupName}
Get all benefit groups
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitGroupsLOV
List of Values/Benefit Options List of Values
The benefitOptionsLOV resource includes a list of all the benefit options.
Get a benefit option
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitOptionsLOV/{benefitOptionsLOVUniqID}
Get all benefit options
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitOptionsLOV
List of Values/Benefit Plan Types List of Values
The benefitPlanTypesLOV resource includes a list of all the benefit plan types.
Get a plan type
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlanTypesLOV/{benefitPlanTypesLOVUniqID}
Get all plan types
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlanTypesLOV
List of Values/Benefit Plans List of Values
The benefitPlansLOV includes a list of all the benefit plans.
Get a benefit plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansLOV/{benefitPlansLOVUniqID}
Get all benefit plans
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansLOV
List of Values/Benefit Programs List of Values
The benefitProgramsLOV resource includes a list of all the benefit programs.
Get a benefit program
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitProgramsLOV/{benefitProgramsLOVUniqID}
Get all benefit programs
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitProgramsLOV
List of Values/Benefits Comparison Plans List of Values
The benefitPlansComparison resource includes all the benefit plans for comparison based on person eligibility. You must use finders with this resource to get results.
Get a benefit plan for comparison
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparisonLOV/{InstanceId}
Get all benefit plans for comparison
Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparisonLOV
List of Values/Business Units List of Values
The hcmBusinessUnitsLOV resource includes the list of values for business units.
Get a business unit
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmBusinessUnitsLOV/{BusinessUnitId}
Get all business units
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmBusinessUnitsLOV
List of Values/Check-In Templates List of Values
The checkInTemplatesLOV resource includes check-in templates assigned to the worker. It is used to define the structure of the check-in document and assign a questionnaire to the worker or manager or both.
Get a template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInTemplatesLOV/{CheckInTemplateId}
Get all templates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInTemplatesLOV
List of Values/Collective Agreements List of Values
The collectiveAgreementsLov resource includes the list of values for collective agreements.
Get a collective agreement
Method: get
Path: /hcmRestApi/resources/11.13.18.05/collectiveAgreementsLov/{collectiveAgreementsLovUniqID}
Get all collective agreements
Method: get
Path: /hcmRestApi/resources/11.13.18.05/collectiveAgreementsLov
List of Values/Competition Participants List of Values
The competitionParticipantsLOV resource includes the list of participants for the employee wellness competition.
Get a competition participant
Method: get
Path: /hcmRestApi/resources/11.13.18.05/competitionParticipantsLOV/{Name}
Get all competition participants
Method: get
Path: /hcmRestApi/resources/11.13.18.05/competitionParticipantsLOV
List of Values/Content Item List of Values
The contentItemsLov resource provides the content items for a specific item catalog. These catalog items enable the definition of item lists for specific talent skills and credentials.
Get a content item
Method: get
Path: /hcmRestApi/resources/11.13.18.05/contentItemsLov/{ContentItemId}
Get all contet items
Method: get
Path: /hcmRestApi/resources/11.13.18.05/contentItemsLov
List of Values/Contracts List of Values
The hcmContractsLOV resource provides the list of values for the worker contracts.
Get a contract
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContractsLOV/{hcmContractsLOVUniqID}
Get all contracts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContractsLOV
List of Values/Cost Centers List of Values
The hcmCostCentersLOV resource includes the list of values for cost centers.
Get a cost center
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmCostCentersLOV/{CostCenterId}
Get all cost centers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmCostCentersLOV
List of Values/Countries List of Values
The hcmCountriesLov resource includes the list of values for countries.
Get a country
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov/{hcmCountriesLovUniqID}
Get all countries
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmCountriesLov
List of Values/Department Tree Nodes List of Values
The departmentTreeNodesLOV resource provides the list of values for the top department nodes of a named department hierarchy for a department hierarchy type.
Get a department tree node
Method: get
Path: /hcmRestApi/resources/11.13.18.05/departmentTreeNodesLOV/{departmentTreeNodesLOVUniqID}
Get all department tree nodes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/departmentTreeNodesLOV
List of Values/Departments List of Values
The departmentsLov resource includes the list of values for departments.
Get a department
Method: get
Path: /hcmRestApi/resources/11.13.18.05/departmentsLov/{departmentsLovUniqID}
Get all departments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/departmentsLov
List of Values/Departments List of Values V2
The departmentsLovV2 resource provides the list of values for departments.
Get a department
Method: get
Path: /hcmRestApi/resources/11.13.18.05/departmentsLovV2/{departmentsLovV2UniqID}
Get all departments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/departmentsLovV2
List of Values/Disability Organizations List of Values
The disabilityOrganizationsLOV resource provides the list of values for the disability organizations.
Get a disability organization
Method: get
Path: /hcmRestApi/resources/11.13.18.05/disabilityOrganizationsLOV/{disabilityOrganizationsLOVUniqID}
Get all disability organizations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/disabilityOrganizationsLOV
List of Values/Document Types List of Values
The document types resource includes all the document types based on which document records are created for a person.
Get a document type
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypesLOV/{DocumentTypeId}
Get all document types
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypesLOV
List of Values/Eligibility Profiles List of Values
The eligibilityProfilesLOV includes the list of values for all active eligibility profiles.
Get all eligibility profiles
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibilityProfilesLOV
Get an eligibility profile
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibilityProfilesLOV/{eligibilityProfilesLOVUniqID}
List of Values/Eligible Contacts List of Values
The eligibleContactsLOV includes the list of values for all eligibility contacts.
Get all eligible Contacts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibleContactsLOV
Get an eligible Contact
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibleContactsLOV/{eligibleContactsLOVUniqID}
List of Values/Eligible Options List of Values
The eligibleOptionsLOV resource provides a list of options in an individual compensation plan. Examples of options are Quarterly Spot Bonus Award or Monthly Spot Bonus Award.
Get a plan option
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibleOptionsLOV/{ComponentId}
Get all plan options
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibleOptionsLOV
List of Values/Eligible Plans List of Values
The eligiblePlansLOV resource provided a list of individual compensation plans available for the person. An individual compensation plan is used to award compensation outside of the regular compensation cycle. These awards, or allocations, can be education reimbursements or personal contributions to charitable or savings plans.
Get all individual compensation plans
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligiblePlansLOV
Get an individual compensation plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligiblePlansLOV/{PlanId}
List of Values/Event Conditions List of Values
The eventConditionsLOV resource provides the active list of event conditions defined in the application.
Get all event conditions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eventConditionsLOV
Get an event condition
Method: get
Path: /hcmRestApi/resources/11.13.18.05/eventConditionsLOV/{ObjConditionId}
List of Values/Flow Instances List of Values
The flowInstancesLOV resource provides a list of all submitted payroll flows.
Get a payroll flow instance
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowInstancesLOV/{FlowInstanceId}
Get all payroll flow instances
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowInstancesLOV
List of Values/Flow Parameter List of Values
The flowParameterValuesLOV resource includes a list of values for a flow parameter.
Get a flow parameter value
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowParameterValuesLOV/{StorageAttribute}
Get all flow parameter values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowParameterValuesLOV
List of Values/Flow Patterns List of Values
The flowpatternsLOV resource provides the list of all flow patterns.
Get a flow pattern
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowPatternsLOV/{FlowId}
Get all flow patterns
Method: get
Path: /hcmRestApi/resources/11.13.18.05/flowPatternsLOV
List of Values/Geographic Hierarchies List of Values
The geographicHierarchiesLov resource provides the list of values for geographic hierarchies.
Get a geographic hierarchy
Method: get
Path: /hcmRestApi/resources/11.13.18.05/geographicHierarchiesLOV/{GeographicHierarchyCode}
Get all geographic hierarchies
Method: get
Path: /hcmRestApi/resources/11.13.18.05/geographicHierarchiesLOV
List of Values/Goal Plan Sets List of Values
The goalPlanSetsLOV resource includes the list of values for goal plan sets used in Goal Management.
Get a goal plan set
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlanSetsLOV/{GoalPlanSetId}
Get all goal plan sets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlanSetsLOV
List of Values/Goal Plans List of Values
The goalPlansLOV resource includes the list of values for goal plans used in Goal Management.
Get a goal plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlansLOV/{GoalPlanId}
Get all goal plans
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlansLOV
List of Values/Grade Ladders List of Values
The gradeLaddersLov resource includes the list of values for grade ladders.
Get a grade ladder
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLaddersLov/{gradeLaddersLovUniqID}
Get all grade ladders
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLaddersLov
List of Values/Grade Steps List of Values
The gradeStepsLOV resource provides the list of values for grade steps.
Get a grade step
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeStepsLOV/{gradeStepsLOVUniqID}
Get all grade steps
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeStepsLOV
List of Values/Grades List of Values
The gradesLov resource includes the list of values for grades.
Get a grade
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradesLov/{gradesLovUniqID}
Get all grades
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradesLov
List of Values/HCM Groups List of Values
The hcmGroupsLOV resource provides the list of values for HCM groups.
Get a HCM group
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmGroupsLOV/{hcmGroupsLOVUniqID}
Get all HCM groups
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmGroupsLOV
List of Values/HCM Trees List of Values
The hcmTreesLOV resource provides the list of values for the hierarchy types of a specified hierarchy type (supported by areas of responsibility).
Get a hierarchy name
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmTreesLOV/{hcmTreesLOVUniqID}
Get all hierarchy names
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmTreesLOV
List of Values/Job Application Grid View Categories
The recruitingGridViewCategoriesLOV resource provides the grid view categories.
Get a grid view category
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingGridViewCategoriesLOV/{recruitingGridViewCategoriesLOVUniqID}
Get all grid view categories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingGridViewCategoriesLOV
List of Values/Job Families List of Values
The jobFamiliesLov resource includes the list of values for job families.
Get a job family
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobFamiliesLov/{jobFamiliesLovUniqID}
Get all job families
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobFamiliesLov
List of Values/Jobs List of Values
The jobsLov resource provides the list of values for jobs.
Get a job
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobsLov/{jobsLovUniqID}
Get all jobs
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobsLov
List of Values/Jobs List of Values V2
The jobsLovV2 resource provides the list of values for jobs.
Get a job
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobsLovV2/{jobsLovV2UniqID}
Get all jobs
Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobsLovV2
List of Values/Labels List of Values
The recruitingLabelsLOV resource provides the list of values for recruiting labels.
Get a label
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingLabelsLOV/{LabelId}
Get all labels
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingLabelsLOV
List of Values/Legal Employers List of Values
The legalEmployersLov resource includes the list of values for legal employers.
Get a legal employer
Method: get
Path: /hcmRestApi/resources/11.13.18.05/legalEmployersLov/{legalEmployersLovUniqID}
Get all legal employers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/legalEmployersLov
List of Values/Legislative Data Groups List of Values
The legislativeDataGroupsLOV resource provides the list of values for the legislative data groups.
Get a legislative data group
Method: get
Path: /hcmRestApi/resources/11.13.18.05/legislativeDataGroupsLOV/{LegislativeDataGroupId}
Get all legislative data groups
Method: get
Path: /hcmRestApi/resources/11.13.18.05/legislativeDataGroupsLOV
List of Values/Library Goals List of Values
The libraryGoalsLOV resource provides the list of values for library goals defined in Goal Management and Career Development.
Get a library goal
Method: get
Path: /hcmRestApi/resources/11.13.18.05/libraryGoalsLOV/{ContentItemId}
Get all library goals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/libraryGoalsLOV
List of Values/Life Events List of Values
The lifeEventsLOV resource provides the list of values for all active life events.
Get a life event
Method: get
Path: /hcmRestApi/resources/11.13.18.05/lifeEventsLOV/{lifeEventsLOVUniqID}
Get all life events
Method: get
Path: /hcmRestApi/resources/11.13.18.05/lifeEventsLOV
List of Values/Locations List of Values
The locationsLov resource includes the list of values for locations.
Get a location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsLov/{locationsLovUniqID}
Get all locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsLov
List of Values/Locations List of Values V2
The locationsLovV2 resource provides the list of values for locations.
Get a location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsLovV2/{locationsLovV2UniqID}
Get all locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsLovV2
List of Values/Majors List of Values
The majorsLOV resource provides the list of majors for education content.
Get a major
Method: get
Path: /hcmRestApi/resources/11.13.18.05/majorsLOV/{majorsLOVUniqID}
Get all majors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/majorsLOV
List of Values/Organization Payment Methods List of Values
The organizationPaymentMethodsLOV resource provides the organization payment methods as of the specified date.
Get all organization payment methods
Method: get
Path: /hcmRestApi/resources/11.13.18.05/organizationPaymentMethodsLOV
Get an organization payment method
Method: get
Path: /hcmRestApi/resources/11.13.18.05/organizationPaymentMethodsLOV/{organizationPaymentMethodsLOVUniqID}
List of Values/Organization Tree Nodes List of Values
The organizationTreeNodesLOV resource provides the list of values for the top organization nodes of a specified organization hierarchy for an organization hierarchy type.
Get all organization tree nodes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/organizationTreeNodesLOV
Get an organization tree node
Method: get
Path: /hcmRestApi/resources/11.13.18.05/organizationTreeNodesLOV/{organizationTreeNodesLOVUniqID}
List of Values/Payroll Balance Definitions List of Values
The payrollBalanceDefinitionsLOV resource provides a list of values for payroll balance definitions. A payroll balance accumulates net total of payroll results for an element or group of elements during a specified period of time.
Get a payroll balance definition
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollBalanceDefinitionsLOV/{BalanceTypeId}
Get all payroll balance definitions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollBalanceDefinitionsLOV
List of Values/Payroll Definitions List of Values
The payrollDefinitionsLOV resource provides the list of values for payroll definitions. A payroll definition groups employees that are processed together with the same processing frequency, such as weekly, biweekly, semi-monthly, or monthly.
Get a payroll definition
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollDefinitionsLOV/{payrollDefinitionsLOVUniqID}
Get all payroll definitions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollDefinitionsLOV
List of Values/Payroll Element Definitions List of Values
The payrollElementDefinitionsLOV resouce includes a list of element definitions.
Get all element definitions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollElementDefinitionsLOV
Get an element definition
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollElementDefinitionsLOV/{payrollElementDefinitionsLOVUniqID}
List of Values/Payroll Input Values List of Values
The payrollInputValuesLOV resouce includes a list of input values as of the given date.
Get a payroll input value
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollInputValuesLOV/{payrollInputValuesLOVUniqID}
Get all payroll input values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollInputValuesLOV
List of Values/Payroll Statutory Units List of Values
The payrollStatutoryUnitsLOV resource provides the list of values for the payroll statutory unit names.
Get a payroll statutory unit
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollStatutoryUnitsLOV/{payrollStatutoryUnitsLOVUniqID}
Get all payroll statutory units
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollStatutoryUnitsLOV
List of Values/Payroll Time Definitions List of Values
The payrollTimeDefinitionsLOV resource provides the list of values for payroll time definitions. Time definitions are unique time spans or dates that can be used in many areas, including payroll employment management, balance dimensions, retroactive and proration events, element start and end dates, and overtime periods.
Get a payroll time definition
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollTimeDefinitionsLOV/{TimeDefinitionId}
Get all payroll time definitions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollTimeDefinitionsLOV
List of Values/Payroll Time Periods List of Values
The payrollTimePeriodsLOV resource includes a list of all time periods belonging to payrolls.
Get a time period
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollTimePeriodsLOV/{payrollTimePeriodsLOVUniqID}
Get all time periods
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollTimePeriodsLOV
List of Values/Performance Template Document Names List Of Values
The performanceTemplateDocumentNamesLOV resources provides the list of values for client-side LOV components in responsive UIs to select a performance document name.
Get a document name
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceTemplateDocumentNamesLOV/{TmplPeriodId}
Get all document names
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceTemplateDocumentNamesLOV
List of Values/Performance Template Task Names List Of Values
The performanceTemplateTaskNamesLOV resource provides the list of values for client-side LOV components in responsive UIs to a select list of available tasks in a performance evaluation.
Get a task name
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceTemplateTaskNamesLOV/{performanceTemplateTaskNamesLOVUniqID}
Get all task names
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceTemplateTaskNamesLOV
List of Values/Person Notes Visibility Options List of Values
The personNotesVisibilityOptionsLOV resource provides the list of values of visibility options for person notes associated with the context type. It specifies visibility options available to users when they create person notes in a given context.
Get a visibility option
Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptionsLOV/{VisibilityCode}
Get all visibility options
Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptionsLOV
List of Values/Person Types List of Values
The personTypesLOV resource includes the list of values for person types.
Get a person type
Method: get
Path: /hcmRestApi/resources/11.13.18.05/personTypesLOV/{PersonTypeId}
Get all person types
Method: get
Path: /hcmRestApi/resources/11.13.18.05/personTypesLOV
List of Values/Position Tree Nodes List of Values
The positionTreeNodesLOV resource provides the list of values for the top position nodes of a named position hierarchy type.
Get a position tree node
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positionTreeNodesLOV/{positionTreeNodesLOVUniqID}
Get all position tree nodes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positionTreeNodesLOV
List of Values/Positions List of Values
The positionsLov resource includes the list of values for positions.
Get a position
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positionsLov/{positionsLovUniqID}
Get all positions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positionsLov
List of Values/Positions List of Values V2
The positionsLovV2 resource provides the list of values for positions.
Get a position
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positionsLovV2/{positionsLovV2UniqID}
Get all positions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positionsLovV2
List of Values/Profile Type Sections List of Values
The profileTypeSectionsLOV resource includes the list of sections for a specific profile type.
Get a profile type section
Method: get
Path: /hcmRestApi/resources/11.13.18.05/profileTypeSectionsLOV/{SectionId}
Get all profile type sections
Method: get
Path: /hcmRestApi/resources/11.13.18.05/profileTypeSectionsLOV
List of Values/Profiles List of Values
The profilesLov resource includes the list of values for profiles for a given profile type.
Get a profile
Method: get
Path: /hcmRestApi/resources/11.13.18.05/profilesLov/{ProfileId}
Get all profiles
Method: get
Path: /hcmRestApi/resources/11.13.18.05/profilesLov
List of Values/Question Answers List of Values
The questionAnswersLOV resource provides a list of answer choices defined for single or multiple choice questions that match the specified criteria.
Get all answer choices
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionAnswersLOV
Get an answer choice
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionAnswersLOV/{QuestionAnswerId}
List of Values/Questionnaire Folders List of Values
The questionnaireFoldersLOV resource provides the list of values for folders in which questionnaires and questions are saved.
Get a questionnaire folder
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireFoldersLOV/{CategoryId}
Get all questionnaire folders
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireFoldersLOV
List of Values/Questionnaire Questions List of Values
The questionnaireQuestionsLOV includes a list of all questions within questionnaires that match the attributes provided when calling the service.
Get a question
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireQuestionsLOV/{QuestionnaireQuestionId}
Get all questions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireQuestionsLOV
List of Values/Questionnaire Response Types List of Values
The questionnaireResponseTypesLOV resource provides the list of values for response types available for a question.
Get a response type
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireResponseTypesLOV/{ResponseTypeId}
Get all response types
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireResponseTypesLOV
List of Values/Questionnaire Subscribers List of Values
The questionnaireSubscribersLOV resource provides the list of subscribers that use the questionnaire and the associated objects.
Get a subscriber
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireSubscribersLOV/{SubscriberId}
Get all subscribers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireSubscribersLOV
List of Values/Questionnaire Templates List of Values
The questionnaireTemplatesLOV resource provides the list of questionnaire templates for a specific subscriber.
Get a questionnaire template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplatesLOV/{QstnrTemplateId}
Get all questionnaire templates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplatesLOV
List of Values/Questionnaires List of Values
The questionnairesLOV resource provides the list of values for questionnaires.
Get a questionnaire
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnairesLOV/{questionnairesLOVUniqID}
Get all questionnaires
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnairesLOV
List of Values/Questions List of Values
The questionsLOV resource provides the list of values for questions.
Get a question
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionsLOV/{questionsLOVUniqID}
Get all questions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionsLOV
List of Values/Rating Levels List of Values
The ratingLevelsLOV resource provides the qualitative values for a rating model.
Get a rating level
Method: get
Path: /hcmRestApi/resources/11.13.18.05/ratingLevelsLOV/{RatingLevelId}
Get all rating levels
Method: get
Path: /hcmRestApi/resources/11.13.18.05/ratingLevelsLOV
List of Values/Rating Models List of Values
The ratingModelsLOV resource provides the list of rating models for the question setup of the questionnaire.
Get a rating model
Method: get
Path: /hcmRestApi/resources/11.13.18.05/ratingModelsLOV/{RatingModelId}
Get all rating models
Method: get
Path: /hcmRestApi/resources/11.13.18.05/ratingModelsLOV
List of Values/Reasons List of Values
The reasonsLOV resource provides the list of values for all the action reasons available in the Configure Actions UI.
Get a reason
Method: get
Path: /hcmRestApi/resources/11.13.18.05/reasonsLOV/{ActionReasonId}
Get all reasons
Method: get
Path: /hcmRestApi/resources/11.13.18.05/reasonsLOV
List of Values/Recruiting Agency Candidates
The recruitingAgencyCandidatesLOV resource includes the details of all the LOV items for the recruiting agency candidates.
Get a candidate from the recruiting agency.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingAgencyCandidatesLOV/{PersonId}
Get all candidates from the recruiting agency.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingAgencyCandidatesLOV
List of Values/Recruiting Agents
The recruitingAgentsLOV resource includes all details of the recruiting agents.
Get a recruiting agent
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingAgentsLOV/{AgentId}
Get all recruiting agents
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingAgentsLOV
List of Values/Recruiting Background Check Screening Packages List
The recruitingBGCAccountPackagesLOV resource provides the background check screening packages.
Get a background check screening package
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingBGCAccountPackagesLOV/{AccountSpAssgmntId}
Get all background check screening packages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingBGCAccountPackagesLOV
List of Values/Recruiting Candidate Pools LOV
The resource gives details of candidate pools LOV.
Get a candidate pool LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidatePoolsLOV/{recruitingCandidatePoolsLOVUniqID}
Get all the candidate pools LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidatePoolsLOV
List of Values/Recruiting Candidate Saved Searches List of Values
The recruitingCandidateSavedSearchesLOV resource provides details about candidate saved searches list of values.
Get a candidate saved searches list of values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateSavedSearchesLOV/{SearchId}
Get all the candidate saved searches list of values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateSavedSearchesLOV
List of Values/Recruiting Candidates List of Values
The recruitingCandidatesLOV resource includes all the metadata for the candidates.
Get a metadata detail for the candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidatesLOV/{PersonId}
Get all metadata details for the candidates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidatesLOV
List of Values/Recruiting Content Library Items LOV
The recruitingContentLibraryItemsLOV resource includes the details about the content library items LOV.
Get a content library item LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{DescVersionId}
Get all content library items LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV
List of Values/Recruiting Geography Hierarchy Locations LOV
The geographyHierarchyLocationsLOV resource includes the details of geography hierarchy locations LOV.
Get the details of a geography hierarchy location LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingGeographyHierarchyLocationsLOV/{GeographyNodeId}
Get the details of all geography hierarchy locations LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingGeographyHierarchyLocationsLOV
List of Values/Recruiting Job Application Filter Autosuggest List of Values
The recruitingJobApplicationFilterAutoSuggestLOV resource provides the list of values for the job application filters.
Get all autosuggest values for job application filters.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplicationFilterAutoSuggestLOV
Get an autosuggest value for a job application filter.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplicationFilterAutoSuggestLOV/{recruitingJobApplicationFilterAutoSuggestLOVUniqID}
List of Values/Recruiting Job Application Grid View Fields
The recruitingGridViewFieldsLOV root resource provides the grid view fields.
Get a grid view field.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingGridViewFieldsLOV/{recruitingGridViewFieldsLOVUniqID}
Get all grid view fields.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingGridViewFieldsLOV
List of Values/Recruiting Job Requisition Template LOV
The recruitingJobRequisitionTemplatesLOV resource includes the details of the job requisitions templates LOV.
Get details of a job requisitions template LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitionTemplatesLOV/{RequisitionId}
Get details of all job requisitions templates LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitionTemplatesLOV
List of Values/Recruiting Job Requisitions LOV
The recruitingJobRequisitionsLOV resource includes the details of the job requisitions LOV
Get details of a job requisitions LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitionsLOV/{recruitingJobRequisitionsLOVUniqID}
Get details of all the job requisitions LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitionsLOV
List of Values/Recruiting Locations LOV
The recruitingLocationsLOV resource includes all the locations for recruiting as a list to the user.
Get a recruitingLocation
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingLocationsLOV/{LocationFQN}
Get all recruitingLocations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingLocationsLOV
List of Values/Recruiting Organizations LOV
The recruitingOrganizationsLOV includes details about the list of values.
Get a recruiting organizations LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOrganizationsLOV/{OrganizationId}
Get all recruiting organizations LOV
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOrganizationsLOV
List of Values/Recruiting Representatives LOV
The recruitingRepresentativesLOV resource includes the list of representatives.
Get a representative in the list
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingRepresentativesLOV/{PersonId}
Get all representatives in the list
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingRepresentativesLOV
List of Values/Recruiting Requisition Questions LOV
The recruitingRequisitionQuestionsLOV resource includes the details of the list of requisition questions.
Get a requisition question
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingRequisitionQuestionsLOV/{recruitingRequisitionQuestionsLOVUniqID}
Get all the requisition questions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingRequisitionQuestionsLOV
List of Values/Reporting Establishments List of Values
The reportingEstablishmentsLOV resource provides the list of values for reporting establishments.
Get a reporting establishment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/reportingEstablishmentsLOV/{reportingEstablishmentsLOVUniqID}
Get all reporting establishments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/reportingEstablishmentsLOV
List of Values/Responsibility Templates List of Values
The responsibilityTemplatesLOV resource provides the list of values for a responsibility template such as name, code, and, responsibility type. Responsibility templates are used to define areas of responsibility.
Get a responsibility template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/responsibilityTemplatesLOV/{TemplateId}
Get all responsibility templates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/responsibilityTemplatesLOV
List of Values/Review Periods List of Values
The reviewPeriodsLOV resource provides the list of values for the review periods used in Talent Management.
Get a review period
Method: get
Path: /hcmRestApi/resources/11.13.18.05/reviewPeriodsLOV/{ReviewPeriodId}
Get all review periods
Method: get
Path: /hcmRestApi/resources/11.13.18.05/reviewPeriodsLOV
List of Values/Roles List of Values
The rolesLOV resource includes the list of values for roles.
Get a role
Method: get
Path: /hcmRestApi/resources/11.13.18.05/rolesLOV/{RoleId}
Get all roles
Method: get
Path: /hcmRestApi/resources/11.13.18.05/rolesLOV
List of Values/Salary Basis List of Values
The salaryBasisLov resource includes a list of salary bases available for workers. A salary basis identifies the currency and period of the quoted base pay and the factor used to annualize base pay. It optionally identifies components used to itemize salary adjustments as well as the grade rate and differential profile used to validate salary.
Get a salary basis
Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaryBasisLov/{SalaryBasisId}
Get all salary bases
Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaryBasisLov
List of Values/Salary Basis List of Values/Salary Basis Components
The salaryBasisComponents resource is a child of the salaryBasisLov resource. It itemizes salary adjustments into different reasons, such as merit, adjustment, and location. Component itemization is for reporting purposes only.
Get a component
Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaryBasisLov/{SalaryBasisId}/child/salaryBasisComponents/{LookupUsageId}
Get all components
Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaryBasisLov/{SalaryBasisId}/child/salaryBasisComponents
List of Values/Scheduling Shifts List of Values
The schedulingShiftsLOV resource includes the list of values for all the scheduling shifts. The attributes listed are displayed OOTB to help managers and schedulers select the correct shift.
Get a shift
Method: get
Path: /hcmRestApi/resources/11.13.18.05/schedulingShiftsLOV/{ShiftId}
Get all shifts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/schedulingShiftsLOV
List of Values/Sets List of Values
The setsLov resource includes the list of values for sets.
Get a set
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmSetsLOV/{SetId}
Get all sets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmSetsLOV
List of Values/Shared Performance Goals List of Values
The sharedPerformanceGoalsLOV resource provides the list of values for the goals shared by the employees and managers with other employees.
Get a shared goal
Method: get
Path: /hcmRestApi/resources/11.13.18.05/sharedPerformanceGoalsLOV/{GoalId}
Get all shared goals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/sharedPerformanceGoalsLOV
List of Values/Succession Plans List of Values
The successionPlansLOV resource includes the list of values for succession plans to which the logged in user has access either through ownership or through derived incumbent access.
Get a plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/successionPlansLOV/{PlanId}
Get all plans
Method: get
Path: /hcmRestApi/resources/11.13.18.05/successionPlansLOV
List of Values/Talent External Candidates List of Values
The talentExternalCandidatesLOV resource provides a list of external succession candidates.
Get all external candidates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentExternalCandidatesLOV
Get an external candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentExternalCandidatesLOV/{ExternalCandidateId}
List of Values/Talent Pools List of Values
The talentPoolsLOV resource includes the list of talent pools for which the logged in user is named as an owner.
Get a talent pool
Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPoolsLOV/{PoolId}
Get all talent pools
Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPoolsLOV
List of Values/Talent Review Managers List of Values
The talentReviewManagersLOV resource includes the list of values for all workers who are managers for a talent review.
Get a manager
Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentReviewManagersLOV/{talentReviewManagersLOVUniqID}
Get all managers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentReviewManagersLOV
List of Values/Tax Reporting Units List of Values
The taxReportingUnitsLOV resource provides the list of values for the tax reporting unit names.
Get a tax reporting unit
Method: get
Path: /hcmRestApi/resources/11.13.18.05/taxReportingUnitsLOV/{taxReportingUnitsLOVUniqID}
Get all tax reporting units
Method: get
Path: /hcmRestApi/resources/11.13.18.05/taxReportingUnitsLOV
List of Values/Team Members List of Values
The worklifeTeamMembersLOV resource provides a list of all active members within the same business group.
Get a team member
Method: get
Path: /hcmRestApi/resources/11.13.18.05/worklifeTeamMembersLOV/{PersonId}
Get all team members
Method: get
Path: /hcmRestApi/resources/11.13.18.05/worklifeTeamMembersLOV
List of Values/Time Card Fields List of Values
The timeCardFieldValuesLOV resource includes the list of values for time card fields.
Get a time card field value
Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeCardFieldValuesLOV/{Id}
Get all time card field values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeCardFieldValuesLOV
List of Values/Time Cards List of Values
The timeCardsLOV resource uses the REST API to return all of an employee's time cards that match the specified search criteria.
Get a time card
Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeCardsLOV/{timeCardsLOVUniqID}
Get all time cards
Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeCardsLOV
List of Values/Unions List of Values
The unionsLov resource includes the list of values for worker unions.
Get a union
Method: get
Path: /hcmRestApi/resources/11.13.18.05/unionsLov/{unionsLovUniqID}
Get all unions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/unionsLov
List of Values/User Accounts List of Values
The userAccountsLOV resource includes the list of values for user accounts.
Get a user account
Method: get
Path: /hcmRestApi/resources/11.13.18.05/userAccountsLOV/{UserId}
Get all user accounts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/userAccountsLOV
List of Values/User Roles List of Values
The userRolesLov resource includes the list of values for the roles that can be requested, self-requested, and delegated by the specified user.
Get a user role
Method: get
Path: /hcmRestApi/resources/11.13.18.05/userRolesLOV/{RoleId}
Get all user roles
Method: get
Path: /hcmRestApi/resources/11.13.18.05/userRolesLOV
List of Values/Worklife Teams List of Values
The worklifeTeamsLOV resource provides the list of values for teams in the same business group.
Get a team
Method: get
Path: /hcmRestApi/resources/11.13.18.05/worklifeTeamsLOV/{TeamId}
Get all teams
Method: get
Path: /hcmRestApi/resources/11.13.18.05/worklifeTeamsLOV
Locations
The locations resource includes all the locations as of the specified date. By default, the current date is retained.
Get a location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locations/{locationsUniqID}
Get all locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locations
Locations V2
The locationsV2 resource includes all the locations as of the specified date. By default, the current date is retained. With this resource, users can retrieve, create, and update the locations.

Operations to create and update locations in Oracle HCM Cloud involve various post-processing steps. Therefore, these operations may take several minutes to complete.

For bulk load and extract operations, it is recommended to use HCM Data Loader (HDL) and HCM Extracts, respectively.
Create a location
Method: post
Path: /hcmRestApi/resources/11.13.18.05/locationsV2
Delete a location
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}
Get a location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}
Get all locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2
Update a location
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}
Locations V2/Addresses
The addresses resource is a child of the locations resource. It includes all the addresses of the location including the main address as of the specified date. By default, the current date is retained.
Create a location address
Method: post
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses
Delete a location address
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses/{addressesUniqID}
Get a location address
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses/{addressesUniqID}
Get all location addresses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses
Update a location address
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses/{addressesUniqID}
Locations V2/Attachments
The attachments resource is a child of the locations resource. It includes all the attachments of a location as of the specified date. It is used to view, create, and update attachments.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{AttachedDocumentId}
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{AttachedDocumentId}
Update an attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{AttachedDocumentId}
Locations V2/Locations Descriptive Flexfields
The locationsDFF resource is a child of the locations resource. It includes all the location descriptive flexfields as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsDFF
Delete a flexfield
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsDFF/{locationsDFFUniqID}
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsDFF/{locationsDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsDFF/{locationsDFFUniqID}
Locations V2/Locations Extensible Flexfields Container
The locationEFFContainer resource is a child of the locations resource. It is a container for the locations extensible flexfields.
Create a flexfield container
Method: post
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}
Get all flexfield containers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer
Locations V2/Locations Extensible Flexfields Container/Locations Extensible Flexfields
The locationsEFF resource is a child of the locationsEFFContainer resource. It includes all the location extensible flexfields as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF
Delete a flexfield
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF/{locationsEFFUniqID}
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF/{locationsEFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF/{locationsEFFUniqID}
Locations V2/Locations Legislative Extensible Flexfields
The locationLegislativeEFF resource is a child of the locations resource. It includes all the location legislative extensible flexfields as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFF
Delete a flexfield
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFF/{locationLegislativeEFFUniqID}
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFF/{locationLegislativeEFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFF/{locationLegislativeEFFUniqID}
Locations/Location Descriptive Flexfields
The LocationDFF resource is a child of the locations resource. It includes all location flexfields as of the specified date. By default, the current date is retained.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locations/{locationsUniqID}/child/LocationDFF/{LocationDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/locations/{locationsUniqID}/child/LocationDFF
My Job Applications
The recruitingMyJobApplications resource provides details about employee job applications in opportunity marketplace.
Create a job application in opportunity marketplace
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications
Get all my job applications in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications
Get one of my job application in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}
My Job Applications/Scheduled Interviews
The SubmissionScheduleInterviews resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the interview schedule requests.
Create a scheduled interview request in opportunity marketplace
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/SubmissionScheduledInterviews
Get a request for a scheduled interview in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/SubmissionScheduledInterviews/{IntrvwRequestsId}
Get all requests for scheduled interviews in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/SubmissionScheduledInterviews
My Job Applications/Unscheduled Job Interviews
The UnScheduleInterviewRequests resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the unscheduled interview requests.
Create an unscheduled interview request
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/UnscheduledInterviewRequests
Get a request for an unscheduled interview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/UnscheduledInterviewRequests/{IntrvwRequestsId}
Get all the unscheduled interview requests
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/UnscheduledInterviewRequests
Object Snapshots
The objectSnapshots resource retrieves data for a specific key attribute synchronously based on the data structure configured using HCM Extracts.
Extract an Object Snapshot
Method: post
Path: /hcmRestApi/resources/11.13.18.05/objectSnapshots
Opportunities Applications in Opportunity Marketplace
The recruitingOppMktUserAppliedOpportunities resource provides the applications to opportunities in opportunity marketplace.
Get all applications for an opportunity in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktUserAppliedOpportunities
Get an application for an opportunity in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktUserAppliedOpportunities/{GigApplicationId}
Opportunities Created by User in Opportunity Marketplace
The recruitingOppMktUserCreatedOpportunities resource provides opportunities created by a user in opportunity marketplace.
Get a user created opportunity in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktUserCreatedOpportunities/{GigId}
Get all user created opportunities in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktUserCreatedOpportunities
Opportunity Marketplace Opportunities
The recruitingOppMktOpportunities resource provides opportunities in opportunity marketplace.
Get all opportunities in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities
Get an opportunity in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities/{SearchId}
Opportunity Marketplace Opportunities/Categories Facet in Opportunity Marketplace
The categoriesFacetCategories resource is the child of recruitingOppMktOpportunities resource and provides categories facets in opportunity marketplace.
Get a category facet in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities/{SearchId}/child/categoriesFacet/{CategoryCode}
Get all categories facets in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities/{SearchId}/child/categoriesFacet
Opportunity Marketplace Opportunities/Opportunities List in Opportunity Marketplace
The opportunityList resource is the child of recruitingOppMktOpportunities resource and provides a list of opportunities in opportunity marketplace.
Get all opportunity lists in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities/{SearchId}/child/opportunityList
Get an opportunity list in opportunity marketplace
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities/{SearchId}/child/opportunityList/{OpportunityId}
Organizations
The organizations resource includes all the organizations as of the specified date. By default, the current date is retained.
Get all organizations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/organizations
Get an organization
Method: get
Path: /hcmRestApi/resources/11.13.18.05/organizations/{organizationsUniqID}
Organizations/Organization Descriptive Flexfields
The OrganizationDFF resource is a child of the organizations resource. It includes all the organization descriptive flexfields as of the specified date. By default, the current date is retained.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/organizations/{organizationsUniqID}/child/OrganizationDFF/{OrganizationDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/organizations/{organizationsUniqID}/child/OrganizationDFF
Organizations/Organization Extra Information
The extraInformation resource is a child resource of the organizations resource. It includes extensible flexfields defined for an organization.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/organizations/{organizationsUniqID}/child/extraInformation/{extraInformationUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/organizations/{organizationsUniqID}/child/extraInformation
Pay Advances
The payAdvances resource allows employees to request early payment of the hours worked in the current pay period. It allows pay advance requests to be processed and paid in a timely manner.
Check the eligibility of an employee
Method: post
Path: /hcmRestApi/resources/11.13.18.05/payAdvances
Get a pay advance
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payAdvances/{User}
Get all pay advances
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payAdvances
Initiate the pay advance request
Method: post
Path: /hcmRestApi/resources/11.13.18.05/payAdvances
Payroll Relationships
The payrollRelationship resource includes a list of all payroll relationships as of the specified date. It returns information on the payroll relationship data. By default, the current date is retained.
Get a payroll relationship
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}
Get all payroll relationships
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships
Update a payroll relationship
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}
Payroll Relationships/Payroll Assignments
The payrollAssignments resource is a child of the payrollRelationships resource.It includes a list of all payroll assignments for a given payroll relationship.
Get a payroll assignment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}
Get all payroll assignments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments
Update a payroll assignment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}
Update a tax reporting unit
Method: post
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}
Payroll Relationships/Payroll Assignments/Assigned Payrolls
The assignedPayrolls resource is a child of the payrollAssignments resource.It includes a list of all payrolls assigned for a given assignment.
Create an assigned payroll
Method: post
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls
Delete an assigned payroll
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}
Get all assigned payrolls
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls
Get an assigned payroll
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}
Update an assigned payroll
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}
Payroll Relationships/Payroll Assignments/Assigned Payrolls/Assigned Payroll Dates
The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.
Get all assigned payroll dates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/child/assignedPayrollDates
Get an assigned payroll date
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/child/assignedPayrollDates/{PayDateId}
Update an assigned payroll date
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/child/assignedPayrollDates/{PayDateId}
Payroll Relationships/Payroll Assignments/Payroll Assignment Dates
The payrollAssignmentDates resource is a child of the payrollAssignments resource. It includes a list of all element duration dates for a given payroll assignment.
Get a payroll assignment date
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/payrollAssignmentDates/{PayDateId}
Get all payroll assignment dates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/payrollAssignmentDates
Update a payroll assignment date
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/payrollAssignmentDates/{PayDateId}
Payroll Relationships/Payroll Relationship Dates
The payrollRelationshipDates resource is a child of the payrollRelationships resource. It includes a list of all element duration dates for the given payroll relationship.
Get a payroll relationship date
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollRelationshipDates/{PayDateId}
Get all payroll relationship dates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollRelationshipDates
Payslips
The payslips resource includes a list of all payslips for a given payroll relationship.
Get a payslip
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}
Get all payslips
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips
Payslips/Documents
The documents resource includes the document for a given payslip.
Get a document
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{AttachedDocumentId}
Get all documents
Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents
Performance Evaluations
The performanceEvaluations resource provides the performance documents in Talent Management. You can filter based on an evaluation ID or list all the performance documents for a given worker.
Get a performance document
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}
Get all performance documents
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceEvaluations
Performance Evaluations/Roles
The Roles resource is a child of the performanceEvaluations resource. It provides the available roles in a performance document. You can filter based on a role ID or list all of the roles for a given performance document.
Get a role
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles/{EvalRoleId}
Get all roles
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles
Performance Evaluations/Roles/Participants
The Participants resource is a child of the roles resource. It provides the available participants in a performance document. You can filter based on a participant ID or list all of the participants for a given performance document.
Get a participant
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles/{EvalRoleId}/child/Participants/{EvalParticipantId}
Get all participants
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles/{EvalRoleId}/child/Participants
Performance Evaluations/Roles/Participants/Tasks
The Tasks resource is a child of the participants resource. It provides the tasks available for all the participants in a performance document. You can filter based on a step ID or list all of the steps for all the participants in a given performance document.
Get a task
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles/{EvalRoleId}/child/Participants/{EvalParticipantId}/child/Tasks/{EvalStepId}
Get all tasks
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles/{EvalRoleId}/child/Participants/{EvalParticipantId}/child/Tasks
Performance Goals
The performanceGoals resource provides the performance goals of a worker.
Get a goal
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceGoals/{GoalId}
Get all goals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceGoals
Person Notes
The personNotes resource is used to view and create notes about a person. For example, you can include information such as feedback or kudos in the note.
Create a person note
Method: post
Path: /hcmRestApi/resources/11.13.18.05/personNotes
Delete a person note
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}
Get a person note
Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}
Get all person notes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotes
Update a person note
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}
Person Notes Visibility Options
The personNotesVisibilityOptions resource includes the configuration of visibility options for person notes associated with the context type. It is used for setting up the visibility of person notes. It specifies visibility options available to users when they create person notes in a given context.
Get a visibility option
Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptions/{personNotesVisibilityOptionsUniqID}
Get all visibility options
Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptions
Personal Payment Methods
The personalPaymentMethods resource includes a list of all personal payment methods for a given payroll relationship.
Create a personal payment method
Method: post
Path: /hcmRestApi/resources/11.13.18.05/personalPaymentMethods
Delete a personal payment method
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/personalPaymentMethods/{personalPaymentMethodsUniqID}
Get a personal payment method
Method: get
Path: /hcmRestApi/resources/11.13.18.05/personalPaymentMethods/{personalPaymentMethodsUniqID}
Get all personal payment methods
Method: get
Path: /hcmRestApi/resources/11.13.18.05/personalPaymentMethods
Update a personal payment method
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/personalPaymentMethods/{personalPaymentMethodsUniqID}
Plan Balances
The planBalances resource is used to view the remaining balance on a worker's absence plan enrollments, along with summary-level or detailed information on all transactions that have impacted the balance on the plan.
Get a plan balance
Method: get
Path: /hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}
Get all plan balances
Method: get
Path: /hcmRestApi/resources/11.13.18.05/planBalances
Plan Balances/Plan Balance Details
The planBalanceDetails resource is a child of the planBalances resource and provides detailed information on all transactions that impact the balance on the plan.
Get a plan balance detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/planBalanceDetails/{personAccrualEntryDtlId}
Get all plan balance details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/planBalanceDetails
Plan Balances/Plan Balance Summaries
The planBalanceSummary resource is a child of the planBalances resource and provides summary-level information on all transactions that impact the balance on the plan.
Get a plan balance summary
Method: get
Path: /hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/planBalanceSummary/{transactionTypeCode}
Get all plan balance summaries
Method: get
Path: /hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/planBalanceSummary
Positions
The positions resource includes all the positions as of the specified date. By default, the current date is retained.
Get a position
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}
Get all positions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positions
Positions/Position Descriptive Flexfields
The PositionCustomerFlex resource is a child of the positions resource. It includes all position descriptive flexfields as of the specified date. By default, the current date is retained.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/PositionCustomerFlex/{PositionCustomerFlexUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/PositionCustomerFlex
Positions/Position Extra Information
The extraInformation resource is a child of the positions resource. It includes extensible flexfields defined for a position, identified by PER_POSITIONS_EIT_EFF code.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/extraInformation/{extraInformationUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/extraInformation
Positions/Position Extra Legislative Information
The legislativeInformation resource is a child of the positions resource. It includes extensible flexfields defined for a position, identified by PER_POSITIONS_LEG_EFF code.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/legislativeExtraInformation/{legislativeExtraInformationUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/legislativeExtraInformation
Positions/Valid Grades
The validGrades resource is a child of the positions resource. It includes all valid grades for the position, as of the specified date.
Get a valid grade
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/validGrades/{validGradesUniqID}
Get all valid grades
Method: get
Path: /hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/validGrades
Public Workers
The publicWorkers resource provides all the active workers as of the current date and returns public information about workers. Worker types include employee, contingent worker, pending worker and nonworker.

For bulk extract operations, it is recommended to use HCM Extracts.
Get a worker
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}
Get all workers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers
Public Workers/Assignments
The assignments resource is a child of the publicWorkers resource. It includes all the active assignments of a worker as of the current date.
Get a worker assignment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}
Get all workers assignments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments
Public Workers/Assignments/All Reports
The allReports resource is a child of the assignments resource. It includes all the reports of a worker as of the current date for a specific assignment.
Get a worker report
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports/{allReportsUniqID}
Get all worker reports
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports
Public Workers/Assignments/AllReportsDepartments
The allReportsDepartments resource is a child of the assignments resource. It includes all the distinct departments that all the reports of a worker belong to, as of the system date for a specific assignment.
Get a department
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReportsDepartments/{DepartmentId}
Get all departments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReportsDepartments
Public Workers/Assignments/AllReportsLocations
The allReportsLocations resource is a child of the assignments resource. It includes all the distinct locations that all the reports of a worker belong to, as of the system date for a specific assignment.
Get a location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReportsLocations/{LocationId}
Get all locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReportsLocations
Public Workers/Assignments/DirectReports
The directReports resource is a child of the assignments resource. It includes all the direct reports of a worker as of the system date for a specific assignment.
Get a direct report
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports/{directReportsUniqID}
Get all direct reports
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports
Public Workers/Assignments/Employment History
The employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker.
Get a worker employment history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/employmentHistory/{AssignmentId2}
Get all worker employment history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/employmentHistory
Public Workers/Assignments/Managers
The managers resource is a child of the assignments resource. It includes all the managers of a worker.
Get a worker manager
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers/{AssignmentSupervisorId}
Get all worker managers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers
Public Workers/Assignments/Representatives
The representatives resource is a child of the assignments resource. It includes all the worker representatives as of the current date.
Get a worker representative
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives/{AsgResponsibilityId}
Get all workers representatives
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives
Public Workers/Messages
The messages resource is a child of the publicWorkers resource. It includes all the available messages of a worker.
Get a worker message
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/messages/{MessageId}
Get all worker messages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/messages
Public Workers/Other Communication Accounts
The otherCommunicationAccounts resource is a child of the publicWorkers resource. It includes all the other communication accounts of a worker.
Get a worker communication account
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/otherCommunicationAccounts/{DeliveryMethodId}
Get all worker communication accounts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/otherCommunicationAccounts
Public Workers/Phones
The phones resource is a child of the publicWorkers resource. It includes all the available phone numbers of a worker.
Get a worker phone
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/phones/{PhoneId}
Get all worker phones
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/phones
Public Workers/Photos
The photos resource is a child of the publicWorkers resource. It includes all the available photos of a worker.
Get a worker photo
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/photos/{PhotoId}
Get all worker photos
Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/photos
Questionnaire Participants
The questionnaireParticipants resource includes the participants responding to the questionnaire. Responses for questionnaires defined for General Surveys subscriber are supported by this resource.
Create a questionnaire participant
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants
Get a questionnaire participant
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}
Get all questionnaire participants
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants
Update a questionnaire participant
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}
Questionnaire Participants/Questionnaire Responses
The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.
Create a questionnaire response
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses
Delete a questionnaire response
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Get a questionnaire response
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses
Update a questionnaire response
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Questionnaire Participants/Questionnaire Responses/Question Responses
The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.
Create a question response
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Get all question responses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Questionnaire Participants/Questionnaire Responses/Question Responses/Question Response Attachments
The questionResponseAttachments resource provides the attachments submitted by a participant while responding to a question.
Create a question response attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Delete a question response attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a question response attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all question response attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Update a question response attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Questionnaire Templates
The questionnaireTemplates resource includes all details of a questionnaire template, its sections, questions and the attachments defined in the template.
Get a questionnaire template
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}
Get all questionnaire templates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates
Questionnaire Templates/Attachments
The attachments resource is a child of the questionnaireTemplates resource. It includes details of the attachments in a questionnaire template.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments/{AttachedDocumentId}
Questionnaire Templates/Sections
The sections resource is a child resource of the questionnaireTemplates resource that includes the details of the sections defined in the questionnaire template.
Get a section
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{SectionId}
Get all sections
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections
Questionnaire Templates/Sections/Questions
The questions resource is a child of the questionnaireTemplates resource. It includes details of the questions included in a section of the questionnaire template.
Get a question
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}
Get all questions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{SectionId}/child/questions
Questionnaire Templates/Sections/Questions/Answers
The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that is included in a questionnaire template section.
Get all answer choices
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}/child/answers
Get an answer choice
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}/child/answers/{QuestionAnswerId}
Questionnaires
The questionnaires resource provides all the details of a questionnaire, its sections, questions, and the attachments defined.
Create a questionnaire
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questionnaires
Delete a questionnaire
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}
Get a questionnaire
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}
Get all questionnaires
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires
Update a questionnaire
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}
Questionnaires/Attachments
The attachments resource is a child of the questionnaires resource. It provides details of the attachments in a questionnaire.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}
Update an attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}
Questionnaires/Sections
The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
Create a section
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections
Delete a section
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}
Get a section
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}
Get all sections
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections
Update a section
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}
Questionnaires/Sections/Questions
The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.
Create a question
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions
Delete a question
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}
Get a question
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}
Get all questions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions
Update a question
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}
Questionnaires/Sections/Questions/Answers
The answers resource is a child of the questionnaires resource. It provides details of the answer choices defined for a question that is included in a questionnaire section.
Get all answer choices
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}/child/answers
Get an answer choice
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}/child/answers/{QuestionAnswerId}
Update an answer choice
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}/child/answers/{QuestionAnswerId}
Questionnaires/Sections/Questions/Answers/Answer Attachments
The answerAttachments resource is a child of the answers resource. It provides details of the attachments added to an answer for a question.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}/child/answers/{QuestionAnswerId}/child/answerAttachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}/child/answers/{QuestionAnswerId}/child/answerAttachments/{AttachedDocumentId}
Questionnaires/Sections/Questions/Question Attachments
The questionAttachments resource is a child of the questions resource. It provides details of the attachments added to a question.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}/child/questionAttachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{SectionId}/child/questions/{QuestionnaireQuestionId}/child/questionAttachments/{AttachedDocumentId}
Questions
The questions resource provides text objects to ask for a response from a participant with or without a pre-defined list of answer choices that participants may choose from as a response.
Create a question
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questions
Delete a question
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}
Get a question
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}
Get all questions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions
Update a question
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}
Questions/Answers
The answers resource is a child of the questions resource. It provides a list of choices that a user can select from when answering single or multiple choice questions.
Create an answer
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers
Delete an answer
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{QuestionAnswerId}
Get all answers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers
Get an answer
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{QuestionAnswerId}
Update an answer
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{QuestionAnswerId}
Questions/Answers/Attachments
The attachments resource is a child of the questions resource. It includes details of the attachments in a question.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{QuestionAnswerId}/child/attachments
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{QuestionAnswerId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{QuestionAnswerId}/child/attachments/{attachmentsUniqID}
Questions/Attachments
The attachments resource is a child of the questions resource. It includes details of the attachments in a question.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}
Questions/Job Family Contexts
The jobFamilyContexts resource is a child of the questions resource. It provides the job family that the question applies to. This context is used only by the Recruiting subscriber.
Create a job family
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFamilyContexts
Delete a job family
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFamilyContexts/{jobFamilyContextsUniqID}
Get a job family
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFamilyContexts/{jobFamilyContextsUniqID}
Get all job families
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFamilyContexts
Questions/Job Function Contexts
The jobFunctionContexts resource is a child of the questions resource. It provides the job function that the question applies to. This context is used only by the Recruiting subscriber.
Create a job function
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFunctionContexts
Delete a job function
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFunctionContexts/{QuestionContextId}
Get a job function
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFunctionContexts/{QuestionContextId}
Get all job functions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFunctionContexts
Questions/Location Contexts
The locationContexts resource is a child of the questions resource. It provides the recruiting location that the question applies to. This context is used only by the Recruiting subscriber.
Create a location
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/locationContexts
Delete a location
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/locationContexts/{locationContextsUniqID}
Get a location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/locationContexts/{locationContextsUniqID}
Get all locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/locationContexts
Questions/Organization Contexts
The organizationContexts resource is a child of the questions resource. It provides the recruiting organization that the question applies to. This context is used only by the Recruiting subscriber.
Create an organization
Method: post
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/organizationContexts
Delete an organization
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/organizationContexts/{organizationContextsUniqID}
Get all organization
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/organizationContexts
Get an organization
Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/organizationContexts/{organizationContextsUniqID}
Recruiting Assessment Account Packages
The recruitingAssessmentAccountPackages resource includes all the details of the recruiting assessment account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Create the details of all recruiting assessment account packages.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages/{recruitingAssessmentAccountPackagesUniqID}
Recruiting Assessment Account Packages/Packages Included in the Recruiting Assessment Account Packages
The packages resource is a child of The recruitingAssessmentAccountPackages. It includes all packages of recruiting assessment account packages.
Create all packages of recruiting assessment account packages.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages/{recruitingAssessmentAccountPackagesUniqID}/child/packages
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages/{recruitingAssessmentAccountPackagesUniqID}/child/packages
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages/{recruitingAssessmentAccountPackagesUniqID}/child/packages/{PackageCode}
Recruiting Assessment Partner Candidate Details
The recruitingPartnerCandidateDetails resource includes the details of the recruiting partner candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Get a recruiting partner candidate details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}
Get all the recruiting partner candidate details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails
Recruiting Assessment Partner Candidate Details/Address Details in the Recruiting Assessment Partner Candidate Details
The addressDetails resource is the child of the recruitingPartnerCandidateDetails and provides individual address fields of the recruiting partner candidate.
Get all address details of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/addressDetails
Get an address details of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/addressDetails/{CandidateToken2}
Recruiting Assessment Partner Candidate Details/Address Format in the Recruiting Assessment Partner Candidate Details
The addressFormat resource is the child of the recruitingPartnerCandidateDetails and provides the address format used in the recruiting partner candidate.
Get all address formats of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/addressFormat
Get an address format of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/addressFormat/{Attribute}
Recruiting Assessment Partner Candidate Details/Certification Related Information in the Recruiting Partner Candidate Details
The certifications resource is a child of recruitingPartnerCandidateDetails. It includes the certifications of the recruiting partner candidate.
Get a certification of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/certifications/{CertificationId}
Get all certifications of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/certifications
Recruiting Assessment Partner Candidate Details/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details
The educations resource is a child of recruitingPartnerCandidateDetails. It includes the educations of the recruiting partner candidate.
Get a education of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}
Get all educations of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations
Recruiting Assessment Partner Candidate Details/National Identifiers of the Candidate in the Recruiting Partner Candidate Details
The NationalIdentifiers resource is a child of recruitingPartnerCandidateDetails. It returns the national identifiers of the recruiting partner candidate.
Get a national identifier of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/nationalIdentifiers/{NationalIdentifierNumber}
Get all national identifiers of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/nationalIdentifiers
Recruiting Assessment Partner Candidate Details/Previous Employments Recorded in the Recruiting Partner Candidate Details
The previousEmployments resource is a child of recruitingPartnerCandidateDetails. It includes the previous employment details of the recruiting partner candidate.
Get a previous employment of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments/{PreviousEmploymentId}
Get all the previous employments of the recruiting partner candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments
Recruiting Background Check Account Packages
The recruitingBGCheckAccountPackages resource includes the details of recruiting background check account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Get all details of the recruiting background check account packages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages
Get details of a recruiting background check account package
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages/{recruitingBGCheckAccountPackagesUniqID}
Post all details of the recruiting background check account packages
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages
Recruiting Background Check Account Packages/Packages Included in the Recruiting Background Check Account Packages
The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account packages.
Create all packages of recruiting background check account packages
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages/{recruitingBGCheckAccountPackagesUniqID}/child/packages
Get all packages of recruiting background check account packages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages/{recruitingBGCheckAccountPackagesUniqID}/child/packages
Get packages of a recruiting background check account package
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages/{recruitingBGCheckAccountPackagesUniqID}/child/packages/{PackageCode}
Recruiting Background Check Candidate Results
The bcCandidateResults resource includes all the details of the candidate background check results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcCandidateResults
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}
Submit all candidate results
Method: post
Path: /hcmRestApi/resources/11.13.18.05/bcCandidateResults
Recruiting Background Check Candidate Results/Services About the Candidate Results
The services resource is a child of the candidate results resource. It includes the services of the candidate results.
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services/{ScreeningPackage}
Submit all services of candidate results
Method: post
Path: /hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services
Recruiting Background Check Screening Packages
The screening packages resource includes the details of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcScreeningPackages
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcScreeningPackages/{bcScreeningPackagesUniqID}
Submit all details of the screening packages
Method: post
Path: /hcmRestApi/resources/11.13.18.05/bcScreeningPackages
Recruiting Background Check Screening Packages/Services About the Screening Packages.
The services resource is a child of the screening package resource. It includes the services of the screening packages.
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcScreeningPackages/{bcScreeningPackagesUniqID}/child/services
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcScreeningPackages/{bcScreeningPackagesUniqID}/child/services/{ScreeningPackage}
Submit all services of the screening packages
Method: post
Path: /hcmRestApi/resources/11.13.18.05/bcScreeningPackages/{bcScreeningPackagesUniqID}/child/services
Recruiting CE Address Formats
The recruitingCEAddressFormats resource includes the format of address for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all address formats of countries
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats
Get an address format of countries
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}
Recruiting CE Address Formats/Address Format Details
The addressFormatDetails resource is a child of recruitingCEAddressFormats. It includes the address format details for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all address formats details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/addressFormatDetails
Get an address format details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/addressFormatDetails/{AttributeName}
Recruiting CE Address Formats/Geographical Hierarchies
The geoHierarchies resource is a child of recruitingCEAddressFormats. It includes the geographical hierarchies for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a geographical hierarchy
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/geoHierarchies/{geoHierarchiesUniqID}
Get all geographical hierarchies
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/geoHierarchies
Recruiting CE Address Formats/State Provinces
The stateProvinces resource is a child of recruitingCEAddressFormats. It includes the details of the states and provinces for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a state and province
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/stateProvinces/{stateProvincesUniqID}
Get all states and provinces
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/stateProvinces
Recruiting CE Application Flows
The recruitingCEApplyFlows resource includes all the corresponding job application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a job application flow
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}
Get all job application flows
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows
Recruiting CE Application Flows/Requisition Flexfields
The requisitionFlexFields resource is a child of the recruitingCEApplyFlows resource. It includes all the job requisition flexfields configured for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a requisition flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/requisitionFlexFields/{ColumnName}
Get all requisition flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/requisitionFlexFields
Recruiting CE Application Flows/Sections
The sections resource is a child of recruitingCEApplyFlows. It includes all the corresponding sections for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a section
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}
Get all sections
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections
Recruiting CE Application Flows/Sections/Pages
The pages resource is a child of the recruitingCErecruitingCEApplyFlows resource. It includes all the corresponding pages for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a page
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}
Get all pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages
Recruiting CE Application Flows/Sections/Pages/Blocks
The blocks resource is a child of the pages resources. It includes all the corresponding blocks for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a block
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}/child/blocks/{PageBlockId}
Get all blocks
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}/child/blocks
Recruiting CE Auto Suggestions on Search.
The recruitingCESearchAutoSuggestions resource gives details of auto suggestions on search. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of all auto suggestions on search
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESearchAutoSuggestions
Get details of an auto suggestion on search
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESearchAutoSuggestions/{Name}
Recruiting CE Candidate Certifications
The recruitingCECandidateCertificationItems resource includes the details about the certification done by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete details of the certification
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}
Get details of a certification
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}
Get details of all the certifications
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems
Submit a patch for the certification.
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}
Submit details of all the certifications
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems
Recruiting CE Candidate Details
The recruitingCECandidates resource includes all the details of recruitingCECandidates. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete details of a candidate
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}
Get all details of recruitingCECandidates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates
Get the details of a candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}
Patch details of a candidate
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}
Post all details of recruitingCECandidates
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates
Recruiting CE Candidate Details/Candidate Details with Attachments
The attachments resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with attachments. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete details of a recruitingCECandidates attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments/{Id}
Get all details of recruitingCECandidates attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments
Get details of a recruitingCECandidates attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments/{Id}
Patch details of a recruitingCECandidates attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments/{Id}
Post all details of recruitingCECandidates attachments
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments
Recruiting CE Candidate Details/Candidate Details with Extra Information Data
The CandidateExtraInformation resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information. Note that the service endpoints in this resource category are only for Oracle internal use.
Create all details of recruitingCECandidates personExtraInformation
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation
Delete a candidate extra information dictionary
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}
Get all extra information dictionary details of candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation
Get extra information dictionary detail of candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}
Update all details of recruitingCECandidates personExtraInformation
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}
Recruiting CE Candidate Details/Candidate Details with Extra Information Data/Candidate Details with Extra Information Rows
The Rows resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information rows. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete an extra information row for a candidate.
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}
Get all extra information row details for a candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows
Get an extra information row detail for a candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}
Update all details of recruitingCECandidates personExtraInformation rows
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}
Update an extra information row record for a candidate.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows
Recruiting CE Candidate Details/Candidate Details with Extra Information Data/Candidate Details with Extra Information Rows/Candidate Details with Extra Information Attributes
The attributes resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information row attributes. Note that the service endpoints in this resource category are only for Oracle internal use.
Create all details of recruitingCECandidates personExtraInformation row attributes
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}/child/attributes
Delete an extra information attribute for candidate extra information row
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}/child/attributes/{AttributeId}
Get all extra information attribute details defined for candidate extra information row
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}/child/attributes
Get an extra information attribute detail defined for the candidate extra information row
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}/child/attributes/{AttributeId}
Update all details of recruitingCECandidates personExtraInformation row attributes
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}/child/attributes/{AttributeId}
Recruiting CE Candidate Details/Candidate Details with PII Data
The CandidatePIIData resource is a child of the recruitingCECandidates resource. It includes the details of the candidate national identifiers and date of birth. Note that the service endpoints in this resource category are only for Oracle internal use.
Create all details of recruitingCECandidates CandidatePIIData
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData
Delete details of a recruitingCECandidates CandidatePIIData
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData/{Id}
Get all details of recruitingCECandidates CandidatePIIData
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData
Get details of a recruitingCECandidates CandidatePIIData
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData/{Id}
Update details of a recruitingCECandidates CandidatePIIData
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData/{Id}
Recruiting CE Candidate Education
The recruitingCECandidateEducationItems resource includes details about the candidate's education. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete the details of the education items of the candidate.
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}
Get all the education items of the candidate.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems
Get an education item of the candidate.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}
Submit all the details of the education items of the candidate.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems
Update the details of the education items of the candidate.
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}
Recruiting CE Candidate Extra Information Dictionary
The recruitingCEExtraInformationDictionary resource includes all the values of dictionary as defined. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all details of the extra information dictionary
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEExtraInformationDictionary
Get details of the extra information dictionary
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEExtraInformationDictionary/{ResourceName}
Recruiting CE Candidate Extra Information Dictionary/Recruiting CE Candidate Extra Information Dictionary List of Values
The CandidateEFFDictionaryList resource is a child of the recruitingCEExtraInformationDictionary resource. It provides a list of values in the current dictionary. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all details of the extra information dictionary list
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEExtraInformationDictionary/{ResourceName}/child/listOfValues
Get details of the extra information dictionary list
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEExtraInformationDictionary/{ResourceName}/child/listOfValues/{ListId}
Recruiting CE Candidate Interview Actions
Details of the actions taken by the candidate during the interview. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a candidate interview action
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewActions/{recruitingCEInterviewActionsUniqID}
Get all candidate interview actions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewActions
Submit a candidate interview action
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewActions
Recruiting CE Candidate Preferences
The recruitingCECandidatePreferences resource includes all the details of the job preferences of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a candidate preference
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreferences/{CandidateNumber}
Get all candidate preferences
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreferences
Update a candidate preference
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreferences/{CandidateNumber}
Recruiting CE Candidate Previous Experience
The recruitingCECandidatePreviousExpItems resource includes the details of the candidate's previous experience. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete the candidate previous experience items.
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}
Get all the candidate previous experience items.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems
Get the candidate previous experience item.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}
Patch the candidate previous experience items.
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}
Post all the candidate previous experience items.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems
Recruiting CE Candidate Profile Blocks Meta Data.
The recruitingCECandidateProfileBlocksMetadata resource includes the details of the candidate profile blocks meta data. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a candidate profile blocks meta data
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileBlocksMetadata/{recruitingCECandidateProfileBlocksMetadataUniqID}
Get all the candidate profile blocks meta data
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileBlocksMetadata
Recruiting CE Candidate Responses to Questions
The recruitingCEQuestionsResponses resource includes the details of responses provided by the candidate to the questions. Note that the service endpoints in this resource category are only for Oracle internal use.
Get the details of a response
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEQuestionsResponses/{recruitingCEQuestionsResponsesUniqID}
Get the details of all responses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEQuestionsResponses
Post details of all responses
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEQuestionsResponses
Recruiting CE Candidate Resume Parser
The recruitingCECandidateResumeParsers resource includes all details of the candidate resume. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a single candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}
Get a single candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}
Get all the candidate resumes in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports
Get all the candidate resumes in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers
Recruiting CE Candidate Resume Parser/Attachments
The attachments resource is a child of candidateResumeParsers. It includes the details of all attachments added by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a single attachment of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/attachments/{Id}
Get a single attachment of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/attachments/{Id}
Get all the attachments of the candidate resume in a collection.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/attachments
Get all the attachments of the candidate resume in a collection.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/attachments
Recruiting CE Candidate Resume Parser/Educations
The educations resource is a child of candidateResumeParsers. It includes details of the educational qualifications of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a single educational details of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/educations/{ProfileItemId}
Get a single educational details of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/educations/{ProfileItemId}
Get all the educational details of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/educations
Get all the educational details of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/educations
Recruiting CE Candidate Resume Parser/Languages
The languages resource is a child of candidateResumeParsers. It includes details of the languages known to the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a single language of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/languages/{ProfileItemId}
Get a single language of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/languages/{ProfileItemId}
Get all the languages of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/languages
Get all the languages of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/languages
Recruiting CE Candidate Resume Parser/Licenses and Certifications
The licensesAndcertifications resource is a child of candidateResumeParsers. It includes the details of all the licenses and certifications obtained by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a single license and certification of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/licensesAndCertifications/{ProfileItemId}
Get a single license and certification of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/licensesAndCertifications/{ProfileItemId}
Get all the licenses and certifications of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/licensesAndCertifications
Get all the licenses and certifications of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/licensesAndCertifications
Recruiting CE Candidate Resume Parser/Skills
The skills resource is a child of candidateResumeParsers. It includes the details of all the skills obtained by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a single skill of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/skills/{ProfileItemId}
Get a single skill of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/skills/{ProfileItemId}
Get all the skills of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/skills
Get all the skills of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/skills
Recruiting CE Candidate Resume Parser/Work Experiences
The workExperiences resource is a child of candidateResumeParsers. It includes the details of all the work experiences of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a single work experiences of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/workExperiences/{ProfileItemId}
Get a single work experiences of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workExperiences/{ProfileItemId}
Get all the work experiences of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/workExperiences
Get all the work experiences of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workExperiences
Recruiting CE Candidate Resume Parser/Work Preferences
The workPreferences resource is a child of candidateResumeParsers. It includes the details of the work preferences of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a single work preference of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/workPreferences/{ContentTypeId}
Get a single work preference of the candidate resume
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workPreferences/{ContentTypeId}
Get all the work preferences of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/workPreferences
Get all the work preferences of the candidate resume in a collection
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workPreferences
Recruiting CE Candidate Site Preferences
The recruitingCECandidateSitePreferences resource includes the details of candidate site preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a candidate site preference
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}
Get all candidate site preferences
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences
Submit all candidate site preferences
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences
Recruiting CE Candidate Site Preferences/Preferred Site TC in the Site Preferences of the Recruiting Candidate
The siteTCPreferences resource is a child of recruitingCECandidateSitePreferences. It includes the details of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a candidate site TCP preference
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}
Get all candidate site TCP preferences
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences
Submit all details of candidate site TCP preferences
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences
Recruiting CE Candidate Site Preferences/Preferred Site TC in the Site Preferences of the Recruiting Candidate/Preferred Job Families
The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a preferred job families of candidate site TCP preferences
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFamilies/{JobFamilyId}
Get all preferred job families of candidate site TCP preferences
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFamilies
Submit all preferred job families of candidate site TCP preferences
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFamilies
Recruiting CE Candidate Site Preferences/Preferred Site TC in the Site Preferences of the Recruiting Candidate/Preferred Job Functions
The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
Create all preferred job functions of a candidate from the Talent Community Pool preferences.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFunctions
Get a preferred job function of a candidate from the Talent Community Pool preferences.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFunctions/{JobFunctionCode}
Get all preferred job functions of a candidate from the Talent Community Pool preferences.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFunctions
Recruiting CE Candidate Site Preferences/Preferred Site TC in the Site Preferences of the Recruiting Candidate/Preferred Locations
The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a preferred locations of candidate site TCP preferences
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredLocations/{GeographyId}
Get all preferred locations of candidate site TCP preferences
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredLocations
Submit all preferred locations of candidate site TCP preferences
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredLocations
Recruiting CE Candidate Work Preferences
The recruitingCECandidateWorkPreferences resource includes the details of the work preferences of the candidates. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete details of a candidate work preference
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}
Get the details of a candidate work preference
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}
Get the details of all the candidate work preferences
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences
Patch details of a candidate work preference
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}
Post the details of all the candidate work preferences
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences
Recruiting CE Dictionaries
The recruitingCEDictionaries resource includes the lookup items relevant to the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a recruiting CE dictionary
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEDictionaries/{Id}
Get all recruiting CE dictionaries
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEDictionaries
Recruiting CE Interview Schedules
The recruitingCEInterviewScheduleDetails resource includes the details of the interview schedules. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all interview schedules
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails
Get an interview schedule
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}
Recruiting CE Interview Schedules/Recruiting CE Interviews
The Interviews resource is a child of recruitingCEInterviewScheduleDetails. It includes the details of the interviews attended by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a scheduled interview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}
Gets details of all scheduled interviews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews
Recruiting CE Interviews
The Interviews resource is a child of recruitingCEInterviewScheduleDetails. It includes the details of the interviews attended by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a scheduled interview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}
Gets details of all scheduled interviews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails
Recruiting CE Interviews/Schedule Interview Participants
The ScheduleInterviewParticipants resource is a child of recruitingCEInterviewDetails. It includes all interview schedules for participants. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all interview schedules for participants
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/child/ScheduleInterviewParticipants
Get the interview schedule for a participant
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/child/ScheduleInterviewParticipants/{ScheduleInterviewParticipantsUniqID}
Recruiting CE Job Referral Clicks
The recruitingCEReferralHits resource gives all details of the requisitions clicks. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a requisitions click
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEReferralHits/{RequisitionNumber}
Get details of all requisitions clicks
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEReferralHits
Submit all details of requisitions clicks
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEReferralHits
Recruiting CE Job Referrals
The recruitingCEReferrals resource includes all the details for recruitingCEReferrals. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a candidate referral
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEReferrals/{ReferralId}
Get all candidate referrals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEReferrals
Submit all details of candidate referrals
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEReferrals
Recruiting CE Job Referrals/Attachments in Referrals
The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all attachments for candidate referral
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEReferrals/{ReferralId}/child/attachments
Get an attachment for candidate referral
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEReferrals/{ReferralId}/child/attachments/{DocumentId}
Recruiting CE Job Requisition Details
The recruitingCEJobRequisitionDetails resource includes the details about an external, published job. You need to provide path parameters for these requests. Requests without parameters aren't allowed and will return an error. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a job requisition details pertaining to a published job
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}
Get all job requisition details pertaining to a published job
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews
Recruiting CE Job Requisition Details/Job Requisition Flexfields
The requisitionFlexFields resource is a child of recruitingCEJobRequisitionDetails. It includes details of requisition flexfields. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a requisition flexfield for the requisition details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/requisitionFlexFields/{ColumnName}
Get all requisition flexfields for the requisition details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/requisitionFlexFields
Recruiting CE Job Requisition Details/Media
The media resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of the media used. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a media used in the requisition template details preview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/media/{Id}
Get all media used in the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/media
Recruiting CE Job Requisition Details/Other Work Locations
The otherWorkLocations resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of other work locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all other work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/otherWorkLocations
Get other work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/otherWorkLocations/{otherWorkLocationsUniqID}
Recruiting CE Job Requisition Details/Secondary Locations
The secondaryLocations resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of the secondary locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a secondary location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/secondaryLocations/{RequisitionLocationId}
Get all secondary locations for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/secondaryLocations
Recruiting CE Job Requisition Details/Work Locations
The workLocation resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of other work locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/workLocation/{workLocationUniqID}
Get all work locations for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/workLocation
Recruiting CE Job Requisitions
The recruitingCEJobRequisitions resource includes the list of the available requisitions. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a job requisition
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}
Get a job requisition
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}
Get all job requisitions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions
Get all job requisitions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions
Recruiting CE Job Requisitions/Categories Facet
The categoriesFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the categories facets. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a categories facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/categoriesFacet/{Id}
Get a categories facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/categoriesFacet/{Id}
Get all categories facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/categoriesFacet
Get all categories facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/categoriesFacet
Recruiting CE Job Requisitions/Flexfields Facet
The flexFieldsFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the flexfields facets which are based on the custom flexfields configured by the users. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a flexfields facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/flexFieldsFacet/{Name}
Get all flexfields facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/flexFieldsFacet
Recruiting CE Job Requisitions/Flexfields Facet/Flexfield Facet Values
The values resource is a child of recruitingCEJobRequisitions. It includes the details of the flexfields facets values. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a flexfields facet values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/flexFieldsFacet/{Name}/child/values/{Id}
Get all flexfields facets values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/flexFieldsFacet/{Name}/child/values
Recruiting CE Job Requisitions/Locations Facet
The locationsFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the locationsFacet. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a location facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/locationsFacet/{Id}
Get a location facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/locationsFacet/{Id}
Get all location facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/locationsFacet
Get all location facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/locationsFacet
Recruiting CE Job Requisitions/Organizations Facet
The organizationsFacet resource is a child of the recruitingCEJobRequisitions and provides details about of the organizations facets. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all organization facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/organizationsFacet
Get an organization facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/organizationsFacet/{Id}
Recruiting CE Job Requisitions/Posting Dates Facet
The postingDatesFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the posting dates facet. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a posting date facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/postingDatesFacet/{Id}
Get a posting date facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/postingDatesFacet/{Id}
Get all posting date facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/postingDatesFacet
Get all posting date facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/postingDatesFacet
Recruiting CE Job Requisitions/Requisition List
The requisitionList resource is a child of recruitingCEJobRequisitions. It includes the details of the the requisition lists. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a requisition list
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}
Get a requisition list
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}
Get all requisition lists
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList
Get all requisition lists
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList
Recruiting CE Job Requisitions/Requisition List/Other Work Locations
The otherWorkLocations resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of other work locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all other work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/otherWorkLocations
Get all other work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/otherWorkLocations
Get other work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/otherWorkLocations/{otherWorkLocationsUniqID}
Get other work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/otherWorkLocations/{otherWorkLocationsUniqID}
Recruiting CE Job Requisitions/Requisition List/Primary Location Coordinates
The primaryLocationCoordinates resource is a child of recruitingCEJobRequisitionDetails. It includes details of primary location coordinates. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a primary location coordinates for the requisition details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/primaryLocationCoordinates/{primaryLocationCoordinatesUniqID}
Get all primary location coordinates for the requisition details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/primaryLocationCoordinates
Recruiting CE Job Requisitions/Requisition List/Secondary Locations
The secondaryLocations resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of the secondary locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a secondary location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/secondaryLocations/{RequisitionLocationId}
Get a secondary location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/secondaryLocations/{RequisitionLocationId}
Get all secondary locations for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/secondaryLocations
Get all secondary locations for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/secondaryLocations
Recruiting CE Job Requisitions/Requisition List/Work Locations
The workLocation resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of other work locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/workLocation/{workLocationUniqID}
Get a work location for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/workLocation/{workLocationUniqID}
Get all work locations for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/workLocation
Get all work locations for the requisition template details previews
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/workLocation
Recruiting CE Job Requisitions/Requisition Locations Coordinates
The requisitionLocationsCoordinates resource is a child of the recruitingCEJobRequisitions resource and provides details about the coordinates of the requisition's locations. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a requisition locations coordinates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionLocationsCoordinates/{SearchId2}
Get all requisitions locations coordinates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionLocationsCoordinates
Recruiting CE Job Requisitions/Requisition Locations Coordinates/Location Coordinates
The locationsCoordinates resource is a child of the recruitingCEJobRequisitions resource and provides details about locations coordinates. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a location coordinates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionLocationsCoordinates/{SearchId2}/child/locationCoordinates/{RequisitionId}
Get all locations coordinates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionLocationsCoordinates/{SearchId2}/child/locationCoordinates
Recruiting CE Job Requisitions/Titles Facet
The titlesFacet resource is a child of the recruitingCEJobRequisitions resource. It includes the details of the titles facet. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a titles facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/titlesFacet/{Id}
Get a titles facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/titlesFacet/{Id}
Get all titles facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/titlesFacet
Get all titles facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/titlesFacet
Recruiting CE Job Requisitions/Work Locations Facet
The workLocationsFacet resource is a child of the recruitingCEJobRequisitions resource. It includes the details of the all the work locations facet. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a work location facet
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
Delete a work location facet
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
Get a work location facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
Get a work location facet
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
Get all work location facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workLocationsFacet
Get all work location facets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/workLocationsFacet
Submit all work location facets
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workLocationsFacet
Submit all work location facets
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/workLocationsFacet
Update a work location facet
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
Update a work location facet
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
Recruiting CE Languages
The recruitingCECandidateLanguageItems resource includes the details of the candidate language items. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete the language items
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}
Get a language item for the candidate.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}
Get all the language items for the candidate.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems
Patch the language items
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}
Submit all the language items.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems
Recruiting CE Name Styles
The recruitingCENameStyles resource includes the details of the CE name styles used in recruiting. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a recruiting CE name style
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCENameStyles/{recruitingCENameStylesUniqID}
Get all recruiting CE name style
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCENameStyles
Recruiting CE Offer Details
The offerDetails resource gets all the details about a job offer.
Create assessment requests for a job application
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessments
Get all details of job offers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails
Get details of a job offer
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}
Get the details of all recruiting candidate assessments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessments
Get the details of the recruiting candidate assessment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessments/{RequisitionNumber}
Recruiting CE Offer Details/Attachments
The attachments resource is a child of the recruitingCEOfferDetails resource. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all details of all offer attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments
Get details of an offer attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{AttachedDocumentId}
Recruiting CE Offer Details/Candidate Reasons to Decline the Job Offer
The offerDeclineReasons resource is a child of the recruitingCEOfferDetails resource. It provides the reasons that the candidate can provide while declining the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a reason that candidates can provide while declining the job offer.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/offerDeclineReasons/{ReasonId}
Get all the reasons that candidates can provide while declining the job offer.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/offerDeclineReasons
Recruiting CE Offer Details/Job Offer Assignment
The assignment resource is a child of the recruitingCEOfferDetails resource. It describes the type of job assignment. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all the job assignment types
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/assignment
Get the type of job assignment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/assignment/{assignmentUniqID}
Recruiting CE Offer Details/Job Offer Letter
The offerLetter resource is a child of the recruitingCEOfferDetails resource. It includes the details of the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a job offer letter
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/offerLetter/{OfferId2}
Get all the job offer letters
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/offerLetter
Recruiting CE Offer Details/Media Links in the Job Offer
The mediaLink resource is a child of the recruitingCEOfferDetails resource. It gets the URL for the media link. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all media link URLs
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/mediaLinks
Get the media link URL
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/mediaLinks/{mediaLinksUniqID}
Recruiting CE Offer Responses
The recruitingCEOfferResponses resource includes all the details of the responses received in response to the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all offer responses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferResponses
Get an offer response
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferResponses/{AccessCode}
Submit all offer responses
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferResponses
Recruiting CE Profile Import Attachments
The recruitingCEProfileImportAttachments resource includes the details for the profile import attachments. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a profile import attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEProfileImportAttachments/{AttachedDocumentId}
Get all profile import attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEProfileImportAttachments
Submit all profile import attachments
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEProfileImportAttachments
Recruiting CE Profile Import Configurations
The recruitingCEProfileImportConfigs resource gives all details for the profile import configuration. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a profile import configuration
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEProfileImportConfigs/{Provider}
Get details of all the profile import configuration
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEProfileImportConfigs
Recruiting CE Prospects
The recruitingCEProspects resource includes all the details about the recruitingCEProspects. Note that the service endpoints in this resource category are only for Oracle internal use.
Create a prospect
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEProspects
Get a prospect
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEProspects/{recruitingCEProspectsUniqID}
Get all recruitingCEProspects
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEProspects
Recruiting CE Questions
The recruitingCEQuestions resource includes the details of the questions faced by a candidate while applying for a job. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a question
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEQuestions/{AttributeName}
Get details of all questions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEQuestions
Recruiting CE Questions/Answers to the Questions
The answers resource is a child of recruitingCEQuestions. It includes the details of the answers provided by the candidate in response to the questions asked while applying for a job. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a answer to the question
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEQuestions/{AttributeName}/child/answers/{LookupCode}
Get details of all answers to the question
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEQuestions/{AttributeName}/child/answers
Recruiting CE Regulatory Configurations
The recruitingCESecuredRegulatoryConfigs resource includes the details of the secured regulatory configurations. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a regulatory configuration
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs/{RequisitionNumber}
Get a secured regulatory configuration
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs/{RequisitionNumber}
Get a secured regulatory configuration
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecuredRegulatoryConfigs/{RequisitionNumber}
Get all secured regulatory configurations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs
Get all secured regulatory configurations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecuredRegulatoryConfigs
Submit all regulatory configurations
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs
Update a regulatory configuration
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs/{RequisitionNumber}
Recruiting CE Sites
The recruitingCESites resource includes the details of the job recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a site
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}
Get a site
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}
Get all recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites
Submit all recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites
Update a site
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}
Recruiting CE Sites/Cookie Consent
The cookieConsent resource is a child of recruitingCESites. It includes the details of the accepted cookies. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a cookie consent in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}
Get all cookie consent in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent
Submit all cookie consent in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent
Update a cookie consent in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}
Recruiting CE Sites/Cookie Consent/Translations
The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all translations of cookie consent in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations
Get translations of cookie consent in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}
Patch translations of cookie consent in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}
Recruiting CE Sites/Filters
The filters resource is a child of recruitingCESites. It includes all the filters of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete filters in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters/{DimensionKey}
Get a filter in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters/{DimensionKey}
Get all filters in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters
Submit all filters in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters
Update a filter in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters/{DimensionKey}
Recruiting CE Sites/Foot Links
The footerLinks resource is a child of recruitingCESites. It includes footer links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete footer links in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}
Get a footer links in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}
Get all footer links in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks
Patch footer links in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}
Submit all footer links in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks
Recruiting CE Sites/Foot Links/Header Link Translations
The translations resource is a child of headerLinks. It includes translations of the header links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a header translation in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/translations/{Language}
Get a header translation in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/translations/{Language}
Get all header translations in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/translations
Submit all header translations in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/translations
Update a header translation in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/translations/{Language}
Recruiting CE Sites/Foot Links/Sublinks
The child links resource is a child of headerLinks. It includes all the child links of each header link of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a child link used in the recruiting site
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}
Get a child link used in the recruiting site
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}
Get all child links used in the recruiting sites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks
Submit all child links used in the recruiting site
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks
Update a child link used in the recruiting site
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}
Recruiting CE Sites/Foot Links/Sublinks/Header Link Translations
The translations resource is a child of headerLinks. It includes translations of the header links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a header translation in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations/{Language}
Get a header translation in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations/{Language}
Get all header translations in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations
Submit all header translations in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations
Update a header translation in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations/{Language}
Recruiting CE Sites/Header Links
The headerLinks resource is a child of recruitingCESites. It includes all the header links of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a header links in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}
Get a header link in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}
Get all header links in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks
Submit all header links in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks
Update a header links in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}
Recruiting CE Sites/Header Links/Header Link Translations
The translations resource is a child of headerLinks. It includes translations of the header links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a header translation in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/translations/{Language}
Get a header translation in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/translations/{Language}
Get all header translations in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/translations
Submit all header translations in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/translations
Update a header translation in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/translations/{Language}
Recruiting CE Sites/Header Links/Sublinks
The child links resource is a child of headerLinks. It includes all the child links of each header link of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a child link used in the recruiting site
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}
Get a child link used in the recruiting site
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}
Get all child links used in the recruiting sites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks
Submit all child links used in the recruiting site
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks
Update a child link used in the recruiting site
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}
Recruiting CE Sites/Header Links/Sublinks/Header Link Translations
The translations resource is a child of headerLinks. It includes translations of the header links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a header translation in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations/{Language}
Get a header translation in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations/{Language}
Get all header translations in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations
Submit all header translations in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations
Update a header translation in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations/{Language}
Recruiting CE Sites/Languages
The languages resource is a child of recruitingCESites. It includes the details of languages in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a languages in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/languages/{SiteLanguage}
Get a language in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/languages/{SiteLanguage}
Get all languages in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/languages
Submit all languages in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/languages
Update a languages in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/languages/{SiteLanguage}
Recruiting CE Sites/Pages
The pages resource is a child of recruitingCESites. It includes the details of the pages in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a page in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}
Get a page in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}
Get all pages in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages
Submit all pages in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages
Update a page in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}
Recruiting CE Sites/Pages/Page Translations
The translations resource is a child of pages. It includes the page translations of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a page translation in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/translations/{Language}
Get all page translations in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/translations
Update a page translation in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/translations/{Language}
Recruiting CE Sites/Pages/Section Parameters
The sectionParams resource is a child of sections. It includes the parameters of the sections in each page of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a section parameter in the sections of pages
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/pageParams/{SettingId}
Get a section parameter in the sections of pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/pageParams/{SettingId}
Get all section parameters in the sections of pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/pageParams
Submit all section parameters in the sections of pages
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/pageParams
Update a section parameter in the sections of pages
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/pageParams/{SettingId}
Recruiting CE Sites/Pages/Sections
The sections resource is a child of pages. It includes the details of the sections in each page in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a section in the pages of recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}
Get a section in the pages of recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}
Get all sections in the pages of recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections
Submit all sections in the pages of recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections
Update a section in the pages of recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}
Recruiting CE Sites/Pages/Sections/Components
The components resource is a child of sections. It includes the details of components in the sections of each page in the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a component in the sections of pages
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}
Get a component in the sections of pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}
Get all components in the sections of pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components
Submit all components in the sections of pages
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components
Update a component in the sections of pages
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}
Recruiting CE Sites/Pages/Sections/Components/Component Translations
The componentTranslations resource is a child of the recruitingCESites resource. It includes the details of the translations of the components in the sections of each page in the career site. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a component translation in the sections of pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations/{Language}
Get all component translations in the sections of pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations
Update a component translation in the sections of pages
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations/{Language}
Recruiting CE Sites/Pages/Sections/Components/Section Parameters
The sectionParams resource is a child of sections. It includes the parameters of the sections in each page of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a section parameter in the sections of pages
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentParams/{SettingId}
Get a section parameter in the sections of pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentParams/{SettingId}
Get all section parameters in the sections of pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentParams
Submit all section parameters in the sections of pages
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentParams
Update a section parameter in the sections of pages
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentParams/{SettingId}
Recruiting CE Sites/Pages/Sections/Section Parameters
The sectionParams resource is a child of sections. It includes the parameters of the sections in each page of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a section parameter in the sections of pages
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/sectionParams/{SettingId}
Get a section parameter in the sections of pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/sectionParams/{SettingId}
Get all section parameters in the sections of pages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/sectionParams
Submit all section parameters in the sections of pages
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/sectionParams
Update a section parameter in the sections of pages
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/sectionParams/{SettingId}
Recruiting CE Sites/Settings
The settings resource is a child of recruitingCESites. It includes all the settings of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a setting in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/settings/{SettingKey}
Get a setting in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/settings/{SettingKey}
Get all settings in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/settings
Submit all settings in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/settings
Update a setting in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/settings/{SettingKey}
Recruiting CE Sites/Site Custom Fonts
The customFonts resource is a child of recruitingCESites. It includes the details for the custom fonts. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a custom font
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}
Get a custom font in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}
Get all custom fonts in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts
Submit all custom fonts in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts
Update a custom font in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}
Recruiting CE Sites/Site Custom Fonts/Site Custom Font Settings
The customFontsSettings resource is a child of customFonts. It includes the details for the custom font settings. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a custom font setting
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}
Get a custom font setting in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}
Get all custom font settings in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings
Submit all custom font settings in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings
Update a custom font setting in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}
Recruiting CE Sites/Site Custom Fonts/Site Custom Font Settings/Site Custom Font Setting Files
The customFontsFiles resource is a child of customFontsSettings. It includes the details for the custom font files. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete a custom font setting file
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}/child/customFontsFiles/{FileNumber}
Get a custom font setting file in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}/child/customFontsFiles/{FileNumber}
Get all custom font setting files in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}/child/customFontsFiles
Submit all custom font setting files in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}/child/customFontsFiles
Update a custom font setting file in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}/child/customFontsFiles/{FileNumber}
Recruiting CE Sites/Site Favicon
The siteFavicon is the child resource of recruitingCESites. It includes three sizes of favorite icons for each site. Note that the service endpoints in this resource category are only for Oracle internal use.
Create all favorite icons in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon
Delete a favorite icon in recruitingCESites
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}
Get a favorite icon in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}
Get all favorite icons in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon
Update a favorite icon in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}
Recruiting CE Sites/Site Translations
The translations resource is a child of recruitingCESites. It includes the translations of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Create all translations in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/translations
Get a translation in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/translations/{Language}
Get all translations in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/translations
Update a translation in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/translations/{Language}
Recruiting CE Sites/Talent Community Sign Up
The resource gives talent community sign up in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all talent community sign up in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp
Get talent community sign up in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}
Patch talent community sign up in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}
Post all talent community sign up in recruitingCESites
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp
Recruiting CE Sites/Talent Community Sign Up/Translations for the Talent Community Sign Up
The translations resource is a child of talentCommunitySignUp. It includes the talent community sign up related translations in the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a talent community enrollment translation in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}/child/translations/{Language}
Get all talent community enrollment translations in recruitingCESites
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}/child/translations
Update a talent community enrollment translation in recruitingCESites
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}/child/translations/{Language}
Recruiting CE Skill Items
The recruitingCECandidateSkillItems resource includes the details of the candidate skill items. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete the skill items
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}
Get a skill item for the candidate.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}
Get all the skill items for the candidate.
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems
Submit all the skill items.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems
Update the skill items
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}
Recruiting CE Source Tracking
The recruitingCESourceTrackings resource gives the details of recruitingCESourceTrackings. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a tracking
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESourceTrackings/{SourceTrackingId}
Get details of all recruitingCESourceTrackings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESourceTrackings
Submit all details of recruitingCESourceTrackings
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESourceTrackings
Recruiting CE Tax Credits
The recruitingCETaxCredits resource includes details about the partner candidate URL for tax credits. Note that the service endpoints in this resource category are only for Oracle internal use.
Create all tax credit requests for a job application
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCETaxCredits
Get all tax credits candidate URLs
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCETaxCredits
Get tax credits partner candidate URL for a job requisition
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCETaxCredits/{RequisitionNumber}
Recruiting CE Themes
The themes resource is a child of recruitingCETemplates. It includes the themes in recruitingCETemplates. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a theme in recruitingCETemplates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}
Get details of all themes in recruitingCETemplates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes
Submit details of all recruitingCEThemes
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes
Update details of recruitingCEThemes
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}
Recruiting CE Themes/Brands in Themes
The brands resource is a child of recruitingCEThemes. It includes the details of brands in the career site themes. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete details of a brand in recruitingCEThemes
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}
Get details of a brand in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}
Get details of all brands in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands
Submit details of all brands in recruitingCEThemes
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands
Update details of a brand in recruitingCEThemes
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}
Recruiting CE Themes/Brands in Themes/Brand Translations of Themes
The translation resource is a child of Brand. It includes the details of the brand translations of the recruiting CE themes. Note that the service endpoints in this resource category are only for Oracle internal use.
Create details of recruitingCEThemes Brand Translations
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations
Get all details of recruitingCEThemes Brand Translation
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations
Get details of recruitingCEThemes Brand Translation
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}
Update details of recruitingCEThemes Brands translations
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}
Recruiting CE Themes/Footer Links in Themes
The footerLinks resource is a child of recruitingCEThemes. It includes the details of footer links in recruitingCEThemes. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete details of a footer link in recruitingCEThemes
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}
Get details of all footer links in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks
Get details of footer links in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}
Submit details of all footer links in recruitingCEThemes
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks
Update details of a footer link in recruitingCEThemes
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}
Recruiting CE Themes/Footer Links in Themes/Translations Used in Brands in Themes
The translations resource is a child of brands. It includes the details of translations in recruitingCEThemes. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a translation in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}/child/translations/{Language}
Get details of all translations in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}/child/translations
Submit details of all translations in recruitingCEThemes
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}/child/translations
Update details of a translation in recruitingCEThemes
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}/child/translations/{Language}
Recruiting CE Themes/Header Links in Themes
The headerLinks resource is a child of recruitingCEThemes. It includes the details of the header links in recruitingCEThemes. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete details of a header link in recruitingCEThemes
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}
Get details of a header link in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}
Get details of all header links in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks
Submit details of all header links in recruitingCEThemes
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks
Update details of a header link in recruitingCEThemes
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}
Recruiting CE Themes/Header Links in Themes/Translations Used in Brands in Themes
The translations resource is a child of brands. It includes the details of translations in recruitingCEThemes. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a translation in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}/child/translations/{Language}
Get details of all translations in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}/child/translations
Submit details of all translations in recruitingCEThemes
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}/child/translations
Update details of a translation in recruitingCEThemes
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}/child/translations/{Language}
Recruiting CE Themes/Styles in Themes
The styles resource is a child of recruitingCEThemes. It includes the details of styles in recruitingCEThemes. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete details of styles in recruitingCEThemes
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/styles/{stylesUniqID}
Get details of a style in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/styles/{stylesUniqID}
Get details of all styles in recruitingCEThemes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/styles
Submit details of all styles in recruitingCEThemes
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/styles
Update details of styles in recruitingCEThemes
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/styles/{stylesUniqID}
Recruiting CE Themes/Translations in a Template
The translations resource is a child of recruitingCETemplates. It includes the translations in recruitingCETemplates. Note that the service endpoints in this resource category are only for Oracle internal use.
Delete recruitingCEThemes brand translation
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}
Get details of a translation in recruitingCETemplates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}
Get details of all translations in recruitingCETemplates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations
Submit details of all translations in recruitingCETemplates
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations
Update details of a translation in recruitingCETemplates
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}
Recruiting CE User Tracking
The recruitingCEUserTrackings resource includes the details of the user's navigation paths. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a user tracking information
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEUserTrackings/{UserId}
Get all users tracking information
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEUserTrackings
Submit all the users tracking information
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEUserTrackings
Update the user tracking information
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEUserTrackings/{UserId}
Recruiting CE Verification
The recruitingCEVerificationTokens resource includes the details of verification tokens. Note that the service endpoints in this resource category are only for Oracle internal use.
Get details of a verification token
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEVerificationTokens/{TokenId}
Get details of all verification token
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEVerificationTokens
Submit all details of verification token
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEVerificationTokens
Recruiting Campaign Details
The recruitingCampaignDetails resource includes all the details of the campaign.
Get a Campaign Details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}
Get all recruitingCampaignDetails
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails
Recruiting Campaign Details/Campaign Assets
The campaignAssets resource is a child of recruitingCampaignDetails. It includes all the assets of the campaign.
Get a Campaign Asset
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}
Get all campaignAssets
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets
Get all campaignAssets
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}
Recruiting Campaign Details/Campaign Assets/Campaign Asset Channels
The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.
Create a CampaignAssetChannel
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/CampaignAssetChannels
Delete a Campaign Asset Channel
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/CampaignAssetChannels/{ChannelId}
Get a Campaign Asset Channel
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/CampaignAssetChannels/{ChannelId}
Get all CampaignAssetChannels
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/CampaignAssetChannels
Update a CampaignAssetChannel
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/CampaignAssetChannels/{ChannelId}
Recruiting Campaign Details/Campaign Assets/Campaign Asset Segments
The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.
Get all campaignAssetSegments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/campaignAssetSegments
Get campaignAssetSegment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/campaignAssetSegments/{AssetSegmentId}
Recruiting Campaign Details/Campaign Goal Responses
The campaignGoalResponses resource is a child of recruitingCampaignDetails. It includes all the goal responses of the campaign.
Get all campaignGoalResponse
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignGoalResponses
Get campaignGoalResponse
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignGoalResponses/{campaignGoalResponsesUniqID}
Recruiting Campaign Email Designs
The messageDesigns resource includes the details to get different Message Designs.
Delete a message design
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns
Delete a message design metadata
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}
Get a message design
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}
Get a message design metadata
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}
Update a message design
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns
Recruiting Campaign Email Designs/Message Design Metadata
The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.
Create all message design metadata
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata
Delete a message design type
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}
Get a message design type
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}
Get all message design metadata
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata
Update a message design metadata
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}
Recruiting Campaign Email Designs/Message DesignTypes
The resource messageDesignTypes is to get different types of message designs.
Create all message design type
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes
Create all message designs
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes/{messageDesignTypesUniqID}
Get all message design type
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes
Get all message designs
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes/{messageDesignTypesUniqID}
Update a message design type
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes/{messageDesignTypesUniqID}
Recruiting Candidate Assessment Results
The recruitingCandidateAssessmentResults resource includes the details of the recruiting candidate assessment results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}
Submit all details of recruiting candidate assessment results
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults
Recruiting Candidate Assessment Results/Packages of Recruiting Candidate Assessment Results
The packages resource is a child of recruitingCandidateAssessmentResults. It includes the details of the packages of recruiting candidate assessment results.
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages
GET action not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}
Submit all packages of recruiting candidate assessment results
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages
Recruiting Candidate Details
The resource includes details about the candidate.
Get details about a candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcCandidateDetails/{bcCandidateDetailsUniqID}
Get details about all candidates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcCandidateDetails
Recruiting Candidate Duplicate Checks
The recruitingCandidateDuplicates resource provides all the details related to a candidate duplicate check.
Create a candidate duplicate check
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateDuplicates
Get a candidate duplicate check
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateDuplicates/{DupChkLogId}
Get all candidate duplicate checks
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateDuplicates
Update a candidate duplicate check
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateDuplicates/{DupChkLogId}
Recruiting Candidate Experience Extra Information Metadata
The recruitingCECandidateExtraInformationMetadata resource provides all the metadata details of the extra information. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all extensible flexfield metadata details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateExtraInformationMetadata
Get an extensible flexfield metadata detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateExtraInformationMetadata/{ContextName}
Recruiting Candidate Experience Extra Information Metadata/Candidate Extra Information Metadata with Attributes
The CandEffAttrMetadata resource is a child of the recruitingCECandidateExtraInformationMetadata resource. It provides metadata details of the extra information attributes. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all extensible flexfield attribute metadata details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateExtraInformationMetadata/{ContextName}/child/attributeList
Get an extensible flexfield attribute metadata detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateExtraInformationMetadata/{ContextName}/child/attributeList/{AttributeId}
Recruiting Candidate Extra Information Details
The recruitingCandidateExtraInformation resource includes all the extra information details of a candidate. It is based on EFF resource. All the actions on the EFF attributes are done based on this service.
Create an extra information details of a candidate
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation
Delete an extra info data of the candidate
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{PersonId}
Get all extra information of a candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation
Get extra information of a candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{PersonId}
Update an extra information details of a candidate
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{PersonId}
Recruiting Candidate Extra Information Details/Person Extra Information Details
Represents the extensible structure of Person information.
Create an extra information details of a Person
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{PersonId}/child/jPersonExtraInformation
Delete an extra info data of the person
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{PersonId}/child/jPersonExtraInformation/{jPersonExtraInformationUniqID}
Get all extra information of a person
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{PersonId}/child/jPersonExtraInformation
Get all extra information of a person
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{PersonId}/child/jPersonExtraInformation/{jPersonExtraInformationUniqID}
Update an extra information details of a person
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{PersonId}/child/jPersonExtraInformation/{jPersonExtraInformationUniqID}
Recruiting Candidate Job Application Drafts
The recruitingCEJobApplicationDrafts resource includes the draft job applications of a candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
Create an application draft
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts
Delete an application draft
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}
Get a draft
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}
Get all application drafts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts
Update an application draft
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}
Recruiting Candidate Job Application Drafts/Attachments of the Job Application Drafts
The attachments resource is the child of the recruitingCEJobApplicationDrafts resource and includes all the attachments of a draft job application. Note that the service endpoints in this resource category are only for Oracle internal use.
Create attachments for the application drafts
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachments/{Id}
Get all attachments for application drafts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachments
Get an attachment for application drafts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachments/{Id}
Update an attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachments/{Id}
Recruiting Candidate PII Data
The recruitingCandidatePIIData resource includes all the details of the candidate national identifiers and date of birth. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Create details of all candidate PII data
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidatePIIData
Get the details of a candidate PII data
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidatePIIData/{recruitingCandidatePIIDataUniqID}
Get the details of all the candidate PII data
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidatePIIData
Recruiting Candidate Responses to Regulatory Questions
The recruitingCERegulatoryResponses resource includes the regulatory related response details. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a regulatory response
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryResponses/{recruitingCERegulatoryResponsesUniqID}
Get all regulatory responses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryResponses
Submit regulatory
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryResponses
Recruiting Candidates
The recruitingCandidates resource includes a list of all candidates available to be accessed by a given user. It is used to view a candidate.
Create a candidate
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates
Delete a candidate
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}
Get a candidate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}
Get all candidates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates
Update a candidate
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}
Recruiting Candidates/Attachments
The attachments resource is a child of the recruitingCandidates resource. It includes all information on the attachments for a given candidate. A candidate may have none or several attachments.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{AttachedDocumentId}
Get a attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{AttachedDocumentId}
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments
Update an attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{AttachedDocumentId}
Recruiting Candidates/Candidate Addresses
The candidateAddress resource is a child of the recruitingCandidates resource. It includes all information on the addresses for a given candidate. A candidate may have none or several addresses.
Create an address
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress
Delete an address
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress/{AddressId}
Get all addresses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress
Get an address
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress/{AddressId}
Update an address
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress/{AddressId}
Recruiting Candidates/Candidate Phones
The candidatePhones resource is a child of the recruitingCandidates resource. It includes all information on the phone numbers for a given candidate. A candidate may have none or several phone numbers.
Create a phone number
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones
Delete a phone number
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones/{PhoneId}
Get a phone number
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones/{PhoneId}
Get all phone numbers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones
Update a number
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones/{PhoneId}
Recruiting Candidates/Education Items
The education resource is a child of the recruitingCandidates resource. It includes all the information on the education items for a given candidate. A candidate may have none or several education items.
Create an education item
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education
Delete an education item
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}
Get all education items
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education
Get an education item
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}
Update an education item
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}
Recruiting Candidates/Experience Items
The experience resource is a child of the recruitingCandidates resource. It includes all information on the experience items for a given candidate. A candidate may have none or several experience items.
Create an experience item
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience
Delete an experience item
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}
Get all experience items
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience
Get an experience item
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}
Update an experience item
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}
Recruiting Candidates/Languages
The languages resource is a child of the recruitingCandidates resource. It includes all information on the languages for a given candidate. A candidate may have none or several languages.
Create a language
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages
Delete a language
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}
Get a language
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}
Get all languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages
Update a language
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}
Recruiting Candidates/Licenses and Certificates
The licensesAndCertificates resource is a child of the recruitingCandidates resource. It includes all information on the licenses and certificates for a given candidate. A candidate may have none or several licenses and certificates.
Create a license and certificate
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates
Delete a license and certificate
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}
Get a license and certificate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}
Get all licenses and certificates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates
Update a license and certificate
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}
Recruiting Candidates/Skills of the Recruiting Candidates
The skills resource is a child of recruitingCandidates. It includes the details of the recruiting candidates skills.
Delete recruiting candidates skill
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}
Get all recruiting candidates skills
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills
Get recruiting candidates skill
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}
Submit all recruiting candidates skills
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills
Update recruiting candidates skill
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}
Recruiting Candidates/Work Preferences
The workPreferences resource is a child of the recruitingCandidates resource. It includes all the information on the work preferences for a given candidate. A candidate may have none or several work preferences.
Create a work preference
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences
Delete a work preference
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
Get a work preference
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
Get all work preferences
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences
Update a work preference
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
Recruiting Career Site Contact Information Metadata
The recruitingCEContactInformationMetadata resource provides all the details of the candidate contact information to be entered on the recruiting career site. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all candidate contact information to be entered on the recruiting career site
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEContactInformationMetadata
Get candidate contact information to be entered on the recruiting career site
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEContactInformationMetadata/{recruitingCEContactInformationMetadataUniqID}
Recruiting Document Format Converter
The recruitingDocumentFormatConverters resource includes the details of the converters used to convert the candidate's documents to a different format.
Get a document format converter
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingDocumentFormatConverters/{AttachedDocumentId}
Get all the document format converters
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingDocumentFormatConverters
Recruiting Hierarchy Locations
The recruitingHierarchyLocations resource includes the details of the hierarchy for locations.
Get a hierarchy locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingHierarchyLocations/{recruitingHierarchyLocationsUniqID}
Get all hierarchy locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingHierarchyLocations
Recruiting Internal Candidate Job Applications
The Recruiting ICE Job Applications resource includes the details of the internal candidate job submissions.
Get all the internal candidate job applications
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobApplications
Get an internal candidate job application
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobApplications/{SubmissionId}
Submit all internal candidate job applications
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobApplications
Recruiting Job Applications
The recruitingJobApplications resource includes a list of all job applications available to be accessed by a given user.
Allows a candidate to move an application to an specific state and phase
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}
Allows a recruiter to confirm a job application on behalf of a candidate.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}
Allows a recruiter to resend a notification to a candidate requesting them to confirm their job application.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}
Allows a recruiter to withdraw a job application on behalf of the candidate.
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}
Create a job application
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications
Get a job application
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}
Get a job application
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}
Get all job applications
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications
Get all job applications
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications
Recruiting Job Applications/Assessment Links
The assessmentLinks resource is a child of recruitingCEJobApplications. It provides the links to go to assessment partner sites. Note that the service endpoints in this resource category are only for Oracle internal use.
Create all assessment links
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/assessmentLinks
Get all assessment links
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/assessmentLinks
Get an assessment link
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/assessmentLinks/{ProvisioningId}
Recruiting Job Applications/Attachments
The attachments resource is a child of the recruitingJobApplications resource. It includes all the information on the attachments for a given candidate job application. A job application may have none or several attachments.
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments/{AttachedDocumentId}
Recruiting Job Applications/Background Check Links
The backgroundCheckLinks resource is a child of recruitingCEJobApplications. It provides the links to go to background check partner sites. Note that the service endpoints in this resource category are only for Oracle internal use.
Create all background check links
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/BackgroundCheckLinks
Get a background check link
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/BackgroundCheckLinks/{ProvisioningId}
Get all background check links
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/BackgroundCheckLinks
Recruiting Job Applications/Candidate Responses to Questions
The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.
Create responses for a questionnaire
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/questionnaireResponses
Get the details of a response for a questionnaire
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/questionnaireResponses/{QuestionnaireId}
Get the details of all responses for a questionnaire
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/questionnaireResponses
Recruiting Job Applications/Education Items
The education resource is a child of the recruitingJobApplications resource. It includes all the information on the education items for a given candidate job application. A job application may have none or several education items.
Get all education items
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education
Get an education item
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}
Recruiting Job Applications/Experience Items
The experience resource is a child of the recruitingJobApplications resource. It includes all the information on the experience items for a given candidate job application. A job application may have none or several experience items.
Get all experience items
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience
Get an experience item
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}
Recruiting Job Applications/Languages
The languages resource is a child of the recruitingJobApplications resource. It includes all the information on the languages for a given candidate job application. A job application may have none or several languages.
Get a language item
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages/{LanguageId}
Get all language items
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages
Recruiting Job Applications/Licenses And Certificates
The licensesAndCertificates resource is a child of the recruitingJobApplications resource. It includes all the information on the licenses and certificates for a given candidate job application. A job application may have none or several licenses and certificates.
Get a license or certificate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}
Get all licenses and certificates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates
Recruiting Job Applications/Preferred Job Locations
The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.
Create a preferred location
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/preferredLocations
Get a preferred location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/preferredLocations/{JaPreferredLocationId}
Get all preferred locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/preferredLocations
Recruiting Job Applications/Recruiting Candidate Responses to Regulatory Questions
The recruitingCERegulatoryResponses resource includes the regulatory related response details. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a regulatory response
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/regulatoryResponses/{regulatoryResponsesUniqID}
Get all regulatory responses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/regulatoryResponses
Submit regulatory
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/regulatoryResponses
Recruiting Job Applications/Schedule Job Interviews
The ScheduleInterviews resource is a child of recruitingCEJobApplications. It includes all details about the scheduled interviews. Note that the service endpoints in this resource category are only for Oracle internal use.
Create a scheduled interview
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/ScheduleInterviews