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 resources is a child of the allocatedChecklists resource. It is used to to view, create, and update attachments for a task.
Create a task attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments
Delete a task attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{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 documents resource is a child of the allocatedChecklists resource. It is used to view, create, and update attachments for a document task type.
Create a document task type attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents
Delete a document task type attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{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
Assessment Configuration in Job Requisition
The recruitingUIRequisitionAssessmentsConfigs resource provides assessment packages for a requisition.
Create an assessment configuration for a requisition
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs
Delete an assessment configuration for a requisition
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}
Get all assessment configurations for a requisition
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs
Get an assessment configuration for a requisition
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}
Assessment Configuration in Job Requisition/Assessment Triggers in Job Requisition
The triggers resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides partner triggers for a requisition.
Create an assessment trigger
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers
Delete an assessment trigger
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}
Get all assessment triggers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers
Get an assessment trigger
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}
Assessment Configuration in Job Requisition/Assessment Triggers in Job Requisition/Assessment Trigger Packages in Job Requisition
The packages resource is the child of the recruitingUIRequisitionAssessmentsConfigs resource and provides trigger packages for a requisition.
Create an assessment package
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}/child/packages
Delete an assessment package
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}/child/packages/{packagesUniqID}
Get all assessment packages for all triggers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}/child/packages
Get an assessment package for a trigger
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}/child/packages/{packagesUniqID}
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/Business Process Approval Attachments
The approvalAttachments resource provides the attachment content for a specific transaction.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}
Get all attachments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments
Get an attachment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}
Update an attachment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}
Business Process Approval Attachments Comments/Business Process Approval Attachments/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/Business Process Approval Attachments/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/Business Process Approval Attachments/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/Business Process Approval Comments
The approvalComments resource provides the comment content for a specific transaction.
Create a comment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments
Delete a comment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments/{businessProcessApprovalAttachmentsComments_approvalComments_Id}
Get a comment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments/{businessProcessApprovalAttachmentsComments_approvalComments_Id}
Get all comments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments
Update a comment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments/{businessProcessApprovalAttachmentsComments_approvalComments_Id}
Business Process Approval Delegation Rules
The businessProcessApprovalDelegationRules resource provides the delegation rules for a user.
Create a delegation rule
Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules
Delete a delegation rule
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/{PersonId}
Delete a delegation rule based on the rule name
Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/action/deleteRule
Get a data privilege for the logged in user
Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/action/hasDataPrivilege
Get a delegation rule
Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/{PersonId}
Get a task category
Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/action/getTaskCategories
Get all delegation rules not supported
Method: get
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules
Update delegation rule not supported
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/{PersonId}
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
Get BIP notification content for a report
Method: post
Path: /hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getBIPContent
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 Profile Metadata
The recruitingUICandidateProfileMetadata resource provides details about candidate profile metadata. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all candidates profile metadata
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata
Get candidate profile metadata
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata/{CandidateNumber}
Candidate Profile Metadata/Candidate Actions
The CandidateActions resource is a child of the recruitingUICandidateProfileMetadata resource and provides details about candidate actions. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a candidate action
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata/{CandidateNumber}/child/CandidateActions/{ActionId}
Get all candidates actions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata/{CandidateNumber}/child/CandidateActions
Candidate Profile Metadata/Candidate Tabs
The CandidateTabs resource is a child of the recruitingUICandidateProfileMetadata resource and provides details about candidate tabs. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a candidate tab
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata/{CandidateNumber}/child/CandidateTabs/{TabId}
Get all candidates tabs
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata/{CandidateNumber}/child/CandidateTabs
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
The questionResponses resource is a child of the questionnaire responses resource. The Question Responses resource includes the responses to the questions from the respondents. A questionnaire may have one or more question responses.
Create a response
Method: post
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{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 responseAttachments resource is a child of the question responses resource. The Response Attachments resource includes the attachments for the responses provided by the respondents to the questions in questionnaires. A question may have none or one or many response attachments.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/checkInDocuments/{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}
Development Goals Mass Assignment Process
The devGoalsMassAssignProcesses resource provides the processes used to mass assign development goals.
Add a requester and their hierarchy
Method: post
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/action/addRequesterInfo
Copy mass assignment process for development goals
Method: post
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/action/copy
Create a mass assignment process for development goals
Method: post
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess
Delete a mass assignment process for development goals
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}
Find mass assignment processes for development goals
Method: post
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/action/findByAdvancedSearchQuery
Get a mass assignment process for development goals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}
Get all mass assignment processes for development goals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess
Remove requester and their hierarchy from mass assignment process
Method: post
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/action/removeRequesterInfo
Update a mass assignment process for development goals
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}
Development Goals Mass Assignment Process/Development Eligibility Profiles
The devEligibilityProfiles resource is a child of the devGoalsMassAssignProcesses resource and provides all eligibility profiles that are added to the mass assignment process of development goals.
Create an associated eligibility profile
Method: post
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devEligibilityProfiles
Delete an associated eligibility profile
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devEligibilityProfiles/{devEligibilityProfilesUniqID}
Get all associated eligibility profiles
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devEligibilityProfiles
Get an associated eligibility profile
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devEligibilityProfiles/{devEligibilityProfilesUniqID}
Update an associated eligibility profile
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devEligibilityProfiles/{devEligibilityProfilesUniqID}
Development Goals Mass Assignment Process/Development Excluded Workers
The devExcludedWorkers resource is a child of the devGoalsMassAssignProcesses resource and provides all the workers who are excluded from the mass assignment process of development goals.
Add an excluded worker in the mass assignment process of development goals
Method: post
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devExcludedWorkers
Delete an excluded worker from the mass assignment process of development goals
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devExcludedWorkers/{MassRequestExemptionId}
Get a worker excluded from the mass assignment process of development goals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devExcludedWorkers/{MassRequestExemptionId}
Get all workers excluded from the mass assignment process of development goals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devExcludedWorkers
Development Goals Mass Assignment Process/Development Goals
The developmentGoals resource provides the development goals of a worker.
Copy a development goal
Method: post
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/action/copyGoal
Create a development goal
Method: post
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals
Delete a development goal
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}
Get a development goal
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}
Get all development goals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals
Update a development goal
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}
Development Goals Mass Assignment Process/Development Goals/Large Object (LOB) Attributes - Comments
Delete a Comments
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/enclosure/Comments
Get a Comments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/enclosure/Comments
Replace a Comments
Method: put
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/enclosure/Comments
Development Goals Mass Assignment Process/Development Goals/Large Object (LOB) Attributes - SuccessCriteria
Delete a SuccessCriteria
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/enclosure/SuccessCriteria
Get a SuccessCriteria
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/enclosure/SuccessCriteria
Replace a SuccessCriteria
Method: put
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/enclosure/SuccessCriteria
Development Goals Mass Assignment Process/Development Included Workers
The devIncludedWorkers resource is a child of the devGoalsMassAssignProcesses resource and provides workers who need to be assigned the development goals that are part of the mass assignment process.
Adds a worker along with their hierarchy to the mass assignment process of development goals
Method: post
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devIncludedWorkers
Delete a worker and their hierarchy from the mass assignment process of development goals
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devIncludedWorkers/{MassRequestHierarchyId}
Get all included workers along with their hierarchy
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devIncludedWorkers
Get an included worker along with their hierarchy
Method: get
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devIncludedWorkers/{MassRequestHierarchyId}
Updates hierarchy of existing worker included in the mass assignment process of development goals
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devIncludedWorkers/{MassRequestHierarchyId}
Development Intents
The developmentIntents resource provides all the development intents of an employee.
Get a development intent
Method: get
Path: /hcmRestApi/resources/11.13.18.05/developmentIntents/{ProfileId}
Get all development intents
Method: get
Path: /hcmRestApi/resources/11.13.18.05/developmentIntents
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
Explore Goals
The exploreGoals resource provides the available library goals and shared goals for a specific employee.
Find a development goal to explore
Method: post
Path: /hcmRestApi/resources/11.13.18.05/exploreGoals/action/getDevSharedAndLibraryGoals
Find a goal to explore
Method: post
Path: /hcmRestApi/resources/11.13.18.05/exploreGoals/action/findByAdvancedSearchQuery
Find a performance goal to explore
Method: post
Path: /hcmRestApi/resources/11.13.18.05/exploreGoals/action/getPerfSharedAndLibraryGoals
Get a goal to explore
Method: get
Path: /hcmRestApi/resources/11.13.18.05/exploreGoals/{PersonId}
Get all goals to explore
Method: get
Path: /hcmRestApi/resources/11.13.18.05/exploreGoals
Ignore shared goal
Method: post
Path: /hcmRestApi/resources/11.13.18.05/exploreGoals/action/exploreGoalAction
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
Generative AI Suggestion
The recruitingCEGenerativeAISuggestions resource generates the work summary for a candidate using generative AI.
Create a generative AI suggestion
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEGenerativeAISuggestions
Creates a work summary based on generative AI
Method: post
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEGenerativeAISuggestions/action/findGenerativeAIResponse
Get a generative AI suggestion
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEGenerativeAISuggestions/{PromptId}
Get all generative AI suggestions
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEGenerativeAISuggestions
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
Goal Plan Assignees
The goalPlanAssignees resource provides details of all employees who are assigned a goal plan.
Delete a goal plan assignment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlanAssignees/{GoalPlanAssignmentId}
Delete goal plan assignments
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlanAssignees/action/batchDelete
Find employees who are assigned a goal plan
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlanAssignees/action/findByAdvancedSearchQuery
Get a goal plan assignee
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlanAssignees/{GoalPlanAssignmentId}
Get all goal plan assignees
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlanAssignees
Goal Plan Goal Weights
The goalPlanGoalWeights resource provides all weights for the goals of a goal plan.
Add weight for a goal
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights
Delete weight of a goal
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights/{goalPlanGoalWeightsUniqID}
Get a goal's weight
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights/{goalPlanGoalWeightsUniqID}
Get all goals' weights
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights
Update weight of a goal
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights/{goalPlanGoalWeightsUniqID}
Goal Plans
The goalPlans resource provides the available goal plans.
Create a goal plan
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlans
Delete a goal plan
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}
Find a goal plan
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/action/findByAdvancedSearchQuery
Get a goal plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}
Get all goal plans
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans
Sync with performance documents
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/action/essProcessTrigger
Update a goal plan
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}
Goal Plans/Associated Performance Document Types
The associatedPerfDocumentTypes resource provides all performance document types associated with a goal plan.
Create a performance document type for a goal plan
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/associatedPerfDocumentTypes
Delete a performance document type associated with the goal plan
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/associatedPerfDocumentTypes/{GoalPlanDocumentTypeId}
Get a performance document type associated with the goal plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/associatedPerfDocumentTypes/{GoalPlanDocumentTypeId}
Get all performance documents types associated with the goal plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/associatedPerfDocumentTypes
Update a performance document type associated with the goal plan
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/associatedPerfDocumentTypes/{GoalPlanDocumentTypeId}
Goal Plans/Performance Goal Eligibility Profiles
The perfGoalEligibilityProfiles resource provides all eligibility profiles associated with a goal plan.
Create an associated eligibility profile
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalEligibilityProfiles
Delete an associated eligibility profile
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalEligibilityProfiles/{EligibilityProfileObjectId}
Get all associated eligibility profiles
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalEligibilityProfiles
Get an associated eligibility profile
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalEligibilityProfiles/{EligibilityProfileObjectId}
Update an associated eligibility profile
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalEligibilityProfiles/{EligibilityProfileObjectId}
Goal Plans/Performance Goal Excluded Workers
The perfGoalExcludedWorkers resource is a child of the goalPlans resource and provides all workers excluded from the goal plan.
Create an excluded worker for the goal plan
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers
Delete a worker excluded from the goal plan
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers/{perfGoalExcludedWorkersUniqID}
Get a worker excluded from the goal plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers/{perfGoalExcludedWorkersUniqID}
Get all workers excluded from the goal plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers
Update a worker excluded from the goal plan
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers/{perfGoalExcludedWorkersUniqID}
Goal Plans/Performance Goal Included Workers
The perfGoalInccludedWorkers resource provides all workers included in a goal plan.
Create an included worker for the goal plan
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers
Delete a worker included in the goal plan
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers/{perfGoalIncludedWorkersUniqID}
Get a worker included in the goal plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers/{perfGoalIncludedWorkersUniqID}
Get all workers included in the goal plan
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers
Update a worker included in the goal plan
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers/{perfGoalIncludedWorkersUniqID}
Goal Plans/Performance Goals
The performanceGoalsV2 resource provides performance goals of workers.
Copy a goal
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/copyGoal
Create a performance goal
Method: post
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals
Delete a performance goal
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}
Get a performance goal
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}
Get all performance goals
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals
Update a performance goal
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}
Goal Plans/Performance Goals/Large Object (LOB) Attributes - Comments
Delete a Comments
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/Comments
Get a Comments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/Comments
Replace a Comments
Method: put
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/Comments
Goal Plans/Performance Goals/Large Object (LOB) Attributes - LongDescription
Delete a LongDescription
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/LongDescription
Get a LongDescription
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/LongDescription
Replace a LongDescription
Method: put
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/LongDescription
Goal Plans/Performance Goals/Large Object (LOB) Attributes - SuccessCriteria
Delete a SuccessCriteria
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/SuccessCriteria
Get a SuccessCriteria
Method: get
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/SuccessCriteria
Replace a SuccessCriteria
Method: put
Path: /hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/SuccessCriteria
Grade Ladders
The gradeLadders resource includes a hierarchy of grades and steps used to identify the progression order for a grade, as of the specified date. It is also includes compensation rates associated to the hierarchy for career grade step progressions. By default, the current date is retained.
Get a grade ladder
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}
Get all grade ladders
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders
Grade Ladders/Grade Ladder Descriptive Flexfields
The gradeLadderDFF resource is a child of the gradeLadders resource. It includes descriptive flexfields for a grade ladder, identified by PER_GRADE_LADDERS_DF code.
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/gradeLadderDFF/{gradeLadderDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/gradeLadderDFF
Grade Ladders/Grades
The grades resource is a child of the gradeLadders resource. It includes all the grades that are attached to the grade ladder and the order in which they are attached.
Get a grade
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/grades/{gradesUniqID}
Get all grades
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/grades
Grade Ladders/Step Rates
The stepRates resource is a child of the gradeLadders resource. It includes step rates, representing pay rate that is defined for the grade steps, as of the specified date.
Get a step rate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates/{stepRatesUniqID}
Get all step rates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates
Grade Ladders/Step Rates/Step Rate Values
The stepRateValues resource is a child of the stepRates resource. It includes monetary values defined for the grade steps and the given step rate, as of the specified date.
Get a value
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates/{stepRatesUniqID}/child/stepRateValues/{stepRateValuesUniqID}
Get all values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates/{stepRatesUniqID}/child/stepRateValues
Grade Rates
The gradeRates resource includes pay rates for all the grades as of the specified date. By default, the current date is retained.
Get a grade rate
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}
Get all grade rates
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeRates
Grade Rates/Rate Values
The rateValues resource is a child of the gradeRates resource. It includes monetary values or ranges of values for all grades assigned to the grade rate, as of the specified date.
Get a rate value
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}/child/rateValues/{rateValuesUniqID}
Get all rate values
Method: get
Path: /hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}/child/rateValues
Grades
The grades resource includes all grades as of the specified date. By default, the current date is retained.
Get a grade
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}
Get all grades
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades
Grades/Grade Customer Flexfields
The GradeCustomerFlex resource is a child of the grades resource. It includes all grade flexfields as of the specified date. By default, the current date is retained.
Get a grade flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}/child/GradeCustomerFlex/{GradeCustomerFlexUniqID}
Get all grade flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}/child/GradeCustomerFlex
Grades/Grade Steps
The steps resource is a child of the grades resource. It includes all steps, that is, incremental points within the grade as of the specified date.
Get a grade step
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}/child/steps/{stepsUniqID}
Get all grade steps
Method: get
Path: /hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}/child/steps
HCM Contacts
The hcmContacts resource provides all the contacts of various workers as of the specified date. By default, the current date is retained.
Create a contact
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts
Get a contact
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}
Get all contacts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts
Update a contact
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}
HCM Contacts/Addresses
The addresses resource is a child of the hcmContacts resource. It provides all the addresses of worker contacts as of the specified date. By default, the current date is retained.
Create an address
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses
Delete an address
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}
Get all addresses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses
Get an address
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}
Update an address
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}
HCM Contacts/Addresses/Address Descriptive Flexfields
The addressesDFF resource is a child of the addresses resource. It provides all the address descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF/{addressesDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF/{addressesDFFUniqID}
HCM Contacts/Citizenships
The citizenships resource is a child of the hcmContacts resource. It provides all the citizenships of worker contacts as of the specified date. By default, the current date is retained.
Create a citizenship
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships
Delete a citizenship
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}
Get a citizenship
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}
Get all citizenships
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships
Update a citizenship
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}
HCM Contacts/Citizenships/Citizenship Descriptive Flexfields
The citizenshipsDFF resource is a child of the citizenships resource. It provides all the citizenship descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF/{CitizenshipId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF/{CitizenshipId2}
HCM Contacts/Contact Descriptive Flexfields
The contactsDFF resource is a child of the hcmContacts resource. It provides all descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF
Delete a flexfield
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF/{PersonId}
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF/{PersonId}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF/{PersonId}
HCM Contacts/Contact Relationships
The contactRelationships resource is a child of the hcmContacts resource. It provides all the contact relationships of workers as of the specified date. By default, the current date is retained.
Create a contact relationship
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships
Delete a contact relationship
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}
Get a contact relationship
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}
Get all contact relationships
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships
Update a contact relationship
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}
HCM Contacts/Contact Relationships/Contact Relationships Descriptive Flexfields
The contactRelationshipsDFF resource is a child of the contactRelationships resource. It provides all the descriptive flexfields for contact relationships as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF/{contactRelationshipsDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF/{contactRelationshipsDFFUniqID}
HCM Contacts/Contact Relationships/Contact Relationships Developer Flexfields
The contactRelationshipsDDF resource is a child of the contactRelationships resource. It provides all the developer flexfields for contact relationships as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF/{contactRelationshipsDDFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF/{contactRelationshipsDDFUniqID}
HCM Contacts/Driver Licenses
The driverLicenses resource is a child of the hcmContacts resource. It provides all the driver licenses of worker contacts as of the specified date. By default, the current date is retained.
Create a drivers license
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses
Delete a drivers license
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}
Get a drivers license
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}
Get all drivers licenses
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses
Update a drivers license
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}
HCM Contacts/Driver Licenses/Driver License Descriptive Flexfields
The driverLicensesDDF resource is a child of the driverLicenses resource. It provides all the driver license descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF/{DriversLicenseTypeId}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF/{DriversLicenseTypeId}
HCM Contacts/Driver Licenses/Driver License Developer Flexfields
The driverLicensesDDF resource is a child of the driverLicenses resource. It provides all the driver license developer flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF/{DriversLicenseId}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF/{DriversLicenseId}
HCM Contacts/Emails
The emails resource is a child of the hcmContacts resource. It provides all the email addresses of worker contacts as of the specified date. By default, the current date is retained.
Create an email
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails
Delete an email
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}
Get all emails
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails
Get an email
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}
Update an email
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}
HCM Contacts/Emails/Email Descriptive Flexfields
The emailsDFF resource is a child of the emails resource. It provides all the email descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF/{EmailAddressId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF/{EmailAddressId2}
HCM Contacts/Ethnicities
The ethnicities resource is a child of the hcmContacts resource. It provides all the ethnicities of worker contacts as of the specified date. By default, the current date is retained.
Create an ethnicity
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities
Delete an ethnicity
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}
Get all ethnicities
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities
Get an ethnicity
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}
Update an ethnicity
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}
HCM Contacts/Ethnicities/Ethnicity Descriptive Flexfields
The ethnicitiesDFF resource is a child of the ethnicities resource. It provides all the ethnicity descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF/{EthnicityId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF/{EthnicityId2}
HCM Contacts/Legislative Information
The legislativeInfo resource is a child of the hcmContacts resource. It provides all the legislative informaton of worker contacts as of the specified date. By default, the current date is retained.
Create a legislative record
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo
Delete a legislative record
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
Get a legislative record
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
Get all legislative records
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo
Update a legislative record
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
HCM Contacts/Legislative Information/Legislative Information Descriptive Flexfields
The legislativeInfoDFF resource is a child of the legislativeInfo resource. It provides all the legislative informaton descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF/{legislativeInfoDFFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF/{legislativeInfoDFFUniqID}
HCM Contacts/Legislative Information/Legislative Information Developer Flexfields
The legislativeInfoDDF resource is a child of the legislativeInfo resource. It provides all the legislative informaton developer flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF/{legislativeInfoDDFUniqID}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF/{legislativeInfoDDFUniqID}
HCM Contacts/Names
The names resource is a child of the hcmContacts resource. It provides all the names of worker contacts as of the specified date. By default, the current date is retained.
Create a name
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names
Delete a name
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names/{namesUniqID}
Get a name
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names/{namesUniqID}
Get all names
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names
Update a name
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names/{namesUniqID}
HCM Contacts/National Identifiers
The nationalIdentifiers resource is a child of the hcmContacts resource. It provides all the national identifiers of worker contacts as of the specified date. By default, the current date is retained.
Create a national identifier
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers
Delete a national identifier
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
Get a national identifier
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
Get all national identifiers
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers
Update a national identifier
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
HCM Contacts/National Identifiers/National Identifier Descriptive Flexfields
The nationalIdentifiersDFF resource is a child of the nationalIdentifiers resource. It provides all the national identifier descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF/{NationalIdentifierId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF/{NationalIdentifierId2}
HCM Contacts/Other Communication Accounts
The otherCommunicationAccounts resource is a child of the hcmContacts resource. It provides all the other communication accounts of worker contacts as of the specified date. By default, the current date is retained.
Create a communication account
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts
Delete a communication account
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
Get a communication account
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
Get all communication accounts
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts
Update a communication account
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
HCM Contacts/Other Communication Accounts/Other Communication Account Descriptive Flexfields
The otherCommunicationAccountsDFF resource is a child of the contacts resource. It provides all the other communication account descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF/{DeliveryMethodId2}
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF/{DeliveryMethodId2}
HCM Contacts/Passports
The passports resource is a child of the hcmContacts resource. It provides all the passports of worker contacts as of the specified date. By default, the current date is retained.
Create a passport
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports
Delete a passport
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}
Get a passport
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}
Get all passports
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports
Update a passport
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}
HCM Contacts/Passports/Passport Developer Flexfields
The passportsDFF resource is a child of the passports resource. It provides all the passport descriptive flexfields for worker contacts as of the specified date. By default, the current date is retained.
Create a flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF
Get a flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF/{PassportId2}
Get all flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF
Update a flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF/{PassportId2}
HCM Contacts/Passports/Person Passports Descriptive Flexfields
The passportsDFF resource is the child of the personPassports resource and provides the details of the person passport descriptive flexfield attributes.
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 provides attachments that are included with a response in a health survey incident.
Create an attachment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments
Delete an attachment
Method: delete
Path: /hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{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 recruitingCEJobRequisitionDetailsPreviews resource provides details about how the information is shown to external candidates once the job is published. 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 in a preview mode
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}
Get all job requisition details in preview mode
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails
Job Requisition Details/Job Requisition Flexfields
The requisitionFlexFields resource is a child of the recruitingCEJobRequisitionDetails resource and provides details about the requisition flexfields. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a requisition flexfield in the requisition details preview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/requisitionFlexFields/{requisitionFlexFieldsUniqID}
Get all requisition flexfields in the requisition details preview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/requisitionFlexFields
Job Requisition Details/Media
The media resource is a child of the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about the media used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a media in the requisition details preview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/media/{Id2}
Get all media in the requisition details preview
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 the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about other work locations used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
Get all other work locations in the requisition details preview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/otherWorkLocations
Get an other work location in the requisition details preview
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 the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about the secondary locations used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a secondary location in the requisition details preview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/secondaryLocations/{RequisitionLocationId}
Get all secondary locations in the requisition details preview
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 the recruitingCERequisitionTemplateDetailsPreviews resource and provides details about work locations used in the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
Get a work location in the requisition details preview
Method: get
Path: /hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/workLocation/{LocationId}
Get all work locations in the requisition details preview
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
The operations from the Journey Task/Allocated Checklist Task Attributes category.
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
The operations from the Journeys/Tasks/Allocated Checklist Task Attributes category.
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 a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
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
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a like
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Get a like
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes/{likeId}
Get all likes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Update a like
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes/{likeId}
Learner Learning Records/Active Learner Comments/Replies
The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a reply
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Get a reply
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}
Get all replies
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Update a reply
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}
Learner Learning Records/Active Learner Comments/Replies/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
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
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a like
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes
Get a like
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes/{likeId}
Get all likes
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes
Update a like
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes/{likeId}
Learner Learning Records/Approval Details
The approvalDetails resource is a child of the learnerLearningRecords resource. It provides the approval details information associated with the learning record.
Get all approval details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/approvalDetails
Get an approval detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/approvalDetails/{approvalDetailsUniqID}
Learner Learning Records/Assigned To Person Details
The assignedToPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assignee of the assignment records.
Get all assignee to person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignedToPersonDetails
Get an assignee to person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignedToPersonDetails/{personId}
Learner Learning Records/Assigner Person Details
The assignerPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assigner of the learner's assignment records.
Get all assigner person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignerPersonDetails
Get an assigner person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignerPersonDetails/{personId}
Learner Learning Records/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Create a completion detail
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}
Get all completion details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails
Update a completion detail
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}
Learner Learning Records/Completion Details/Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity when sequencing is enabled.
Get a hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint/{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
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
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}
Learner Learning Records/Completion Details/Activity Content Attempts/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/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
Learner Learning Records/Completion Details/Activity Content Attempts/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/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
The activitySectionCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity section when sequencing is enabled.
Get a hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint/{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 classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{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 attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
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
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{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 learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors
Get an instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorsUniqID}
Learner Learning Records/Completion Details/Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{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 learningItemTalentProfileSummary resource is a child of the completionDetails resource. It provides talent profile summary for the learner???s assignment records for specialization course activities.
Get a talent profile summary
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/learningItemTalentProfileSummary/{learningItemId}
Get all talent profile summaries
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/learningItemTalentProfileSummary
Learner Learning Records/Completion Details/Offered Languages
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
Get an offered language
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages/{offeredLanguagesUniqID}
Learner Learning Records/Completion Details/Offered Locations
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
Get an offering location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings
The otherSelectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings other than the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Get a single other selected course offering
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
Get all other selected course offerings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings
Update single other selected course offering
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}
Get all completion details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity when sequencing is enabled.
Get a hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/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
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
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}
Learner Learning Records/Completion Details/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/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
Learner Learning Records/Completion Details/Other Selected Course Offerings/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/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Completion Details/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/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}
Learner Learning Records/Completion Details/Other Selected Course Offerings/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/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
Learner Learning Records/Completion Details/Other Selected Course Offerings/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/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}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Content Attempts/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/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
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Content Attempts/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/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
The activitySectionCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity section when sequencing is enabled.
Get a hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/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 classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{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 attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
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
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{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 learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors
Get an instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{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
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages
Get an offered language
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages/{offeredLanguagesUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Offered Locations
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations
Get an offering location
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/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
Learner Learning Records/Completion Details/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/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}
Learner Learning Records/Completion Details/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/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
Learner Learning Records/Completion Details/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/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}
Learner Learning Records/Completion Details/Other Selected Course Offerings/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/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
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/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/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
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{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
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/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
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/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
The errors resource is a child of the learnerLearningRecords resource. It lists all the errors that exist on the learning record.
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
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Get a learning item flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF/{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 learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner???s assignment record.
Create a learning item rating
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
Get a learning item rating
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{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 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/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
The offeringDFF resource is a child of the selectedCourseOfferings resource. It provides additional offering information stored in flexfields.
Get all offering flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF
Get an offering flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF/{offeringDFFUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/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}
Learner Learning Records/Completion Details/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/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
Learner Learning Records/Completion Details/Other Selected Course Offerings/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/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
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Get a transaction history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory/{transactionId}
Get all transaction histories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory
Learner Learning Records/Completion Details/Primary Selected Course Offerings
The primarySelectedCourseOffering resource is a child of the learnerLearningRecords resource. It provides the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Get a primary selected course offering
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}
Get all primary selected course offerings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering
Update a primary selected course offering
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{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
The activityCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity when sequencing is enabled.
Get a hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/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
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
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}
Learner Learning Records/Completion Details/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/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
Learner Learning Records/Completion Details/Primary Selected Course Offerings/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/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Completion Details/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/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}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/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/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
Learner Learning Records/Completion Details/Primary Selected Course Offerings/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/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}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/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/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
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/Activity Content Attempts/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/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
The activitySectionCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity section when sequencing is enabled.
Get a hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/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 classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{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 attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
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
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{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 learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{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
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{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
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{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
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{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
Learner Learning Records/Completion Details/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/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}
Learner Learning Records/Completion Details/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/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
Learner Learning Records/Completion Details/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/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}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/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/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
Learner Learning Records/Completion Details/Primary Selected Course Offerings/Completion Details/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/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
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/completionDetails/{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
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/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
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/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
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Get a learning item flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemDFF/{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 learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner???s assignment record.
Create a learning item rating
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails
Get a learning item rating
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/learningItemRatingDetails/{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 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/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
The offeringDFF resource is a child of the selectedCourseOfferings resource. It provides additional offering information stored in flexfields.
Get all offering flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/offeringDFF
Get an offering flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/offeringDFF/{offeringDFFUniqID}
Learner Learning Records/Completion Details/Primary Selected Course Offerings/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}
Learner Learning Records/Completion Details/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/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
Learner Learning Records/Completion Details/Primary Selected Course Offerings/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/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
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Get a transaction history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/transactionHistory/{transactionId}
Get all transaction histories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{primarySelectedCourseOfferingUniqID}/child/transactionHistory
Learner Learning Records/Completion Details/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
Learner Learning Records/Completion Details/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/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
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{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
The selectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Create a selected course offering
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings
Get a selected course offering
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}
Get all selected course offerings
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings
Update a selected course offering
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments
The activeLearnerComments resource is a child of the learnerLearningRecords resource. It provides details of all comments of active and completed learners for the learning item associated to a learner's assignment record.
Create an active learner comment
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments
Get all active learner comments
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments
Get an active learner comment
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Update an active learner comment
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Active Learner Comments/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
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
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a like
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
Get a like
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{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
The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a reply
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
Get a reply
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{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 a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
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
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Create a like
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/activeLearnerComments/{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
The approvalDetails resource is a child of the learnerLearningRecords resource. It provides the approval details information associated with the learning record.
Get all approval details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/approvalDetails
Get an approval detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/approvalDetails/{approvalDetailsUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Assigner Person Details
The assignerPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assigner of the learner's assignment records.
Get all assigner person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignerPersonDetails
Get an assigner person details
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignerPersonDetails/{personId}
Learner Learning Records/Completion Details/Selected Course Offerings/Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Create an assignment flexfield
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF
Get all assignment flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF
Get an assignment flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Update an assignment flexfield
Method: patch
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Get a completion detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{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
The activityCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity when sequencing is enabled.
Get a hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/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
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
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
Learner Learning Records/Completion Details/Selected Course Offerings/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/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID4}/child/activityContentAttempts/{activityContentAttemptsUniqID4}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Completion Details/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/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}
Learner Learning Records/Completion Details/Selected Course Offerings/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/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
Learner Learning Records/Completion Details/Selected Course Offerings/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/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}
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Content Attempts/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/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
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/Activity Content Attempts/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/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
The activitySectionCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity section when sequencing is enabled.
Get a hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/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 classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Get a classroom detail
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{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 attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
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
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{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 learnerLearningRecords resource. It provides the instructors associated with the learning record.
Get all instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{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
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{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
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Get all offered languages
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{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
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Get all offering locations
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{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
Learner Learning Records/Completion Details/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/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}
Learner Learning Records/Completion Details/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/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
Learner Learning Records/Completion Details/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/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}
Learner Learning Records/Completion Details/Selected Course Offerings/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/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
Learner Learning Records/Completion Details/Selected Course Offerings/Completion Details/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/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
The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Get a related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/completionDetails/{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
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/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
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/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 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/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
The errors resource is a child of the learnerLearningRecords resource. It lists all the errors that exist on the learning record.
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
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Get a learning item flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemDFF/{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 learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner???s assignment record.
Create a learning item rating
Method: post
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails
Get a learning item rating
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{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
The learningItemRelatedMaterials resource is a child of the learnerLearningRecords resource. It provides related materials for the learning item associated to a learner's assignment record.
Get a learning item related material
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{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 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/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
The offeringDFF resource is a child of the selectedCourseOfferings resource. It provides additional offering information stored in flexfields.
Get all offering flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringDFF
Get an offering flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringDFF/{offeringDFFUniqID}
Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Classrooms
The offeringPrimaryClassroom resource is a child of the selectedCourseOfferings resource. It provides primary classroom details for the Instructor-Led activity of the Instructor-Led and Blended offering.
Get all offering primary classrooms
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom
Get an offering primary classroom
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}
Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Classrooms/Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
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
The classroomDFFs resource is a child of the classrooms resource. It provides additional classroom information stored in flexfields.
Get a classroom flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/classroomDFFs/{ResourceId}
Get all classroom flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/classroomDFFs
Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Instructors
The offeringPrimaryInstructor resource is a child of the selectedCourseOfferings resource. It provides the primary instructor details associated with the offering learning record.
Get all offering primary instructors
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor
Get an offering primary instructor
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}
Learner Learning Records/Completion Details/Selected Course Offerings/Offering Primary Instructors/Instructor Descriptive Flexfields
The instructorDFF resource is a child of the instructors resource. It provides additional offering information stored in flexfields.
Get all instructor flexfields
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF
Get an instructor flexfield
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF/{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}
Learner Learning Records/Completion Details/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/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
Learner Learning Records/Completion Details/Selected Course Offerings/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/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
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Get a transaction history
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/transactionHistory/{transactionId}
Get all transaction histories
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/transactionHistory
Learner Learning Records/Completion Details/Selected Course Offerings/User Action Hints
The userActionHints resource is a child of the learnerLearningRecords resource. It provides hints for possible actions on learner's assignment records.
Get a user action hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/userActionHints/{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
The userActionHints resource is a child of the learnerLearningRecords resource. It provides hints for possible actions on learner's assignment records.
Get a user action hint
Method: get
Path: /hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/userActionHints/{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