REST API for Oracle Fusion Cloud HCM

All REST Endpoints

Absences

The absences resource provides 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}
Search existing absences: Method: post
Path: /hcmRestApi/resources/11.13.18.05/absences/action/findByAdvancedSearchQuery
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 provides 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 Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}/enclosure/FileContents

Absences/Absence Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}/enclosure/FileWebImage

Absences/Absence Descriptive Flexfields

The absenceRecordingDFF resource provides 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 provides 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 provides 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 provides 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 provides 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}

Accomplishment Items

Get all profile tag details

Get all profile tag details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions
Get all profile tag details: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions
Get all profile tag details: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}
Get all profile tag details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}
Get all profile tag details: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}

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}

Actions in Opportunity Marketplace/Large Object (LOB) Attributes - WriteUp

Delete a WriteUp: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktActions/{ActionType}/enclosure/WriteUp
Get a WriteUp: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktActions/{ActionType}/enclosure/WriteUp
Replace a WriteUp: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktActions/{ActionType}/enclosure/WriteUp

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/action/allocateChecklist
Allocate a new task: Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/allocateNewTask
Allocate a task from the task library: Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/allocateTaskFromTaskLibrary
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}/action/forceCloseChecklist
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}/action/reopenTask
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}/action/updateTaskStatus

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 resource is used to view, create, and update attachments.

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/{attachmentsUniqID}
Get a task attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}
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/{attachmentsUniqID}

Allocated Checklists/Allocated Tasks/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Allocated Checklists/Allocated Tasks/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Allocated Checklists/Allocated Tasks/Documents

The attachments resource is used to view, create, and update attachments.

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/{documentsUniqID}
Get a document task type attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{documentsUniqID}
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/{documentsUniqID}

Allocated Checklists/Allocated Tasks/Documents/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents

Allocated Checklists/Allocated Tasks/Documents/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{documentsUniqID}/enclosure/FileWebImage

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

Application Details in Opportunity Marketplace/Large Object (LOB) Attributes - WriteUp

Get a WriteUp: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktApplicationDetails/{ApplicationId}/enclosure/WriteUp

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}
Find areas of responsibility information: Method: post
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/action/findByAdvancedSearch
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}/action/reassign
Scope details for the responsibility template.: Method: post
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/action/getAorScopeDetails
Update an area of responsibility: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}

Areas of Responsibility/Banner Override Messages

The bannerOverrideMessages resource provides all the status information and related messages for an object.

Get a message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}/child/bannerOverrideMessages/{ObjectId}
Get all messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}/child/bannerOverrideMessages

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}

Benefits Comparison Plans/Images/Large Object (LOB) Attributes - Image

Get an Image: Method: get
Path: /hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/images/{ImageId}/enclosure/Image

Business Process Approval Attachments Comments

The businessProcessApprovalAttachmentsComments resource provides comment and attachments content for a specific transaction.

Create a comment and attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments
Get a comment and attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}
Get all comments and attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments
Update a comment and attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}

Business Process Approval Attachments Comments/approvalAttachments

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments
Delete: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}

Business Process Approval Attachments Comments/approvalAttachments/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_attachments_Id}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_attachments_Id}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_attachments_Id}

Business Process Approval Attachments Comments/approvalAttachments/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_attachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_attachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_attachments_Id}/enclosure/FileContents

Business Process Approval Attachments Comments/approvalAttachments/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_attachments_Id}/enclosure/FileWebImage

Business Process Approval Attachments Comments/approvalComments

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments
Delete: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments/{businessProcessApprovalAttachmentsComments_approvalComments_Id}
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments/{businessProcessApprovalAttachmentsComments_approvalComments_Id}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments/{businessProcessApprovalAttachmentsComments_approvalComments_Id}

Business Process Notifications

The businessProcessNotifications resource provides BIP notifications content. You can retrieve the list of actions that can be performed on a task.

Generate a deep link URL for the edit action: Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getDeeplinkUrlForEditAction
Get a notification content: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}
Get all notification content: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications
Perform action on a transaction: Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/performAction
Perform action on a transaction with comments: Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/performActionWithComments
Perform action on multiple transaction with comments: Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/performActionOnBulkTransactionWithComments
Retrieve the list of actions: Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getActionsBasedOnIdentificationKey
Retrieve the list of task actions: Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getActionsBasedOnTaskId

Business Process Notifications/Large Object (LOB) Attributes - approvalHistory

Get an approvalHistory: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}/enclosure/approvalHistory

Business Process Notifications/Large Object (LOB) Attributes - content

Get a content: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}/enclosure/content

Business Process Notifications/Large Object (LOB) Attributes - contentWithHistory

Get a contentWithHistory: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}/enclosure/contentWithHistory

Business Process Notifications/Large Object (LOB) Attributes - contentWithoutHistory

Get a contentWithoutHistory: Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}/enclosure/contentWithoutHistory

Candidate Recommendations for a Gig.

The recruitingOppMktGigCandRecommendations resource is the child of the recruitingOppMktGig resource, and provides details on recommended candidates in opportunity marketplace.

Get a recommended candidate for a gig.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigCandRecommendations/{PersonId}
Get all recommended candidates for a gig.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigCandRecommendations

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

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/{checkInDocumentsUniqID}
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/{checkInDocumentsUniqID}

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/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses

Check-In Documents/Questionnaire Responses/Question Responses

(Resource of questionResponses)

Create a response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}
Get all responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}

Check-In Documents/Questionnaire Responses/Question Responses/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}

Check-In Documents/Questionnaire Responses/Question Responses/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}/enclosure/FileContents

Check-In Documents/Questionnaire Responses/Question Responses/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}/enclosure/FileWebImage

Check-In Documents/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerCLOB

Delete an AnswerCLOB: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/enclosure/AnswerCLOB
Get an AnswerCLOB: Method: get
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/enclosure/AnswerCLOB
Replace an AnswerCLOB: Method: put
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/enclosure/AnswerCLOB

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/recruitingOppMktCompletedGigs/{GigId}
Get all completed gigs for an opportunity marketplace application: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktCompletedGigs

Count

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

Count/Facet

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/{facetsUniqID}
Get all facets: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}/child/facets

Count/Facet/Value

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/{facetsUniqID}/child/values/{valuesUniqID}
Get all values: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}/child/facets/{facetsUniqID}/child/values

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.

Create all document delivery preferences: Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2
Delete a document delivery preference: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2/{documentDeliveryPreferencesV2UniqID}
Get a delivery preference for a document record: Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentDeliveryPreferences/{documentDeliveryPreferencesUniqID}
Get a document delivery preference: Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2/{documentDeliveryPreferencesV2UniqID}
Get all delivery preferences for document records: Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentDeliveryPreferences
Get all document delivery preferences: Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2
Update a document delivery preference: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2/{documentDeliveryPreferencesV2UniqID}

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.

Check access for unpublished document records: Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/action/checkViewUnpublishedAccess
Check manage access: Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/action/checkManageAccess
Check mass download access: Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/action/checkMassdownloadAccess
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}
Download attachments for a document record: Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/action/downloadAttachments
Find document records: Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/action/findByAdvancedSearchQuery
Generate letter for a document record: Method: post
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/action/generateDraftLetter
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/{attachmentsUniqID}
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/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}

Document Records/Attachments/Attachment Previews

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Document Records/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Document Records/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Document Records/Banner Override Messages

The bannerOverrideMessages resource provides all the status information and related messages for an object.

Get a message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/bannerOverrideMessages/{ObjectId}
Get all messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/bannerOverrideMessages

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/{DocumentsOfRecordId3}
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/{DocumentsOfRecordId3}

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 provides 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 is a child of the elementEntries resource.It provides 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. Operations to create and update worker records in Oracle Fusion Cloud HCM involve various post-processing steps across products. Therefore, these operations may take several minutes to complete. For bulk load and extract operations, you must use HCM Data Loader (HDL) and HCM Extracts, respectively. Also, you shouldn't use REST APIs for detecting data changes in the application. Instead, use Atom feeds to detect or identify changes made to data for key transactions in Oracle Fusion Cloud HCM. For example, you may use Atom feeds to detect changes in employee's personal details, employment data, new hires, and terminations. See the Atom Feeds section for details about delivered feeds in Oracle Fusion Cloud HCM.

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/Photos/Large Object (LOB) Attributes - Image

Unique location of the image. Encrypted version of the file.

Delete an Image: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}/enclosure/Image
Get an Image: Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}/enclosure/Image
Replace an Image: Method: put
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}/enclosure/Image

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/{rolesUniqID}
Get a role: Method: get
Path: /hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/roles/{rolesUniqID}
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/{rolesUniqID}

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}/action/getAvailableActions
Perform a corrective action: Method: post
Path: /hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/action/performAction

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}/action/getAvailableActions
Perform a corrective action for a checklist: Method: post
Path: /hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/child/checklists/{FlowTaskInstanceId}/action/performAction

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}/action/submitFlow

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 Benefits/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}/enclosure/Description

Gig Details/Gig Classifications

The gig classification resource is the child of the recruitingOppMktGigDetails resource and provides the list of classifications for a gig in opportunity marketplace.

Create the gig classification in opportunity marketplace: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications
Delete a gig classification in opportunity marketplace: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications/{ClassificationId}
Get a gig classification in opportunity marketplace: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications/{ClassificationId}
Get all gig classifications in opportunity marketplace: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications
Update a gig classification in opportunity marketplace: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications/{ClassificationId}

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}

Gig Details/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/enclosure/Description

Gig Prospects

A gig prospect is the child resource of an opportunity marketplace gig.

Get a gig prospect.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigProspects/{recruitingOppMktGigProspectsUniqID}
Get all gig prospects.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktGigProspects

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

An object to capture the values for the step rates within an Assignment Grade Ladder.

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/Passports/Person Passports Descriptive Flexfields

(Resource of passportsDFF)

Create a person passport descriptive flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDFF
Get a person passport descriptive flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDFF/{PassportId3}
Get all person passport descriptive flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDFF
Update a person passport descriptive flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDFF/{PassportId3}

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}

HR Document Types

The hrDocumentTypes resource includes all the document types based on which document records are created for a person.

Create all document types: Method: post
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes
Delete a document type: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}
Get a document type: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}
Get all document types: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes
Update a document type: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}

HR Document Types/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments/{attachmentsUniqID}

HR Document Types/Attachments/Attachment Previews

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments/{attachmentsUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments/{attachmentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

HR Document Types/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

HR Document Types/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

HR Document Types/Descriptive Flexfields for Document Types

(Resource of documentTypesDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/documentTypesDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/documentTypesDFF/{DocumentTypeId3}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/documentTypesDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/documentTypesDFF/{DocumentTypeId3}

HR Document Types/Developer Descriptive Flexfields for Document Types

(Resource of documentTypesDDF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/documentTypesDDF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/documentTypesDDF/{DocumentTypeId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/documentTypesDDF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/documentTypesDDF/{DocumentTypeId2}

HR Document Types/Translations for Document Types

The translations is a child of the hrDocumentTypes resource. It includes all the translated values of the document type.

Get a translated document type: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/translations/{translationsUniqID}
Get all translated document types: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/translations
Update a translated document type: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hrDocumentTypes/{DocumentTypeId}/child/translations/{translationsUniqID}

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/action/calculateHsaProjections
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 is used to view, create, and update attachments.

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/{AttachmentsUniqID}
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/{AttachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}

Health Surveys/Questionnaire Responses/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents

Health Surveys/Questionnaire Responses/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage

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}

Incident Kiosks/Large Object (LOB) Attributes - IncidentDescription

Delete an IncidentDescription: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentDescription
Get an IncidentDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentDescription
Replace an IncidentDescription: Method: put
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentDescription

Incident Kiosks/Large Object (LOB) Attributes - IncidentImmeActDescr

Delete an IncidentImmeActDescr: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentImmeActDescr
Get an IncidentImmeActDescr: Method: get
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentImmeActDescr
Replace an IncidentImmeActDescr: Method: put
Path: /hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentImmeActDescr

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/Large Object (LOB) Attributes - Description

Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/enclosure/Description

Job Details in Opportunity Marketplace/Large Object (LOB) Attributes - Qualifications

Get a Qualifications: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/enclosure/Qualifications

Job Details in Opportunity Marketplace/Large Object (LOB) Attributes - Responsibilities

Get a Responsibilities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/enclosure/Responsibilities

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 Offer Lists

The recruitingUIJobOffers resource provides the list of job offers based on the provided filter.

Create a list of job offers: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers/action/findByAdvancedSearchQuery
Create a method to perform job offer actions: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers/action/offerAction
Get a job offer: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers/{recruitingUIJobOffersUniqID}
Get all job offers: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers

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/{Id}
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/{Id}/child/requisitionFlexFields/{requisitionFlexFieldsUniqID}
Get all requisition flexfields for the requisition details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/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/{Id}/child/media/{Id2}
Get all media used in the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/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/{Id}/child/otherWorkLocations
Get other work location for the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/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/{Id}/child/primaryLocationCoordinates/{primaryLocationCoordinatesUniqID}
Get all primary location coordinates for the requisition details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/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/{Id}/child/secondaryLocations/{RequisitionLocationId}
Get all secondary locations for the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/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/{Id}/child/skills/{skillsUniqID}
Get the details of all the skills: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/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/{Id}/child/workLocation/{LocationId}
Get all work locations for the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/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 Allocations

The journeyAllocations resource includes all the attributes required for journey allocation.

Create a journey assignment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations
Find an assigned journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/action/findByAdvancedSearchQuery
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 Allocations/Criteria

The criteria resource is the child of the journeyAllocations resource. It includes all the various allocation criteria for a journey.

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 Allocations/Worker Counts

The count resource is the child of the journeyAllocations resource. It includes a summary of the count of workers in the journey allocation.

Get a count of workers in a journey allocation: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workerCounts/{JourneyAllocationId}
Get all counts of workers in a journey allocation: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workerCounts

Journey Allocations/Workers

The workers resource is the child of the journeyAllocations resource. It includes all the workers matching the allocation criteria.

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 Allocations/Workers/Large Object (LOB) Attributes - ErrorDetails

Get an ErrorDetails: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workers/{JourneyAllocationWorkerId}/enclosure/ErrorDetails

Journey Task

The workerJourneyTasks resource provides all the tasks for a worker journey.

Check task completion: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/action/checkTaskCompletion
Create a journey task: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}
Delete a journey task: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}
Get a journey task: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}
Get all journey tasks: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks
Initiate a process task: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/action/invokeProcessAutomation
Navigate to a task: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/action/generateNavigationURL
Reassign a task: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/action/reassign
Send a task reminder: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/action/sendReminder
Update journey tasks: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks
Upload a document: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/action/copyToDocumentRecords

Journey Task Library

The resource includes all global library tasks and personal library tasks of the signed in user.

Create a personal library task: 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 Task 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/{documentsUniqID}
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/{documentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{documentsUniqID}

Journey Task Library/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents

Journey Task Library/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileWebImage

Journey Task 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 notification override for library task: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/notifications/{LibraryJourneyTaskNotificationId}
Get all notification overrides for library task: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/notifications
Update a notification override for library task: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/notifications/{LibraryJourneyTaskNotificationId}

Journey Task 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/{propertiesUniqID}
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/{propertiesUniqID}

Journey Task Library/Large Object (LOB) Attributes - Notes

Delete a Notes: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/enclosure/Notes
Get a Notes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/enclosure/Notes
Replace a Notes: Method: put
Path: /hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/enclosure/Notes

Journey Task/Allocated Checklist Task Attributes

(Resource of tasksDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/tasksDFF
Delete: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/tasksDFF/{AllocatedTaskId}
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/tasksDFF/{AllocatedTaskId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/tasksDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/tasksDFF/{AllocatedTaskId}

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/workerJourneyTasks/{WorkerJourneyTaskId}/child/attachments
Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/documents
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/attachments/{attachmentsUniqID}
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/documents/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/attachments
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/documents
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/attachments/{attachmentsUniqID}
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/documents/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/documents/{attachmentsUniqID}

Journey Task/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/documents/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/documents/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/documents/{attachmentsUniqID}/enclosure/FileContents

Journey Task/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/documents/{attachmentsUniqID}/enclosure/FileWebImage

Journey Task/Large Object (LOB) Attributes - AddToCalendar

Get an AddToCalendar: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/enclosure/AddToCalendar

Journey Task/Large Object (LOB) Attributes - Notes

Get a Notes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/enclosure/Notes

Journey Task/Learning Content Items List of Values

The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.

Get a learning content item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/learningItems/{workerJourneyTasks_learningItems_Id}
Get all learning content items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/learningItems

Journey Task/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}

Journey Task/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}

Journey Task/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject

Journey Task/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Journey Task/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Journey Task/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{WorkerJourneyTaskId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

Journeys

The workerJourneys resource includes all the journeys of a worker.

Add a library task: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/action/addTaskFromLibrary
Allocate a journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/action/assignJourney
Assign a contextual journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/action/assignContextualJourney
Create a journey template: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys
Create a worker journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys
Delete a journey template: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}
Delete a worker journey: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}
Find a contextual journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/action/findOrAssignContextualJourney
Find an assigned journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/action/findByAdvancedSearchQuery
Find popular development journeys: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/action/findPopularJourneys
Force complete a journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/action/forceComplete
Get a contextual action in a journey template: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/action/contextualActionLabel
Get a default journey template property: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/action/defaultProperties
Get a default task type property in a journey template: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/action/defaultTaskTypeProperties
Get a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}
Get a worker journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}
Get all journey templates: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys
Get all worker journeys: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys
Update a journey: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}
Update a journey template: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}

Journeys/All Step Tasks

The allStepTasks resource is a child of the workerJourneys resource. It includes all the step tasks in the worker journey.

Get a step task: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks/{allStepTasksUniqID}
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: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks
Get all step tasks in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/allStepTasks

Journeys/All Step Tasks/Large Object (LOB) Attributes - Notes

Delete a Notes: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks/{allStepTasksUniqID}/enclosure/Notes
Get a Notes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/allStepTasks/{JourneyTaskId}/enclosure/Notes
Get a Notes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks/{allStepTasksUniqID}/enclosure/Notes
Replace a Notes: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks/{allStepTasksUniqID}/enclosure/Notes

Journeys/Contacts

The contacts resource is a child of the workerJourneys resource. It includes a list of contacts associated with the worker journey.

Create a contact in a journey template: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts
Get a contact: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/contacts/{WorkerJourneyContactId}
Get a contact in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts/{JourneyContactId}
Get all contacts: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/contacts
Get all contacts in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts

Journeys/Events

The events resource is a child of the workerJourneys resource. It includes a list of events associated with the worker journey.

Create an event in a journey template: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/events
Get all events: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/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: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/events/{WorkerJourneyEventId}
Get an event in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/events/{JourneyEventId}

Journeys/Journey Task Property

The properties resource is the child of the workerJourneys resource. It includes all the journey properties associated with the parent journey template.

Create a property in an assigned journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/properties
Get a property in an assigned journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/properties/{propertiesUniqID}
Get all properties in an assigned journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/properties
Update all properties in an assigned journey: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/properties/{propertiesUniqID}

Journeys/Large Object (LOB) Attributes - BackgroundImage

Delete a BackgroundImage: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/BackgroundImage
Get a BackgroundImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/BackgroundImage
Replace a BackgroundImage: Method: put
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/BackgroundImage

Journeys/Large Object (LOB) Attributes - CroppedBackgroundImage

Delete a CroppedBackgroundImage: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/CroppedBackgroundImage
Get a CroppedBackgroundImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/CroppedBackgroundImage
Replace a CroppedBackgroundImage: Method: put
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/CroppedBackgroundImage

Journeys/Notes

The notes resource is a child of the workerJourneys resource. It includes the notes associated with the worker journey.

Create a note in a journey template: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/notes
Get a note: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/notes/{WorkerJourneyNoteId}
Get a note in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/notes/{JourneyNoteId}
Get all notes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/notes
Get all notes in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/notes

Journeys/Properties

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/{propertiesUniqID}
Get a property in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties/{propertiesUniqID}
Get all properties in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties

Journeys/Task Count

The taskCounts resource is a child of the workerJourneys resource. It includes a summary of the tasks in the worker journey.

Get a task count: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskCounts/{WorkerJourneyId2}
Get all task counts: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskCounts

Journeys/Task Types

The taskTypes resource is the child of the workerJourneys 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 a task type in an assigned journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/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 a task type in an assigned journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}
Get all task types in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes
Get all task types in an assigned journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes
Update all task types in an assigned journey: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}

Journeys/Task Types/Journey Task Property

The properties resource is the child of the taskTypes resource and provides default properties of a journey.

Create a task type property in assigned journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}/child/properties
Get a task type property in an assigned journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}/child/properties/{propertiesUniqID}
Get all task type properties in an assigned journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}/child/properties
Update a task type property in an assigned journey: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}/child/properties/{propertiesUniqID}

Journeys/Task Types/Properties

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 an assigned journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties/{propertiesUniqID}
Get all task type properties in an assigned journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties
Update a task type property in an assigned journey: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties/{propertiesUniqID}

Journeys/Tasks

The tasks resource is a child of the workerJourneys resource. It includes all the tasks in the worker journey.

Check task completion: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/checkTaskCompletion
Create a task: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks
Create a task in a journey template: Method: post
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks
Delete a task: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}
Delete a task in a journey template: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}
Get a task: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}
Get a task in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}
Get all tasks: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks
Get all tasks in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks
Initiate process automation: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/invokeProcessAutomation
Navigate to a task: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/generateNavigationURL
Reassign a task: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/reassign
Send a task reminder: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/sendReminder
Update a task: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}
Update a task in a journey template: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}
Update status: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/updateStatus
Upload a document: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/copyToDocumentRecords

Journeys/Tasks/Allocated Checklist Task Attributes

(Resource of tasksDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/tasksDFF
Delete: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/tasksDFF/{AllocatedTaskId}
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/tasksDFF/{AllocatedTaskId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/tasksDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/tasksDFF/{AllocatedTaskId}

Journeys/Tasks/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
Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments
Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}

Journeys/Tasks/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileContents

Journeys/Tasks/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileWebImage
Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileWebImage

Journeys/Tasks/Journey Task Property

The properties resource is the child of the workerJourneys resource. It includes all the task type properties associated with the parent journey template.

Create a task property in an assigned journey: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/properties
Get a task property in an assigned journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/properties/{propertiesUniqID}
Get all task properties in an assigned journey: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/properties
Update all task properties in an assigned journey: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/properties/{propertiesUniqID}

Journeys/Tasks/Large Object (LOB) Attributes - AddToCalendar

Get an AddToCalendar: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/AddToCalendar

Journeys/Tasks/Large Object (LOB) Attributes - Notes

Delete a Notes: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/enclosure/Notes
Delete a Notes: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/Notes
Get a Notes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/enclosure/Notes
Get a Notes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/Notes
Replace a Notes: Method: put
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/enclosure/Notes
Replace a Notes: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/Notes

Journeys/Tasks/Learning Content Items List of Values

The learningContentItemsLOV resource provides a list of learning content items such as SCORM, HACP, PDF, video, assessment, and web link.

Get a learning content item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/learningItems/{workerJourneys_tasks_learningItems_Id}
Get all learning content items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/learningItems

Journeys/Tasks/Notifications

The notifications resource is a child of the tasks resource. It includes notification settings for the task performer and owner.

Create a notification: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/notifications
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: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/notifications/{WorkerJourneyTaskNotificationId}
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: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/notifications
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: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/notifications/{WorkerJourneyTaskNotificationId}
Update a notification in a journey template: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/notifications/{JourneyTaskNotificationId}

Journeys/Tasks/Properties

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/{JourneyTaskId2}/child/properties/{propertiesUniqID}
Get a task property in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId2}/child/properties/{propertiesUniqID}
Get all task properties in a journey template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/properties

Journeys/Tasks/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}

Journeys/Tasks/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}

Journeys/Tasks/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject

Journeys/Tasks/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Journeys/Tasks/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Journeys/Tasks/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

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/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}

Learner Learning Records/Active Learner Comments/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Learner Learning Records/Active Learner Comments/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Active Learner Comments/Likes

(Resource of likes)

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

(Resource of replies)

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/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}

Learner Learning Records/Active Learner Comments/Replies/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Learner Learning Records/Active Learner Comments/Replies/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Active Learner Comments/Replies/Likes

(Resource of likes)

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

(Resource of activityCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
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

(Resource of activityContentAttempts)

Create a content attempt detail: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Get a content attempt detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}
Get all content attempt details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Update a content attempt detail: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}

Learner Learning Records/Completion Details/Activity Content Attempts/Large Object (LOB) Attributes - Content Long Description

Long description for the activity content.

Get a Content Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription

Learner Learning Records/Completion Details/Activity Content Attempts/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}

Learner Learning Records/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}

Learner Learning Records/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Learner Learning Records/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Learner Learning Records/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}

Learner Learning Records/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Activity Section Completion Predecessor Hints

(Resource of activitySectionCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
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 the classroom details for the instructor-led activities associated with instructor-led and blended offerings.

Get a classroom detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}
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 relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}

Learner Learning Records/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}/enclosure/FileContents

Learner Learning Records/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Classrooms/Classroom Descriptive Flexfields

(Resource of classroomDFFs)

Get a classroom flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/classroomDFFs

Learner Learning Records/Completion Details/Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.

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/{instructorsUniqID}

Learner Learning Records/Completion Details/Instructors/Instructor Descriptive Flexfields

(Resource of instructorDFF)

Get all instructor flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorsUniqID}/child/instructorDFF
Get an instructor flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorsUniqID}/child/instructorDFF/{ResourceId}

Learner Learning Records/Completion Details/Large Object (LOB) Attributes - activityDescriptionLong

Get an activityDescriptionLong: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/enclosure/activityDescriptionLong

Learner Learning Records/Completion Details/Large Object (LOB) Attributes - activitySectionLongDescription

Get an activitySectionLongDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/enclosure/activitySectionLongDescription

Learner Learning Records/Completion Details/Learning Item Talent Profile Summaries

The summary learning information from the talent profile, such as if a course is configured with prerequisites or outcomes.

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

(Resource of offeredLanguages)

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/{offeredLanguagesUniqID}

Learner Learning Records/Completion Details/Offered Locations

(Resource of offeredLocations)

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

(Resource of otherSelectedCourseOfferings)

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

(Resource of assignmentDFF)

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

(Resource of completionDetails)

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 Completion Predecessor Hints

(Resource of activityCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityCompletionPredecessorHint

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Content Attempts

(Resource of activityContentAttempts)

Create a content attempt detail: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts
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/{activityContentAttemptsUniqID}
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
Update a content attempt detail: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Large Object (LOB) Attributes - Content Long Description

Long description for the activity content.

Get a Content Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/enclosure/AnswerLargeObject

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Section Completion Predecessor Hints

(Resource of activitySectionCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activitySectionCompletionPredecessorHint

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms

The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.

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/{classroomsUniqID}
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 relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}
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/{classroomsUniqID}/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/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileContents

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields

(Resource of classroomDFFs)

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/{classroomsUniqID2}/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/{classroomsUniqID}/child/classroomDFFs

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.

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/{instructorsUniqID}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields

(Resource of instructorDFF)

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/{instructorsUniqID}/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/{instructorsUniqID2}/child/instructorDFF/{ResourceId}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activityDescriptionLong

Get an activityDescriptionLong: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/enclosure/activityDescriptionLong

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activitySectionLongDescription

Get an activitySectionLongDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/enclosure/activitySectionLongDescription

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Offered Languages

(Resource of offeredLanguages)

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/{offeredLanguagesUniqID}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Offered Locations

(Resource of offeredLocations)

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/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/enclosure/AnswerLargeObject

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Related Materials

(Resource of relatedMaterials)

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/{AttachedDocumentId}
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/Completion Details/Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Summaries

(Resource of completionSummary)

Get a completion summary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionSummary/{completionSummaryUniqID}
Get all completion summaries: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionSummary

Learner Learning Records/Completion Details/Other Selected Course Offerings/Enrollment History

(Resource of enrollmentHistory)

Get all enrollment history items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory
Get an enrollment history item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory/{enrollmentHistoryUniqID}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Errors

(Resource of errors)

Get all errors: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/errors
Get an error: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/errors/{errorId}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Large Object (LOB) Attributes - Assigned Learning Item Long Description

Learning item long description provided while creating the learning item.

Get an Assigned Learning Item Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/enclosure/liLongDescription

Learner Learning Records/Completion Details/Other Selected Course Offerings/Learning Item Descriptive Flexfields

(Resource of learningItemDFF)

Get a learning item flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF/{learningItemDFFUniqID}
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 learnerLearningOfferings resource. It provides the details of the ratings for an offering.

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/{learningItemRatingDetailsUniqID}
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/{learningItemRatingDetailsUniqID}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Learning Item Rating Details/Rater Person Details

The publisherPersonDetails resource is a child of the learnerLearningOfferings resource. It provides the details of the publisher of the offering.

Get a person detail item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails/{personId}
Get all person details items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails

Learner Learning Records/Completion Details/Other Selected Course Offerings/Messages

The messages resource is a child of the learningAssignmentHints resource. It provides details of the messages that need to be displayed for the course.

Get a message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages/{messagesUniqID}
Get all messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages

Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Descriptive Flexfields

(Resource of offeringDFF)

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/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Learner Learning Records/Completion Details/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}

Learner Learning Records/Completion Details/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Other Selected Course Offerings/Transaction Histories

(Resource of transactionHistory)

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

(Resource of primarySelectedCourseOffering)

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

(Resource of assignmentDFF)

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

(Resource of completionDetails)

Get a completion detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}
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 Completion Predecessor Hints

(Resource of activityCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityCompletionPredecessorHint

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Activity Content Attempts

(Resource of activityContentAttempts)

Create a content attempt detail: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts
Get a content attempt detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}
Get all content attempt details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts
Update a content attempt detail: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Large Object (LOB) Attributes - Content Long Description

Long description for the activity content.

Get a Content Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/enclosure/AnswerLargeObject

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Activity Section Completion Predecessor Hints

(Resource of activitySectionCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activitySectionCompletionPredecessorHint

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Classrooms

The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.

Get a classroom detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}
Get all classroom details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Classrooms/Attachments

The relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/child/attachments/{AttachedDocumentId}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/child/attachments/{AttachedDocumentId}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/child/attachments/{AttachedDocumentId}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/child/attachments/{AttachedDocumentId}/enclosure/FileContents

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/child/attachments/{AttachedDocumentId}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields

(Resource of classroomDFFs)

Get a classroom flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/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/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/classroomDFFs

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.

Get all instructors: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/instructors
Get an instructor: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields

(Resource of instructorDFF)

Get all instructor flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID}/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/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID3}/child/instructorDFF/{ResourceId}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activityDescriptionLong

Get an activityDescriptionLong: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/enclosure/activityDescriptionLong

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activitySectionLongDescription

Get an activitySectionLongDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/enclosure/activitySectionLongDescription

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Offered Languages

(Resource of offeredLanguages)

Get all offered languages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/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/{completionDetailsUniqID3}/child/offeredLanguages/{offeredLanguagesUniqID}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Offered Locations

(Resource of offeredLocations)

Get all offering locations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/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/{completionDetailsUniqID3}/child/offeredLocations/{offeredLocationsUniqID}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Related Materials

(Resource of relatedMaterials)

Get a related material: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/relatedMaterials/{AttachedDocumentId}
Get all related materials: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/relatedMaterials

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Summaries

(Resource of completionSummary)

Get a completion summary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionSummary/{completionSummaryUniqID}
Get all completion summaries: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionSummary

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Enrollment History

(Resource of enrollmentHistory)

Get all enrollment history items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/enrollmentHistory
Get an enrollment history item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/enrollmentHistory/{enrollmentHistoryUniqID}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Large Object (LOB) Attributes - Assigned Learning Item Long Description

Learning item long description provided while creating the learning item.

Get an Assigned Learning Item Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/enclosure/liLongDescription

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Learning Item Descriptive Flexfields

(Resource of learningItemDFF)

Get a learning item flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemDFF/{learningItemDFFUniqID}
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 learnerLearningOfferings resource. It provides the details of the ratings for an offering.

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/{learningItemRatingDetailsUniqID}
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/{learningItemRatingDetailsUniqID}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Learning Item Rating Details/Rater Person Details

The publisherPersonDetails resource is a child of the learnerLearningOfferings resource. It provides the details of the publisher of the offering.

Get a person detail item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID2}/child/ratedByPersonDetails/{personId}
Get all person details items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Messages

The messages resource is a child of the learningAssignmentHints resource. It provides details of the messages that need to be displayed for the course.

Get a message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/messages/{messagesUniqID}
Get all messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/messages

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Offering Descriptive Flexfields

(Resource of offeringDFF)

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/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Primary Selected Course Offerings/Transaction Histories

(Resource of transactionHistory)

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/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}

Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}

Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}

Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Related Materials

(Resource of relatedMaterials)

Get a related material: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId}
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/Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents

Learner Learning Records/Completion Details/Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings

(Resource of selectedCourseOfferings)

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

(Resource of activeLearnerComments)

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/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}

Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Likes

(Resource of likes)

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/{activeLearnerCommentsUniqID2}/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/{activeLearnerCommentsUniqID2}/child/likes/{likeId}

Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Replies

(Resource of replies)

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/{activeLearnerCommentsUniqID2}/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/{activeLearnerCommentsUniqID2}/child/replies/{commentId}

Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Replies/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}

Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Replies/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Replies/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Replies/Likes

(Resource of likes)

Create a like: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/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/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/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/{activeLearnerCommentsUniqID2}/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/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/likes/{likeId}

Learner Learning Records/Completion Details/Selected Course Offerings/Approval Details

(Resource of approvalDetails)

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 publisherPersonDetails resource is a child of the learnerLearningOfferings resource. It provides the details of the publisher of the offering.

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

(Resource of assignmentDFF)

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

(Resource of completionDetails)

Get a completion detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}
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 Completion Predecessor Hints

(Resource of activityCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityCompletionPredecessorHint

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Content Attempts

(Resource of activityContentAttempts)

Create a content attempt detail: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts
Get a content attempt detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID}
Get all content attempt details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts
Update a content attempt detail: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Content Attempts/Large Object (LOB) Attributes - Content Long Description

Long description for the activity content.

Get a Content Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/enclosure/AnswerLargeObject

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Section Completion Predecessor Hints

(Resource of activitySectionCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activitySectionCompletionPredecessorHint

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Classrooms

The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.

Get a classroom detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID}
Get all classroom details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Classrooms/Attachments

The relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID4}/child/attachments/{AttachedDocumentId}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID4}/child/attachments/{AttachedDocumentId}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID4}/child/attachments/{AttachedDocumentId}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID4}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID4}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID4}/child/attachments/{AttachedDocumentId}/enclosure/FileContents

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID4}/child/attachments/{AttachedDocumentId}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields

(Resource of classroomDFFs)

Get a classroom flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID4}/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/{completionDetailsUniqID4}/child/classrooms/{classroomsUniqID}/child/classroomDFFs

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.

Get all instructors: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/instructors
Get an instructor: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/instructors/{instructorsUniqID}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields

(Resource of instructorDFF)

Get all instructor flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/instructors/{instructorsUniqID}/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/{completionDetailsUniqID4}/child/instructors/{instructorsUniqID4}/child/instructorDFF/{ResourceId}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activityDescriptionLong

Get an activityDescriptionLong: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/enclosure/activityDescriptionLong

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activitySectionLongDescription

Get an activitySectionLongDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/enclosure/activitySectionLongDescription

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Offered Languages

(Resource of offeredLanguages)

Get all offered languages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/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/{completionDetailsUniqID4}/child/offeredLanguages/{offeredLanguagesUniqID}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Offered Locations

(Resource of offeredLocations)

Get all offering locations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/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/{completionDetailsUniqID4}/child/offeredLocations/{offeredLocationsUniqID}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/enclosure/AnswerLargeObject

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId10}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID10}/child/QuestionResponses/{QuestionResponseId20}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Related Materials

(Resource of relatedMaterials)

Get a related material: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/relatedMaterials/{AttachedDocumentId}
Get all related materials: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/relatedMaterials

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Completion Summaries

(Resource of completionSummary)

Get a completion summary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionSummary/{completionSummaryUniqID}
Get all completion summaries: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionSummary

Learner Learning Records/Completion Details/Selected Course Offerings/Enrollment History

(Resource of enrollmentHistory)

Get all enrollment history items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentHistory
Get an enrollment history item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentHistory/{enrollmentHistoryUniqID}

Learner Learning Records/Completion Details/Selected Course Offerings/Enrollment Related Materials

The relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an enrollment related material: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
Delete an enrollment related material: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}
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/{AttachedDocumentId}
Update an enrollment related material: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}

Learner Learning Records/Completion Details/Selected Course Offerings/Enrollment Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents

Learner Learning Records/Completion Details/Selected Course Offerings/Enrollment Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Errors

(Resource of errors)

Get all errors: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/errors
Get an error: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/errors/{errorId}

Learner Learning Records/Completion Details/Selected Course Offerings/Large Object (LOB) Attributes - Assigned Learning Item Long Description

Learning item long description provided while creating the learning item.

Get an Assigned Learning Item Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/enclosure/liLongDescription

Learner Learning Records/Completion Details/Selected Course Offerings/Learning Item Descriptive Flexfields

(Resource of learningItemDFF)

Get a learning item flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemDFF/{learningItemDFFUniqID}
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 learnerLearningOfferings resource. It provides the details of the ratings for an offering.

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/{learningItemRatingDetailsUniqID}
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/{learningItemRatingDetailsUniqID}

Learner Learning Records/Completion Details/Selected Course Offerings/Learning Item Rating Details/Rater Person Details

The publisherPersonDetails resource is a child of the learnerLearningOfferings resource. It provides the details of the publisher of the offering.

Get a person detail item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID3}/child/ratedByPersonDetails/{personId}
Get all person details items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails

Learner Learning Records/Completion Details/Selected Course Offerings/Learning Item Related Materials

(Resource of learningItemRelatedMaterials)

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/{AttachedDocumentId10}
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/Learning Item Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId10}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId10}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId10}/enclosure/FileContents

Learner Learning Records/Completion Details/Selected Course Offerings/Learning Item Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId10}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Messages

The messages resource is a child of the learningAssignmentHints resource. It provides details of the messages that need to be displayed for the course.

Get a message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/messages/{messagesUniqID}
Get all messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/messages

Learner Learning Records/Completion Details/Selected Course Offerings/Offering Descriptive Flexfields

(Resource of offeringDFF)

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 learnerLearningOfferings resource. It provides primary classroom details of the instructor-led or 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 relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId11}
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/{AttachedDocumentId11}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId11}

Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Classrooms/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId11}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId11}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId11}/enclosure/FileContents

Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId11}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Classrooms/Classroom Descriptive Flexfields

(Resource of classroomDFFs)

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 learnerLearningOfferings resource. It provides the details for the primary instructor of the offering.

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

(Resource of instructorDFF)

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/{ResourceId10}

Learner Learning Records/Completion Details/Selected Course Offerings/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}

Learner Learning Records/Completion Details/Selected Course Offerings/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}

Learner Learning Records/Completion Details/Selected Course Offerings/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}

Learner Learning Records/Completion Details/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/enclosure/FileContents

Learner Learning Records/Completion Details/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}

Learner Learning Records/Completion Details/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject

Learner Learning Records/Completion Details/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId11}/child/questionResponses/{QuestionResponseId21}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID11}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Completion Details/Selected Course Offerings/Transaction Histories

(Resource of transactionHistory)

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

Hints for possible actions on a 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/{userActionHintsUniqID}
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

Hints for possible actions on a 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/{userActionHintsUniqID}
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/{courseDFFUniqID}
Get all course flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/courseDFF

Learner Learning Records/Enrollment History

The enrollmentHistory resource is a child of the learnerLearningRecords resource. It provides the details of the enrollment history for the learning record.

Get all enrollment history items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentHistory
Get an enrollment history item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentHistory/{enrollmentHistoryUniqID}

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.

Create an enrollment related material: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials
Delete an enrollment related material: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}
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/{AttachedDocumentId1}
Update an enrollment related material: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}

Learner Learning Records/Enrollment Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents

Learner Learning Records/Enrollment Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileWebImage

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/{learningItemDFFUniqID}
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/{learningItemRatingDetailsUniqID}
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/{learningItemRatingDetailsUniqID}

Learner Learning Records/Learning Item Rating Details/Rater Person Details

The publisherPersonDetails resource is a child of the learnerLearningOfferings resource. It provides the details of the publisher of the offering.

Get a person detail item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID4}/child/ratedByPersonDetails/{personId}
Get all person details items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails

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/{AttachedDocumentId1}
Get all learning item related materials: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials

Learner Learning Records/Learning Item Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents

Learner Learning Records/Learning Item Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileWebImage

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/Messages

The messages resource is a child of the learnerLearningRecords resource. It provides details of the messages that are relevant to the learning record.

Get a message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/messages/{messagesUniqID}
Get all messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/messages

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

(Resource of assignmentDFF)

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/{otherSelectedCourseOfferingsUniqID2}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/assignmentDFF/{RequestDetailId}

Learner Learning Records/Other Selected Course Offerings/Completion Details

(Resource of completionDetails)

Get a completion detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/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 Completion Predecessor Hints

(Resource of activityCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint

Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts

(Resource of activityContentAttempts)

Create a content attempt detail: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Get a content attempt detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID}
Get all content attempt details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Update a content attempt detail: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Large Object (LOB) Attributes - Content Long Description

Long description for the activity content.

Get a Content Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription

Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId1}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId1}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId2}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId2}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject

Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileWebImage

Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/enclosure/AnswerLargeObject

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activityContentAttempts/{activityContentAttemptsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId12}/child/questionResponses/{QuestionResponseId23}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId24}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Section Completion Predecessor Hints

(Resource of activitySectionCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint

Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms

The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.

Get a classroom detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID}
Get all classroom details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/classrooms

Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Attachments

The relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID5}/child/attachments/{AttachedDocumentId1}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID5}/child/attachments/{AttachedDocumentId1}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID5}/child/attachments/{AttachedDocumentId1}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID5}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID5}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID5}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents

Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID5}/child/attachments/{AttachedDocumentId1}/enclosure/FileWebImage

Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields

(Resource of classroomDFFs)

Get a classroom flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID}/child/classroomDFFs/{ResourceId11}
Get all classroom flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/classrooms/{classroomsUniqID}/child/classroomDFFs

Learner Learning Records/Other Selected Course Offerings/Completion Details/Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.

Get all instructors: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/instructors
Get an instructor: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/instructors/{instructorsUniqID}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields

(Resource of instructorDFF)

Get all instructor flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/instructors/{instructorsUniqID}/child/instructorDFF
Get an instructor flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/instructors/{instructorsUniqID5}/child/instructorDFF/{ResourceId1}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activityDescriptionLong

Get an activityDescriptionLong: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activityDescriptionLong

Learner Learning Records/Other Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activitySectionLongDescription

Get an activitySectionLongDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activitySectionLongDescription

Learner Learning Records/Other Selected Course Offerings/Completion Details/Offered Languages

(Resource of offeredLanguages)

Get all offered languages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
Get an offered language: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/offeredLanguages/{offeredLanguagesUniqID}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Offered Locations

(Resource of offeredLocations)

Get all offering locations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
Get an offering location: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/offeredLocations/{offeredLocationsUniqID}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId1}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId1}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId2}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId2}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject

Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents

Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileWebImage

Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}

Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/enclosure/AnswerLargeObject

Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/questionnaireResponses/{QuestionnaireResponseId13}/child/questionResponses/{QuestionResponseId25}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId26}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Other Selected Course Offerings/Completion Details/Related Materials

(Resource of relatedMaterials)

Get a related material: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/relatedMaterials/{AttachedDocumentId1}
Get all related materials: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials

Learner Learning Records/Other Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileContents

Learner Learning Records/Other Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID5}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileWebImage

Learner Learning Records/Other Selected Course Offerings/Completion Summaries

(Resource of completionSummary)

Get a completion summary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionSummary/{completionSummaryUniqID}
Get all completion summaries: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionSummary

Learner Learning Records/Other Selected Course Offerings/Enrollment History

(Resource of enrollmentHistory)

Get all enrollment history items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory
Get an enrollment history item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentHistory/{enrollmentHistoryUniqID}

Learner Learning Records/Other Selected Course Offerings/Errors

(Resource of errors)

Get all errors: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/errors
Get an error: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/errors/{errorId}

Learner Learning Records/Other Selected Course Offerings/Large Object (LOB) Attributes - Assigned Learning Item Long Description

Learning item long description provided while creating the learning item.

Get an Assigned Learning Item Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/enclosure/liLongDescription

Learner Learning Records/Other Selected Course Offerings/Learning Item Descriptive Flexfields

(Resource of learningItemDFF)

Get a learning item flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemDFF/{learningItemDFFUniqID}
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 learnerLearningOfferings resource. It provides the details of the ratings for an offering.

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/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
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/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}

Learner Learning Records/Other Selected Course Offerings/Learning Item Rating Details/Rater Person Details

The publisherPersonDetails resource is a child of the learnerLearningOfferings resource. It provides the details of the publisher of the offering.

Get a person detail item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID5}/child/ratedByPersonDetails/{personId}
Get all person details items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails

Learner Learning Records/Other Selected Course Offerings/Messages

The messages resource is a child of the learningAssignmentHints resource. It provides details of the messages that need to be displayed for the course.

Get a message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/messages/{messagesUniqID}
Get all messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages

Learner Learning Records/Other Selected Course Offerings/Offering Descriptive Flexfields

(Resource of offeringDFF)

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/{otherSelectedCourseOfferingsUniqID2}/child/offeringDFF/{offeringDFFUniqID}

Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId1}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId1}

Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId2}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId2}

Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject

Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}

Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents

Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileWebImage

Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}

Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/enclosure/AnswerLargeObject

Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId14}/child/questionResponses/{QuestionResponseId27}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId28}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Other Selected Course Offerings/Transaction Histories

(Resource of transactionHistory)

Get a transaction history: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/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

(Resource of relatedLearningRecords)

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

(Resource of assignmentDFF)

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/{primarySelectedCourseOfferingUniqID2}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/assignmentDFF/{RequestDetailId}

Learner Learning Records/Primary Selected Course Offerings/Completion Details

(Resource of completionDetails)

Get a completion detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/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 Completion Predecessor Hints

(Resource of activityCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Activity Content Attempts

(Resource of activityContentAttempts)

Create a content attempt detail: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Get a content attempt detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID}
Get all content attempt details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Update a content attempt detail: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Large Object (LOB) Attributes - Content Long Description

Long description for the activity content.

Get a Content Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId2}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId2}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId2}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileWebImage

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/enclosure/AnswerLargeObject

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activityContentAttempts/{activityContentAttemptsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId15}/child/questionResponses/{QuestionResponseId29}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId30}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Activity Section Completion Predecessor Hints

(Resource of activitySectionCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Classrooms

The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.

Get a classroom detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID}
Get all classroom details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/classrooms

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Classrooms/Attachments

The relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID6}/child/attachments/{AttachedDocumentId1}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID6}/child/attachments/{AttachedDocumentId1}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID6}/child/attachments/{AttachedDocumentId1}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID6}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID6}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID6}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID6}/child/attachments/{AttachedDocumentId1}/enclosure/FileWebImage

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields

(Resource of classroomDFFs)

Get a classroom flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID6}/child/classroomDFFs/{ResourceId1}
Get all classroom flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/classrooms/{classroomsUniqID}/child/classroomDFFs

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.

Get all instructors: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/instructors
Get an instructor: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/instructors/{instructorsUniqID}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields

(Resource of instructorDFF)

Get all instructor flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/instructors/{instructorsUniqID}/child/instructorDFF
Get an instructor flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/instructors/{instructorsUniqID6}/child/instructorDFF/{ResourceId1}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activityDescriptionLong

Get an activityDescriptionLong: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activityDescriptionLong

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activitySectionLongDescription

Get an activitySectionLongDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activitySectionLongDescription

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Offered Languages

(Resource of offeredLanguages)

Get all offered languages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
Get an offered language: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/offeredLanguages/{offeredLanguagesUniqID}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Offered Locations

(Resource of offeredLocations)

Get all offering locations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
Get an offering location: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/offeredLocations/{offeredLocationsUniqID}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses/{QuestionResponseId31}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses/{QuestionResponseId31}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses/{QuestionResponseId31}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses/{QuestionResponseId31}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses/{QuestionResponseId31}/enclosure/AnswerLargeObject

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileWebImage

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/questionnaireResponses/{QuestionnaireResponseId16}/child/questionResponses/{QuestionResponseId31}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID16}/child/QuestionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Related Materials

(Resource of relatedMaterials)

Get a related material: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/relatedMaterials/{AttachedDocumentId1}
Get all related materials: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileContents

Learner Learning Records/Primary Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionDetails/{completionDetailsUniqID6}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileWebImage

Learner Learning Records/Primary Selected Course Offerings/Completion Summaries

(Resource of completionSummary)

Get a completion summary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/completionSummary/{completionSummaryUniqID}
Get all completion summaries: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionSummary

Learner Learning Records/Primary Selected Course Offerings/Enrollment History

(Resource of enrollmentHistory)

Get all enrollment history items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/enrollmentHistory
Get an enrollment history item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/enrollmentHistory/{enrollmentHistoryUniqID}

Learner Learning Records/Primary Selected Course Offerings/Large Object (LOB) Attributes - Assigned Learning Item Long Description

Learning item long description provided while creating the learning item.

Get an Assigned Learning Item Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/enclosure/liLongDescription

Learner Learning Records/Primary Selected Course Offerings/Learning Item Descriptive Flexfields

(Resource of learningItemDFF)

Get a learning item flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/learningItemDFF/{learningItemDFFUniqID}
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 learnerLearningOfferings resource. It provides the details of the ratings for an offering.

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/{primarySelectedCourseOfferingUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
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/{primarySelectedCourseOfferingUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}

Learner Learning Records/Primary Selected Course Offerings/Learning Item Rating Details/Rater Person Details

The publisherPersonDetails resource is a child of the learnerLearningOfferings resource. It provides the details of the publisher of the offering.

Get a person detail item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails/{personId10}
Get all person details items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails

Learner Learning Records/Primary Selected Course Offerings/Messages

The messages resource is a child of the learningAssignmentHints resource. It provides details of the messages that need to be displayed for the course.

Get a message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/messages/{messagesUniqID}
Get all messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/messages

Learner Learning Records/Primary Selected Course Offerings/Offering Descriptive Flexfields

(Resource of offeringDFF)

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/{primarySelectedCourseOfferingUniqID2}/child/offeringDFF/{offeringDFFUniqID}

Learner Learning Records/Primary Selected Course Offerings/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId1}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId1}

Learner Learning Records/Primary Selected Course Offerings/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId3}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId3}

Learner Learning Records/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject

Learner Learning Records/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}

Learner Learning Records/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents

Learner Learning Records/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileWebImage

Learner Learning Records/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}

Learner Learning Records/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/enclosure/AnswerLargeObject

Learner Learning Records/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Learner Learning Records/Primary Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId17}/child/questionResponses/{QuestionResponseId33}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId34}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Primary Selected Course Offerings/Transaction Histories

(Resource of transactionHistory)

Get a transaction history: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID2}/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/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId1}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId1}

Learner Learning Records/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId3}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId3}

Learner Learning Records/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject

Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}

Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents

Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileWebImage

Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}

Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/enclosure/AnswerLargeObject

Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId18}/child/questionResponses/{QuestionResponseId35}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId36}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

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 Summary

The selectedCourseOfferingsSummary resource is a child of the learnerLearningRecords resource. It provides a summary of all selected course offerings.

Get a selected course offering summary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferingsSummary/{selectedCourseOfferingsSummaryUniqID}
Get all selected course offering summaries: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferingsSummary

Learner Learning Records/Selected Course Offerings/Active Learner Comments

(Resource of activeLearnerComments)

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/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Update an active learner comment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}

Learner Learning Records/Selected Course Offerings/Active Learner Comments/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}

Learner Learning Records/Selected Course Offerings/Active Learner Comments/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Learner Learning Records/Selected Course Offerings/Active Learner Comments/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Active Learner Comments/Likes

(Resource of likes)

Create a like: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Get a like: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/likes/{likeId}
Get all likes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Update a like: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/likes/{likeId}

Learner Learning Records/Selected Course Offerings/Active Learner Comments/Replies

(Resource of replies)

Create a reply: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Get a reply: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}
Get all replies: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Update a reply: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}

Learner Learning Records/Selected Course Offerings/Active Learner Comments/Replies/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}

Learner Learning Records/Selected Course Offerings/Active Learner Comments/Replies/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Learner Learning Records/Selected Course Offerings/Active Learner Comments/Replies/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Active Learner Comments/Replies/Likes

(Resource of likes)

Create a like: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}/child/likes
Get a like: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/likes/{likeId}
Get all likes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}/child/likes
Update a like: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/likes/{likeId}

Learner Learning Records/Selected Course Offerings/Approval Details

(Resource of approvalDetails)

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/{selectedCourseOfferingsUniqID2}/child/approvalDetails/{approvalDetailsUniqID}

Learner Learning Records/Selected Course Offerings/Assigner Person Details

The publisherPersonDetails resource is a child of the learnerLearningOfferings resource. It provides the details of the publisher of the offering.

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/{personId11}

Learner Learning Records/Selected Course Offerings/Assignment Descriptive Flexfields

(Resource of assignmentDFF)

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/{selectedCourseOfferingsUniqID2}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/assignmentDFF/{RequestDetailId}

Learner Learning Records/Selected Course Offerings/Completion Details

(Resource of completionDetails)

Get a completion detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/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 Completion Predecessor Hints

(Resource of activityCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint

Learner Learning Records/Selected Course Offerings/Completion Details/Activity Content Attempts

(Resource of activityContentAttempts)

Create a content attempt detail: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Get a content attempt detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID}
Get all content attempt details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
Update a content attempt detail: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID}

Learner Learning Records/Selected Course Offerings/Completion Details/Activity Content Attempts/Large Object (LOB) Attributes - Content Long Description

Long description for the activity content.

Get a Content Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription

Learner Learning Records/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId1}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId1}

Learner Learning Records/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId3}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId1}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId3}

Learner Learning Records/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject

Learner Learning Records/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}

Learner Learning Records/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/enclosure/AnswerLargeObject

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activityContentAttempts/{activityContentAttemptsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId19}/child/questionResponses/{QuestionResponseId37}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID1}/child/QuestionResponses/{QuestionResponseId38}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Completion Details/Activity Section Completion Predecessor Hints

(Resource of activitySectionCompletionPredecessorHint)

Get a hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
Get all hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint

Learner Learning Records/Selected Course Offerings/Completion Details/Classrooms

The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.

Get a classroom detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID}
Get all classroom details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/classrooms

Learner Learning Records/Selected Course Offerings/Completion Details/Classrooms/Attachments

The relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID7}/child/attachments/{AttachedDocumentId1}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID7}/child/attachments/{AttachedDocumentId1}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID7}/child/attachments/{AttachedDocumentId1}

Learner Learning Records/Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID7}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID7}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID7}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents

Learner Learning Records/Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID7}/child/attachments/{AttachedDocumentId1}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Completion Details/Classrooms/Classroom Descriptive Flexfields

(Resource of classroomDFFs)

Get a classroom flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID7}/child/classroomDFFs/{ResourceId1}
Get all classroom flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/classrooms/{classroomsUniqID}/child/classroomDFFs

Learner Learning Records/Selected Course Offerings/Completion Details/Instructors

The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.

Get all instructors: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/instructors
Get an instructor: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/instructors/{instructorsUniqID}

Learner Learning Records/Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields

(Resource of instructorDFF)

Get all instructor flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/instructors/{instructorsUniqID}/child/instructorDFF
Get an instructor flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/instructors/{instructorsUniqID7}/child/instructorDFF/{ResourceId1}

Learner Learning Records/Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activityDescriptionLong

Get an activityDescriptionLong: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activityDescriptionLong

Learner Learning Records/Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activitySectionLongDescription

Get an activitySectionLongDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activitySectionLongDescription

Learner Learning Records/Selected Course Offerings/Completion Details/Offered Languages

(Resource of offeredLanguages)

Get all offered languages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
Get an offered language: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/offeredLanguages/{offeredLanguagesUniqID}

Learner Learning Records/Selected Course Offerings/Completion Details/Offered Locations

(Resource of offeredLocations)

Get all offering locations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
Get an offering location: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/offeredLocations/{offeredLocationsUniqID}

Learner Learning Records/Selected Course Offerings/Completion Details/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId20}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId20}

Learner Learning Records/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}

Learner Learning Records/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/enclosure/AnswerLargeObject

Learner Learning Records/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}

Learner Learning Records/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/enclosure/FileContents

Learner Learning Records/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}

Learner Learning Records/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/enclosure/AnswerLargeObject

Learner Learning Records/Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/questionnaireResponses/{QuestionnaireResponseId20}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID20}/child/QuestionResponses/{QuestionResponseId40}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Completion Details/Related Materials

(Resource of relatedMaterials)

Get a related material: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/relatedMaterials/{AttachedDocumentId1}
Get all related materials: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials

Learner Learning Records/Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileContents

Learner Learning Records/Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID7}/child/relatedMaterials/{AttachedDocumentId1}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Completion Summaries

(Resource of completionSummary)

Get a completion summary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/completionSummary/{completionSummaryUniqID}
Get all completion summaries: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionSummary

Learner Learning Records/Selected Course Offerings/Enrollment History

(Resource of enrollmentHistory)

Get all enrollment history items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentHistory
Get an enrollment history item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/enrollmentHistory/{enrollmentHistoryUniqID}

Learner Learning Records/Selected Course Offerings/Enrollment Related Materials

The relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an enrollment related material: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
Delete an enrollment related material: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId20}
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/{AttachedDocumentId20}
Update an enrollment related material: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId20}

Learner Learning Records/Selected Course Offerings/Enrollment Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId20}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId20}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId20}/enclosure/FileContents

Learner Learning Records/Selected Course Offerings/Enrollment Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId20}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Errors

(Resource of errors)

Get all errors: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/errors
Get an error: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/errors/{errorId}

Learner Learning Records/Selected Course Offerings/Large Object (LOB) Attributes - Assigned Learning Item Long Description

Learning item long description provided while creating the learning item.

Get an Assigned Learning Item Long Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/enclosure/liLongDescription

Learner Learning Records/Selected Course Offerings/Learning Item Descriptive Flexfields

(Resource of learningItemDFF)

Get a learning item flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/learningItemDFF/{learningItemDFFUniqID}
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 learnerLearningOfferings resource. It provides the details of the ratings for an offering.

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/{selectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
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/{selectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}

Learner Learning Records/Selected Course Offerings/Learning Item Rating Details/Rater Person Details

The publisherPersonDetails resource is a child of the learnerLearningOfferings resource. It provides the details of the publisher of the offering.

Get a person detail item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID7}/child/ratedByPersonDetails/{personId1}
Get all person details items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails

Learner Learning Records/Selected Course Offerings/Learning Item Related Materials

(Resource of learningItemRelatedMaterials)

Get a learning item related material: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId21}
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/Learning Item Related Materials/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId21}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId21}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId21}/enclosure/FileContents

Learner Learning Records/Selected Course Offerings/Learning Item Related Materials/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId21}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Messages

The messages resource is a child of the learningAssignmentHints resource. It provides details of the messages that need to be displayed for the course.

Get a message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/messages/{messagesUniqID}
Get all messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/messages

Learner Learning Records/Selected Course Offerings/Offering Descriptive Flexfields

(Resource of offeringDFF)

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/{selectedCourseOfferingsUniqID2}/child/offeringDFF/{offeringDFFUniqID}

Learner Learning Records/Selected Course Offerings/Offering Primary Classrooms

The offeringPrimaryClassroom resource is a child of the learnerLearningOfferings resource. It provides primary classroom details of the instructor-led or 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/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId}

Learner Learning Records/Selected Course Offerings/Offering Primary Classrooms/Attachments

The relatedMaterials resource is a child of the learnerLearningOfferings resource. It provides the related materials associated with an offering.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId2}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId2}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId2}

Learner Learning Records/Selected Course Offerings/Offering Primary Classrooms/Attachments/Large Object (LOB) Attributes - File Contents

Actual content of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId2}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId2}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId2}/enclosure/FileContents

Learner Learning Records/Selected Course Offerings/Offering Primary Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId2}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Offering Primary Classrooms/Classroom Descriptive Flexfields

(Resource of classroomDFFs)

Get a classroom flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/classroomDFFs/{ResourceId1}
Get all classroom flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId}/child/classroomDFFs

Learner Learning Records/Selected Course Offerings/Offering Primary Instructors

The offeringPrimaryInstructor resource is a child of the learnerLearningOfferings resource. It provides the details for the primary instructor of the offering.

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/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryInstructor/{instructorId}

Learner Learning Records/Selected Course Offerings/Offering Primary Instructors/Instructor Descriptive Flexfields

(Resource of instructorDFF)

Get all instructor flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF
Get an instructor flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/offeringPrimaryInstructor/{instructorId2}/child/instructorDFF/{ResourceId1}

Learner Learning Records/Selected Course Offerings/Questionnaire Responses

The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.

Create a questionnaire response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses
Get a questionnaire response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}
Get all questionnaire responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses
Update a questionnaire response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}

Learner Learning Records/Selected Course Offerings/Questionnaire Responses/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}

Learner Learning Records/Selected Course Offerings/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/enclosure/AnswerLargeObject

Learner Learning Records/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}

Learner Learning Records/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/enclosure/FileContents

Learner Learning Records/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses

The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.

Create a question response: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses
Get a question response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}
Get all question responses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses
Update a question response: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}

Learner Learning Records/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject

Delete an AnswerLargeObject: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/enclosure/AnswerLargeObject
Get an AnswerLargeObject: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/enclosure/AnswerLargeObject
Replace an AnswerLargeObject: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/enclosure/AnswerLargeObject

Learner Learning Records/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments

The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.

Create a response attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments
Delete a response attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get a response attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Get all response attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments
Update a response attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}

Learner Learning Records/Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents

Actual content of the attachment.

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId21}/child/questionResponses/{QuestionResponseId41}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID21}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage

Learner Learning Records/Selected Course Offerings/Transaction Histories

(Resource of transactionHistory)

Get a transaction history: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/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

Hints for possible actions on a learner's assignment records.

Get a user action hint: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID2}/child/userActionHints/{userActionHintsUniqID}
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/{specializationDFFUniqID}
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/{userActionHintsUniqID}
Get all user action hints: Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/userActionHints

Learning Content Items

The learningContentItems resource provides 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 provides the list of absence types that can be used to add an absence for a worker. It is used for the client-side LOV component in responsive UIs.

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/{actionReasonsLOVUniqID}

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/Alert Templates List of Values

The alertTemplatesLOV resource provides the list of values for the templates created for an alert.

Get a template: Method: get
Path: /hcmRestApi/resources/11.13.18.05/alertTemplatesLOV/{alertTemplatesLOV_Id}
Get all templates: Method: get
Path: /hcmRestApi/resources/11.13.18.05/alertTemplatesLOV

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/{bargainingUnitsLovUniqID}
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/Common Lookups List of Values

The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility.

Get all common lookups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

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/{contentItemsLovUniqID}
Get all contet items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/contentItemsLov

List of Values/Content Types List of Values

The contentTypesLOV resource provides the list of content types defined in the profile management system. Content types are the different types of skills and qualifications tracked in the talent profiles.

Get a content type: Method: get
Path: /hcmRestApi/resources/11.13.18.05/contentTypesLOV/{contentTypesLOVUniqID}
Get all content types: Method: get
Path: /hcmRestApi/resources/11.13.18.05/contentTypesLOV

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/Currencies

The currencies lists of values resource is used to query the ISO standard currencies.

Get all currencies: Method: get
Path: /fscmRestApi/resources/11.13.18.05/currenciesLOV

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/Descriptive Flexfield Contexts

Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

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/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/Employee Communication Eligibility Profiles List of Values

The employeeCommunicationEligibilityProfilesLOV resource provides the list of values for the employee communication eligibility profiles.

Get all employee communication eligibility profiles: Method: get
Path: /hcmRestApi/resources/11.13.18.05/employeeCommunicationEligibilityProfilesLOV
Get an employee communication eligibility profile: Method: get
Path: /hcmRestApi/resources/11.13.18.05/employeeCommunicationEligibilityProfilesLOV/{employeeCommunicationEligibilityProfilesLOVUniqID}

List of Values/Employee Communication Sender Profiles List of Values

The employeeCommunicationSenderProfilesLOV resource provides the list of values for employee communication sender profiles.

Get all employee communication sender profiles: Method: get
Path: /hcmRestApi/resources/11.13.18.05/employeeCommunicationSenderProfilesLOV
Get an employee communication sender profile: Method: get
Path: /hcmRestApi/resources/11.13.18.05/employeeCommunicationSenderProfilesLOV/{employeeCommunicationSenderProfilesLOVUniqID}

List of Values/Employee Communications List of Values

The employeeCommunicationTeamsLOV resource provides the list of values for employee communications.

Get all employee communications: Method: get
Path: /hcmRestApi/resources/11.13.18.05/employeeCommunicationTeamsLOV
Get an employee communication: Method: get
Path: /hcmRestApi/resources/11.13.18.05/employeeCommunicationTeamsLOV/{employeeCommunicationTeamsLOVUniqID}

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/{eventConditionsLOVUniqID}

List of Values/Extended Lookup Codes List of Values

The hcmExtendedLookupCodesLOV resource provides the extended lookup values when creating an object. It stores subcategories of various HCM lookup codes such as visa permit type and is used in the visa and permit category field.

Get all extended lookups: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmExtendedLookupCodesLOV
Get an extended lookup: Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmExtendedLookupCodesLOV/{ExtendedLookupCodeId}

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 provides the 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/Generic Value Set Values

Get all: Method: get
Path: /fscmRestApi/resources/11.13.18.05/FlexFndPvsCharacterIdCharacterValues

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/{geographicHierarchiesLOVUniqID}
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 provides the list of values for the goal plan sets that can be accessed by the specified user.

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 provides the list of values for the goal plans that can be accessed by the specified user.

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/Journey Categories

The journeyCategoriesLOV resource provides the list of values for different categories of journeys.

Get a journey category: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyCategoriesLOV/{LookupCode}
Get all journey categories: Method: get
Path: /hcmRestApi/resources/11.13.18.05/journeyCategoriesLOV

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/Languages

The languages list of values resource is used to query the list of languages.

Get all languages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/languagesLOV

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/{libraryGoalsLOVUniqID}
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/My Brand Skills List of Values

The myBrandSkillsLOV resource provides the list of values for skills used to build the personal brand skill profile of a worker.

Get a skill: Method: get
Path: /hcmRestApi/resources/11.13.18.05/myBrandSkillsLOV/{myBrandSkillsLOV_Id}
Get all skills: Method: get
Path: /hcmRestApi/resources/11.13.18.05/myBrandSkillsLOV

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/{performanceTemplateDocumentNamesLOVUniqID}
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/{profileTypeSectionsLOVUniqID}
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/{questionAnswersLOVUniqID}

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/{questionnaireFoldersLOVUniqID}
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/{questionnaireQuestionsLOVUniqID}
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/{questionnaireResponseTypesLOVUniqID}
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/{questionnaireSubscribersLOVUniqID}
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/{questionnaireTemplatesLOVUniqID}
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/{ratingLevelsLOVUniqID}
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/{ratingModelsLOVUniqID}
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 Assessment Packages List of Values

The recruitingAssessmentAccountPackagesLOV resource provides the list of values for the assessment screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get all assessment screening packages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackagesLOV
Get an assessment screening package: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackagesLOV/{recruitingAssessmentAccountPackagesLOVUniqID}

List of Values/Recruiting Background Check Screening Packages List

The recruitingBGCAccountPackagesLOV resource provides the background check screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get a background check screening package: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingBGCAccountPackagesLOV/{recruitingBGCAccountPackagesLOVUniqID}
Get all background check screening packages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingBGCAccountPackagesLOV

List of Values/Recruiting Campaign Email Sender Profiles List of Values

The recruitingCampaignsEmailSenderProfilesLOV resource provides the list of values for the recruiting campaign email sender profiles.

Get a list of values for the recruiting campaign email sender profiles: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignsEmailSenderProfilesLOV/{ConfigId}
Get all the list of values for the recruiting campaign email sender profiles: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignsEmailSenderProfilesLOV

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 provides the list of values for the details about the content library items.

Get a content library item LOV: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}
Get all content library items LOV: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV

List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values

The recruitingContentLibraryItemsLOVdescriptions resource provides the list of values for the descriptions for a given recruiting content library item.

Get a content library item description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}
Get all content library item descriptions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions

List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values/Large Object (LOB) Attributes - Description

Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}/enclosure/Description

List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values/Large Object (LOB) Attributes - Qualifications

Get a Qualifications: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}/enclosure/Qualifications

List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values/Large Object (LOB) Attributes - Responsibilities

Get a Responsibilities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}/enclosure/Responsibilities

List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values/Large Object (LOB) Attributes - ShortDescription

Get a ShortDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}/enclosure/ShortDescription

List of Values/Recruiting Descriptive Flexfield Contexts List of Values

The recruitingFlexContextsLOV resource provides the list of values for descriptive flexfield context selection.

Get a descriptive flexfield context: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingFlexContextsLOV/{recruitingFlexContextsLOVUniqID}
Get all descriptive flexfield contexts: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingFlexContextsLOV

List of Values/Recruiting Event Interview Participants List of Values

The resource provides details about all the candidates who are attending an interview.

Get all the event attendees: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingEventParticipantsLOV
Get an event attendee: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingEventParticipantsLOV/{EventPoolMemberId}

List of Values/Recruiting Flexfield Segment Values

The recruitingFlexSegmentValuesLOV resource includes all details about job application flexfield segment values.

Get a job application flexfield segment value: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingFlexSegmentValuesLOV/{Code}
Get all job application flexfield segment values: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingFlexSegmentValuesLOV

List of Values/Recruiting Flexfield Segments

The recruitingFlexSegmentsLOV resource includes all details about job application flexfield segments.

Get a job application flexfield segment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingFlexSegmentsLOV/{recruitingFlexSegmentsLOVUniqID}
Get all job application flexfield segments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingFlexSegmentsLOV

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 Interview Feedback Questionnaires in Requisitions

The recruitingRequisitionQuestionnairesLOV resource includes the list of recruiting interview feedback questionnaires in a requisition.

Get a requisition interview feedback questionnaire: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingRequisitionQuestionnairesLOV/{recruitingRequisitionQuestionnairesLOVUniqID}
Get all requisition interview feedback questionnaires: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingRequisitionQuestionnairesLOV

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/{QstnAnswerId}
Get all the requisition questions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingRequisitionQuestionsLOV

List of Values/Recruiting Tax Credit Packages List of Values

The recruitingTCAccountPackagesLOV resource provides the list of values for the tax credit screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get a tax credit screening package: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTCAccountPackagesLOV/{recruitingTCAccountPackagesLOVUniqID}
Get all tax credit screening packages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTCAccountPackagesLOV

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/{responsibilityTemplatesLOVUniqID}
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/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 performance goals that are shared with a specified user.

Get a shared performance goal: Method: get
Path: /hcmRestApi/resources/11.13.18.05/sharedPerformanceGoalsLOV/{GoalId}
Get all shared performance 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 Profile Section Subscribers List of Values

The talentProfileSectionSubscribersLOV resource provides the list of all subscribers of talent profile sections.

Get a talent profile section subscriber: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentProfileSectionSubscribersLOV/{talentProfileSectionSubscribersLOVUniqID}
Get all talent profile section subscribers: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentProfileSectionSubscribersLOV

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/Time Zone List of Values

The recruitingTimezonesLOV resource provides the list of values for getting all the time zones available.

Get a time zone: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTimezonesLOV/{TimezoneId}
Get all time zones: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTimezonesLOV

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/{userRolesLOVUniqID}
Get all user roles: Method: get
Path: /hcmRestApi/resources/11.13.18.05/userRolesLOV

List of Values/Wellness Activities List of Values

The wellnessActivitiesLOV resource provides a list of all wellness user activities within the same business group.

Get a wellness user activity: Method: get
Path: /hcmRestApi/resources/11.13.18.05/wellnessActivitiesLOV/{TopicId}
Get all wellness user activities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/wellnessActivitiesLOV

List of Values/Work Life 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

List of Values/eligibilityProfilesLOV

(Resource of eligibilityProfilesLOV)

Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibilityProfilesLOV/{eligibilityProfilesLOVUniqID}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibilityProfilesLOV

List of Values/eligibleOptionsLOV

(Resource of eligibleOptionsLOV)

Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibleOptionsLOV/{ComponentId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligibleOptionsLOV

List of Values/eligiblePlansLOV

(Resource of eligiblePlansLOV)

Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligiblePlansLOV/{PlanId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/eligiblePlansLOV

List of Values/salaryBasisLov

(Resource of salaryBasisLov)

Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaryBasisLov/{SalaryBasisId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaryBasisLov

List of Values/salaryBasisLov/salaryBasisComponents

(Resource of salaryBasisComponents)

Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaryBasisLov/{SalaryBasisId}/child/salaryBasisComponents/{LookupUsageId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaryBasisLov/{SalaryBasisId}/child/salaryBasisComponents

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 provides 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.

Change the effective start date: Method: post
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/action/changeEffectiveStartDate
Create a date-effective update on the job when only a child record is updated: Method: post
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/action/splitLocationForChildUpdate
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 provides 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 provides 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/{attachmentsUniqID}
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/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}

Locations V2/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Locations V2/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Locations V2/Locations Descriptive Flexfields

The locationsDFF resource is a child of the locations resource. It provides 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 provides 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 provides 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/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/action/checkEligibility
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/action/requestAdvance

Payroll Document Records

The payrollDocumentRecords resource provides the payroll tax document records for a person.

Get a payroll tax document record: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}
Get all payroll tax document records: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollDocumentRecords

Payroll Document Records/Attachments

The attachments resource provides the attachments of a payroll document record for a person.

Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}

Payroll Document Records/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Payroll Document Records/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

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}/action/updateTRU

Payroll Relationships/Payroll Assignments/Assigned Payrolls

(Resource of assignedPayrolls)

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}
Transfer a payroll: Method: post
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/action/transferPayroll
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

(Resource of assignedPayrollDates)

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 Assigments Developer Descriptive Flexfields

(Resource of PayrollRelationshipGroupsDDF)

Get all payroll assignment flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/PayrollRelationshipGroupsDDF
Get all payroll assignment flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/PayrollRelationshipGroupsDDF/{PayrollRelationshipGroupsDDFUniqID}
Update a payroll assignment flexfields: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/PayrollRelationshipGroupsDDF/{PayrollRelationshipGroupsDDFUniqID}

Payroll Relationships/Payroll Assignments/Payroll Assignment Dates

(Resource of payrollAssignmentDates)

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

Payroll Relationships/Payroll Relationships Developer Descriptive Flexfields

The PayRelationshipsDDF resource is a child of the payrollRelationships resource. It includes all payrollRelationships developer descriptive flexfields as of the specified date.

Get all payroll relationship flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/PayRelationshipsDDF
Get all payroll relationship flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/PayRelationshipsDDF/{PayRelationshipsDDFUniqID}
Update a payroll relationship flexfields: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/PayRelationshipsDDF/{PayRelationshipsDDFUniqID}

Payslips

The payslips resource includes a list of all payslips for a given payroll relationship.

downloadAttachments: Method: post
Path: /hcmRestApi/resources/11.13.18.05/payslips/action/downloadAttachments
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/{documentsUniqID}
Get all documents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents

Payslips/Documents/Attachment Previews

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}

Payslips/Documents/Attachment Previews/Attachments

The attachments resource is used to view, create, and update attachments.

Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}

Payslips/Documents/Attachment Previews/Attachments/Attachment Previews

The attachments preview resource is used to preview the attachment pages.

Get all attachment preview pages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
Get an attachment preview page: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview/{payslips_documents_AttachmentsPreview_Attachment_AttachmentsPreview_Id}

Payslips/Documents/Attachment Previews/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Payslips/Documents/Attachment Previews/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Payslips/Documents/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/enclosure/FileContents

Payslips/Documents/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/enclosure/FileWebImage

Payslips/Payslip History

The payslipHistory resource is a child of the payslips resource. It includes all the historical payment details made to the employee.

Get all earnings and deductions for a payslip.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/payslipHistory
Get an earning and deduction for a payslip.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/payslipHistory/{payslipHistoryUniqID}

Payslips/Payslips Summary

(Resource of PayslipSummary)

Get all earnings and deductions for a payslip.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/PayslipSummary
Get an earning and deduction for a payslip.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/PayslipSummary/{PayrollRelActionId}

Payslips/Payslips Summary/Net Pay Distribution

The netPayDistribution resource is a child of the payslips resource. It includes all the payment details made to the employee.

Get a payment for a payslip.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/PayslipSummary/{PayrollRelActionId}/child/NetPayDistribution/{NetPayDistributionUniqID}
Get all payments for a payslip.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/PayslipSummary/{PayrollRelActionId}/child/NetPayDistribution

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

(Resource of Roles)

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/{TasksUniqID}
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 performance goal: Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceGoals/{performanceGoalsUniqID}
Get all performance goals: Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceGoals

Performance Goals/Associated Goal Plans

The associatedGoalPlans resource returns all goal plans associated with the performance goal.

Get all associated goal plans: Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceGoals/{performanceGoalsUniqID}/child/associatedGoalPlans
Get an associated goal plan: Method: get
Path: /hcmRestApi/resources/11.13.18.05/performanceGoals/{performanceGoalsUniqID}/child/associatedGoalPlans/{GoalPlanGoalId}

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
Decrement the reference count: Method: post
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/action/decrementReferenceCount
Delete a person note: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}
Find out if a user has the privilege to view a person's public notes: Method: post
Path: /hcmRestApi/resources/11.13.18.05/personNotes/action/getViewPubPersonNotePrivilege
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
Increment the reference count: Method: post
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/action/incrementReferenceCount
Returns the context name: Method: post
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/action/getContextName
Send a thank you note: Method: post
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/action/sendThankYou
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

Person Notes/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}

Person Notes/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Person Notes/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Person Notes/Large Object (LOB) Attributes - NoteText

Delete a NoteText: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/enclosure/NoteText
Get a NoteText: Method: get
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/enclosure/NoteText
Replace a NoteText: Method: put
Path: /hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/enclosure/NoteText

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 provides 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/Details

The details resource is a child of the planBalances resource and provides details of each transaction type available for the absence plan.

Get a plan balance transaction: Method: get
Path: /hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/details/{planBalanceDetailsId}
Get all plan balance transactions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/details

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

Plan Balances/Year End Details

The yearEndDetails resource is a child of the planBalances resource and provides the details for the plan year end transactions.

Get a year-end detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/yearEndDetails/{planBalanceYearEndId}
Get all year-end details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/yearEndDetails

Plan Information

The compensationPlanDetails resource provides the ability to show line managers attributes about a compensation cycle and any other information administrators feel they need to see or read. Attributes include things like the due date, as of what date data was extracted from HR tables, and the plan currency.

Get plan information details for all plans: Method: get
Path: /hcmRestApi/resources/11.13.18.05/compensationPlanDetails
Get plan information for a single plan: Method: get
Path: /hcmRestApi/resources/11.13.18.05/compensationPlanDetails/{PersonEventId}

Plan Information/Large Object (LOB) Attributes - InstructionText

Get an InstructionText: Method: get
Path: /hcmRestApi/resources/11.13.18.05/compensationPlanDetails/{PersonEventId}/enclosure/InstructionText

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

Product Settings in Opportunity Marketplace

The recruitingOppMktSettings resource provides the product settings in opportunity marketplace.

Get a setting for opportunity marketplace.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktSettings/{SettingKey}
Get all settings for opportunity marketplace.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktSettings

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, you must use HCM Extracts. Also, you shouldn't use REST APIs for detecting data changes in the application. Instead, use Atom feeds to detect or identify changes made to data for key transactions in Oracle Fusion Cloud HCM. For example, you may use Atom feeds to detect changes in employee's personal details, employment data, new hires, and terminations. See the Atom Feeds section for details about delivered feeds in Oracle Fusion Cloud HCM.

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/All Reports/Large Object (LOB) Attributes - Photo

Delete a Photo: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports/{allReportsUniqID}/enclosure/Photo
Get a Photo: Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports/{allReportsUniqID}/enclosure/Photo
Replace a Photo: Method: put
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports/{allReportsUniqID}/enclosure/Photo

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/DirectReports/Large Object (LOB) Attributes - Photo

Delete a Photo: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports/{directReportsUniqID}/enclosure/Photo
Get a Photo: Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports/{directReportsUniqID}/enclosure/Photo
Replace a Photo: Method: put
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports/{directReportsUniqID}/enclosure/Photo

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/Managers/Large Object (LOB) Attributes - Photo

Delete a Photo: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers/{AssignmentSupervisorId}/enclosure/Photo
Get a Photo: Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers/{AssignmentSupervisorId}/enclosure/Photo
Replace a Photo: Method: put
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers/{AssignmentSupervisorId}/enclosure/Photo

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/Assignments/Representatives/Large Object (LOB) Attributes - Photo

Delete a Photo: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives/{AsgResponsibilityId}/enclosure/Photo
Get a Photo: Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives/{AsgResponsibilityId}/enclosure/Photo
Replace a Photo: Method: put
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives/{AsgResponsibilityId}/enclosure/Photo

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

Public Workers/Photos/Large Object (LOB) Attributes - Photo

Delete a Photo: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/photos/{PhotoId}/enclosure/Photo
Get a Photo: Method: get
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/photos/{PhotoId}/enclosure/Photo
Replace a Photo: Method: put
Path: /hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/photos/{PhotoId}/enclosure/Photo

Questionnaire Instructions

The questionnaireInstructions resource includes the instruction text defined for a questionnaire.

Get all questionnaire instructions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireInstructions
Get questionnaire instructions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}

Questionnaire Instructions/Attachments

The attachments resource is used to view, create, and update attachments.

Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments/{questionnaireInstructionAttachmentsUniqID}

Questionnaire Instructions/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments/{questionnaireInstructionAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments/{questionnaireInstructionAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments/{questionnaireInstructionAttachmentsUniqID}/enclosure/FileContents

Questionnaire Instructions/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments/{questionnaireInstructionAttachmentsUniqID}/enclosure/FileWebImage

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

(Resource of questionResponses)

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/Large Object (LOB) Attributes - Answer Large Object

Attachment provided by the participant to respond to the question.

Delete an Answer Large Object: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Get an Answer Large Object: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Replace an Answer Large Object: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject

Questionnaire Participants/Questionnaire Responses/Question Responses/Question Response Attachments

(Resource of questionResponseAttachments)

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 Participants/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - File Contents

File contents of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents

Questionnaire Participants/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - File Web Image

Base64 encoded image of the file displayed in .png format when the source is a convertible image.

Get a File Web Image: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage

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/{attachmentsUniqID}

Questionnaire Templates/Attachments/Large Object (LOB) Attributes - File Contents

File contents of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Questionnaire Templates/Attachments/Large Object (LOB) Attributes - File Web Image

Base64 encoded image of the file displayed in .png format when the source is a convertible image.

Get a File Web Image: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

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/{sectionsUniqID}
Get all sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections

Questionnaire Templates/Sections/Questions

(Resource of questions)

Get a question: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}
Get all questions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions

Questionnaire Templates/Sections/Questions/Answers

(Resource of answers)

Get all answer choices: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers
Get an answer choice: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}

Questionnaire Templates/Sections/Questions/Answers/Large Object (LOB) Attributes - Response Feedback

Feedback provided to the participant when the answer choice is selected.

Delete a Response Feedback: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
Get a Response Feedback: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
Replace a Response Feedback: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback

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/Attachments/Large Object (LOB) Attributes - File Contents

File contents of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Questionnaires/Attachments/Large Object (LOB) Attributes - File Web Image

Base64 encoded image of the file displayed in .png format when the source is a convertible image.

Get a File Web Image: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

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/{sectionsUniqID}
Get a section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}
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/{sectionsUniqID}

Questionnaires/Sections/Questions

(Resource of questions)

Create a question: Method: post
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions
Delete a question: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}
Get a question: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}
Get all questions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions
Update a question: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}

Questionnaires/Sections/Questions/Answers

(Resource of answers)

Get all answer choices: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers
Get an answer choice: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}
Update an answer choice: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}

Questionnaires/Sections/Questions/Answers/Answer Attachments

The attachments resource is used to view, create, and update attachments.

Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments/{answerAttachmentsUniqID}

Questionnaires/Sections/Questions/Answers/Answer Attachments/Large Object (LOB) Attributes - File Contents

File contents of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments/{answerAttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments/{answerAttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments/{answerAttachmentsUniqID}/enclosure/FileContents

Questionnaires/Sections/Questions/Answers/Answer Attachments/Large Object (LOB) Attributes - File Web Image

Base64 encoded image of the file displayed in .png format when the source is a convertible image.

Get a File Web Image: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments/{answerAttachmentsUniqID}/enclosure/FileWebImage

Questionnaires/Sections/Questions/Answers/Large Object (LOB) Attributes - Response Feedback

Feedback provided to the participant when the answer choice is selected.

Get a Response Feedback: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback

Questionnaires/Sections/Questions/Question Attachments

The attachments resource is used to view, create, and update attachments.

Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments/{questionAttachmentsUniqID}

Questionnaires/Sections/Questions/Question Attachments/Large Object (LOB) Attributes - File Contents

File contents of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments/{questionAttachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments/{questionAttachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments/{questionAttachmentsUniqID}/enclosure/FileContents

Questionnaires/Sections/Questions/Question Attachments/Large Object (LOB) Attributes - File Web Image

Base64 encoded image of the file displayed in .png format when the source is a convertible image.

Get a File Web Image: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments/{questionAttachmentsUniqID}/enclosure/FileWebImage

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/{answersUniqID}
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/{answersUniqID}
Update an answer: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}

Questions/Answers/Attachments

(Resource of attachments)

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments/{attachmentsUniqID}

Questions/Answers/Attachments/Large Object (LOB) Attributes - File Contents

File contents of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Questions/Answers/Attachments/Large Object (LOB) Attributes - File Web Image

Base64 encoded image of the file displayed in .png format when the source is a convertible image.

Get a File Web Image: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Questions/Answers/Large Object (LOB) Attributes - Response Feedback

Feedback provided to the participant when the answer choice is chosen.

Delete a Response Feedback: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
Get a Response Feedback: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
Replace a Response Feedback: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback

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/Attachments/Large Object (LOB) Attributes - File Contents

File contents of the attachment.

Delete a File Contents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Questions/Attachments/Large Object (LOB) Attributes - File Web Image

Base64 encoded image of the file displayed in .png format when the source is a convertible image.

Get a File Web Image: Method: get
Path: /hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

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 Activity Center Configurations

The recruitingRACConfigurations resource provides the overview of the configuration associated with items of recruiting activity center.

Create a value for the configuration: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingRACConfigurations
Get a value for the configuration: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingRACConfigurations/{SubscriberRuleId}
Get all values for the configuration: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingRACConfigurations
Update a value of the configuration: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingRACConfigurations/{SubscriberRuleId}

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. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

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 provides details about the recruiting partner in the candidate job application. 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 resource and provides the individual address fields used for the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

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/{addressDetailsUniqID}

Recruiting Assessment Partner Candidate Details/Address Format in the Recruiting Assessment Partner Candidate Details

The addressFormat resource is the child of the recruitingPartnerCandidateDetails resource and provides the address format used for the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

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 the child of the recruitingPartnerCandidateDetails resource and provides the certifications of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

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/Certification Related Information in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Comments

Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/certifications/{CertificationId}/enclosure/Comments

Recruiting Assessment Partner Candidate Details/Certification Related Information in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Restrictions

Get a Restrictions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/certifications/{CertificationId}/enclosure/Restrictions

Recruiting Assessment Partner Candidate Details/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details

The educations resource is the child of the recruitingPartnerCandidateDetails resource and provides details about the education of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

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/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - ActivitySummary

Get an ActivitySummary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/ActivitySummary

Recruiting Assessment Partner Candidate Details/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Comments

Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/Comments

Recruiting Assessment Partner Candidate Details/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Description

Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/Description

Recruiting Assessment Partner Candidate Details/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Reimbursements

Get a Reimbursements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/Reimbursements

Recruiting Assessment Partner Candidate Details/National Identifiers of the Candidate in the Recruiting Partner Candidate Details

The NationalIdentifiers resource is a child of the recruitingPartnerCandidateDetails resource and provides the national identifiers of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

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 the child of the recruitingPartnerCandidateDetails resource and provides the previous employment details of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

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 Assessment Partner Candidate Details/Previous Employments Recorded in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Achievements

Get an Achievements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments/{PreviousEmploymentId}/enclosure/Achievements

Recruiting Assessment Partner Candidate Details/Previous Employments Recorded in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - AdditionalInformation

Get an AdditionalInformation: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments/{PreviousEmploymentId}/enclosure/AdditionalInformation

Recruiting Assessment Partner Candidate Details/Previous Employments Recorded in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - LeavingReason

Get a LeavingReason: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments/{PreviousEmploymentId}/enclosure/LeavingReason

Recruiting Assessment Partner Candidate Details/Previous Employments Recorded in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Responsibilities

Get a Responsibilities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments/{PreviousEmploymentId}/enclosure/Responsibilities

Recruiting Assessment Partner Candidate Details/Requisition Additional Attributes Recorded in the Recruiting Partner Candidate Details

The requisitionAdditionalAttributes resource is the child of the recruitingPartnerCandidateDetails resource and provides the previous employment details of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get a requisition additional attribute of the recruiting partner candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/requisitionAdditionalAttributes/{AttributeName}
Get all the requisition additional attributes of the recruiting partner candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/requisitionAdditionalAttributes

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. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

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 bcCandidateResults resource. It includes the services of the candidate 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/{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 Candidate Results/Services About the Candidate Results/Additional Candidate Background Check Results

The additionalResultsAttributes resource is a child of the bcCandidateResults resource. It includes the additional attributes of the candidate 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/{PartnerId}/child/services/{ScreeningPackage}/child/AdditionalResultsAttributes
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services/{ScreeningPackage}/child/AdditionalResultsAttributes/{AttributeName}
Submit additional results of candidate background check: Method: post
Path: /hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services/{ScreeningPackage}/child/AdditionalResultsAttributes

Recruiting Background Check Screening Packages

The bcScreeningPackages 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 bcScreeningPackages resource. It includes the services 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/{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 Certifications/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Comments

Recruiting CE Candidate Certifications/Large Object (LOB) Attributes - Restrictions

Delete a Restrictions: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Restrictions
Get a Restrictions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Restrictions
Replace a Restrictions: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Restrictions

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 Education/Large Object (LOB) Attributes - ActivitySummary

Delete an ActivitySummary: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/ActivitySummary
Get an ActivitySummary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/ActivitySummary
Replace an ActivitySummary: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/ActivitySummary

Recruiting CE Candidate Education/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Comments

Recruiting CE Candidate Education/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Description

Recruiting CE Candidate Education/Large Object (LOB) Attributes - Reimbursements

Delete a Reimbursements: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Reimbursements
Get a Reimbursements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Reimbursements
Replace a Reimbursements: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Reimbursements

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

The recruitingCEInterviewActions resource provides details about the actions taken by the candidate during the interview. Note that the service endpoints in this resource category are only for Oracle internal use.

Create a candidate interview action: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewActions
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

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 Previous Experience/Large Object (LOB) Attributes - Achievements

Delete an Achievements: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Achievements
Get an Achievements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Achievements
Replace an Achievements: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Achievements

Recruiting CE Candidate Previous Experience/Large Object (LOB) Attributes - AdditionalInformation

Delete an AdditionalInformation: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/AdditionalInformation
Get an AdditionalInformation: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/AdditionalInformation
Replace an AdditionalInformation: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/AdditionalInformation

Recruiting CE Candidate Previous Experience/Large Object (LOB) Attributes - LeavingReason

Delete a LeavingReason: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/LeavingReason
Get a LeavingReason: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/LeavingReason
Replace a LeavingReason: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/LeavingReason

Recruiting CE Candidate Previous Experience/Large Object (LOB) Attributes - Responsibilities

Delete a Responsibilities: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Responsibilities
Get a Responsibilities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Responsibilities
Replace a Responsibilities: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Responsibilities

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.

Create a candidate resume: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers
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 recruitingCECandidateResumeParsers. 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.

Create an attachment with the candidate resume: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/attachments
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 recruitingCECandidateResumeParsers. 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.

Create education in the candidate resume: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/educations
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 recruitingCECandidateResumeParsers. 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.

Create a language in the candidate resume: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/languages
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 recruitingCECandidateResumeParsers. 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.

Create a license and certification in the candidate resume: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/licensesAndCertifications
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 recruitingCECandidateResumeParsers. 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.

Create a skill in the candidate resume: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/skills
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 recruitingCECandidateResumeParsers. 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.

Create a work experience in the candidate resume: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workExperiences
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 recruitingCECandidateResumeParsers. 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.

Create a work preference in the candidate resume: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workPreferences
Get a single work preference of the candidate resume: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/workPreferences/{workPreferencesUniqID}
Get a single work preference of the candidate resume: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workPreferences/{workPreferencesUniqID}
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 Candidate Work Preferences/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}/enclosure/Comments

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/{recruitingCEDictionariesUniqID}
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/Large Object (LOB) Attributes - PostScheduleDetails

Delete a PostScheduleDetails: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PostScheduleDetails
Get a PostScheduleDetails: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PostScheduleDetails
Replace a PostScheduleDetails: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PostScheduleDetails

Recruiting CE Interview Schedules/Large Object (LOB) Attributes - PreScheduleDetails

Delete a PreScheduleDetails: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PreScheduleDetails
Get a PreScheduleDetails: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PreScheduleDetails
Replace a PreScheduleDetails: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PreScheduleDetails

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 all interviews attended by the candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews
Get an interview attended by the candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}

Recruiting CE Interview Schedules/Recruiting CE Interviews/Large Object (LOB) Attributes - CandidateNotes

Delete a CandidateNotes: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/CandidateNotes
Get a CandidateNotes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/CandidateNotes
Replace a CandidateNotes: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/CandidateNotes

Recruiting CE Interview Schedules/Recruiting CE Interviews/Large Object (LOB) Attributes - LocationDetails

Delete a LocationDetails: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/LocationDetails
Get a LocationDetails: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/LocationDetails
Replace a LocationDetails: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/LocationDetails

Recruiting CE Interview Schedules/Recruiting CE Interviews/Large Object (LOB) Attributes - PostScheduleDetails

Delete a PostScheduleDetails: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/PostScheduleDetails
Get a PostScheduleDetails: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/PostScheduleDetails
Replace a PostScheduleDetails: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/PostScheduleDetails

Recruiting CE Interview Schedules/Schedule Interview Participants

The ScheduleParticipantsProgrammatic resource is the child of the recruitingCEInterviewScheduleDetails resource and provides the details about the interview participants for an interview schedule. Note that the service endpoints in this resource category are only for Oracle internal use.

Get details of all interview schedule participants: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/ScheduleParticipantsProgrammatic
Get details of an interview schedule participant: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/ScheduleParticipantsProgrammatic/{ScheduleId2}

Recruiting CE Interviews

Get all interviews attended by the candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails
Get an interview attended by the candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}

Recruiting CE Interviews/Large Object (LOB) Attributes - CandidateNotes

Delete a CandidateNotes: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/CandidateNotes
Get a CandidateNotes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/CandidateNotes
Replace a CandidateNotes: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/CandidateNotes

Recruiting CE Interviews/Large Object (LOB) Attributes - LocationDetails

Delete a LocationDetails: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/LocationDetails
Get a LocationDetails: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/LocationDetails
Replace a LocationDetails: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/LocationDetails

Recruiting CE Interviews/Large Object (LOB) Attributes - PostScheduleDetails

Delete a PostScheduleDetails: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/PostScheduleDetails
Get a PostScheduleDetails: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/PostScheduleDetails
Replace a PostScheduleDetails: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/PostScheduleDetails

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

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

Get a requisition flexfield for the requisition details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/requisitionFlexFields/{requisitionFlexFieldsUniqID}
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/Large Object (LOB) Attributes - ExternalDescription

Get an ExternalDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/ExternalDescription

Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - ExternalQualifications

Get an ExternalQualifications: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/ExternalQualifications

Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - ExternalResponsibilities

Get an ExternalResponsibilities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/ExternalResponsibilities

Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - InternalQualifications

Get an InternalQualifications: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/InternalQualifications

Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - InternalResponsibilities

Get an InternalResponsibilities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/InternalResponsibilities

Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - ShortDescription

Get a ShortDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/ShortDescription

Recruiting CE Job Requisition Details/Media

Get a media used in the requisition template details preview: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/media/{mediaUniqID}
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

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

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

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/{valuesUniqID}
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 the recruitingCEJobRequisitions. It includes the details of 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/Large Object (LOB) Attributes - ShortDescription

Get a ShortDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/enclosure/ShortDescription
Get a ShortDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/enclosure/ShortDescription

Recruiting CE Job Requisitions/Requisition List/Other Work Locations

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

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

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

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/{requisitionLocationsCoordinatesUniqID}
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/{requisitionLocationsCoordinatesUniqID}/child/locationCoordinates/{locationCoordinatesUniqID}
Get all locations coordinates: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionLocationsCoordinates/{requisitionLocationsCoordinatesUniqID}/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 Job Requisitions/Workplace Type Facet

The workplaceTypesFacet resource is a child of the recruitingCEJobRequisitions resource. It includes the details of the workplace type facet. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a workplace type facet: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workplaceTypesFacet/{Id}
Get all workplace type facets: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workplaceTypesFacet

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 Languages/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}/enclosure/Comments

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 recruitingCandidateAssessments resource includes all the details of recruiting candidate assessments. Note that the service endpoints in this resource category are only for Oracle internal use.

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 used to view, create, and update attachments.

Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{attachmentsUniqID}

Recruiting CE Offer Details/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Recruiting CE Offer Details/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

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/{answersUniqID}
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/Header Link 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/Cookie Consent/Header Link Translations/Large Object (LOB) Attributes - PolicyMessage

Delete a PolicyMessage: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/PolicyMessage
Get a PolicyMessage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/PolicyMessage
Replace a PolicyMessage: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/PolicyMessage

Recruiting CE Sites/Cookie Consent/Large Object (LOB) Attributes - PolicyMessage

Delete a PolicyMessage: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/PolicyMessage
Get a PolicyMessage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/PolicyMessage
Replace a PolicyMessage: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/PolicyMessage

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

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 Link 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/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

Delete a header translation in recruitingCESites: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/child/translations/{Language}
Get a header translation in recruitingCESites: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/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/{LinkNumber3}/child/translations/{Language}

Recruiting CE Sites/Header Links/Sublinks

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/{LinkNumber4}
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/{LinkNumber4}
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/{LinkNumber4}

Recruiting CE Sites/Header Links/Sublinks/Header Link Translations

Delete a header translation in recruitingCESites: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/child/sublinks/{LinkNumber4}/child/translations/{Language}
Get a header translation in recruitingCESites: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/child/sublinks/{LinkNumber4}/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/{LinkNumber4}/child/translations
Submit all header translations in recruitingCESites: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber4}/child/translations
Update a header translation in recruitingCESites: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/child/sublinks/{LinkNumber4}/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/Header Link 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/Component Translations/Large Object (LOB) Attributes - ComponentContent

Delete a ComponentContent: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations/{Language}/enclosure/ComponentContent
Get a ComponentContent: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations/{Language}/enclosure/ComponentContent
Replace a ComponentContent: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations/{Language}/enclosure/ComponentContent

Recruiting CE Sites/Pages/Sections/Components/Large Object (LOB) Attributes - ComponentContent

Delete a ComponentContent: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/enclosure/ComponentContent
Get a ComponentContent: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/enclosure/ComponentContent
Replace a ComponentContent: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/enclosure/ComponentContent

Recruiting CE Sites/Pages/Sections/Components/Section Parameters

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

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 Favicon/Large Object (LOB) Attributes - FaviconImg

Delete a FaviconImg: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}/enclosure/FaviconImg
Get a FaviconImg: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}/enclosure/FaviconImg
Replace a FaviconImg: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}/enclosure/FaviconImg

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/Header Link Translations

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 Skill Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Comments

Recruiting CE Skill Items/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Description

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/Brand Translations of Themes

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 Themes/Brand Translations of Themes/Large Object (LOB) Attributes - WelcomeText

Delete a WelcomeText: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}/enclosure/WelcomeText
Get a WelcomeText: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}/enclosure/WelcomeText
Replace a WelcomeText: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}/enclosure/WelcomeText

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/Brands in Themes/Brand Translations of Themes/Large Object (LOB) Attributes - CustomCSS

Delete a CustomCSS: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/CustomCSS
Get a CustomCSS: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/CustomCSS
Replace a CustomCSS: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/CustomCSS

Recruiting CE Themes/Brands in Themes/Brand Translations of Themes/Large Object (LOB) Attributes - NavigationFooterHTML

Delete a NavigationFooterHTML: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationFooterHTML
Get a NavigationFooterHTML: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationFooterHTML
Replace a NavigationFooterHTML: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationFooterHTML

Recruiting CE Themes/Brands in Themes/Brand Translations of Themes/Large Object (LOB) Attributes - NavigationHeaderHTML

Delete a NavigationHeaderHTML: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationHeaderHTML
Get a NavigationHeaderHTML: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationHeaderHTML
Replace a NavigationHeaderHTML: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationHeaderHTML

Recruiting CE Themes/Brands in Themes/Large Object (LOB) Attributes - CustomCSSCLOB

Delete a CustomCSSCLOB: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomCSSCLOB
Get a CustomCSSCLOB: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomCSSCLOB
Replace a CustomCSSCLOB: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomCSSCLOB

Recruiting CE Themes/Brands in Themes/Large Object (LOB) Attributes - CustomJSCLOB

Delete a CustomJSCLOB: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomJSCLOB
Get a CustomJSCLOB: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomJSCLOB
Replace a CustomJSCLOB: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomJSCLOB

Recruiting CE Themes/Brands in Themes/Large Object (LOB) Attributes - FooterHTMLCLOB

Delete a FooterHTMLCLOB: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/FooterHTMLCLOB
Get a FooterHTMLCLOB: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/FooterHTMLCLOB
Replace a FooterHTMLCLOB: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/FooterHTMLCLOB

Recruiting CE Themes/Brands in Themes/Large Object (LOB) Attributes - HeaderHTMLCLOB

Delete a HeaderHTMLCLOB: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/HeaderHTMLCLOB
Get a HeaderHTMLCLOB: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/HeaderHTMLCLOB
Replace a HeaderHTMLCLOB: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/HeaderHTMLCLOB

Recruiting CE Themes/Custom Headers of Themes

The customHeaders resource is a child of recruitingCEThemes. It includes the headers configuration. Note that the service endpoints in this resource category are only for Oracle internal use.

Create details of recruitingCEThemes Headers: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders
Delete details of recruitingCEThemes Headers: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}
Get all details of recruitingCEThemes Headers: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders
Get details of Headers in recruitingCEThemes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}
Update details of recruitingCEThemes Headers: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}

Recruiting CE Themes/Custom Headers of Themes/Brand Translations of Themes

The translations resource is a child of customHeaders. It includes the headers translations. Note that the service endpoints in this resource category are only for Oracle internal use.

Get all details of recruitingCEThemes Header Translations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/translations
Get details of recruitingCEThemes Header Translations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/translations/{Language}
Update details of recruitingCEThemes Header Translations: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/translations/{Language}

Recruiting CE Themes/Custom Headers of Themes/Settings of the Header

The settings resource is a child of customHeaders. It includes the headers settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.

Create details of recruitingCEThemes Header Settings: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings
Delete details of recruitingCEThemes Header Settings: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings/{SettingKey}
Get all details of recruitingCEThemes Header Settings: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings
Get details of recruitingCEThemes Header Settings: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings/{SettingKey}
Update details of recruitingCEThemes Header Settings: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings/{SettingKey}

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/Brand Translations of 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/Brand Translations of Themes

Get details of a translation in recruitingCEThemes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber2}/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/{LinkNumber2}/child/translations/{Language}

Recruiting CE Themes/Large Object (LOB) Attributes - GeneratedCustomCSS

Delete a GeneratedCustomCSS: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/GeneratedCustomCSS
Get a GeneratedCustomCSS: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/GeneratedCustomCSS
Replace a GeneratedCustomCSS: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/GeneratedCustomCSS

Recruiting CE Themes/Large Object (LOB) Attributes - WelcomeText

Delete a WelcomeText: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/WelcomeText
Get a WelcomeText: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/WelcomeText
Replace a WelcomeText: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/WelcomeText

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 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 detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}
Get all recruiting campaign details: 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 campaign assets: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets
Get all campaign assets: 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 campaign asset channel: 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 campaign asset channel: 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 a campaign asset segment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/campaignAssetSegments/{campaignAssetSegmentsUniqID}
Get all campaign asset segments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/campaignAssetSegments

Recruiting Campaign Details/Campaign Goal Responses

The campaignGoalResponses resource is a child of recruitingCampaignDetails. It includes all the goal responses of the campaign.

Get a campaign goal response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignGoalResponses/{campaignGoalResponsesUniqID}
Get all campaign goal response: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignGoalResponses

Recruiting Campaign Details/Large Object (LOB) Attributes - CampaignDescription

Get a CampaignDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/enclosure/CampaignDescription

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 Design Metadata/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/Description

Recruiting Campaign Email Designs/Message Design Metadata/Large Object (LOB) Attributes - DesignMetadata

Delete a DesignMetadata: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/DesignMetadata
Get a DesignMetadata: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/DesignMetadata
Replace a DesignMetadata: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/DesignMetadata

Recruiting Campaign Email Designs/Message Design Metadata/Large Object (LOB) Attributes - HTMLTemplate

Delete a HTMLTemplate: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/HTMLTemplate
Get a HTMLTemplate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/HTMLTemplate
Replace a HTMLTemplate: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/HTMLTemplate

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/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/enclosure/Comments

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. 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/{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 Assessment Results/Packages of Recruiting Candidate Assessment Results/Additional Candidate Assessment Results

The additionalResultsAttributes resource is a child of recruitingCandidateAssessmentResults. It includes additional details of the packages of 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/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/child/AdditionalResultsAttributes
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/child/AdditionalResultsAttributes/{AttributeName}
Submit additional results for assessment package: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/child/AdditionalResultsAttributes

Recruiting Candidate Assessment Results/Packages of Recruiting Candidate Assessment Results/Large Object (LOB) Attributes - StatusDescription

Delete a StatusDescription: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/enclosure/StatusDescription
Get a StatusDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/enclosure/StatusDescription
Replace a StatusDescription: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/enclosure/StatusDescription

Recruiting Candidate Details

The bcCandidateDetails resource provides details about background check in the candidate job application. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners and has been deprecated.

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

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 Experience Prefill Questions

The recruitingCEPrefillQuestionResponses resource provides the responses to the questions asked to candidates when they apply for a job. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a response to a question in a questionnaire: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEPrefillQuestionResponses/{QuestionId}
Get all responses to questions in a questionnaire: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEPrefillQuestionResponses

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.

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/{recruitingCandidateExtraInformationUniqID}

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/{recruitingCandidateExtraInformationUniqID}/child/jPersonExtraInformation
Delete an extra info data of the person: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{recruitingCandidateExtraInformationUniqID}/child/jPersonExtraInformation/{jPersonExtraInformationUniqID}
Get all extra information of a person: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{recruitingCandidateExtraInformationUniqID}/child/jPersonExtraInformation
Get all extra information of a person: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{recruitingCandidateExtraInformationUniqID}/child/jPersonExtraInformation/{jPersonExtraInformationUniqID}
Update an extra information details of a person: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{recruitingCandidateExtraInformationUniqID}/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 Job Application Drafts/Large Object (LOB) Attributes - Content

Delete a Content: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/enclosure/Content
Get a Content: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/enclosure/Content
Replace a Content: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/enclosure/Content

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 the details of the recruiting candidates.

Delete a recruiting candidate: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}
Get a recruiting candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}
Get all recruiting candidates: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates
Submit all recruiting candidates: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates
Update a recruiting candidate: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}

Recruiting Candidates/Address of the Recruiting Candidates

The candidateAddress resource is a child of recruitingCandidates. It includes the details of recruiting candidates address.

Delete recruiting candidates address: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress/{AddressId}
Get a recruiting candidates address: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress/{AddressId}
Get all recruiting candidates address: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress
Submit all recruiting candidates address: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress
Update recruiting candidates address: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress/{AddressId}

Recruiting Candidates/Attachments

The attachments resource is used to view, create, and update 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/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}

Recruiting Candidates/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Recruiting Candidates/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Recruiting Candidates/Education of the Recruiting Candidates

The education resource is a child of recruitingCandidates. It includes the details of recruiting candidates education.

Delete a recruiting candidates education: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}
Get all recruiting candidates education: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education
Get recruiting candidates education: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}
Submit all recruiting candidates education: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education
Update a recruiting candidates education: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}

Recruiting Candidates/Education of the Recruiting Candidates/Large Object (LOB) Attributes - ActivitySummary

Delete an ActivitySummary: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/ActivitySummary
Get an ActivitySummary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/ActivitySummary
Replace an ActivitySummary: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/ActivitySummary

Recruiting Candidates/Education of the Recruiting Candidates/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Comments

Recruiting Candidates/Education of the Recruiting Candidates/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Description

Recruiting Candidates/Education of the Recruiting Candidates/Large Object (LOB) Attributes - Reimbursements

Delete a Reimbursements: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Reimbursements
Get a Reimbursements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Reimbursements
Replace a Reimbursements: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Reimbursements

Recruiting Candidates/Experience of the Recruiting Candidates

The experience resource is a child of recruitingCandidates. It includes the details of recruiting candidates work experience.

Delete a recruiting candidates experience: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}
Get all recruiting candidates experience: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience
Get recruiting candidates experience: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}
Submit all recruiting candidates experience: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience
Update a recruiting candidates experience: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}

Recruiting Candidates/Experience of the Recruiting Candidates/Large Object (LOB) Attributes - Achievements

Delete an Achievements: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Achievements
Get an Achievements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Achievements
Replace an Achievements: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Achievements

Recruiting Candidates/Experience of the Recruiting Candidates/Large Object (LOB) Attributes - AdditionalInformation

Delete an AdditionalInformation: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation
Get an AdditionalInformation: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation
Replace an AdditionalInformation: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation

Recruiting Candidates/Experience of the Recruiting Candidates/Large Object (LOB) Attributes - LeavingReason

Delete a LeavingReason: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason
Get a LeavingReason: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason
Replace a LeavingReason: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason

Recruiting Candidates/Experience of the Recruiting Candidates/Large Object (LOB) Attributes - Responsibilities

Delete a Responsibilities: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities
Get a Responsibilities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities
Replace a Responsibilities: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities

Recruiting Candidates/Languages of the Recruiting Candidates

The languages resource is a child of recruitingCandidates. It includes the details of the recruiting candidates languages.

Delete a recruiting candidates languages: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}
Get a recruiting candidates languages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}
Get all recruiting candidates languages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages
Submit all recruiting candidates languages: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages
Update a recruiting candidates languages: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}

Recruiting Candidates/Languages of the Recruiting Candidates/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}/enclosure/Comments

Recruiting Candidates/Licenses and Certifications of the Recruiting Candidates

The licensesAndCertificates resource is a child of recruitingCandidates. It includes the details of the recruiting candidates licenses and certificates.

Delete a recruiting candidates licenses and certifications: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}
Get a recruiting candidates licenses and certifications: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}
Get all recruiting candidates licenses and certifications: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates
Submit a recruiting candidates licenses and certifications: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}
Update all recruiting candidates licenses and certifications: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates

Recruiting Candidates/Licenses and Certifications of the Recruiting Candidates/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments

Recruiting Candidates/Licenses and Certifications of the Recruiting Candidates/Large Object (LOB) Attributes - Restrictions

Delete a Restrictions: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions
Get a Restrictions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions
Replace a Restrictions: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions

Recruiting Candidates/Phone of the Recruiting Candidates

The candidatePhones resource is a child of recruitingCandidates. It includes the details of recruiting candidates phone numbers.

Delete recruiting candidates phone: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones/{PhoneId}
Get all recruiting candidates phone: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones
Get recruiting candidates phone: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones/{PhoneId}
Submit all recruiting candidates phone: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones
Update recruiting candidates phone: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones/{PhoneId}

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/Skills of the Recruiting Candidates/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Comments

Recruiting Candidates/Skills of the Recruiting Candidates/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Description

Recruiting Candidates/Work Preferences of the Recruiting Candidates

The workPreferences is a child of recruitingCandidates. It includes the details of the recruiting candidates work preferences.

Delete recruiting candidates work preferences: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
Get a recruiting candidates work preferences: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
Get all recruiting candidates work preferences: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences
Submit all recruiting candidates work preferences: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences
Update recruiting candidates work preferences: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}

Recruiting Candidates/Work Preferences of the Recruiting Candidates/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments

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 Chatbot Settings

The recruitingChatbotSettings resource includes the settings identifier for the chatbot.

Get a setting: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingChatbotSettings/{BotSettingId}
Get all settings: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingChatbotSettings

Recruiting Chatbot Settings/Recruiting Chatbot Setting Values

The recruitingChatbotSettingValues resource is the child of the recruitingChatbotSettings resource and provides the settings value for the chatbot.

Get a setting value: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingChatbotSettings/{BotSettingId}/child/recruitingChatbotSettingValues/{BotSettingValueId}
Get all setting values: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingChatbotSettings/{BotSettingId}/child/recruitingChatbotSettingValues

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 Event Check In Processes

The recruitingCEEventRegistrationCheckIns validates the candidate's registration to an event and updates the candidate's status.

Creates an update to the candidate's registration and marks the candidate's attendance.: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrationCheckIns

Recruiting Event Details

The recruitingCEEventDetails resource provide details about a recruiting event. Note that the service endpoints in this resource category are only for Oracle internal use.

Get details for a recruiting event.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventDetails/{recruitingCEEventDetailsUniqID}
Get details for all recruiting events.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventDetails

Recruiting Event Details Preview

The recruitingCEEventDetailsPreview resource shows details in the preview screen about a recruiting event. Note that the service endpoints in this resource category are only for Oracle internal use.

Get details for a recruiting event: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventDetailsPreviews/{recruitingCEEventDetailsPreviewsUniqID}
Get details for all recruiting events: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventDetailsPreviews

Recruiting Event Registrations

The recruitingCEEventRegistrations resource provides details about registrations for a recruiting event. Note that the service endpoints in this resource category are only for Oracle internal use.

Create a registration for a recruiting event.: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations
Get a registration for a recruiting event. Currently not supported.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations/{recruitingCEEventRegistrationsUniqID}
Get all registrations for a recruiting event.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations

Recruiting Event Registrations/Candidate Responses to Questions

The RecruitingEventQuestionnaireResponses 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/recruitingCEEventRegistrations/{recruitingCEEventRegistrationsUniqID}/child/RecruitingEventQuestionnaireResponses
Get the details of a response for a questionnaire: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations/{recruitingCEEventRegistrationsUniqID}/child/RecruitingEventQuestionnaireResponses/{QuestionnaireId}
Get the details of all responses for a questionnaire: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations/{recruitingCEEventRegistrationsUniqID}/child/RecruitingEventQuestionnaireResponses

Recruiting Events

The recruitingCEEvents resource provides details about recruiting events. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a recruiting event: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}
Get all recruiting events: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents

Recruiting Events Auto Suggestions

The recruitingCEEventSearchAutoSuggestions resource shows auto suggestions on search of recruiting events. Note that the service endpoints in this resource category are only for Oracle internal use.

Get details of all auto suggestions through events search: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventSearchAutoSuggestions
Get details of an auto suggestion through events search: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEventSearchAutoSuggestions/{Name}

Recruiting Events/Event Category Facets

The eventCategoriesFacet resource is a child of recruitingCEEvents. It includes the details of the event categories facets. Note that the service endpoints in this resource category are only for Oracle internal use.

Get all event category facets: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventCategoriesFacet
Get an event category facet: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventCategoriesFacet/{Id}

Recruiting Events/Event Format Facets

The eventFormatsFacet resource is a child of recruitingCEEvents. It includes the details of the event formats facets. Note that the service endpoints in this resource category are only for Oracle internal use.

Get all event format facets: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventFormatsFacet
Get an event format facet: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventFormatsFacet/{Id}

Recruiting Events/Location Facets

The locationsFacet resource is a child of recruitingCEEvents. It includes the details of the event location facets. Note that the service endpoints in this resource category are only for Oracle internal use.

Get all event location facets: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/locationsFacet
Get an event location facet: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/locationsFacet/{Id}

Recruiting Events/Recruiting Events List of Values

The eventList is the child of the recruitingCEEvents resource and provides the list of values for recruiting events. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a recruiting event list of values: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventList/{eventListUniqID}
Get all recruiting event lists of values: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventList

Recruiting Events/Start Date Range Facets

The startDatesFacet resource is a child of recruitingCEEvents. It includes the details of the event start date facets. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a start date facet: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/startDatesFacet/{Id}
Get all start date facets: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/startDatesFacet

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/{GeographyId}
Get all hierarchy locations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingHierarchyLocations

Recruiting Interactions

The recruitingUIInteractions resource provides the details of recruiting interactions.

Create an interaction: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIInteractions
Get all interactions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIInteractions
Get an interaction: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}

Recruiting Interactions/Recruiting Interaction Recipients

The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.

Create an interaction recipient: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}/child/InteractionRecipients
Get all interaction recipients: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}/child/InteractionRecipients
Get an interaction recipient: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}/child/InteractionRecipients/{InteractionRecipientId}

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 Interview Schedules

The recruitingInterviewSchedulesLOV resource includes all of the recruiting interview schedules.

Get a recruiting interview schedule.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingInterviewSchedulesLOV/{ScheduleId}
Get all recruiting interview schedules.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingInterviewSchedulesLOV

Recruiting Job Applications

The recruitingJobApplications resource includes all details about the job applications.

Action to confirm a job application on behalf of a candidate: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/action/confirm
Action to move a job application to an specific phase and state: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/action/move
Action 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}/action/sendConfirmationRequest
Action to withdraw a job application on behalf of the candidate: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/action/withdraw
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 for recruiting: 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 for recruiting: 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 used to view, create, and update 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/{attachmentsUniqID}

Recruiting Job Applications/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Recruiting Job Applications/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

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/{BackgroundCheckLinksUniqID}
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 Details

The education resource is a child of recruitingJobApplications. It includes the educational related details in the job application.

Get a education information from job application: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}
Get all educational information from job application: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education

Recruiting Job Applications/Education Details/Large Object (LOB) Attributes - ActivitySummary

Delete an ActivitySummary: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/ActivitySummary
Get an ActivitySummary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/ActivitySummary
Replace an ActivitySummary: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/ActivitySummary

Recruiting Job Applications/Education Details/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Comments

Recruiting Job Applications/Education Details/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Description

Recruiting Job Applications/Education Details/Large Object (LOB) Attributes - Reimbursements

Delete a Reimbursements: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Reimbursements
Get a Reimbursements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Reimbursements
Replace a Reimbursements: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Reimbursements

Recruiting Job Applications/Experience Details

The experience resource is a child of recruitingJobApplications. It includes the experience related details in the job application.

Get a job experience from job application: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}
Get all job experiences from job application: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience

Recruiting Job Applications/Experience Details/Large Object (LOB) Attributes - Achievements

Delete an Achievements: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Achievements
Get an Achievements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Achievements
Replace an Achievements: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Achievements

Recruiting Job Applications/Experience Details/Large Object (LOB) Attributes - AdditionalInformation

Delete an AdditionalInformation: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation
Get an AdditionalInformation: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation
Replace an AdditionalInformation: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation

Recruiting Job Applications/Experience Details/Large Object (LOB) Attributes - LeavingReason

Delete a LeavingReason: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason
Get a LeavingReason: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason
Replace a LeavingReason: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason

Recruiting Job Applications/Experience Details/Large Object (LOB) Attributes - Responsibilities

Delete a Responsibilities: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities
Get a Responsibilities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities
Replace a Responsibilities: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities

Recruiting Job Applications/Language Information

The languages resource is a child of recruitingJobApplications. It includes the candidates language related details in the job application.

Get a language from job application: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages/{LanguageId}
Get all languages from job applications: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages

Recruiting Job Applications/Language Information/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages/{LanguageId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages/{LanguageId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages/{LanguageId}/enclosure/Comments

Recruiting Job Applications/Licenses and Certificates of the Candidates

The licensesAndCertificates resource is a child of recruitingJobApplications. It includes the licenses and certificate details of the candidate.

Get a license and certificate from job application: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}
Get all licenses and certificate from job application: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates

Recruiting Job Applications/Licenses and Certificates of the Candidates/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments

Recruiting Job Applications/Licenses and Certificates of the Candidates/Large Object (LOB) Attributes - Restrictions

Delete a Restrictions: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions
Get a Restrictions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions
Replace a Restrictions: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions

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/Recruiting Work Preferences

The workPreferences resource is a child of recruitingJobApplications. It includes the work preferences of the candidate.

Get a work preference: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferences/{WorkPreferenceId}
Get all work preferences: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferences

Recruiting Job Applications/Recruiting Work Preferences/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments

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
Get a scheduled interview: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/ScheduleInterviews/{IntrvwRequestsId}
Get all the scheduled interviews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/ScheduleInterviews
Update a scheduled interview: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/ScheduleInterviews/{IntrvwRequestsId}

Recruiting Job Applications/Secondary Job Submissions

The secondaryrecruitingCEJobApplications resource includes all the secondary job applications. Note that the service endpoints in this resource category are only for Oracle internal use.

Create a secondary job application: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/secondarySubmissions
Get a secondary job application: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/secondarySubmissions/{SecondaryFlowId}
Get all the secondary job applications: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/secondarySubmissions
Update a secondary job application: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/secondarySubmissions/{SecondaryFlowId}

Recruiting 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/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/UnscheduledInterviewRequests
Get a request for an unscheduled interview: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/UnscheduledInterviewRequests/{IntrvwRequestsId}
Get all the unscheduled interview requests: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/UnscheduledInterviewRequests
Update an unscheduled interview request: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/UnscheduledInterviewRequests/{IntrvwRequestsId}

Recruiting Job Families

The recruitingJobFamilies resource includes the details to get different Recruiting Job Families.

Get a recruiting job family: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobFamilies/{recruitingJobFamiliesUniqID}
Get all recruiting job families: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobFamilies

Recruiting Job Offer Actions

The recruitingJobOfferActions resource provides the actions performed on recruiting job offers.

Create a recruiting job offer action: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOfferActions
Get a recruiting job offer action: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOfferActions/{recruitingJobOfferActionsUniqID}
Get all recruiting job offer actions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOfferActions

Recruiting Job Offers

The recruitingJobOffersLOV resource provides details about the list of values for the recruiting job offers.

Get a job offer: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}
Get a recruiting job offer: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffersLOV/{recruitingJobOffersLOVUniqID}
Get all job offers: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers
Get all recruiting job offers: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffersLOV

Recruiting Job Offers/Attachments

The attachments resource is used to view, create, and update attachments.

Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments/{attachmentsUniqID}

Recruiting Job Offers/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Recruiting Job Offers/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Recruiting Job Offers/Collaborators

The collaborators resource includes all details about the collaborators who create and manage the job offers.

Get a collaborator: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/collaborators/{CollaboratorId}
Get all collaborators: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/collaborators

Recruiting Job Offers/Descriptive Flexible Field for the Job Offer

(Resource of offerDFF)

Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/offerDFF/{offerDFFUniqID}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/offerDFF

Recruiting Job Offers/Large Object (LOB) Attributes - AdditionalTextOne

Delete an AdditionalTextOne: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextOne
Get an AdditionalTextOne: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextOne
Replace an AdditionalTextOne: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextOne

Recruiting Job Offers/Large Object (LOB) Attributes - AdditionalTextTwo

Delete an AdditionalTextTwo: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextTwo
Get an AdditionalTextTwo: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextTwo
Replace an AdditionalTextTwo: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextTwo

Recruiting Job Offers/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/Description

Recruiting Job Offers/Large Object (LOB) Attributes - EsignatureInstructions

Delete an EsignatureInstructions: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/EsignatureInstructions
Get an EsignatureInstructions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/EsignatureInstructions
Replace an EsignatureInstructions: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/EsignatureInstructions

Recruiting Job Requisition Distribution

The jobDistributionDetails resource includes all the details of the job distribution. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get the details of a job distribution: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}
Get the details of all job distributions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails

Recruiting Job Requisition Distribution Posting Details

The jobPostingDetails resource includes all the details of the job posting. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get details of a job posting: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobPostingDetails/{RequisitionNumber}
Get details of all job postings: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobPostingDetails
Post details of all job postings: Method: post
Path: /hcmRestApi/resources/11.13.18.05/jobPostingDetails

Recruiting Job Requisition Distribution Posting Details/Job Posting on the Job Boards

The jobBoards resource is a child of jobPostingDetails. It includes the details of job postings on job boards.

Get details of a job posting on job boards: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobPostingDetails/{RequisitionNumber}/child/jobBoards/{ResultId}
Get details of all job postings on job boards: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobPostingDetails/{RequisitionNumber}/child/jobBoards
Post details of all job postings on job boards: Method: post
Path: /hcmRestApi/resources/11.13.18.05/jobPostingDetails/{RequisitionNumber}/child/jobBoards

Recruiting Job Requisition Distribution/Requisition Languages

The requisitionLanguages resource is a child of jobDistributionDetails. It includes the details of the languages mentioned in the job description.

Get the details of all the required languages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages
Get the details of the required language: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}

Recruiting Job Requisition Distribution/Requisition Languages/Secondary Locations

The media resource is a child of requisitionLanguages. It includes the details of the type of media used in the job distribution.

Get the details of a secondary location: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/secondaryLocations/{RequisitionMediaLinkId}
Get the details of all the media: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/media
Get the details of all the secondary locations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/secondaryLocations
Get the details of the media: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/media/{RequisitionMediaLinkId}

Recruiting Job Requisition Distribution/Requisition Skills

The skills resource is a child of jobDistributionDetails. It includes the details of skills mentioned in the requisition.

Get the details of a skill: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/skills/{skillsUniqID}
Get the details of all the skills: Method: get
Path: /hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/skills

Recruiting Job Requisition Template Details Preview

The recruitingCERequisitionTemplateDetailsPreviews resource includes the details about the requisition templates. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a requisition template details preview: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}
Get all requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews

Recruiting Job Requisition Template Details Preview/Job Requisition Flexfields

Get a requisition flexfield for the requisition details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/requisitionFlexFields/{requisitionFlexFieldsUniqID}
Get all requisition flexfields for the requisition details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/requisitionFlexFields

Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - ExternalDescription

Get an ExternalDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ExternalDescription

Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - ExternalQual

Get an ExternalQual: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ExternalQual

Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - ExternalResp

Get an ExternalResp: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ExternalResp

Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - InternalQual

Get an InternalQual: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/InternalQual

Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - InternalResp

Get an InternalResp: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/InternalResp

Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - ShortDescription

Delete a ShortDescription: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ShortDescription
Get a ShortDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ShortDescription
Replace a ShortDescription: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ShortDescription

Recruiting Job Requisition Template Details Preview/Media

Get a media used in the requisition template details preview: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/media/{mediaUniqID}
Get all media used in the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/media

Recruiting Job Requisition Template Details Preview/Other Work Locations

Get all other work location for the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/otherWorkLocations
Get other work location for the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/otherWorkLocations/{otherWorkLocationsUniqID}

Recruiting Job Requisition Template Details Preview/Secondary Locations

Get a secondary location for the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/secondaryLocations/{RequisitionLocationId}
Get all secondary locations for the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/secondaryLocations

Recruiting Job Requisition Template Details Preview/Work Locations

Get a work location for the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/workLocation/{workLocationUniqID}
Get all work locations for the requisition template details previews: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/workLocation

Recruiting Job Requisitions

The recruitingJobRequisitions resource includes the details of recruiting job requisitions.

Delete recruiting job requisitions: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}
Get a recruiting job requisition: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}
Get all recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions
Submit all recruiting job requisitions: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions
Update recruiting job requisitions: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}

Recruiting Job Requisitions/Attachments

The attachments resource is used to view, create, and update attachments.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}

Recruiting Job Requisitions/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Recruiting Job Requisitions/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Recruiting Job Requisitions/Collaborators in Recruiting Job Requisitions

The collaborators resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions collaborators.

Delete recruiting job requisitions collaborators: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/collaborators/{collaboratorsUniqID}
Get a collaborator in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/collaborators/{collaboratorsUniqID}
Get all collaborators in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/collaborators
Submit all recruiting job requisitions collaborators: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/collaborators

Recruiting Job Requisitions/Languages in Recruiting Job Requisitions

The languages resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions languages.

Delete recruiting job requisitions languages: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/languages/{LanguageId}
Get a language in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/languages/{LanguageId}
Get all languages in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/languages
Submit all recruiting job requisitions languages: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/languages

Recruiting Job Requisitions/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/Comments

Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalDescription

Delete an ExternalDescription: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescription
Get an ExternalDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescription
Replace an ExternalDescription: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescription

Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalDescriptionHTML

Delete an ExternalDescriptionHTML: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescriptionHTML
Get an ExternalDescriptionHTML: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescriptionHTML
Replace an ExternalDescriptionHTML: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescriptionHTML

Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalQual

Delete an ExternalQual: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQual
Get an ExternalQual: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQual
Replace an ExternalQual: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQual

Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalQualHTML

Delete an ExternalQualHTML: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQualHTML
Get an ExternalQualHTML: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQualHTML
Replace an ExternalQualHTML: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQualHTML

Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalResp

Delete an ExternalResp: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalResp
Get an ExternalResp: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalResp
Replace an ExternalResp: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalResp

Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalRespHTML

Delete an ExternalRespHTML: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalRespHTML
Get an ExternalRespHTML: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalRespHTML
Replace an ExternalRespHTML: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalRespHTML

Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalShortDescription

Delete an ExternalShortDescription: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalShortDescription
Get an ExternalShortDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalShortDescription
Replace an ExternalShortDescription: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalShortDescription

Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalDescription

Delete an InternalDescription: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescription
Get an InternalDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescription
Replace an InternalDescription: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescription

Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalDescriptionHTML

Delete an InternalDescriptionHTML: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescriptionHTML
Get an InternalDescriptionHTML: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescriptionHTML
Replace an InternalDescriptionHTML: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescriptionHTML

Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalQual

Delete an InternalQual: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQual
Get an InternalQual: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQual
Replace an InternalQual: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQual

Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalQualHTML

Delete an InternalQualHTML: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQualHTML
Get an InternalQualHTML: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQualHTML
Replace an InternalQualHTML: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQualHTML

Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalResp

Delete an InternalResp: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalResp
Get an InternalResp: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalResp
Replace an InternalResp: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalResp

Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalRespHTML

Delete an InternalRespHTML: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalRespHTML
Get an InternalRespHTML: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalRespHTML
Replace an InternalRespHTML: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalRespHTML

Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalShortDescription

Delete an InternalShortDescription: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalShortDescription
Get an InternalShortDescription: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalShortDescription
Replace an InternalShortDescription: Method: put
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalShortDescription

Recruiting Job Requisitions/Media Links in Recruiting Job Requisitions

The mediaLinks resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions media links.

Delete recruiting job requisitions media links: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}
Get a media link in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}
Get all media links in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks
Submit all recruiting job requisitions media links: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks
Update recruiting job requisitions media links: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}

Recruiting Job Requisitions/Media Links in Recruiting Job Requisitions/Media Languages in Recruiting Job Requisitions

The mediaLanguages resource is a child of mediaLinks. It includes the details of recruiting job requisitions media languages.

Delete recruiting job requisitions media languages: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}/child/mediaLanguages/{MediaLanguageId}
Get a media language used in the media links: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}/child/mediaLanguages/{MediaLanguageId}
Get all media languages used in the media links: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}/child/mediaLanguages
Submit all recruiting job requisitions media languages: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}/child/mediaLanguages

Recruiting Job Requisitions/Other Locations in Recruiting Job Requisitions

The otherLocations resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions for other locations.

Delete recruiting job requisitions other languages: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherLocations/{LocationId}
Get all other locations in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherLocations
Get an other location in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherLocations/{LocationId}
Submit all recruiting job requisitions other languages: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherLocations

Recruiting Job Requisitions/Other Work Locations in Recruiting Job Requisitions

The otherWorkLocations resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions in other work locations.

Delete recruiting job requisitions other work locations: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherWorkLocations/{otherWorkLocationsUniqID}
Get all other work locations in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherWorkLocations
Get an other work location in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherWorkLocations/{otherWorkLocationsUniqID}
Submit all recruiting job requisitions other work locations: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherWorkLocations

Recruiting Job Requisitions/Published Jobs in Recruiting Job Requisitions

The publishedJobs resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions published jobs.

Get a published job in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/publishedJobs/{PublishedJobId}
Get all published jobs in the recruiting job requisitions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/publishedJobs

Recruiting Job Requisitions/Requisition DFF in Recruiting Job Requisitions

(Resource of requisitionDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/requisitionDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/requisitionDFF/{requisitionDFFUniqID}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/requisitionDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/requisitionDFF/{requisitionDFFUniqID}

Recruiting Job Requisitions/Skills in Recruiting Job Requisitions

The skills resource is the child of the recruitingjobRequisitions resource and provides all the skills of the job requisition.

Create a skill for a recruiting job requisition: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/skills
Delete a skill for a recruiting job requisition: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/skills/{SkillId}
Get a skill for a recruiting job requisition: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/skills/{SkillId}
Get all skills for a recruiting job requisition: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/skills
Update a skill for a recruiting job requisition: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/skills/{SkillId}

Recruiting LinkedIn Event Notifications

The recruitingLinkedInEventNotifications resource receives notifications from LinkedIn for the push events.

Creates an event for the notification received from LinkedIn: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingLinkedInEventNotifications
Get details about a notification received from LinkedIn: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingLinkedInEventNotifications/{recruitingLinkedInEventNotificationsUniqID}
Get details about all notifications received from LinkedIn: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingLinkedInEventNotifications

Recruiting Message Designer Mail Services

The recruitingMessageDesignerMailServices resource includes the details for sending and receiving messages.

Get a messageDesignerMailService: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesignerMailServices/{AssetId}
Get all recruitingMessageDesignerMailServices: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesignerMailServices
Submit a messageDesignerMailService: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesignerMailServices
Update a messageDesignerMailService: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingMessageDesignerMailServices/{AssetId}

Recruiting Metadata for Sensitive Personal Information Block

The recruitingCECandidatePIIMetadata resource includes the metadata for the sensitive personal information block. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a metadata detail for the sensitive personal information block: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePIIMetadata/{AttributeName}
Get all metadata detail for the sensitive personal information block: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCECandidatePIIMetadata

Recruiting Opportunity Marketplace My Job Referrals

The recruitingMyJobRferrals resource provides list of job referrals displayed in opportunity marketplace.

Create referrals in opportunity marketplace.: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobReferrals
Delete a referral in opportunity marketplace.: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobReferrals/{ReferralId}
Get a referral as displayed in opportunity marketplace.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobReferrals/{ReferralId}
Get all referrals in opportunity marketplace.: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobReferrals
Update a referral in opportunity marketplace.: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingMyJobReferrals/{ReferralId}

Recruiting SecondaryApply Flows

The recruitingCESecondaryApplyFlows resource provides details about the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a recruiting secondary application flow: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}
Get all recruiting secondary application flows: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows

Recruiting SecondaryApply Flows/Requisition Flexfields

Get a requisition flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/requisitionFlexFields/{ColumnName}
Get all requisition flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/requisitionFlexFields

Recruiting SecondaryApply Flows/Sections

The sections resource is a child of the recruitingCESecondaryApplyFlows resource. It provides details about the sections contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a section of a recruiting secondary application flow: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}
Get all sections of a recruiting secondary application flow: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections

Recruiting SecondaryApply Flows/Sections/Pages

The pages resource is the child of the sections resource. It provides details about the pages of the sections contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a page of a recruiting secondary application flow: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}
Get all pages of a recruiting secondary application flow: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages

Recruiting SecondaryApply Flows/Sections/Pages/Blocks

The blocks resource is the child of the pages resources. It provides details about the blocks of the pages contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.

Get a block of a recruiting secondary application flow: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}/child/blocks/{blocksUniqID}
Get all blocks of a recruiting secondary application flow: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}/child/blocks

Recruiting Tax Credit Accounts

The recruitingTaxCreditsAccountPackages resource includes all the details of the tax credit account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Create or update details of all tax credits accounts: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages/{recruitingTaxCreditsAccountPackagesUniqID}

Recruiting Tax Credit Accounts/Recruiting Tax Credit Account Packages

The packages resource is a child of the recruitingTaxCreditsAccountPackages resource. It contains details of a tax credits account package. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Create or update details of tax credits account packages: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages/{recruitingTaxCreditsAccountPackagesUniqID}/child/packages
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages/{recruitingTaxCreditsAccountPackagesUniqID}/child/packages
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages/{recruitingTaxCreditsAccountPackagesUniqID}/child/packages/{PackageCode}

Recruiting Tax Credits Candidate Details

The recruitingTaxCreditsCandidateDetails resource provides details about tax credits in the candidate job application. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get details for a job application: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}
Get details for all job applications: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails

Recruiting Tax Credits Candidate Details/Recruiting Tax Credits Address Details

The addressDetails resource is a child of the recruitingTaxCreditsCandidateDetails and provides the individual address fields of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get all the address details of the candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/addressDetails
Get the address details of the candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/addressDetails/{addressDetailsUniqID}

Recruiting Tax Credits Candidate Details/Recruiting Tax Credits Address Format

The addressFormat resource is a child of the recruitingTaxCreditsCandidateDetails and provides the address format used in the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get all address formats of the candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/addressFormat
Get an address format of the candidate: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/addressFormat/{Attribute}

Recruiting Tax Credits Candidate Details/Recruiting Tax Credits Candidate National Identifiers

The NationalIdentifiers resource is the child of the recruitingTaxCreditsCandidateDetails resource and provides the national identifiers of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get a candidate national identifier: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/NationalIdentifiers/{NationalIdentifierNumber}
Get all candidate national identifiers: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/NationalIdentifiers

Recruiting Tax Credits Candidate Details/Recruiting Tax Credits Other Work Locations

The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get a job requisition other work location: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/CandidatePreferredLocations/{Location}
Get a job requisition other work location: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/OtherRequisitionLocations/{Location}
Get a job requisition other work location: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/OtherWorkLocations/{Location}
Get all job requisition other work locations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/CandidatePreferredLocations
Get all job requisition other work locations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/OtherRequisitionLocations
Get all job requisition other work locations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/OtherWorkLocations

Recruiting Tax Credits Candidate Details/Recruiting Tax Credits Requisition Additional Attributes

The requisitionAdditionalAttributes resource is the child of the recruitingTaxCreditsCandidateDetails resource and provides the additional requisition attributes. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Get all additional attributes of a job requisition: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/requisitionAdditionalAttributes
Get an additional attribute of the job requisition: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/requisitionAdditionalAttributes/{AttributeName}

Recruiting Tax Credits Results

The recruitingTaxCreditsCandidateResults resource includes all the details of the tax credit screening results of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Create results for all tax credits screening: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}

Recruiting Tax Credits Results/Recruiting Tax Credits Package Results

The packages resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Create or update results for a tax credit package: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}

Recruiting Tax Credits Results/Recruiting Tax Credits Package Results/Additional Candidate Tax Credits Results

The additionalResultsAttributes resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes additional results of a tax credit screening. 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/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/AdditionalResultsAttributes
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/AdditionalResultsAttributes/{AttributeName}
Submit additional results for a tax credit package: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/AdditionalResultsAttributes

Recruiting Tax Credits Results/Recruiting Tax Credits Package Results/Other Eligible Credits for Recruiting Tax Credits Package Results

The otherEligibleCredits resource is a child of the packages resource. It includes all other eligible credits the candidate has been reviewed for. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Create results for other eligible credits for a tax credit screening: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/OtherEligibleCredits
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/OtherEligibleCredits
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/OtherEligibleCredits/{AdditionalResultId}

Salaries

The salaries resource includes the salary records for a given worker assignment. You can filter based on a worker's assignment and salary start date or list all of the salary records for a given assignment.

Create a salary for a worker's assignment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/salaries
Delete a salary for a worker's assignment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}
Get a salary for a worker's assignment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}
Get all salaries for a worker's assignment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaries
Update a salary for a worker's assignment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}

Salaries/Salary Components

The salaryComponents resource is the child of the salaries resource and includes all the components that itemize salary adjustments for a given salary record, such as Adjustment, Location, and Merit.

Create a component: Method: post
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents
Delete a component: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents/{SalaryComponentId}
Get a component: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents/{SalaryComponentId}
Get all components: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents
Update a component: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents/{SalaryComponentId}

Salaries/Salary Rate Components

The salaryRateComponents resource is the child of the salaries resource and includes all of the rate components for a given salary record. This resource is currently under controlled availability.

Create a rate component: Method: post
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents
Delete a rate component: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents/{SalaryPayComponentId}
Get a rate component: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents/{SalaryPayComponentId}
Get all rate components: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents
Update a rate component: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents/{SalaryPayComponentId}

Salaries/Salary Simple Components

The salarySimpleComponents resource is the child of the salaries resource and includes all of the simple components for a given salary record, such as Base Salary, Location Allowance, and Special Allowance.

Create a simple component: Method: post
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents
Delete a simple component: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents/{SimpleSalaryCompntId}
Get a simple component: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents/{SimpleSalaryCompntId}
Get all simple components: Method: get
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents
Update a simple component: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents/{SimpleSalaryCompntId}

Schedule Requests

The scheduleRequests resource is the schedule import request sent from a specified source.

Create a schedule request: Method: post
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests
Get a schedule request: Method: get
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}
Get all schedule requests: Method: get
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests

Schedule Requests/Schedule Events

The scheduleEvents resource is the scope of schedule updates, for example, resource and time period.

Create a schedule event: Method: post
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents
Get a schedule event: Method: get
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}
Get all schedule events: Method: get
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents

Schedule Requests/Schedule Events/Schedule Shift Events

The scheduleShiftEvents resource is a list of imported values to create, update, or delete a shift.

Create a schedule shift event: Method: post
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents
Get a schedule shift event: Method: get
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents/{schedShiftEventId}
Get all schedule shift events: Method: get
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents

Schedule Requests/Schedule Events/Schedule Shift Events/Schedule Shift Attributes

The scheduleShiftAttributes resource is a list of imported values of time attributes associated with a shift.

Create a schedule shift attribute: Method: post
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents/{schedShiftEventId}/child/scheduleShiftAttributes
Get a schedule shift attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents/{schedShiftEventId}/child/scheduleShiftAttributes/{schedShiftAtrbId}
Get all schedule shift attributes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents/{schedShiftEventId}/child/scheduleShiftAttributes

Search Development Goals

The searchDevGoals resource provides information about development goals.

Find development goals: Method: post
Path: /hcmRestApi/resources/11.13.18.05/searchDevGoals/action/findByAdvancedSearchQuery
Get a development goal: Method: get
Path: /hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}
Get all development goals: Method: get
Path: /hcmRestApi/resources/11.13.18.05/searchDevGoals

Search Development Goals/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/Comments

Search Development Goals/Large Object (LOB) Attributes - SuccessCriteria

Delete a SuccessCriteria: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/SuccessCriteria
Get a SuccessCriteria: Method: get
Path: /hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/SuccessCriteria
Replace a SuccessCriteria: Method: put
Path: /hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/SuccessCriteria

Seeker Preferences in Opportunity Marketplace

The recruitingOppMktSeekerPreferences resource provides the preferences of the seeker in opportunity marketplace.

Create seeker preferences in opportunity marketplace: Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktSeekerPreferences
Delete seeker preferences in opportunity marketplace: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktSeekerPreferences/{PreferenceId}
Get a seeker preference in opportunity marketplace: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktSeekerPreferences/{PreferenceId}
Get all seeker preferences in opportunity marketplace: Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktSeekerPreferences
Update seeker preferences in opportunity marketplace: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/recruitingOppMktSeekerPreferences/{PreferenceId}

Self Details

The selfDetails resource provides details of the signed in user. User details are retrieved from the security token.

Get a self detail: Method: get
Path: /hcmRestApi/resources/11.13.18.05/selfDetails/{selfDetailsUniqID}
Get all self details: Method: get
Path: /hcmRestApi/resources/11.13.18.05/selfDetails

Self Details/Large Object (LOB) Attributes - Photo

Get a Photo: Method: get
Path: /hcmRestApi/resources/11.13.18.05/selfDetails/{selfDetailsUniqID}/enclosure/Photo

Status Change Requests

The statusChangeRequests resource is a unique identifier for the status change request sent using the status changes REST API. This request can contain one or more status change records.

Create status change requests: Method: post
Path: /hcmRestApi/resources/11.13.18.05/statusChangeRequests
Get a status change request: Method: get
Path: /hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}
Get all status change requests: Method: get
Path: /hcmRestApi/resources/11.13.18.05/statusChangeRequests

Status Change Requests/Status Changes

The statusChanges resource is a unique identifier of a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It is a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work performed, such as regular or overtime.

Create a status change record: Method: post
Path: /hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}/child/statusChanges
Get a status change record: Method: get
Path: /hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}/child/statusChanges/{statusChangeId}
Get all status change records: Method: get
Path: /hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}/child/statusChanges

Talent Person Profiles

The talentPersonProfiles resource provides the profile information for a person.

Create a person profile: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles
Get a person profile: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}
Get all person profiles: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles
Update a person profile: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}

Talent Person Profiles/Accomplishment Sections

The accomplishmentSections resource is the child of the talentPersonProfiles resource. It provides the list of secured accomplishment sections for a person.

Create an accomplishment section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections
Get all accomplishment sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections
Get an accomplishment section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}

Talent Person Profiles/Accomplishment Sections/Accomplishment Items

The accomplishmentItems resource is the child of the accomplishmentSections resource. It provides the list of accomplishment items within an accomplishment section for a person.

Create an accomplishment item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems
Delete an accomplishment item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}
Get all accomplishment items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems
Get an accomplishment item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}
Update an accomplishment item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}

Talent Person Profiles/Accomplishment Sections/Accomplishment Items/Accomplishment Items Descriptive Flexfields

(Resource of accomplishmentItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/child/accomplishmentItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/child/accomplishmentItemsDFF/{AccomplishmentId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/child/accomplishmentItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/child/accomplishmentItemsDFF/{AccomplishmentId2}

Talent Person Profiles/Accomplishment Sections/Accomplishment Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Comments

Talent Person Profiles/Accomplishment Sections/Accomplishment Items/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Description

Talent Person Profiles/Areas of Expertise

The areasOfExpertise resource is the child of the talentPersonProfiles resource. It provides the list of expertise items for a person.

Create an area of expertise: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfExpertise
Get all areas of expertise: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfExpertise
Get an area of expertise: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfExpertise/{ExpertiseId}
Update an area of expertise: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfExpertise/{ExpertiseId}

Talent Person Profiles/Areas of Interest

The areasOfInterest resource is the child of the talentPersonProfiles resource. It provides the list of interests for a person.

Create an area of interest: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfInterest
Get all areas of interest: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfInterest
Get an area of interest: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfInterest/{InterestId}
Update an area of interest: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfInterest/{InterestId}

Talent Person Profiles/Attachments

The attachments resource is a child of talentPersonProfiles resource. It provides all the attachments for a worker profile.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}

Talent Person Profiles/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Talent Person Profiles/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Talent Person Profiles/Career Preference Items

The careerStatements resource includes the career statement associated with a person.

Create a career statement: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements
Get a career statement: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements/{CareerStatmentId}
Get all career statements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements
Update a career statement: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements/{CareerStatmentId}

Talent Person Profiles/Career Preference Items/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements/{CareerStatmentId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements/{CareerStatmentId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements/{CareerStatmentId}/enclosure/Description

Talent Person Profiles/Career Preference Sections

The careerPreferenceSections resource is the child of the talentPersonProfiles resource. It provides the list of secured career preference sections for a person.

Create a career preference section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections
Get a career preference section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}
Get all career preference sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections

Talent Person Profiles/Career Preference Sections/Career Preference Items

The careerPreferenceItems resource is the child of the careerPreferenceSections resource. It provides the list of career preference Items within a career preference section for a person.

Create a career preference item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems
Get a career preference item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}
Get all career preference items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems
Update a career preference item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}

Talent Person Profiles/Career Preference Sections/Career Preference Items/Certification Items Descriptive Flexfields

(Resource of careerPreferenceItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/child/careerPreferenceItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/child/careerPreferenceItemsDFF/{CareerPrefId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/child/careerPreferenceItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/child/careerPreferenceItemsDFF/{CareerPrefId}

Talent Person Profiles/Career Preference Sections/Career Preference Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/Comments

Talent Person Profiles/Career Preference Sections/Career Preference Items/Large Object (LOB) Attributes - PreferredJobDescr

Delete a PreferredJobDescr: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/PreferredJobDescr
Get a PreferredJobDescr: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/PreferredJobDescr
Replace a PreferredJobDescr: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/PreferredJobDescr

Talent Person Profiles/Careers of Interest

The careersOfInterest resource includes a list of all the careers of interest associated with a person.

Create a career of interest: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest
Delete a career of interest: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest/{CareerInterestId}
Get a career of interest: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest/{CareerInterestId}
Get all careers of interest: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest
Update a career of interest: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest/{CareerInterestId}

Talent Person Profiles/Certification Sections

The certificationSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured certification sections for a person.

Create a certification section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections
Get a certification section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}
Get all certification sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections

Talent Person Profiles/Certification Sections/Certification Items

The certificationItems resource is the child of the certificationSections resource. It provides the list of certification items within a certification section for a person.

Create a certification item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems
Delete a certification item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}
Get a certification item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}
Get all certification items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems
Update a certification item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}

Talent Person Profiles/Certification Sections/Certification Items/Certification Item Attachments

The certificationItemAttachments resource is a child of certificationItems resource. It provides all the attachments for the certification item.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}

Talent Person Profiles/Certification Sections/Certification Items/Certification Item Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}/enclosure/FileContents

Talent Person Profiles/Certification Sections/Certification Items/Certification Item Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}/enclosure/FileWebImage

Talent Person Profiles/Certification Sections/Certification Items/Certification Items Descriptive Flexfields

(Resource of certificationItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemsDFF/{CertificationId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemsDFF/{CertificationId2}

Talent Person Profiles/Certification Sections/Certification Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Comments

Talent Person Profiles/Certification Sections/Certification Items/Large Object (LOB) Attributes - Restrictions

Delete a Restrictions: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Restrictions
Get a Restrictions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Restrictions
Replace a Restrictions: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Restrictions

Talent Person Profiles/Competency Sections

The competencySections resource is the child of the talentPersonProfiles resource. It provides the list of the secured competency sections for a person.

Create a competency section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections
Get a competency section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}
Get all competency sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections

Talent Person Profiles/Competency Sections/All Competency Items

The allCompetencyItems resource is the child of the competencySections resource. It provides the list of distinct competency items within a competency section for a person profile.

Get a distinct competency item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/allCompetencyItems/{allCompetencyItemsUniqID}
Get all distinct competency items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/allCompetencyItems

Talent Person Profiles/Competency Sections/Competency Items

The competencyItems resource is the child of the competencySections resource. It provides the list of the competency items within a competency section for a person.

Create a competency item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems
Delete a competency item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}
Get a competency item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}
Get all competency items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems
Update a competency item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}

Talent Person Profiles/Competency Sections/Competency Items/Behavior Items

The behaviorItems resource is the child of the competencyItems resource. It provides the list of the behavior items related to a competency item for a competency section.

Create a behavior item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/behaviorItems
Delete a behavior item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/behaviorItems/{BehaviorId}
Get a behavior item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/behaviorItems/{BehaviorId}
Get all behavior items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/behaviorItems
Update a behavior item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/behaviorItems/{BehaviorId}

Talent Person Profiles/Competency Sections/Competency Items/Behavior Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/behaviorItems/{BehaviorId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/behaviorItems/{BehaviorId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/behaviorItems/{BehaviorId}/enclosure/Comments

Talent Person Profiles/Competency Sections/Competency Items/Competency Items Descriptive Flexfields

(Resource of competencyItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/competencyItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/competencyItemsDFF/{CompetencyId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/competencyItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/child/competencyItemsDFF/{CompetencyId2}

Talent Person Profiles/Competency Sections/Competency Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/enclosure/Comments

Talent Person Profiles/Competency Sections/Competency Items/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/enclosure/Description

Talent Person Profiles/Competency Sections/Competency Items/Large Object (LOB) Attributes - EvaluationComments

Delete an EvaluationComments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/enclosure/EvaluationComments
Get an EvaluationComments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/enclosure/EvaluationComments
Replace an EvaluationComments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{CompetencyId}/enclosure/EvaluationComments

Talent Person Profiles/Education Sections

The educationSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured education sections for a person.

Create an education section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections
Get all education sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections
Get an education section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}

Talent Person Profiles/Education Sections/Education Items

The educationItems resource is the child of the educationSections resource. It provides the list of the education items within an education section for a person.

Create an education item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems
Delete an education item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}
Get all education items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems
Get an education item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}
Update an education item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}

Talent Person Profiles/Education Sections/Education Items/Education Item Attachments

The educationItemAttachments resource is a child of educationItems resource. It provides all the attachments for the education item.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}

Talent Person Profiles/Education Sections/Education Items/Education Item Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}/enclosure/FileContents

Talent Person Profiles/Education Sections/Education Items/Education Item Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}/enclosure/FileWebImage

Talent Person Profiles/Education Sections/Education Items/Education Items Descriptive Flexfields

(Resource of educationItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemsDFF/{EducationId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemsDFF/{EducationId2}

Talent Person Profiles/Education Sections/Education Items/Large Object (LOB) Attributes - ActivitySummary

Delete an ActivitySummary: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/ActivitySummary
Get an ActivitySummary: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/ActivitySummary
Replace an ActivitySummary: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/ActivitySummary

Talent Person Profiles/Education Sections/Education Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Comments

Talent Person Profiles/Education Sections/Education Items/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Description

Talent Person Profiles/Education Sections/Education Items/Large Object (LOB) Attributes - Reimbursements

Delete a Reimbursements: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Reimbursements
Get a Reimbursements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Reimbursements
Replace a Reimbursements: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Reimbursements

Talent Person Profiles/Favorite Links

The favoriteLinks resource is the child of the talentPersonProfiles resource. It provides the favorite links for a person.

Create a favorite link: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/favoriteLinks
Delete a favorite link: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/favoriteLinks/{BookmarkId}
Get a favorite link: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/favoriteLinks/{BookmarkId}
Get all favorite links: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/favoriteLinks
Update a favorite link: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/favoriteLinks/{BookmarkId}

Talent Person Profiles/Honor Sections

The honorSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured honor sections for a person.

Create an honor section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections
Get all honor sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections
Get an honor section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}

Talent Person Profiles/Honor Sections/Honor Items

The honorItems resource is the child of the honorSections resource. It provides the list of honor items within an honor section for a person.

Create an honor item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems
Delete an honor item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}
Get all honor items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems
Get an honor item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}
Update an honor item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}

Talent Person Profiles/Honor Sections/Honor Items/Honor Item Attachments

The honorItemAttachments resource is a child of honorItems resource. It provides all the attachments for the honor item.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}

Talent Person Profiles/Honor Sections/Honor Items/Honor Item Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}/enclosure/FileContents

Talent Person Profiles/Honor Sections/Honor Items/Honor Item Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}/enclosure/FileWebImage

Talent Person Profiles/Honor Sections/Honor Items/Honor Items Descriptive Flexfields

(Resource of honorItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemsDFF/{HonorId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemsDFF/{HonorId2}

Talent Person Profiles/Honor Sections/Honor Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Comments

Talent Person Profiles/Honor Sections/Honor Items/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Description

Talent Person Profiles/Language Sections

The languageSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured language sections for a person.

Create a language section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections
Get a language section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}
Get all language sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections

Talent Person Profiles/Language Sections/Language Items

The languageItems resource is the child of the languageSections resource. It provides the list of the language items within a language section for a person.

Create a language item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems
Delete a language item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems/{LanguageId}
Get a language item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems/{LanguageId}
Get all language items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems
Update a language item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems/{LanguageId}

Talent Person Profiles/Language Sections/Language Items/Language Items Descriptive Flexfields

(Resource of languageItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems/{LanguageId}/child/languageItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems/{LanguageId}/child/languageItemsDFF/{LanguageId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems/{LanguageId}/child/languageItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems/{LanguageId}/child/languageItemsDFF/{LanguageId2}

Talent Person Profiles/Language Sections/Language Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems/{LanguageId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems/{LanguageId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId}/child/languageItems/{LanguageId}/enclosure/Comments

Talent Person Profiles/Membership Sections

The membershipSections resource is the child of the talentPersonProfiles resource. It provides the list of secured membership sections for a person.

Create a membership section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections
Get a membership section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}
Get all membership sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections

Talent Person Profiles/Membership Sections/Membership Items

The membershipItems resource is the child of the membershipSections resource. It provides the list of the membership items within a membership section for a person.

Create a membership item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems
Delete a membership item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}
Get a membership item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}
Get all membership items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems
Update a membership item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}

Talent Person Profiles/Membership Sections/Membership Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}/enclosure/Comments

Talent Person Profiles/Membership Sections/Membership Items/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}/enclosure/Description

Talent Person Profiles/Membership Sections/Membership Items/Membership Items Descriptive Flexfields

(Resource of membershipItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}/child/membershipItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}/child/membershipItemsDFF/{MembershipId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}/child/membershipItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId}/child/membershipItems/{MembershipId}/child/membershipItemsDFF/{MembershipId2}

Talent Person Profiles/Public Skills

The publicSkills resource is the child of the talentPersonProfiles resource. It provides a list of the skill items for the skill content subscribed by the skill center. This resource is currently under controlled availability.

Create a public skill: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills
Delete a public skill: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}
Get a public skill: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}
Get all public skills: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills
Send an endorsement request: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/action/sendEndorsementRequests
Update a public skill: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}

Talent Person Profiles/Public Skills/Endorsements

The endorsements resource is a child of public skills resource. It provides a list of all endorsements for worker's public skills. This resource is currently under controlled availability.

Create an endorsement: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/child/endorsements
Delete an endorsement: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/child/endorsements/{EndorsementId}
Get all endorsements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/child/endorsements
Get an endorsement: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/child/endorsements/{EndorsementId}
Update an endorsement: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/child/endorsements/{EndorsementId}

Talent Person Profiles/Skill Sections

The skillSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured skill sections for a person.

Create a skill section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections
Get a skill section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId}
Get all skill sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections

Talent Person Profiles/Skill Sections/Skill Items

The skillItemsresource is the child of the skillSections resource. It provides the list of the skill items within a skill section for a person.

Create a skill item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId}/child/skillItems
Delete a skill item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}
Get a skill item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}
Get all skill items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId}/child/skillItems
Update a skill item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}

Talent Person Profiles/Skill Sections/Skill Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}/enclosure/Comments

Talent Person Profiles/Skill Sections/Skill Items/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}/enclosure/Description

Talent Person Profiles/Skill Sections/Skill Items/Skill Items Descriptive Flexfields

(Resource of skillItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}/child/skillItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}/child/skillItemsDFF/{SkillId3}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}/child/skillItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId9}/child/skillItems/{SkillId}/child/skillItemsDFF/{SkillId3}

Talent Person Profiles/Special Project Sections

The specialProjectSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured special project sections for a person.

Create a special project section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections
Get a special project section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}
Get all special project sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections

Talent Person Profiles/Special Project Sections/Special Project Items

The specialProjectItems resource is the child of the specialProjectSections resource. It provides the list of the special project items within a special project section for a person.

Create a special project item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems
Delete a special project item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}
Get a special project item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}
Get all special project items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems
Update a special project item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}

Talent Person Profiles/Special Project Sections/Special Project Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}/enclosure/Comments

Talent Person Profiles/Special Project Sections/Special Project Items/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}/enclosure/Description

Talent Person Profiles/Special Project Sections/Special Project Items/Special Project Items Descriptive Flexfields

(Resource of specialProjectItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}/child/specialProjectItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}/child/specialProjectItemsDFF/{ProjectId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}/child/specialProjectItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId10}/child/specialProjectItems/{ProjectId}/child/specialProjectItemsDFF/{ProjectId2}

Talent Person Profiles/Tags

The tags resource is the child of the talentPersonProfiles resource. It provides the list of the tags associated with a person profile.

Create a tag: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/tags
Delete a tag: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/tags/{TagId}
Get a tag: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/tags/{TagId}
Get all tags: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/tags
Update a tag: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/tags/{TagId}

Talent Person Profiles/Work History Sections

The workHistorySections resource is the child of the talentPersonProfiles resource. It provides the list of the secured work history sections for a person.

Create a work history section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections
Get all work history sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections
Get work history section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}

Talent Person Profiles/Work History Sections/Work History Items

The workHistoryItems resource is the child of the workHistorySections resource. It provides the list of the work history items within a work history section for a person.

Create a work history item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems
Delete a work history item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}
Get all work history items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems
Get work history item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}
Update a work history item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}

Talent Person Profiles/Work History Sections/Work History Items/Large Object (LOB) Attributes - Achievements

Delete an Achievements: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Achievements
Get an Achievements: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Achievements
Replace an Achievements: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Achievements

Talent Person Profiles/Work History Sections/Work History Items/Large Object (LOB) Attributes - AdditionalInformation

Delete an AdditionalInformation: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/AdditionalInformation
Get an AdditionalInformation: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/AdditionalInformation
Replace an AdditionalInformation: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/AdditionalInformation

Talent Person Profiles/Work History Sections/Work History Items/Large Object (LOB) Attributes - ReasonforLeaving

Delete a ReasonforLeaving: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/ReasonforLeaving
Get a ReasonforLeaving: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/ReasonforLeaving
Replace a ReasonforLeaving: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/ReasonforLeaving

Talent Person Profiles/Work History Sections/Work History Items/Large Object (LOB) Attributes - Responsibilities

Delete a Responsibilities: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Responsibilities
Get a Responsibilities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Responsibilities
Replace a Responsibilities: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Responsibilities

Talent Person Profiles/Work History Sections/Work History Items/Work History Items Descriptive Flexfields

(Resource of workHistoryItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/child/workHistoryItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/child/workHistoryItemsDFF/{PrevEmploymentId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/child/workHistoryItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId11}/child/workHistoryItems/{workHistoryItemsUniqID}/child/workHistoryItemsDFF/{PrevEmploymentId}

Talent Person Profiles/Work Preference Sections

The workPreferenceSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured work preference sections for a person.

Create a work preference section: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections
Get a work preference section: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}
Get all work preference sections: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections

Talent Person Profiles/Work Preference Sections/Work Preference Items

The workPreferenceItems resource is the child of the workPreferenceSections resource. It provides the list of the work preference items within a work preference section for a person.

Create a work preference item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems
Get a work preference item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}
Get all work preference items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems
Update a work preference item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}

Talent Person Profiles/Work Preference Sections/Work Preference Items/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/enclosure/Comments

Talent Person Profiles/Work Preference Sections/Work Preference Items/Work Preference Items Descriptive Flexfields

(Resource of workPreferenceItemsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/child/workPreferenceItemsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/child/workPreferenceItemsDFF/{WorkPrefId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/child/workPreferenceItemsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/child/workPreferenceItemsDFF/{WorkPrefId}

Talent Ratings

The talentRatings resource is the top-level resource that provides talent rating data for a person profile.

Get a talent rating: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}
Get all talent ratings: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings

Talent Ratings/Advancement Readiness

The advancementReadiness resource is the child of the talentRatings resource and helps to manage an employees readiness for the next position in their career development.

Create an advancement readiness item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness
Delete an advancement readiness item: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}
Get a advancement readiness item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}
Get all advancement readiness items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness
Update an advancement readiness item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}

Talent Ratings/Advancement Readiness/Advancement Readiness Descriptive Flexfields

(Resource of advancementReadinessDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/child/advancementReadinessDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/child/advancementReadinessDFF/{AdvReadinessId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/child/advancementReadinessDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/child/advancementReadinessDFF/{AdvReadinessId}

Talent Ratings/Advancement Readiness/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/enclosure/Comments

Talent Ratings/Career Potential

The careerPotential resource is the child of the talentRatings resource. It evaluates the career potential of a person.

Create a career potential rating item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential
Get a career potential rating item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}
Get all career potential rating items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential
Update a career potential rating item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}

Talent Ratings/Career Potential/Career Potential Descriptive Flexfields

(Resource of careerPotentialsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/child/careerPotentialsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/child/careerPotentialsDFF/{CareerPotentialId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/child/careerPotentialsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/child/careerPotentialsDFF/{CareerPotentialId2}

Talent Ratings/Career Potential/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/enclosure/Comments

Talent Ratings/Impact of Losses

The impactOfLosses resource is the child of the talentRatings resource. It evaluates the impact of the loss of a person.

Create an impact of loss rating item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses
Get all impact of loss rating items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses
Get an impact of loss rating item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}
Update an impact of loss rating item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}

Talent Ratings/Impact of Losses/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}/enclosure/Comments

Talent Ratings/N Box Cell Assignments

The nBoxCellAssignments resource is the child of the talentRatings resource. It evaluates the nBox cell assignment of a person.

Get all nBox cell assignments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/nBoxCellAssignments
Get an nBox cell assignment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/nBoxCellAssignments/{NBoxAssignmentId}

Talent Ratings/Performance Ratings

The performanceRatings resource is the child of the talentRatings resource. It evaluates the performance of a person.

Create a performance rating item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings
Get a performance rating item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}
Get all performance rating items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings
Update a performance rating item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}

Talent Ratings/Performance Ratings/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/enclosure/Comments

Talent Ratings/Performance Ratings/Performance Rating Descriptive Flexfields

(Resource of performanceRatingsDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/child/performanceRatingsDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/child/performanceRatingsDFF/{PerfRatingId}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/child/performanceRatingsDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/child/performanceRatingsDFF/{PerfRatingId}

Talent Ratings/Risk of Losses

The riskOfLosses resource is the child of the talentRatings resource. It evaluates the risk of loss of a person.

Create a risk of loss rating item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses
Get a risk of loss rating item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}
Get all risks of loss rating items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses
Update a risk of loss rating item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}

Talent Ratings/Risk of Losses/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/enclosure/Comments

Talent Ratings/Risk of Losses/Risk of Losses Descriptive Flexfields

(Resource of riskOfLossesDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/child/riskOfLossesDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/child/riskOfLossesDFF/{RiskOfLossId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/child/riskOfLossesDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/child/riskOfLossesDFF/{RiskOfLossId2}

Talent Ratings/Talent Scores

The talentScores resource is the child of the talentRatings resource. It evaluates the talent score of a person.

Create a talent score rating item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores
Get a talent score rating item: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}
Get all talent score rating items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores
Update a talent score rating item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}

Talent Ratings/Talent Scores/Large Object (LOB) Attributes - Comments

Delete a Comments: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/enclosure/Comments
Get a Comments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/enclosure/Comments
Replace a Comments: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/enclosure/Comments

Talent Ratings/Talent Scores/Talent Score Descriptive Flexfields

(Resource of talentScoresDFF)

Create: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/child/talentScoresDFF
Get: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/child/talentScoresDFF/{TalentScoreId2}
Get all: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/child/talentScoresDFF
Update: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/child/talentScoresDFF/{TalentScoreId2}

Talent Ratings/User Defined Rating Sections

The userDefinedRatingSections resource is the child of the talentRatings resource. It provides the list of user-defined talent rating sections associated with a person profile.

Create a custom talent rating section for a profile: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections
Get a custom talent rating section for a profile: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}
Get all custom talent rating sections for a profile: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections

Talent Ratings/User Defined Rating Sections/User Defined Ratings

The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.

Create a custom talent rating item: Method: post
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings
Get a custom talent rating item for a profile: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings/{RatingId}
Get all custom talent rating items: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings
Update a custom talent rating item: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings/{RatingId}

Talent Ratings/User Defined Rating Sections/User Defined Ratings/Large Object (LOB) Attributes - Description

Delete a Description: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings/{RatingId}/enclosure/Description
Get a Description: Method: get
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings/{RatingId}/enclosure/Description
Replace a Description: Method: put
Path: /hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings/{RatingId}/enclosure/Description

Target Date Migrations

The targetDateMigrations resource allows the application to add configuration values (Target Dates) to the configuration table.

Create a target date migration: Method: post
Path: /hcmRestApi/resources/11.13.18.05/targetDateMigrations
Get a target date migration: Method: get
Path: /hcmRestApi/resources/11.13.18.05/targetDateMigrations/{ConfigId}
Get all target date migrations: Method: get
Path: /hcmRestApi/resources/11.13.18.05/targetDateMigrations
Update a target date migration: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/targetDateMigrations/{ConfigId}

Tasks

The tasks resource includes information about Oracle HCM Cloud tasks. It provides contextual and transactional information for the task and links to applicable additional information.

Get a task: Method: get
Path: /hcmRestApi/resources/11.13.18.05/tasks/{IdentificationKey}
Get all tasks: Method: get
Path: /hcmRestApi/resources/11.13.18.05/tasks

Tasks/Changed Attributes

The changedAttributes resource is a child of the tasks resource. It includes attribute values that changed as a result of the transaction.

Get a changed attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/tasks/{IdentificationKey}/child/changedAttributes/{changedAttributesUniqID}
Get all changed attributes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/tasks/{IdentificationKey}/child/changedAttributes

Time Attribute Values

The timeAttributeValues resource retrieves the list of time attribute values that the time events, time records or schedule REST services can use.

Get a time attribute value: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeAttributeValues/{value}
Get all time attribute values: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeAttributeValues

Time Attributes

The timeAttributes resource retrieves the list of time attributes that the time events, time records, or schedule REST services can handle.

Get a time attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeAttributes/{timeAttributesUniqID}
Get all time attributes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeAttributes

Time Attributes/Data Source Usages

The dataSourceUsages resource is a child of the time attributes resource. It retrieves the data source usage details based on the time attribute field identifier, that is further used to get the time attribute values.

Get all data sources associated with the time attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeAttributes/{timeAttributesUniqID}/child/dataSourceUsages
Get the data source associated with the time attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeAttributes/{timeAttributesUniqID}/child/dataSourceUsages/{dataSourceUsageId}

Time Attributes/Data Source Usages/Data Source Criteria Binds

(Resource of dataSourceCriteriaBinds)

Get all data source criteria binds: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeAttributes/{timeAttributesUniqID}/child/dataSourceUsages/{dataSourceUsageId}/child/dataSourceCriteriaBinds
Get the data source criterion bind: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeAttributes/{timeAttributesUniqID}/child/dataSourceUsages/{dataSourceUsageId}/child/dataSourceCriteriaBinds/{dataSourceCriteriaBindsUniqID}

Time Event Requests

The timeEventRequests resource is a unique identifier for the time event request sent by the time collection device supplier. This request can contain one or more time events.

Create a time event request: Method: post
Path: /hcmRestApi/resources/11.13.18.05/timeEventRequests
Get a time event request: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}
Get all time event requests: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeEventRequests

Time Event Requests/Time Events

The timeEvents resource is a child of the time event requests resource. It is a single In or Out time transaction that the time reporter records on a time collection device.

Create a time event: Method: post
Path: /hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents
Get a time event: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents/{timeEventId}
Get all time events: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents

Time Event Requests/Time Events/Time Event Attributes

The timeEventAttributes resource is a child of the time events resource, and hence the child of child of the time events requests resource. It is a qualifier associated with the time event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the payroll time type attribute indicates if the time for payroll consumers must be paid.

Create a time event attribute: Method: post
Path: /hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents/{timeEventId}/child/timeEventAttributes
Get a time event attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents/{timeEventId}/child/timeEventAttributes/{timeEventAttributeId}
Get all time event attributes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents/{timeEventId}/child/timeEventAttributes

Time Layout Sets

The timeLayoutSets resource retrieves the list of existing time layout sets

Get a time layout set: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}
Get all time layout sets: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeLayoutSets

Time Layout Sets/Web Clock Layouts

The webClockLayouts resource retrieves the web clock layout details based on the time layout set identifier

Get a web clock layout: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}
Get all web clock layouts for a time layout set: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts

Time Layout Sets/Web Clock Layouts/Buttons

(Resource of buttons)

Get a web clock button: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons/{buttonId}
Get all buttons for a web clock layout: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons

Time Layout Sets/Web Clock Layouts/Buttons/Time Attributes

(Resource of timeAttributes)

Get a time attribute for a button: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons/{buttonId}/child/timeAttributes/{attributeId}
Get all time attributes for a button: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons/{buttonId}/child/timeAttributes

Time Layout Sets/Web Clock Layouts/Buttons/Time Card Fields

(Resource of timeCardFields)

Get a time card field for a button: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons/{buttonId}/child/timeCardFields/{timeCardFieldId}
Get all time card fields for a button: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons/{buttonId}/child/timeCardFields

Time Record Event Requests

The timeRecordEventRequests resource is a unique identifier for the time record event request sent using the time records REST API. This request can contain one or more time record events.

Create a time record event request: Method: post
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests
Get a time record event request: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}
Get all time record event requests: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests
Identify a time card as favorite: Method: post
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/action/createFavorite
Stop identifying a time card as favorite: Method: post
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/action/deleteFavorite

Time Record Event Requests/Time Record Events

The timeRecordEvents resource is a child of the time record event requests resource. It's a unique identifier of a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed.

Create a time record event: Method: post
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent
Get a time record event: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}
Get all time record events: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent

Time Record Event Requests/Time Record Events/Time Record Event Attributes

(Resource of timeRecordEventAttribute)

Create a time record event attribute: Method: post
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventAttribute
Get a time record event attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventAttribute/{timeRecordEventAttributeId}
Get all time record event attributes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventAttribute

Time Record Event Requests/Time Record Events/Time Record Event Messages

(Resource of timeRecordEventMessage)

Create a time record event message: Method: post
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventMessage
Get a time record event message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventMessage/{timeRecordEventMessageId}
Get all time record event messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventMessage

Time Record Groups

The timeRecordGroups resource is a unique identifier for the time record group sent using the time records REST API. A time record group can contain one or more time records.

Get a time record group: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}
Get all time record groups: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups

Time Record Groups/Time Attributes

The timeAttributes resource is a child of the time record groups resource. It is a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.

Get a time record group attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeAttributes/{attributeId}
Get all time record group attributes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeAttributes

Time Record Groups/Time Messages

The timeMessages resource is a child of the time record groups resource. It is a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.

Get a time record group message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeMessages/{messageId}
Get all time record group messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeMessages

Time Record Groups/Time Messages/Time Message Tokens

(Resource of timeMessageTokens)

Get a time record group message token: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeMessages/{messageId}/child/timeMessageTokens/{messageTokenId}
Get all time record group message tokens: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeMessages/{messageId}/child/timeMessageTokens

Time Record Groups/Time Record Groups

(Resource of timeRecordGroups)

Get a time record group: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}
Get all time record groups: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups

Time Record Groups/Time Record Groups/Time Attributes

Get a time record group attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeAttributes/{attributeId}
Get all time record group attributes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeAttributes

Time Record Groups/Time Record Groups/Time Messages

Get a time record group message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeMessages/{timeRecordGroups_messageId}
Get all time record group messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeMessages

Time Record Groups/Time Record Groups/Time Messages/Time Message Tokens

(Resource of timeMessageTokens)

Get a time record group message token: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeMessages/{timeRecordGroups_messageId}/child/timeMessageTokens/{messageTokenId}
Get all time record group message tokens: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeMessages/{timeRecordGroups_messageId}/child/timeMessageTokens

Time Record Groups/Time Record Groups/Time Record Groups

(Resource of timeRecordGroups)

Get a time record group: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroups_timeRecordGroupId}
Get all time record groups: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecordGroups

Time Record Groups/Time Record Groups/Time Records

The timeRecords resource is a child of the time record groups resource. It is a unique identifier for the time record sent using the time records REST API. It corresponds to either a range expressed as start and stop times or a quantity in hours or units, along with any associated attribution that details the kind of work performed.

Get a time record: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}
Get all time records: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords

Time Record Groups/Time Record Groups/Time Records/Time Attributes

(Resource of timeAttributes)

Get a time record group attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeAttributes/{attributeId}
Get all time record group attributes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeAttributes

Time Record Groups/Time Record Groups/Time Records/Time Messages

(Resource of timeMessages)

Get a time record group message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeMessages/{messageId}
Get all time record group messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeMessages

Time Record Groups/Time Record Groups/Time Records/Time Messages/Time Message Tokens

(Resource of timeMessageTokens)

Get a time record group message token: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeMessages/{messageId3}/child/timeMessageTokens/{messageTokenId}
Get all time record group message tokens: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeMessages/{messageId}/child/timeMessageTokens

Time Record Groups/Time Record Groups/Time Records/Time Statuses

(Resource of timeStatuses)

Get a time record group status: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeStatuses/{statusId}
Get all time record group statuses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeStatuses

Time Record Groups/Time Record Groups/Time Statuses

The timeStatuses resource is a child of the time record groups resource. It is a unique identifier for the status of the time record group sent using the time records REST API.

Get a time record group status: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeStatuses/{timeRecordGroups_statusId4}
Get all time record group statuses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeStatuses

Time Record Groups/Time Records

Get a time record: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId}
Get all time records: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords

Time Record Groups/Time Records/Time Attributes

(Resource of timeAttributes)

Get a time record group attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeAttributes/{attributeId}
Get all time record group attributes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeAttributes

Time Record Groups/Time Records/Time Messages

(Resource of timeMessages)

Get a time record group message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeMessages/{messageId}
Get all time record group messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeMessages

Time Record Groups/Time Records/Time Messages/Time Message Tokens

(Resource of timeMessageTokens)

Get a time record group message token: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeMessages/{messageId4}/child/timeMessageTokens/{messageTokenId}
Get all time record group message tokens: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeMessages/{messageId}/child/timeMessageTokens

Time Record Groups/Time Records/Time Statuses

(Resource of timeStatuses)

Get a time record group status: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeStatuses/{statusId}
Get all time record group statuses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeStatuses

Time Record Groups/Time Statuses

The timeStatuses resource is a child of the time record groups resource. It is a unique identifier for the status of the time record group sent using the time records REST API.

Get a time record group status: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeStatuses/{statusId}
Get all time record group statuses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeStatuses

Time Records

The timeRecords resource is a unique identifier for the time record sent using the time records REST API. It corresponds to either a range expressed as start and stop times or a quantity in hours or units, along with any associated attribution that details the kind of work performed.

Get a time record: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}
Get all time records: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecords

Time Records/Time Attributes

The timeAttributes resource is a child of the time records resource. It is a qualifier associated with the time record that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the payroll time type attribute indicates if the time for payroll consumers must be paid.

Get a time record attribute: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeAttributes/{attributeId}
Get all time record attributes: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeAttributes

Time Records/Time Messages

The timeMessages resource is a child of the time records resource. It is a unique identifier for the message associated with the time record. A message gives some information on the time record resulting from rules or validations.

Get a time record message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeMessages/{messageId}
Get all time record messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeMessages

Time Records/Time Messages/Time Message Tokens

(Resource of timeMessageTokens)

Get a time record message token: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeMessages/{messageId}/child/timeMessageTokens/{messageTokenId}
Get all time record message tokens: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeMessages/{messageId}/child/timeMessageTokens

Time Records/Time Statuses

The timeStatuses resource is a child of the time records resource. It is a unique identifier for the status of the time record sent using the time records REST API.

Get a time record status: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeStatuses/{statusId}
Get all time record statuses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeStatuses

Tracking Services

The trackingServices resource includes all external services that provide wellness-related information to the product. You can retrieve existing tracking services or create new services using this resource.

Create a tracking service: Method: post
Path: /hcmRestApi/resources/11.13.18.05/trackingServices
Delete a tracking service: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}
Get a tracking service: Method: get
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}
Get all tracking services: Method: get
Path: /hcmRestApi/resources/11.13.18.05/trackingServices
Update a tracking service: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}

Tracking Services/Authorization Artifacts

The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.

Delete an authorization artifact: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts/{authArtifactsUniqID}
Get all authorization artifacts: Method: get
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts
Get an authorization artifact: Method: get
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts/{authArtifactsUniqID}

Tracking Services/Authorization Artifacts/Large Object (LOB) Attributes - Artifacts

Delete an Artifacts: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts/{authArtifactsUniqID}/enclosure/Artifacts
Get an Artifacts: Method: get
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts/{authArtifactsUniqID}/enclosure/Artifacts
Replace an Artifacts: Method: put
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts/{authArtifactsUniqID}/enclosure/Artifacts

Tracking Services/Large Object (LOB) Attributes - ProtocolParams

Delete a ProtocolParams: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/enclosure/ProtocolParams
Get a ProtocolParams: Method: get
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/enclosure/ProtocolParams
Replace a ProtocolParams: Method: put
Path: /hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/enclosure/ProtocolParams

User Accounts

The userAccounts resource includes all the user accounts as of the specified date. By default, the current date is retained.

Create a user account: Method: post
Path: /hcmRestApi/resources/11.13.18.05/userAccounts
Delete a user account: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}
Get a user account: Method: get
Path: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}
Get all user accounts: Method: get
Path: /hcmRestApi/resources/11.13.18.05/userAccounts
Reset a user account password: Method: post
Path: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/action/resetPassword
Trigger roles autoprovisioning process: Method: post
Path: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/action/autoprovisionRoles
Update a user account: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}
Update a user account password: Method: post
Path: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/action/updatePassword

User Accounts/User Account Roles

The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.

Create a role assignment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/child/userAccountRoles
Delete a role assignment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/child/userAccountRoles/{UserRoleId}
Get a role assignment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/child/userAccountRoles/{UserRoleId}
Get all role assignments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/child/userAccountRoles

Web Clock Events

The webClockEvents resource provides the ability to create and view web clock events for employees.

Create a web clock event: Method: post
Path: /hcmRestApi/resources/11.13.18.05/webClockEvents
Get a web clock event: Method: get
Path: /hcmRestApi/resources/11.13.18.05/webClockEvents/{webClockClickId}
Get all web clock events: Method: get
Path: /hcmRestApi/resources/11.13.18.05/webClockEvents

Web Clock Events/Time Card Fields

The timeCardFields resource is a child of the webClockEvents resource, used to create and view the time card fields for a web clock event.

Create a time card field: Method: post
Path: /hcmRestApi/resources/11.13.18.05/webClockEvents/{webClockClickId}/child/timeCardFields
Get a time card field: Method: get
Path: /hcmRestApi/resources/11.13.18.05/webClockEvents/{webClockClickId}/child/timeCardFields/{timeCardFieldsUniqID}
Get all time card fields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/webClockEvents/{webClockClickId}/child/timeCardFields

Wellness Activities

The wellnessActivities resource includes activities that improve physical well-being. Currently, only daily activity summaries can be added using the REST API.

Create a wellness activity: Method: post
Path: /hcmRestApi/resources/11.13.18.05/wellnessActivities
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/wellnessActivities
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/wellnessActivities/{wellnessActivitiesUniqID}

Wellness Activities/Activity Measures

The activityMeasures resource is a child of the wellnessActivities resource. It includes measures to track fitness activities. For example, a daily activity summary includes a value for the number of steps equivalent to the activities recorded for that day, as well as the time spent at low, moderate, and high activity levels.

Create an activity measure: Method: post
Path: /hcmRestApi/resources/11.13.18.05/wellnessActivities/{wellnessActivitiesUniqID}/child/activitymeasures
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/wellnessActivities/{wellnessActivitiesUniqID}/child/activitymeasures
GET action not supported: Method: get
Path: /hcmRestApi/resources/11.13.18.05/wellnessActivities/{wellnessActivitiesUniqID}/child/activitymeasures/{activitymeasuresUniqID}

Workers

The workers resource provides all the worker records as of the specified date. Worker types include employee, contingent worker, and pending worker. By default, the current date is retained. Operations to create and update worker records in Oracle Fusion Cloud HCM involve various post-processing steps across products. Therefore, these operations may take several minutes to complete. For bulk load and extract operations, you must use HCM Data Loader (HDL) and HCM Extracts, respectively. Also, you shouldn't use REST APIs for detecting data changes in the application. Instead, use Atom feeds to detect or identify changes made to data for key transactions in Oracle Fusion Cloud HCM. For example, you may use Atom feeds to detect changes in employee's personal details, employment data, new hires, and terminations. See the Atom Feeds section for details about delivered feeds in Oracle Fusion Cloud HCM.

Create a worker: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers
Get a worker: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}
Get all workers: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers
Update a worker: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}

Workers/Addresses

The addresses resource is a child of the workers resource. It provides all the addresses of a worker as of the specified date. By default, the current date is retained.

Create a worker address: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses
Delete a worker address: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}
Get a worker address: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}
Get all worker addresses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses
Update a worker address: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}

Workers/Addresses/Address Descriptive Flexfields

The addressesDFF resource is a child of the addresses resource. It provides all the address descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF/{addressesDFFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF/{addressesDFFUniqID}

Workers/Citizenships

The citizenships resource is a child of the workers resource. It provides all the citizenships of a worker as of the specified date. By default, the current date is retained.

Create a worker citizenship: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships
Delete a worker citizenship: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}
Get a worker citizenship: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}
Get all worker citizenships: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships
Update a worker citizenship: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}

Workers/Citizenships/Citizenship Descriptive Flexfields

The citizenshipsDFF resource is a child of the citizenships resource. It provides all the citizenship descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF/{CitizenshipId2}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF/{CitizenshipId2}

Workers/Disabilities

The disabilities resource is a child of the workers resource. It provides all the worker disabilities as of the specified date. By default, the current date is retained.

Create a worker disability: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities
Delete a worker disability: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}
Get a worker disability: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}
Get all worker disabilities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities
Update a worker disability: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}

Workers/Disabilities/Attachments

The attachments resource is a child of disabilities resource. It provides all the attachments for a worker disability.

Create an attachment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments
Delete an attachment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}
Get all attachments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments
Get an attachment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}
Update an attachment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}

Workers/Disabilities/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Workers/Disabilities/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Workers/Disabilities/Disabilities Developer Flexfields

The disabilitesDFF resource is a child of the disablities resource. It provides all the disablities developer flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/disabilitiesDDF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/disabilitiesDDF/{disabilitiesDDFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/disabilitiesDDF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/disabilitiesDDF/{disabilitiesDDFUniqID}

Workers/Driver Licenses

The driverLicenses resource is a child of the workers resource. It provides all the driver licenses of a worker as of the specified date. By default, the current date is retained.

Create a worker drivers license: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses
Delete a worker drivers license: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}
Get a worker drivers license: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}
Get all worker drivers licenses: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses
Update a worker drivers license: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}

Workers/Driver Licenses/Driver License Descriptive Flexfields

The driverLicensesDFF resource is a child of the driverLicenses resource. It provides all the driver license descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF/{DriversLicenseTypeId}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF/{DriversLicenseTypeId}

Workers/Driver Licenses/Driver License Developer Flexfields

The driverLicensesDDF resource is a child of the driverLicenses resource. It provides all the driver license developer flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF/{DriversLicenseId}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF/{DriversLicenseId}

Workers/Emails

The emails resource is a child of the workers resource. It provides all the emails of a worker as of the specified date. By default, the current date is retained.

Create a worker email: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails
Delete a worker email: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}
Get a worker email: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}
Get all worker emails: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails
Update a worker email: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}

Workers/Emails/Email Descriptive Flexfields

The emailsDFF resource is a child of the emails resource. It provides all the email descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}/child/emailsDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}/child/emailsDFF/{EmailAddressId2}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}/child/emailsDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}/child/emailsDFF/{EmailAddressId2}

Workers/Ethnicities

The ethnicities resource is a child of the workers resource. It provides all the ethnicities of a worker as of the specified date. By default, the current date is retained.

Create a worker ethnicity: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities
Delete a worker ethnicity: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}
Get a worker ethnicity: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}
Get all worker ethnicities: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities
Update a worker ethnicity: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}

Workers/Ethnicities/Ethnicity Descriptive Flexfields

The ethnicitiesDFF resource is a child of the ethnicities resource. It provides all the ethnicity descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF/{EthnicityId2}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF/{EthnicityId2}

Workers/External Identifiers

The externalIdentifiers resource is a child of the workers resource. It provides all the external identifiers of a worker as of the specified date. By default, the current date is retained.

Create a worker external identifier: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers
Delete a worker external identifier: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers/{ExternalIdentifierId}
Get a worker external identifier: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers/{ExternalIdentifierId}
Get all worker external identifiers: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers
Update a worker external identifier: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers/{ExternalIdentifierId}

Workers/Legislative Information

The legislativeInfo resource is a child of the workers resource. It provides the legislative information of a worker as of the specified date. By default, the current date is retained.

Create a worker legislative record: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo
Delete a worker legislative record: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
Get a worker legislative record: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
Get all worker legislative records: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo
Update a worker legislative record: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}

Workers/Legislative Information/Legislative Information Descriptive Flexfields

The legislativeInfoDFF resource is a child of the legislativeInfo resource. It provides all the legislative informaton descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF/{legislativeInfoDFFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF/{legislativeInfoDFFUniqID}

Workers/Legislative Information/Legislative Information Developer Flexfields

The legislativeInfoDDF resource is a child of the legislativeInfo resource. It provides all the legislative informaton developer flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF/{legislativeInfoDDFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF/{legislativeInfoDDFUniqID}

Workers/Messages

The messages resource is a child of the workers resource. It provides all the available messages of a worker.

Create a worker message: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/messages
Delete a worker message: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/messages/{MessageId}
Get a worker message: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/messages/{MessageId}
Get all worker messages: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/messages
Update a worker message: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/messages/{MessageId}

Workers/Names

The names resource is a child of the workers resource. It provides all the names of a worker as of the specified date. By default, the current date is retained.

Create a worker name: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names
Delete a worker name: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names/{namesUniqID}
Get a worker name: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names/{namesUniqID}
Get all worker names: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names
Update a worker name: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names/{namesUniqID}

Workers/National Identifiers

The nationalIdentifiers resource is a child of the workers resource. It provides all the national identifiers of a worker as of the specified date. By default, the current date is retained.

Create a worker national identifier: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers
Delete a worker national identifier: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
Get a worker national identifier: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
Get all worker national identifiers: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers
Update a worker national identifier: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}

Workers/National Identifiers/National Identifier Descriptive Flexfields

The nationalIdentifiersDFF resource is a child of the nationalIdentifiers resource. It provides all the national identifier descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF/{NationalIdentifierId2}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF/{NationalIdentifierId2}

Workers/Other Communication Accounts

The otherCommunicationAccounts resource is a child of the workers resource. It provides all the other communication accounts of a worker as of the specified date. By default, the current date is retained.

Create a worker communication account: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts
Delete a worker communication account: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
Get a worker communication account: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
Get all worker communication accounts: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts
Update a worker communication account: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}

Workers/Other Communication Accounts/Other Communication Account Descriptive Flexfields

The otherCommunicationAccountsDFF resource is a child of the workers resource. It provides all the descriptive flexfields for other communication accounts of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF/{DeliveryMethodId2}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF/{DeliveryMethodId2}

Workers/Passports

The passports resource is a child of the workers resource. It provides all worker of a worker as of the specified date. By default, the current date is retained.

Create a worker passport: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports
Delete a worker passport: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}
Get a worker passport: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}
Get all worker passports: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports
Update a worker passport: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}

Workers/Passports/Passport Descriptive Flexfields

The passportsDFF resource is a child of the passports resource. It provides all the passport descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}/child/passportsDDF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}/child/passportsDDF/{PassportId2}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}/child/passportsDDF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}/child/passportsDDF/{PassportId2}

Workers/Phones

The phones resource is a child of the workers resource. It provides all the phones of a worker as of the specified date. By default, the current date is retained.

Create a worker phone: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones
Delete a worker phone: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}
Get a worker phone: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}
Get all worker phones: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones
Update a worker phone: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}

Workers/Phones/Phone Descriptive Flexfields

The phonesDFF resource is a child of the phones resource. It provides all the phone descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}/child/phonesDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}/child/phonesDFF/{PhoneId2}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}/child/phonesDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}/child/phonesDFF/{PhoneId2}

Workers/Photos

The photo resource is a child of the workers resource. It provides the all photos of a worker as of the specified date. By default, the current date is retained.

Create a worker photo: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos
Delete a worker photo: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}
Get a worker photo: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}
Get all worker photos: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos
Update a worker photo: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}

Workers/Photos/Large Object (LOB) Attributes - Photo

Delete a Photo: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/enclosure/Photo
Get a Photo: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/enclosure/Photo
Replace a Photo: Method: put
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/enclosure/Photo

Workers/Photos/Photo Descriptive Flexfields

The photosDFF resource is a child of the photos resource. It provides all the photo descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/child/photosDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/child/photosDFF/{ImageId}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/child/photosDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/child/photosDFF/{ImageId}

Workers/Religions

The religions resource is a child of the workers resource. It provides all the religions of a worker as of the specified date. By default, the current date is retained.

Create a worker religion: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions
Delete a worker religion: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}
Get a worker religion: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}
Get all worker religions: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions
Update a worker religion: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}

Workers/Religions/Religion Descriptive Flexfields

The religionsDFF resource is a child of the workers resource. It provides all the religion descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}/child/religionsDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}/child/religionsDFF/{ReligionId2}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}/child/religionsDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}/child/religionsDFF/{ReligionId2}

Workers/Visa Permits

The visasPermits resource is a child of the workers resource. It provides all the visas and permits of a worker as of the specified date. By default, the current date is retained.

Create a worker visa permit: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits
Delete a worker visa permit: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}
Get a worker visa permit: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}
Get all worker visas permits: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits
Update a worker visa permit: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}

Workers/Visa Permits/Visa Permit Descriptive Flexfields

The visasPermitsDFF resource is a child of the visasPermits resource. It provides all the visa permit developer flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF/{visasPermitsDFFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF/{visasPermitsDFFUniqID}

Workers/Visa Permits/Visa Permit Developer Flexfields

The visasPermitsDDF resource is a child of the visasPermits resource. It provides all the visa permit descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF/{visasPermitsDDFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF/{visasPermitsDDFUniqID}

Workers/Work Relationships

The workRelationships resource is a child of the workers resource. It provides all the work relationships of a worker as of the specified date. By default, the current date is retained.

Add a temporary assignment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/addTemporaryAssignment
Cancel a work relationship: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/cancelWorkRelationship
Change the legal employer or create a temporary assignment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/changeLegalEmployer
Change the primary flag of a work relationship: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/changePrimaryFlag
Change the start date of a work relationship: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/changeStartDate
Correct a worker termination: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/correctTermination
Create a worker work relationship: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships
Get a worker work relationship: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}
Get all worker work relationships: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships
Reverse a worker termination: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/reverseTermination
Terminate a worker: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/terminate
Update a worker work relationship: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}

Workers/Work Relationships/Assignments

The assignments resource is a child of the workRelationships resource. It provides all the worker assignments as of the specified date. By default, the current date is retained.

Create a worker assignment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments
Delete a worker assignment: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}
End a worker assignment: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/action/endAssignment
Get a worker assignment: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}
Get all worker assignments: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments
Update a worker assignment: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}

Workers/Work Relationships/Assignments/All Reports

The allReports resource is a child of the assignments resource. It provides all the reports of a worker as of the specified date. By default, the current date is retained.

Get a worker report: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/allReports/{allReportsUniqID}
Get all worker reports: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/allReports

Workers/Work Relationships/Assignments/Assignment Descriptive Flexfields

The assignmentsDFF resource is a child of the assignments resource. It provides all the assignment descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDFF/{assignmentsDFFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDFF/{assignmentsDFFUniqID}

Workers/Work Relationships/Assignments/Assignment Developer Flexfields

The assignmentsDDF resource is a child of the assignments resource. It provides all the assignment developer flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDDF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDDF/{assignmentsDDFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDDF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDDF/{assignmentsDDFUniqID}

Workers/Work Relationships/Assignments/Assignment Extensible FlexFields

The assignmentsEFF resource is a child of the assignments resource. It provides all the assignment extensible flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF
Delete a flexfield: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF/{assignmentsEFFUniqID}
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF/{assignmentsEFFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF/{assignmentsEFFUniqID}

Workers/Work Relationships/Assignments/Grade Steps

The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained.

Create an assignment grade step: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/gradeSteps
Delete an assignment grade step: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/gradeSteps/{gradeStepsUniqID}
Get all assignment grade steps: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/gradeSteps
Get an assignment grade step: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/gradeSteps/{gradeStepsUniqID}
Update an assignment grade step: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/gradeSteps/{gradeStepsUniqID}

Workers/Work Relationships/Assignments/Managers

The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained.

Create an assignment manager: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/managers
Delete an assignment manager: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/managers/{managersUniqID}
Get all assignment managers: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/managers
Get an assignment manager: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/managers/{managersUniqID}
Update an assignment manager: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/managers/{managersUniqID}

Workers/Work Relationships/Assignments/Representatives

The representatives resource is a child of the assignments resource. It provides all the representatives of a worker as of the specified date. By default, the current date is retained.

Get a worker representative: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/representatives/{AsgResponsibilityId}
Get all worker representatives: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/representatives

Workers/Work Relationships/Assignments/Work Measures

The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained.

Create an assignment work measure: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures
Delete an assignment work measure: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures/{workMeasuresUniqID}
Get all assignment work measures: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures
Get an assignment work measure: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures/{workMeasuresUniqID}
Update an assignment work measure: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures/{workMeasuresUniqID}

Workers/Work Relationships/Contracts

The contracts resource is a child of the workRelationships resource. It provides all the contracts of a worker as of the specified date. By default, the current date is retained.

Create a worker contract: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts
Delete a worker contract: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}
Get a worker contract: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}
Get all worker contracts: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts
Update a worker contract: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}

Workers/Work Relationships/Contracts/Contracts Descriptive Flexfields

The contractsDFF resource is a child of the contracts resource. It provides all the contracts descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDFF/{contractsDFFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDFF/{contractsDFFUniqID}

Workers/Work Relationships/Contracts/Contracts Developer Flexfields

The contractsDDF resource is a child of the contracts resource. It provides all the contracts developer flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDDF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDDF/{contractsDDFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDDF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDDF/{contractsDDFUniqID}

Workers/Work Relationships/Work Relationship Descriptive Flexfields

The workRelationshipsDFF resource is a child of the workRelationships resource. It provides all the work relationship descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDFF/{PeriodOfServiceId3}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDFF/{PeriodOfServiceId3}

Workers/Work Relationships/Work Relationship Developer Flexfields

The workRelationshipsDDF resource is a child of the workRelationships resource. It provides all the work relationship developer descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDDF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDDF/{PeriodOfServiceId2}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDDF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDDF/{PeriodOfServiceId2}

Workers/Worker Descriptive Flexfields

The workersDFF resource is a child of the workers resource. It provides all the descriptive flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersDFF
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersDFF/{PersonId}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersDFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersDFF/{PersonId}

Workers/Worker Extensible Flexfields

The workersEFF resource is a child of the workers resource. It provides all the extensible flexfields of a worker as of the specified date. By default, the current date is retained.

Create a flexfield: Method: post
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersEFF
Delete a flexfield: Method: delete
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersEFF/{workersEFFUniqID}
Get a flexfield: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersEFF/{workersEFFUniqID}
Get all flexfields: Method: get
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersEFF
Update a flexfield: Method: patch
Path: /hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersEFF/{workersEFFUniqID}