All REST Endpoints
(Unlisted) List of Values/Schedule Competencies for Staffing Grids
The scheduleCompetenciesLOV provides a list of competencies to use in staffing grid requirements.
- Get a single schedule competency
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleCompetenciesLOV/{scheduleCompetenciesLOV_Id}
- Get all schedule competencies
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleCompetenciesLOV
(Unlisted) List of Values/Staffing Plan Jobs
The StaffingPlanJobsLOV provides a list of jobs to use in staffing grid requirements.
- Get a single job for the staffing plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/staffingPlanJobsLOV/{staffingPlanJobsLOV_Id}
- Get all jobs for the staffing plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/staffingPlanJobsLOV
(Unlisted) List of Values/Workers List of Values
The workersLov resource is used for the client-side LOV component in responsive UIs and enables you to search for worker records.
- Get a worker
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workersLov/{workersLov_Id}
- Get all workers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workersLov
(Unlisted) List of Values/Workforce Scheduling Global Setup Content Types
The scheduleContentTypesLOV resource provides information about the workforce schedule setup content types.
- Get a single content type
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleContentTypesLOV/{scheduleContentTypesLOV_Id}
- Get all content types
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleContentTypesLOV
Absences
The absences resource provides the absence service used to record, view, update, and withdraw absences for employees.
- Create an absence record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/absences
- Delete an absence record
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}
- Display absence cases based on search criteria
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/absences/action/findByAdvancedSearchQueryForCases
- Display absence type projected balance.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/absences/action/loadProjectedBalance
- Display daily and shift details of the absence request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/absences/action/absenceDailyDetailsBreakdown
- Get all absence records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences
- Get an absence record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}
- Get an absence type balance
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/absences/action/getAbsenceTypeBalance
- Search existing absences
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/absences/action/findByAdvancedSearchQuery
- Update an absence record
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}
Absences/Absence Attachments
The absence attachments resource provides the attached documents added to the absence transactions.
- Create an attachment for an absence
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments
- Delete an attachment for an absence
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}
- Get all attachments for an absence
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments
- Get an absence attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}
- Update an attachment of an absence
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}
Absences/Absence Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceAttachments/{absenceAttachmentsUniqID}/enclosure/FileWebImage
Absences/Absence Descriptive Flexfields
The operations from the Absences/Absence Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingDFF/{PerAbsenceEntryId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingDFF/{PerAbsenceEntryId}
Absences/Absence Developer Flexfields
The operations from the Absences/Absence Developer Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingsDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingsDDF/{absenceRecordingsDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceRecordingsDDF
- Update
- Method: patchPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements
- Get an entitlement summary record
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements/{absenceEntitlementsUniqID}/child/absenceEntitlementDetails
- Get an entitlement detail record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntitlements/{absenceEntitlementsUniqID}/child/absenceEntitlementDetails/{entitlementDetailId}
Absences/Absence Entry Details
The absenceEntryDetails resource provides a individual day breakdown and a shift breakdown of the absence request dates.
- Create an absence entry detail
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails
- Delete an absence entry detail
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails/{PersonAbsenceEntryDetailId}
- Get all absence entry details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails
- Get an absence entry detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails/{PersonAbsenceEntryDetailId}
- Update an absence entry detail
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceEntryDetails/{PersonAbsenceEntryDetailId}
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: postPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceMaternity
- Get a maternity absence record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceMaternity/{personAbsenceMaternityId}
- Get all maternity absence records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceMaternity
- Update a maternity absence record
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/absences/{absencesUniqID}/child/absenceMaternity/{personAbsenceMaternityId}
Accomplishment Items
Get all profile tag details
- Get all profile tag details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions
- Get all profile tag details
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions
- Get all profile tag details
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}
- Get all profile tag details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentFeedbackSuggestions/{talentFeedbackSuggestionsUniqID}
- Get all profile tag details
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions
- Get all actions in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions
- Get an action in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions/{ActionType}
Actions in Opportunity Marketplace/Large Object (LOB) Attributes - WriteUp
- Delete a WriteUp
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions/{ActionType}/enclosure/WriteUp
- Get a WriteUp
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions/{ActionType}/enclosure/WriteUp
- Replace a WriteUp
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktActions/{ActionType}/enclosure/WriteUp
Allocated Checklist
The allocated checklists resource includes all the checklists allocated to a person. It's used to view, allocate, and modify checklist details for a person.
- Allocate a checklist
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/action/allocateChecklist
- Allocate a new task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/allocateNewTask
- Allocate a task from the task library
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/allocateTaskFromTaskLibrary
- Delete an allocated checklist
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
- Force close an incomplete checklist
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/action/forceCloseChecklist
- Get all allocated checklists
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists
- Get an allocated checklist
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
- Update an allocated checklist
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}
Allocated Checklist/Allocated Task
The allocated tasks resource is a child of the allocated Checklists resource. It includes details of all the allocated tasks.
- Delete an allocated task
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
- Get all allocated tasks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks
- Get an allocated task
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
- Reopen a task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/action/reopenTask
- Update an allocated task
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}
- Update the task status
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/action/updateTaskStatus
Allocated Checklist/Allocated Task/Allocated Checklist Task Attributes
The operations from the Allocated Checklist/Allocated Task/Allocated Checklist Task Attributes category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/allocatedChecklistTaskFlex/{AllocatedTaskId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/allocatedChecklistTaskFlex
Allocated Checklist/Allocated Task/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{attachmentsUniqID}
Allocated Checklist/Allocated Task/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{attachmentsUniqID}/enclosure/FileContents
Allocated Checklist/Allocated Task/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/allocatedChecklists/{allocatedChecklistsUniqID}/child/allocatedTasks/{AllocatedTaskId}/child/documents/{attachmentsUniqID}/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktApplicationDetails/{ApplicationId}
- Get all details on an opportunity marketplace gig application
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktApplicationDetails/{ApplicationId}/child/completedGigs/{GigId}
- Get all completed gigs for an opportunity marketplace application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktApplicationDetails/{ApplicationId}/child/completedGigs
Application Details in Opportunity Marketplace/Large Object (LOB) Attributes - WriteUp
- Get a WriteUp
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktApplicationDetails/{ApplicationId}/enclosure/WriteUp
Application Flows
The recruitingJobSiteApplyFlows resource provides details about the application flow for a posted job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a job application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteApplyFlows/{FlowId}
- Get all job application flows
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteApplyFlows
Areas of Responsibility
The representatives resource provides details of representatives of a person. A person can have different types of representatives such as benefits representative, human resources representative, and so on.
- Create the responsibilities for a representative
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/areasOfResponsibility
- Delete a responsibility for a representative
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}
- Find areas of responsibility information
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/areasOfResponsibility/action/findByAdvancedSearch
- Get a representative
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}
- Get all representatives
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/areasOfResponsibility
- Reassign a responsibility
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}/action/reassign
- Scope details for the responsibility template.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/areasOfResponsibility/action/getAorScopeDetails
- Update a responsibility for a representative
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/areasOfResponsibility/{areasOfResponsibilityUniqID}
Assessment Configuration in Job Requisition
The recruitingUIRequisitionAssessmentsConfigs resource provides assessment packages for a requisition.
- Create an assessment configuration for a requisition
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs
- Delete an assessment configuration for a requisition
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}
- Get all assessment configurations for a requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs
- Get an assessment configuration for a requisition
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers
- Delete an assessment trigger
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}
- Get all assessment triggers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers
- Get an assessment trigger
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}/child/packages
- Delete an assessment package
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}/child/packages/{packagesUniqID}
- Get all assessment packages for all triggers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}/child/packages
- Get an assessment package for a trigger
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAssessmentsConfigs/{AssessmentConfigId}/child/triggers/{triggersUniqID}/child/packages/{packagesUniqID}
Assessment Results
The recruitingUIAssessmentResults resource provides assessment results.
- Cancel an assessment request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIAssessmentResults/action/cancelRequest
- Get all assessment results
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIAssessmentResults
- Get an assessment result
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIAssessmentResults/{recruitingUIAssessmentResultsUniqID}
- Initiate an assessment request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIAssessmentResults/action/initiateRequest
- View assessment results
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIAssessmentResults/action/viewResults
Assessment Results/Assessment Results Additional Attributes
The additionalResultAttributes resource provides additional assessment results.
- Get all additional assessment results
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIAssessmentResults/{recruitingUIAssessmentResultsUniqID}/child/AdditionalResultAttributes
- Get an additional assessment result
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIAssessmentResults/{recruitingUIAssessmentResultsUniqID}/child/AdditionalResultAttributes/{AdditionalResultAttributesUniqID}
Asset Generative AI Responses
The Generative AI asset selection root resource for recruitingCESites.
- Create an asset
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAssetGenerativeAIResponses
- Delete an asset
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAssetGenerativeAIResponses/{RequisitionNumber}
- Get all assets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAssetGenerativeAIResponses
- Get an asset
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAssetGenerativeAIResponses/{RequisitionNumber}
- Get asset for an element
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAssetGenerativeAIResponses/action/getElementsAssets
- Update the metadata for an asset
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAssetGenerativeAIResponses/{RequisitionNumber}
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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunities
- Get an enrollment opportunity
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitEnrollments
- Get an enrollment
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/costs/{RateValueId}
- Get all costs
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/dependents/{CoveredDependentId}
- Get all covered dependents
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/providers/{ProviderOrganizationId}
- Get all plan providers
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/providers/{ProviderOrganizationId}/child/providerRoles/{ProviderOrganizationRoleId}
- Get all roles
- Method: getPath:
/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's 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: postPath:
/hcmRestApi/resources/11.13.18.05/benefitGroups
- Delete a benefit group
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/benefitGroups/{BenefitGroupName}
- Get a benefit group
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitGroups/{BenefitGroupName}
- Get all benefit groups
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitGroups
- Update a benefit group
- Method: patchPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}
- Get all benefit plans for comparison
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/estimatedCosts
- Get an estimated cost
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/featureValues/{InstanceValueId}
- Get all feature values
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/featureValues/{InstanceValueId}/child/footnoteReferences/{ItemId}
- Get all footnote references
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/footnotes/{ItemId}
- Get all footnotes
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/highlights/{InstanceValueId}
- Get all highlights
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/images
- Get an image
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansComparison/{InstanceId}/child/images/{ImageId}
Benefits Comparison Plans/Images/Large Object (LOB) Attributes - Image
- Get an Image
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments
- Get a comment and attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}
- Get all comments and attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments
- Get all previous attachments added by an initiator or prior approver
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/action/getPreviousAttchmentsByTransactionId
- Get all previous comments added by an initiator or prior approver
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/action/getPreviousCommentsByTransactionId
- Update a comment and attachment
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}
- Update an attachment
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_attachments_Id}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalAttachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_Id}/child/attachments/{businessProcessApprovalAttachmentsComments_approvalAttachments_attachments_Id}
- Update an attachment
- Method: patchPath:
/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: deletePath:
/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: getPath:
/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: putPath:
/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: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments
- Delete a comment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments/{businessProcessApprovalAttachmentsComments_approvalComments_Id}
- Get a comment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments/{businessProcessApprovalAttachmentsComments_approvalComments_Id}
- Get all comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalAttachmentsComments/{ObjectKey}/child/approvalComments
- Update a comment
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules
- Delete a delegation rule based on the rule name
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/action/deleteRule
- Delete a delegation rule not supported
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/{PersonId}
- Get a data privilege for the logged in user
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/action/hasDataPrivilege
- Get a delegation rule
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/{PersonId}
- Get a task category
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules/action/getTaskCategories
- Get all delegation rules not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessApprovalDelegationRules
- Update delegation rule not supported
- Method: patchPath:
/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 resume action
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getDeeplinkForResumeTransaction
- Generate a deep link URL for the edit action
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getDeeplinkUrlForEditAction
- Generate translated parameter values for the notification title
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/translateTaskTitleAttributeValues
- Get a notification content
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}
- Get all notification content
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications
- Get BIP notification content for a report
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getBIPContent
- Perform action on a transaction
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/performAction
- Perform action on a transaction with comments
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/performActionWithComments
- Perform action on multiple transaction with comments
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/performActionOnBulkTransactionWithComments
- Retrieve the list of actions
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getActionsBasedOnIdentificationKey
- Retrieve the list of task actions
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/action/getActionsBasedOnTaskId
Business Process Notifications/Large Object (LOB) Attributes - approvalHistory
- Get an approvalHistory
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}/enclosure/approvalHistory
Business Process Notifications/Large Object (LOB) Attributes - content
- Get a content
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}/enclosure/content
Business Process Notifications/Large Object (LOB) Attributes - contentWithHistory
- Get a contentWithHistory
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}/enclosure/contentWithHistory
Business Process Notifications/Large Object (LOB) Attributes - contentWithoutHistory
- Get a contentWithoutHistory
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}/enclosure/contentWithoutHistory
Business Process Notifications/Large Object (LOB) Attributes - observerApprovalHistory
- Get an observerApprovalHistory
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}/enclosure/observerApprovalHistory
Business Process Notifications/Large Object (LOB) Attributes - observerContentWithoutHistory
- Get an observerContentWithoutHistory
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessNotifications/{taskId}/enclosure/observerContentWithoutHistory
Business Process User Alert Configurations
The businessProcessUserAlertConfigurations resource provides the user specific alert configurations.
- Create an alert configuration for a user not supported
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessUserAlertConfigurations
- Delete an alert configuration for a user not supported
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/businessProcessUserAlertConfigurations/{businessProcessUserAlertConfigurationsUniqID}
- Determine if alert configuration is enabled
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessUserAlertConfigurations/action/isAlertConfigFeatureEnabled
- Get all alert configurations for a user not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessUserAlertConfigurations
- Get all error templates
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessUserAlertConfigurations/action/getErrorTemplates
- Get an alert configuration for a user not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/businessProcessUserAlertConfigurations/{businessProcessUserAlertConfigurationsUniqID}
- Update alert configuration
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/businessProcessUserAlertConfigurations/action/updateAlertConfiguration
- Update an alert configuration for a user not supported
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/businessProcessUserAlertConfigurations/{businessProcessUserAlertConfigurationsUniqID}
Campaign Details
The campaign details resource creates and updates a campaign.
- Allow user to perform actions
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/action/campaignAction
- Create a campaign
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails
- Delete a campaign
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}
- Get a campaign
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}
- Get all campaigns
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails
- Update a campaign
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}
Campaign Details/Campaign Audience Details
The audience details resource adds and updates the audience for a campaign.
- Create a campaign audience
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails
- Delete a campaign audience
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}
- Get a campaign audience
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}
- Get all selections of campaign audience
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails
- Update a campaign audience
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}
Campaign Details/Campaign Audience Details/Campaign Target Audience Details
The audience source item resource provides the target audience for a campaign.
- Create target audience
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}/child/CampaignAudienceSourceItems
- Delete target audience
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}/child/CampaignAudienceSourceItems/{AudienceItemId}
- Get a campaign target audience
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}/child/CampaignAudienceSourceItems/{AudienceItemId}
- Get all campaign target audiences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}/child/CampaignAudienceSourceItems
- Update target audience
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}/child/CampaignAudienceSourceItems/{AudienceItemId}
Campaign Details/Campaign Channel Details
The asset details resource creates and updates channels on the campaign.
- Create a channel
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails
- Delete a channel
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}
- Get a channel
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}
- Get all channels
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails
- Update a channel
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}
Campaign Details/Campaign Channel Details/Campaign Banner Details
The post content resource creates and updates the banner associated with a post based campaign.
- Create a banner
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/postContent
- Delete a banner
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/postContent/{PostContentId}
- Get a banner
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/postContent/{PostContentId}
- Get all banners
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/postContent
- Update a banner
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/postContent/{PostContentId}
Campaign Details/Campaign Channel Details/Campaign Channel Metrics
The asset metrics resource retrieves the metrics associated with one or more channels defined within a campaign.
- Create a channel's metrics
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/assetMetrics
- Delete a channel's metrics
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/assetMetrics/{AssetId2}
- Get a channel's metrics
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/assetMetrics/{AssetId2}
- Gets all channels' metrics
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/assetMetrics
- Update a channel's metrics
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/assetMetrics/{AssetId2}
Campaign Details/Campaign Channel Details/Grow Notification Metrics
The notification metrics resource retrieves the metrics associated with one or more grow notification email cycles.
- Create a grow notification's metrics
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/notificationMetrics
- Delete a grow notification's metrics
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/notificationMetrics/{NotificationId}
- Get a grow notification's metrics
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/notificationMetrics/{NotificationId}
- Gets all grow notifications' metrics
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/notificationMetrics
- Update a grow notification's metrics
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/notificationMetrics/{NotificationId}
Campaign Details/Campaign Owners
The owner details resource adds and updates the owners for a campaign.
- Create a campaign owner
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/owners
- Delete a campaign owner
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/owners/{TeamMemberId}
- Get a campaign owner
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/owners/{TeamMemberId}
- Get all campaign owners
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/owners
- Update a campaign owner
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/owners/{TeamMemberId}
Campaign Details/Large Object (LOB) Attributes - CampaignDescription
- Delete a CampaignDescription
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/enclosure/CampaignDescription
- Get a CampaignDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/enclosure/CampaignDescription
- Replace a CampaignDescription
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/enclosure/CampaignDescription
Candidate Interview Requests
The recruitingICECandidateInterviewRequests resource includes the candidate information and exposes all pending interview requests and scheduled and rescheduled interviews for the provided candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all interview requests sent to the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICECandidateInterviewRequests
- Get an interview request sent to the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICECandidateInterviewRequests/{PersonId}
Candidate Interview Requests/Scheduled Interviews
The ScheduleInterviews resource is a child of the recruitingICECandidateInterviewRequests which includes scheduled interview requests for the provided candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a scheduled interview request for a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICECandidateInterviewRequests/{PersonId}/child/ScheduleInterviews/{ScheduleInterviewsUniqID}
- Get all scheduled interview requests for a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICECandidateInterviewRequests/{PersonId}/child/ScheduleInterviews
Candidate Interview Requests/Scheduled Interviews/Schedule Interview Participants
The ScheduleInterviewParticipants resource is a child of recruitingCEInterviewDetails. It includes all interview schedules for participants. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all interview schedules for participants
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICECandidateInterviewRequests/{PersonId}/child/ScheduleInterviews/{ScheduleInterviewsUniqID}/child/ScheduleInterviewParticipants
- Get the interview schedule for a participant
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICECandidateInterviewRequests/{PersonId}/child/ScheduleInterviews/{ScheduleInterviewsUniqID}/child/ScheduleInterviewParticipants/{ScheduleInterviewParticipantsUniqID}
Candidate Interview Requests/Unscheduled Interview Requests
The UnscheduleInterviewRequests is a child of the recruitingICECandidateInterviewRequests which includes pending schedule interview requests for the provided candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all unscheduled interview requests for a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICECandidateInterviewRequests/{PersonId}/child/UnscheduledInterviewRequests
- Get an unscheduled interview request for a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICECandidateInterviewRequests/{PersonId}/child/UnscheduledInterviewRequests/{IntrvwRequestsId}
Candidate Job Match Scores
The recruitingCEJobMatchScoreGenerativeAIResponses rest service provides the scores for skills, relevant experience, domain knowledge, and seniority in the role along with the average score. The service endpoints in this resource category are only for Oracle internal use.
- Create job match scores
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobMatchScoreGenerativeAIResponses
- Delete job match scores
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobMatchScoreGenerativeAIResponses/{recruitingCEJobMatchScoreGenerativeAIResponsesUniqID}
- Get job match scores for a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobMatchScoreGenerativeAIResponses/{recruitingCEJobMatchScoreGenerativeAIResponsesUniqID}
- Get job match scores for all candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobMatchScoreGenerativeAIResponses
- Update job match scores
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobMatchScoreGenerativeAIResponses/{recruitingCEJobMatchScoreGenerativeAIResponsesUniqID}
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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata
- Get candidate profile metadata
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata/{CandidateNumber}/child/CandidateActions/{ActionId}
- Get all candidates actions
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidateProfileMetadata/{CandidateNumber}/child/CandidateTabs/{TabId}
- Get all candidates tabs
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigCandRecommendations/{PersonId}
- Get all recommended candidates for a gig.
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEBackgroundChecks
- Get a background check
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEBackgroundChecks/{ProvisioningId}
- Get all background checks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEBackgroundChecks
Career Interests
The careerInterests resource provides all the careers of interest of an employee.
- Create a career of interest
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/careerInterests
- Delete a career of interest
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/careerInterests/{CareerInterestId}
- Get a career of interest
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/careerInterests/{CareerInterestId}
- Get all careers of interest
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/careerInterests
- Update a career of interest
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/careerInterests/{CareerInterestId}
Career Site Candidate Duplicate Checks
The recruitingJobSiteCandidateDuplicateCheck resource verifies if a candidate already exists in the database. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateDuplicates
- Get a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateDuplicates/{CandidateNumber}
- Get a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTNCommonLookupsLOV
- Get a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTNCommonLookupsLOV/{recruitingTNCommonLookupsLOVUniqID}
- Get all candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateDuplicates
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 check-in document
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments
- Get a check-in document
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}
- Get all check-in documents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments
- Update a check-in document
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}
Check-In Documents/Questionnaire Responses
The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses
Check-In Documents/Questionnaire Responses/Question Responses
The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}
Check-In Documents/Questionnaire Responses/Question Responses/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}
- Update an attachment
- Method: patchPath:
/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: deletePath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/child/responseAttachments/{responseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: getPath:
/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: deletePath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/enclosure/AnswerCLOB
- Get an AnswerCLOB
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInDocuments/{checkInDocumentsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{questionResponsesUniqID}/enclosure/AnswerCLOB
- Replace an AnswerCLOB
- Method: putPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktCompletedGigs/{GigId}
- Get all completed gigs for an opportunity marketplace application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktCompletedGigs
Departments
The departments resource provides details of all departments as on a specified date. You can retrieve, create, and update the departments.
- Get a department
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/organizations/{organizationsUniqID}
- Get all departments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/organizations
Departments/Organizations Descriptive Flexfields
The operations from the Departments/Organizations Descriptive Flexfields category.
Departments/Organizations Extra Information
The operations from the Departments/Organizations Extra Information category.
Dependent Care FSA Calculators
The dependentCareFsaCalculator resource provides estimates on how much more the employee can save by enrolling in a flexible spending account.
- Collection GET action not supported.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dependentCareFsaCalculator
- Create an estimate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dependentCareFsaCalculator
- Singular GET action not supported.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dependentCareFsaCalculator/{dependentCareFsaCalculatorUniqID}
Development Goal Assigned Person Approval Details
The devGoalPersonDetails resource provides information about development goal approvals for a person.
- Get a development goal approval details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalPersonDetails/{PersonId}
- Get all development goals approval details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalPersonDetails
Development Goal Assigned Person Approval Details/Banner Override Messages
The bannerOverrideMessages resource provides all the status information and related messages for an object.
- Get a message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalPersonDetails/{PersonId}/child/bannerOverrideMessages/{ObjectId}
- Get all messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalPersonDetails/{PersonId}/child/bannerOverrideMessages
Development Goals Mass Assignment Process
The devGoalsMassAssignProcesses resource provides the processes used to mass assign development goals.
- Add a requester and their hierarchy
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/action/addRequesterInfo
- Copy mass assignment process for development goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/action/copy
- Create a mass assignment process for development goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess
- Delete a mass assignment process for development goals
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}
- Find mass assignment processes for development goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/action/findByAdvancedSearchQuery
- Get a mass assignment process for development goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}
- Get all mass assignment processes for development goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess
- Remove requester and their hierarchy from mass assignment process
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/action/removeRequesterInfo
- Update a mass assignment process for development goals
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devEligibilityProfiles
- Delete an associated eligibility profile
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devEligibilityProfiles/{devEligibilityProfilesUniqID}
- Get all associated eligibility profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devEligibilityProfiles
- Get an associated eligibility profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devEligibilityProfiles/{devEligibilityProfilesUniqID}
- Update an associated eligibility profile
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devExcludedWorkers
- Delete an excluded worker from the mass assignment process of development goals
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devExcludedWorkers/{MassRequestExemptionId}
- Get a worker excluded from the mass assignment process of development goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devExcludedWorkers/{MassRequestExemptionId}
- Get all workers excluded from the mass assignment process of development goals
- Method: getPath:
/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.
- Assign a development goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/action/goalAssignAction
- Check if goal's evaluated in performance documents and included in check-in documents
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/action/checkGoalInPDAndCheckInDoc
- Clear comments and attachments
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/action/prepareApprovalTxnForSubmission
- Copy a development goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/action/copyGoal
- Copy library goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/action/getDevelopmentLibraryGoalDetails
- Create a development goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals
- Create intents for a development goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/action/createGoalIntents
- Delete a development goal
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}
- Get a development goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}
- Get all development goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals
- Get development goal details
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/action/getDevelopmentGoalDetails
- Get development goal details for multiple goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/action/getMultipleDevelopmentGoalDetails
- Save development goal data for approval
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/action/saveDevGoalApproval
- Submit mass assignment process for development goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/action/submitEss
- Update a development goal
- Method: patchPath:
/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: deletePath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/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: deletePath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/enclosure/SuccessCriteria
- Get a SuccessCriteria
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devGoals/{GoalId}/enclosure/SuccessCriteria
- Replace a SuccessCriteria
- Method: putPath:
/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: postPath:
/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: deletePath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devIncludedWorkers/{MassRequestHierarchyId}
- Get all included workers along with their hierarchy
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/devGoalsMassAssignProcess/{devGoalsMassAssignProcessUniqID}/child/devIncludedWorkers
- Get an included worker along with their hierarchy
- Method: getPath:
/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: patchPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/developmentIntents/{ProfileId}
- Get all development intents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/developmentIntents
Document Delivery Preferences
The document delivery preferences resource is used for getting a person's delivery preferences for document records.
- Create all document delivery preferences
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2
- Delete a document delivery preference
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2/{documentDeliveryPreferencesV2UniqID}
- Get a delivery preference
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferences/{documentDeliveryPreferencesUniqID}
- Get a document delivery preference
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2/{documentDeliveryPreferencesV2UniqID}
- Get all delivery preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferences
- Get all document delivery preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2
- Update a document delivery preference
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/documentDeliveryPreferencesV2/{documentDeliveryPreferencesV2UniqID}
Document Records
The documentRecords resource includes all the document records for a person. It's used to create and view the document records for a person.
- Check access for unpublished document records
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkViewUnpublishedAccess
- Check document type create access
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkPersonDocumentTypeCreateAccess
- Check document type delete access
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkPersonDocumentTypeDeleteAccess
- Check document type edit access
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkPersonDocumentTypeEditAccess
- Check if approval is in progress for a document record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/isApprovalInProgress
- Check manage access
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkManageAccess
- Check mass download access
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkMassdownloadAccess
- Checks manage access of document records.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/checkPersonDocumentTypeManageAccess
- Create a document record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords
- Delete a document record
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}
- Download attachments for a document record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/downloadAttachments
- Find document records
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/findByAdvancedSearchQuery
- Generate letter for a document record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/action/generateDraftLetter
- Get a document record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}
- Get all document records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords
- Update a document record
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}
Document Records/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}
Document Records/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/bannerOverrideMessages/{ObjectId}
- Get all messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/bannerOverrideMessages
Document Records/Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachmentsPreview
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachmentsPreview/{attachmentsPreviewUniqID}
Document Records/Candidate Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachmentsPreview/{attachmentsPreviewUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachmentsPreview/{attachmentsPreviewUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachmentsPreview/{attachmentsPreviewUniqID}/enclosure/FileContents
Document Records/Candidate Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/attachmentsPreview/{attachmentsPreviewUniqID}/enclosure/FileWebImage
Document Records/Descriptive Flexfields for Document Records
The operations from the Document Records/Descriptive Flexfields for Document Records category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDFF/{DocumentsOfRecordId3}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDFF/{DocumentsOfRecordId3}
Document Records/Developer Descriptive Flexfields for Document Records
The operations from the Document Records/Developer Descriptive Flexfields for Document Records category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDDF/{DocumentsOfRecordId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/documentRecords/{DocumentsOfRecordId}/child/documentRecordsDDF/{DocumentsOfRecordId2}
Element Entries
The elementEntries resource includes salary, benefits, or any other recurring or nonrecurring entries, such as bonus for a worker.
- Create an element entry
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/elementEntries
- Delete an element entry
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}
- Get all element entries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/elementEntries
- Get an element entry
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}
- Update an element entry
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}
Element Entries/Element Entry History
The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.
- Get all element entry values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/ElementEntryHistory
- Get an element entry value
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/ElementEntryHistory/{ElementEntryId}
Element Entries/Element Entry Values
The elementEntryValues is a child of the elementEntries resource which includes values entered for an element, such as amount, periodicity, or rate.
- Create an element entry value
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/elementEntryValues
- Get all element entry values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/elementEntryValues
- Get an element entry value
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/elementEntries/{elementEntriesUniqID}/child/elementEntryValues/{elementEntryValuesUniqID}
- Update an element entry value
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjectResults
- Delete an eligibility object result
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjectResults/{eligibilityObjectResultsUniqID}
- Get all eligibility object results
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjectResults
- Get an eligibility object result
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjectResults/{eligibilityObjectResultsUniqID}
- Update an eligibility object result
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjects
- Delete an eligibility object
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}
- Get all eligibility objects
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjects
- Get an eligibility object
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}
- Update an eligibility object
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles
- Delete an eligibility object profile
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles/{eligibilityObjectProfilesUniqID}
- Get all eligibility object profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles
- Get an eligibility object profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles/{eligibilityObjectProfilesUniqID}
- Update an eligibility object profile
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/eligibilityObjects/{eligibilityObjectsUniqID}/child/eligibilityObjectProfiles/{eligibilityObjectProfilesUniqID}
Email Address Migrations
Email address capability that allows the application to add configuration values (email addresses) to the configuration table
- Create an email address migration
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/emailAddrMigrations
- Get all email address migrations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emailAddrMigrations
- Get an email address migration
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emailAddrMigrations/{ConfigId}
- Update an email address migration
- Method: patchPath:
/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 postprocessing steps across products. Therefore, these operations may take several minutes to complete. For bulk load and extract operations, you must use HCM Data Loader and HCM Extracts, respectively. Also, you must not 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: postPath:
/hcmRestApi/resources/11.13.18.05/emps
- Get all employees
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps
- Get an employee
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}
- Update an employee
- Method: patchPath:
/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.
This resource is currently under controlled availability.
- Create an assignment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments
- Get all assignments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments
- Get an assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}
- Update an assignment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}
Employees/Assignments/Assignment Extensible Flexfields
The operations from the Employees/Assignments/Assignment Extensible Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentExtraInformation
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentExtraInformation/{assignmentExtraInformationUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentExtraInformation
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentExtraInformation/{assignmentExtraInformationUniqID}
Employees/Assignments/Assignment Legislative Descriptive Flexfields
The operations from the Employees/Assignments/Assignment Legislative Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentDFF/{assignmentDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/assignmentDFF/{assignmentDFFUniqID}
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.
This resource is currently under controlled availability.
- Get a representative
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/empreps/{emprepsUniqID}
- Get all representatives
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/empreps
Employees/Assignments/People Group Key Flexfields
The operations from the Employees/Assignments/People Group Key Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/assignments/{assignmentsUniqID}/child/peopleGroupKeyFlexfield/{_PEOPLE_GROUP_ID}
- Get all
- Method: getPath:
/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.
This resource is currently under controlled availability.
- Get a direct report
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/directReports/{directReportsUniqID}
- Get all direct reports
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/directReports
Employees/Person Descriptive Flexfields
The operations from the Employees/Person Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personDFF/{PersonId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personDFF/{PersonId}
Employees/Person Extra Information Extensible Flexfields
The operations from the Employees/Person Extra Information Extensible Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personExtraInformation
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personExtraInformation/{personExtraInformationUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/personExtraInformation
- Update
- Method: patchPath:
/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.
This resource is currently under controlled availability.
- Create a photo
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo
- Delete a photo
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}
- Get a photo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}
- Get all photos
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo
- Update a photo
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}
Employees/Photos/Large Object (LOB) Attributes - Image
- Delete an Image
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}/enclosure/Image
- Get an Image
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/photo/{ImageId}/enclosure/Image
- Replace an Image
- Method: putPath:
/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.
This resource is currently under controlled availability.
- Create a role
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/roles
- Delete a role
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/roles/{rolesUniqID}
- Get a role
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/roles/{rolesUniqID}
- Get all roles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/roles
- Update a role
- Method: patchPath:
/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.
This resource is currently under controlled availability.
- Get a visa
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/emps/{empsUniqID}/child/visas/{visasUniqID}
- Get all visas
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/exploreGoals/action/getDevSharedAndLibraryGoals
- Find a goal to explore
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/exploreGoals/action/findByAdvancedSearchQuery
- Find a performance goal to explore
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/exploreGoals/action/getPerfSharedAndLibraryGoals
- Get a goal to explore
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/exploreGoals/{PersonId}
- Get all goals to explore
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/exploreGoals
- Get performance comments and goal level comments
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/exploreGoals/action/findPerformanceComments
- Ignore shared goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/exploreGoals/action/exploreGoalAction
External Prescreening Questions
The recruitingJobSiteApplicationQuestions resource provides details about the prescreening questions asked to candidates when they apply for a job. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get details about a prescreening question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteApplicationQuestions/{QuestionId}
- Get details about a prescreening question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTNApplicationQuestions/{QuestionId}
- Get details about all prescreening questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteApplicationQuestions
- Get details about all prescreening questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTNApplicationQuestions
External Prescreening Questions/Answers to the Questions
Meaning of the answer to a question.
- Get details about all the answers to the questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteApplicationQuestions/{QuestionId}/child/answers
- Get details about all the answers to the questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTNApplicationQuestions/{QuestionId}/child/answers
- Get details about the answer to a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteApplicationQuestions/{QuestionId}/child/answers/{LookupCode}
- Get details about the answer to a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTNApplicationQuestions/{QuestionId}/child/answers/{LookupCode}
Feedback Given
The givenFeedbacks resource retrieves the feedback information of other workers for the feedback participant.
- Get a feedback
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/givenFeedbacks/{ReferenceId}
- Get all feedback
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/givenFeedbacks
Flexfield Context
The recruitingCEFlexFields resource includes the list of the available descriptive flexfield contexts. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a descriptive flexfield's context
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEFlexFields/{recruitingCEFlexFieldsUniqID}
- Get all descriptive flexfield's contexts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEFlexFields
Flexfield Context/Flexfield Segment
The recruitingCEFlexFields segments resource includes the list of the available descriptive flexfield segments. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a descriptive flexfield segment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEFlexFields/{recruitingCEFlexFieldsUniqID}/child/segments/{segmentsUniqID}
- Get all descriptive flexfield segments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEFlexFields/{recruitingCEFlexFieldsUniqID}/child/segments
Flow Instances
The flowInstances resource provides a list of all submitted payroll flows.
- Get a payroll flow instance
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}
- Get all payroll flow instances
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/flowInstances
- Get available corrective actions
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/action/getAvailableActions
- Perform a corrective action
- Method: postPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/child/checklists/{FlowTaskInstanceId}
- Get all payroll flow checklists
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/child/checklists
- Get corrective actions for a checklist
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/flowInstances/{FlowInstanceId}/child/checklists/{FlowTaskInstanceId}/action/getAvailableActions
- Perform a corrective action for a checklist
- Method: postPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/flowPatterns/{FlowId}
- Get all flow patterns
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/flowPatterns
- Submit a flow
- Method: postPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/flowPatterns/{FlowId}/child/flowParameters/{FlowParameterId}
- Get all flow parameters
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEGenerativeAISuggestions
- Creates a work summary based on generative AI
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEGenerativeAISuggestions/action/findGenerativeAIResponse
- Get a generative AI suggestion
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEGenerativeAISuggestions/{PromptId}
- Get all generative AI suggestions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEGenerativeAISuggestions
Geofences
The geofences resource lets administrators manage geofences using the CREATE, UPDATE, and DELETE actions.
- Create a geofence
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeGeofences
- Delete a geofence
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/timeGeofences/{timeGeofencesUniqID}
- Get a geofence
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeGeofences/{timeGeofencesUniqID}
- Get all geofences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeGeofences
- Return geographic coordinates and formatted postal address for the location
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeGeofences/action/fetchGeocoordinatesAndFormattedAddresses
- Update a geofence
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/timeGeofences/{timeGeofencesUniqID}
Gig Details
The recruitingOppMktGigDetails resource provides details on a gig in opportunity marketplace.
- Create gig details in opportunity marketplace
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails
- Delete a detail on a gig in opportunity marketplace
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}
- Get a detail on an opportunity marketplace gig
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}
- Get all details on an opportunity marketplace gig
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails
- Update a detail on a gig in opportunity marketplace
- Method: patchPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigApplications
- Get an application for a gig in opportunity marketplace
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits
- Delete a benefit of a gig in opportunity marketplace
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}
- Get a benefit of a gig in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}
- Get all benefits of a gig in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits
- Update a benefit of a gig in opportunity marketplace
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}
Gig Details/Gig Benefits/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/benefits/{BenefitId}/enclosure/Description
- Replace a Description
- Method: putPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications
- Delete a gig classification in opportunity marketplace
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications/{ClassificationId}
- Get a gig classification in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications/{ClassificationId}
- Get all gig classifications in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigClassifications
- Update a gig classification in opportunity marketplace
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigMediaLinks
- Delete a media link for a gig in opportunity marketplace
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigMediaLinks/{GigMediaLinkId}
- Get a media link for a gig in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigMediaLinks/{GigMediaLinkId}
- Get all media links for a gig in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigMediaLinks
- Update a media link for a gig in opportunity marketplace
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigSkills
- Delete a skill on a gig in opportunity marketplace
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigSkills/{SkillId}
- Get a skill on an opportunity marketplace gig
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/gigSkills/{SkillId}
- Get all skills on an opportunity marketplace gig
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/teamMembers
- Delete a team member for a gig in opportunity marketplace
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/teamMembers/{TeamMemberId}
- Get a team member for a gig in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/teamMembers/{TeamMemberId}
- Get all team members for a gig in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/teamMembers
- Update a team member for a gig in opportunity marketplace
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/child/teamMembers/{TeamMemberId}
Gig Details/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigDetails/{GigId}/enclosure/Description
- Replace a Description
- Method: putPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktGigProspects/{recruitingOppMktGigProspectsUniqID}
- Get all gig prospects.
- Method: getPath:
/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: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlanAssignees/{GoalPlanAssignmentId}
- Delete goal plan assignments
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlanAssignees/action/batchDelete
- Find employees who are assigned a goal plan
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlanAssignees/action/findByAdvancedSearchQuery
- Get a goal plan assignee
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlanAssignees/{GoalPlanAssignmentId}
- Get all goal plan assignees
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights
- Delete weight of a goal
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights/{goalPlanGoalWeightsUniqID}
- Get a goal's weight
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights/{goalPlanGoalWeightsUniqID}
- Get all goals' weights
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights
- Update weight of a goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights/action/updateDraftGoal
- Update weight of a goal
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/goalPlanGoalWeights/{goalPlanGoalWeightsUniqID}
Goal Plans
The goalPlans resource provides the available goal plans.
- Create a goal plan
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans
- Delete a goal plan
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}
- Find a goal plan
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/action/findByAdvancedSearchQuery
- Get a goal plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}
- Get all goal plans
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans
- Sync with performance documents
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/action/essProcessTrigger
- Update a goal plan
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/associatedPerfDocumentTypes
- Delete a performance document type associated with the goal plan
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/associatedPerfDocumentTypes/{GoalPlanDocumentTypeId}
- Get a performance document type associated with the goal plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/associatedPerfDocumentTypes/{GoalPlanDocumentTypeId}
- Get all performance documents types associated with the goal plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/associatedPerfDocumentTypes
- Update a performance document type associated with the goal plan
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalEligibilityProfiles
- Delete an associated eligibility profile
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalEligibilityProfiles/{EligibilityProfileObjectId}
- Get all associated eligibility profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalEligibilityProfiles
- Get an associated eligibility profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalEligibilityProfiles/{EligibilityProfileObjectId}
- Update an associated eligibility profile
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers
- Delete a worker excluded from the goal plan
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers/{perfGoalExcludedWorkersUniqID}
- Get a worker excluded from the goal plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers/{perfGoalExcludedWorkersUniqID}
- Get all workers excluded from the goal plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalExcludedWorkers
- Update a worker excluded from the goal plan
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers
- Delete a worker included in the goal plan
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers/{perfGoalIncludedWorkersUniqID}
- Get a worker included in the goal plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers/{perfGoalIncludedWorkersUniqID}
- Get all workers included in the goal plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers
- Update a worker included in the goal plan
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/perfGoalIncludedWorkers/{perfGoalIncludedWorkersUniqID}
Goal Plans/Performance Goals
The performanceGoalsV2 resource provides performance goals of workers.
- Assign a performance goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/goalAssignActionBatch
- Assign a performance goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/goalAssignAction
- Check if goal's evaluated in performance documents and included in check-in documents
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/checkGoalInPDAndCheckInDoc
- Copy a goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/action/copyGoal
- Copy attachments of shared goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/copyAttachments
- Create a performance goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals
- Delete a performance goal
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}
- Generate report URL
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/buildBipReportUrlForGoals
- Get a performance goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}
- Get all performance goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals
- Get details of a performance library goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/getPerformanceLibraryGoalDetails
- Get goal plan approval transaction status
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/goalApprovalTransactionData
- Get performance goal details
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/getPerformanceGoalDetails
- Get performance goal details for multiple goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/getMultiplePerformanceGoalDetails
- Performance Goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/prepareApprovalTxnForSubmission
- Save performance goal data for approval
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/savePerfGoalApproval
- Share selected performance goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/shareActionBatch
- Submit mass assignment process for performance goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/action/submitEss
- Update a performance goal
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}
Goal Plans/Performance Goals/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/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: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/LongDescription
- Get a LongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/LongDescription
- Replace a LongDescription
- Method: putPath:
/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: deletePath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/SuccessCriteria
- Get a SuccessCriteria
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/SuccessCriteria
- Replace a SuccessCriteria
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/goalPlans/{GoalPlanId}/child/performanceGoals/{performanceGoalsUniqID}/enclosure/SuccessCriteria
Grade Ladders
The gradeLadders resource provides the grade ladder details including grade type, status, and progression details.
- Get a grade ladder
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}
- Get all grade ladders
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeLadders
Grade Ladders/Grade Ladders Grades
The grades resource is a child of the gradeLadders resource. It identifies the grades in the ladder, along with the sequence of the grades.
- Get all grades in a grade ladder
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/grades
- Get grades in a grade ladder
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/grades/{gradesUniqID}
Grade Ladders/Grade Ladders Step Rates
The stepRates resource is a child of the gradeLadders resource and provides the step rate details including currency, frequency, and annualization factor.
- Get a step rate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates/{stepRatesUniqID}
- Get all step rates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates
Grade Ladders/Grade Ladders Step Rates/Grade Ladders Step Rate Values
The stepRateValues resource is a child of the gradeLadders resource and provides the value amounts for the steps in the step rate.
- Get all step rate values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates/{stepRatesUniqID}/child/stepRateValues
- Get step rate values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeLadders/{gradeLaddersUniqID}/child/stepRates/{stepRatesUniqID}/child/stepRateValues/{stepRateValuesUniqID}
Grade Ladders/Grade Ladders V2 Descriptive Flexfields
The operations from the Grade Ladders/Grade Ladders V2 Descriptive Flexfields category.
Grade Rates
The gradeRates resource provides the grade rate details including currency, frequency, and annualization factor.
- Get a grade rate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}
- Get all grade rates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeRates
Grade Rates/Grade Rates Rate Values
The rateValues resource is a child of the gradeRates resource. It provides information about the grades included in a grade rate, such as the minimum, maximum, midpoint, and value amounts.
- Get all grade rate values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}/child/rateValues
- Get grade rate values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeRates/{gradeRatesUniqID}/child/rateValues/{rateValuesUniqID}
Grades
The grades resource provides the grade details including name, code, and type.
- Get a grade
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}
- Get all grades
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/grades
Grades/Grades Descriptive Flexfields
The operations from the Grades/Grades Descriptive Flexfields category.
Grades/Grades Steps
The steps resource is a child of the grades resource. It provides information about the steps included in a grade, such as the name and number.
- Get a grade step
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/grades/{gradesUniqID}/child/steps/{stepsUniqID}
- Get all grade steps
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts
- Get a contact
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}
- Get all contacts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts
- Update a contact
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses
- Delete an address
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}
- Get all addresses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses
- Get an address
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}
- Update an address
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}
HCM Contacts/Addresses/Person Address Usage Descriptive Flexfields
The operations from the HCM Contacts/Addresses/Person Address Usage Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF/{addressesDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF
- Update
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships
- Delete a citizenship
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}
- Get a citizenship
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}
- Get all citizenships
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships
- Update a citizenship
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}
HCM Contacts/Citizenships/Person Citizenships Descriptive Flexfields
The operations from the HCM Contacts/Citizenships/Person Citizenships Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF/{CitizenshipId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF/{CitizenshipId2}
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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships
- Delete a contact relationship
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}
- Get a contact relationship
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}
- Get all contact relationships
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships
- Update a contact relationship
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}
HCM Contacts/Contact Relationships/Contact Relationships Descriptive Flexfields
The operations from the HCM Contacts/Contact Relationships/Contact Relationships Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF/{contactRelationshipsDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDFF/{contactRelationshipsDFFUniqID}
HCM Contacts/Contact Relationships/Contact Relationships Developer Descriptive Flexfields
The operations from the HCM Contacts/Contact Relationships/Contact Relationships Developer Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF/{contactRelationshipsDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactRelationships/{contactRelationshipsUniqID}/child/contactRelationshipsDDF
- Update
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses
- Delete a drivers license
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}
- Get a drivers license
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}
- Get all drivers licenses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses
- Update a drivers license
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}
HCM Contacts/Driver Licenses/Person Driver Licenses Descriptive Flexfields
The operations from the HCM Contacts/Driver Licenses/Person Driver Licenses Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF/{DriversLicenseTypeId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF/{DriversLicenseTypeId}
HCM Contacts/Driver Licenses/Person Driver Licenses Developer Descriptive Flexfields
The operations from the HCM Contacts/Driver Licenses/Person Driver Licenses Developer Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF/{DriversLicenseId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF
- Update
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails
- Delete an email
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}
- Get all emails
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails
- Get an email
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}
- Update an email
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}
HCM Contacts/Emails/Person Emails Descriptive Flexfields
The operations from the HCM Contacts/Emails/Person Emails Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF/{EmailAddressId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/emails/{EmailAddressId}/child/emailsDFF
- Update
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities
- Delete an ethnicity
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}
- Get all ethnicities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities
- Get an ethnicity
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}
- Update an ethnicity
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}
HCM Contacts/Ethnicities/Person Ethnicities Descriptive Flexfields
The operations from the HCM Contacts/Ethnicities/Person Ethnicities Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF/{EthnicityId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF
- Update
- Method: patchPath:
/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 information of worker contacts as of the specified date. By default, the current date is retained.
- Create a legislative record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo
- Delete a legislative record
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
- Get a legislative record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
- Get all legislative records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo
- Update a legislative record
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
HCM Contacts/Legislative Information/Person Legislative Descriptive Flexfields
The operations from the HCM Contacts/Legislative Information/Person Legislative Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF/{legislativeInfoDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF/{legislativeInfoDFFUniqID}
HCM Contacts/Legislative Information/Person Legislative Developer Descriptive Flexfields
The operations from the HCM Contacts/Legislative Information/Person Legislative Developer Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF/{legislativeInfoDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF
- Update
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names
- Delete a name
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names/{namesUniqID}
- Get a name
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names/{namesUniqID}
- Get all names
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/names
- Update a name
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers
- Delete a national identifier
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
- Get a national identifier
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
- Get all national identifiers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers
- Update a national identifier
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
HCM Contacts/National Identifiers/Person National Identifiers Descriptive Flexfields
The operations from the HCM Contacts/National Identifiers/Person National Identifiers Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF/{NationalIdentifierId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF
- Update
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts
- Delete a communication account
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
- Get a communication account
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
- Get all communication accounts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts
- Update a communication account
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
HCM Contacts/Other Communication Accounts/Person Other Communication Accounts Descriptive Flexfields
The operations from the HCM Contacts/Other Communication Accounts/Person Other Communication Accounts Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF/{DeliveryMethodId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF
- Update
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports
- Delete a passport
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}
- Get a passport
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}
- Get all passports
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports
- Update a passport
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}
HCM Contacts/Passports/Person Passports Descriptive Flexfields
The operations from the HCM Contacts/Passports/Person Passports Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDFF/{PassportId3}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDFF/{PassportId3}
HCM Contacts/Passports/Person Passports Developer Descriptive Flexfields
The operations from the HCM Contacts/Passports/Person Passports Developer Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF/{PassportId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/passports/{PassportId}/child/passportsDDF/{PassportId2}
HCM Contacts/Person Descriptive Flexfields
The operations from the HCM Contacts/Person Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF/{PersonId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/contactsDFF/{PersonId}
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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones
- Delete a phone
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}
- Get a phone
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}
- Get all phones
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones
- Update a phone
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}
HCM Contacts/Phones/Person Phones Descriptive Flexfields
The operations from the HCM Contacts/Phones/Person Phones Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}/child/phonesDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}/child/phonesDFF/{PhoneId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/phones/{PhoneId}/child/phonesDFF
- Update
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions
- Delete a religion
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}
- Get a religion
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}
- Get all religions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions
- Update a religion
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}
HCM Contacts/Religions/Person Religions Descriptive Flexfields
The operations from the HCM Contacts/Religions/Person Religions Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}/child/religionsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}/child/religionsDFF/{ReligionId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/religions/{ReligionId}/child/religionsDFF
- Update
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits
- Delete a visa permit
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}
- Get a visa permit
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}
- Get all visas permits
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits
- Update a visa permit
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}
HCM Contacts/Visa Permits/Person Visas and Permits Descriptive Flexfields
The operations from the HCM Contacts/Visa Permits/Person Visas and Permits Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF/{visasPermitsDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF/{visasPermitsDFFUniqID}
HCM Contacts/Visa Permits/Person Visas and Permits Developer Descriptive Flexfields
The operations from the HCM Contacts/Visa Permits/Person Visas and Permits Developer Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF/{visasPermitsDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/hcmContacts/{hcmContactsUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF/{visasPermitsDDFUniqID}
HCM Data Loader Data Sets
The dataLoadDataSets resource is used to review the details of HCM Data Loader and HCM Spreadsheet Data Loader data sets. Actions are supplied to initiate, stop or submit HCM Data Loader and HCM Spreadsheet Data Loader. All actions submit a process to complete the requested action, which may take some time to complete.
- Delete a data set
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/deleteDataSet
- Delete a spreadsheet data set
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/deleteSpreadsheetDataSet
- Generate failed lines files for the business objects within the data set.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/generateFailedLinesFile
- Get a data set
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}
- Get all data sets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets
- Perform advanced search
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/action/findByAdvancedSearchQuery
- Stop data set processing
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/stop
- Submit data set processing
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/action/submit
- Submit HCM Data Loader
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/action/createFileDataSet
- Submit HCM Spreadsheet Data Loader
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/action/createSpreadsheetDataSet
- Upload file to HDL import account
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/action/uploadFile
HCM Data Loader Data Sets/Data Set Business Objects
The businessObjects resource is a child of the dataLoadDataSets resource. It's used to view details of the business objects included in the data set.
- Generate a failed lines file for the business object.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/businessObjects/{DataSetBusObjId}/action/generateFailedLinesFile
- Get a business object
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/businessObjects/{DataSetBusObjId}
- Get all business objects
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/businessObjects
- Stop business object processing
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/businessObjects/{DataSetBusObjId}/action/stop
- Submit business object processing
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/businessObjects/{DataSetBusObjId}/action/submit
HCM Data Loader Data Sets/Messages
The messages resource is a child of the dataLoadDataSets resource. It's used to view details of the messages raised for a data set, including the details of the record the message was raised against.
- Get a data set message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/messages/{MessageLineId}
- Get all data set messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/messages
HCM Data Loader Data Sets/Submitted Processes
The processes resource is a child of the dataLoadDataSets resource. It's used to view details of the processes submitted to action the data set.
- Get a data set process
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/processes/{ProcessId}
- Get all data set processes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/processes
HCM Data Loader Data Sets/Submitted Processes/Submitted Subprocesses
The subprocesses resource is a child of the processes resource. It provides details of the subprocesses submitted by a specific HCM Data Loader data set process.
- Get a subprocess
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/processes/{ProcessId}/child/subprocesses/{ProcessId2}
- Get all subprocesses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/dataLoadDataSets/{RequestId}/child/processes/{ProcessId}/child/subprocesses
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.
- Collection GET action not supported.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthCareFsaCalculator
- Create an estimate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/healthCareFsaCalculator
- Singular GET action not supported.
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator/action/calculateHsaProjections
- Collection GET action not supported.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator
- Create an estimate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator
- Singular GET action not supported.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator/{healthSavingsAccountCalculatorUniqID}
Incident ID
Health survey events submitted by employees to record health and related details.
- Create a health survey
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys
- Get a health survey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}
- Get all health surveys
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys
Incident ID/Incident ID
Questions and responses to use in a questionnaire in a health survey incident.
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses
Incident ID/Incident ID/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}
Incident ID/Incident ID/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Incident ID/Incident ID/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/healthSurveys/{IncidentId}/child/QuestionnaireResponses/{QuestionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage
Incident Kiosks
A kiosk version of incident.
- Create an incident
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks
- Get all incidents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks
- Get an incident
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}
- Update an incident
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}
Incident Kiosks/Incident Detail Kiosks
A kiosk version of incident events.
- Create an incident event
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/IncidentDetailKiosk
- Get all incident events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/IncidentDetailKiosk
- Get an incident event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/IncidentDetailKiosk/{IncidentDetailId}
- Update an incident event
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/IncidentDetailKiosk/{IncidentDetailId}
Incident Kiosks/Incident Kiosks Descriptive Flexfields
The operations from the Incident Kiosks/Incident Kiosks Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/HnsIncidentsDFF
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/HnsIncidentsDFF/{IncidentId2}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/HnsIncidentsDFF/{IncidentId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/HnsIncidentsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/child/HnsIncidentsDFF/{IncidentId2}
Incident Kiosks/Large Object (LOB) Attributes - IncidentDescription
- Delete an IncidentDescription
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentDescription
- Get an IncidentDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentDescription
- Replace an IncidentDescription
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentDescription
Incident Kiosks/Large Object (LOB) Attributes - IncidentImmeActDescr
- Delete an IncidentImmeActDescr
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentImmeActDescr
- Get an IncidentImmeActDescr
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentImmeActDescr
- Replace an IncidentImmeActDescr
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/incidentKiosks/{IncidentId}/enclosure/IncidentImmeActDescr
Internal Candidate Assessments
The recruitingUICandidateAssessments resource provides the completion status of the candidate assessment and is used to trigger and retrieve assessment URL.
- Create a candidate assessment request to a partner
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidateAssessments
- Get a candidate assessment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidateAssessments/{RequisitionId}
- Get all candidate assessments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidateAssessments
Internal Candidate Job Offer Detail
The recruitingUIICEOfferPreviews resource provides the details of the offer letter for candidates along with media links and the contact information for the hiring and recruiting manager. It also provides the ability to accept or decline an offer.
- Create a record when offer is accepted or declined
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews
- Get all details of the offer letter for the internal candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews
- Get an offer letter detail for internal candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}
Internal Candidate Job Offer Detail/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/attachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/candidateOfferLetter
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/candidateOfferLetter/{attachmentsUniqID}
Internal Candidate Job Offer Detail/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/candidateOfferLetter/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/candidateOfferLetter/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/candidateOfferLetter/{attachmentsUniqID}/enclosure/FileContents
Internal Candidate Job Offer Detail/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/candidateOfferLetter/{attachmentsUniqID}/enclosure/FileWebImage
Internal Candidate Job Offer Detail/Candidate Reasons to Decline the Job Offer
The offerDeclineReasons resource is a child of the recruitingCEOfferDetails resource. It provides the reasons that the candidate can provide while declining the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a reason that candidates can provide while declining the job offer.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/offerDeclineReasons/{ReasonId}
- Get all the reasons that candidates can provide while declining the job offer.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/offerDeclineReasons
Internal Candidate Job Offer Detail/Job Offer Contact
The contacts resource provides the contact information for the hiring manager and recruiter.
- Get a contact detail of the hiring manager or recruiter associated with the offer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/contacts/{TeamMemberId}
- Get all the contact details of the hiring manager and recruiter associated with the offer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/contacts
Internal Candidate Job Offer Detail/Recruiting Job Offer Media Links
The mediaLinks resource provides the media links that are available for the requisition on which the job offer is created.
- Get all media links
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/mediaLinks
- Gets a media link
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews/{OfferId}/child/mediaLinks/{MediaLinkId}
Job Applications
The recruitingUIJobApplications resource provides the ability to perform actions on job applications.
- Confirm a job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/action/confirm
- Create a job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications
- Create a prospect
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/action/createProspect
- Create a proxy job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/confirmJobApplications
- Create a proxy job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/createProxyJobApplications
- Create a proxy job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/deleteJobApplication
- Create a proxy job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/fetchBulkPrintInformation
- Create a proxy job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/fetchPrintURL
- Create a proxy job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/markJobApplicationAsViewed
- Create a proxy job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/returnToPriorPhase
- Create a proxy job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/returnToPriorState
- Create a proxy job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/sendConfirmationRequest
- Create an action on the list of job applications
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications
- Delete a job application
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}
- Get a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}
- Get all job application details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications
- Get all job applications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications
- Get job application details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}
- Returns job applications based on the filters and queries applied.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/moveJobApplication
- Returns job applications based on the filters and queries applied.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/requestMoreInfo
- Search for job applications.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/action/findByAdvancedSearchQuery
- Update a job application
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}
Job Applications/Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
- Create a proxy job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/PreferredLocations
- Create a proxy job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/PreferredLocations
- Create a proxy job application
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/PreferredLocations/{AttachmentsUniqID}
- Create a proxy job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/PreferredLocations/{AttachmentsUniqID}
- Create a proxy job application
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/PreferredLocations/{AttachmentsUniqID}
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/Attachments
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/InternalAttachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/Attachments/{AttachmentsUniqID}
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/InternalAttachments/{AttachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/Attachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/InternalAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/Attachments/{AttachmentsUniqID}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/InternalAttachments/{AttachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/Attachments/{AttachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/InternalAttachments/{AttachmentsUniqID}
Job Applications/Candidate Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/InternalAttachments/{AttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/InternalAttachments/{AttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/InternalAttachments/{AttachmentsUniqID}/enclosure/FileContents
Job Applications/Candidate Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications/{SubmissionId}/child/InternalAttachments/{AttachmentsUniqID}/enclosure/FileWebImage
Job Applications/Candidate Responses to Questions
The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.
- Create responses for a questionnaire
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/questionnaireResponses
- Get the details of a response for a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/questionnaireResponses/{QuestionnaireId}
- Get the details of all responses for a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/questionnaireResponses
Job Applications/Preferred Job Locations
The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a preferred location
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/preferredLocations
- Get a preferred location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/preferredLocations/{JaPreferredLocationId}
- Get all preferred locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/preferredLocations
Job Applications/Regulatory Responses
The regulatoryResponses resource provides details about the responses provided by the candidate for a regulatory question. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a regulatory response for a job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/regulatoryResponses
- Get details of a regulatory response for a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/regulatoryResponses/{regulatoryResponsesUniqID}
- Get details of all regulatory responses for a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteJobApplications/{recruitingJobSiteJobApplicationsUniqID}/child/regulatoryResponses
Job Category Introductory Text
The recruitingCESecuredJobFamilyTextGenerativeAIResponses allows administrators to use AI to construct introductory text for job categories in a career site.
- Create introductory text for a job category
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecuredJobFamilyTextGenerativeAIResponses
- Delete introductory text for a job category
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecuredJobFamilyTextGenerativeAIResponses/{recruitingCESecuredJobFamilyTextGenerativeAIResponsesUniqID}
- Get introductory text for a job category
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecuredJobFamilyTextGenerativeAIResponses/{recruitingCESecuredJobFamilyTextGenerativeAIResponsesUniqID}
- Get introductory text for all job categories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecuredJobFamilyTextGenerativeAIResponses
- Update introductory text for a job category
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecuredJobFamilyTextGenerativeAIResponses/{recruitingCESecuredJobFamilyTextGenerativeAIResponsesUniqID}
Job Details in Opportunity Marketplace
The recruitingOppMktJobDetails resource provides details on a job in opportunity marketplace.
- Get a job detail in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}
- Get all job details in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails
- URL of the job page in opportunity marketplace.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/action/shareJob
Job Details in Opportunity Marketplace/Descriptive Flexfields in Job Requisition
The operations from the Job Details in Opportunity Marketplace/Descriptive Flexfields in Job Requisition category.
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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/contacts/{PersonId}
- Get all contacts for a job in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/contacts
- Get all contacts for a job in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/jobProfileNonPublicSkillSections
- Get all contacts for a job in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/jobProfileNonPublicSkillSections/{PersonId}
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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/secondaryLocations/{RequisitionLocationId}
- Get all secondary locations for a job in opportunity marketplace
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/secondaryWorkLocations/{RequisitionWorkLocationId}
- Get all secondary work locations for a job in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/secondaryWorkLocations
Job Details in Opportunity Marketplace/Large Object (LOB) Attributes - Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/enclosure/Description
Job Details in Opportunity Marketplace/Large Object (LOB) Attributes - Qualifications
- Get a Qualifications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/enclosure/Qualifications
Job Details in Opportunity Marketplace/Large Object (LOB) Attributes - Responsibilities
- Get a Responsibilities
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/medias/{MediaLinkId}
- Get all media for a job in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktJobDetails/{RequisitionId}/child/medias
Job Families
The jobFamilies resource provides the details of all the job families as on a specified date. You can retrieve the job families.
- Get a job family
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobFamilies/{jobFamiliesUniqID}
- Get all job families
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobFamilies
Job Families/Job Families V2 Descriptive Flexfields
The operations from the Job Families/Job Families V2 Descriptive Flexfields category.
Job Offer Lists
The recruitingUIJobOffers resource provides the list of job offers based on the provided filter.
- Create a list of job offers
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers/action/findByAdvancedSearchQuery
- Create a method to perform job offer actions
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers/action/offerAction
- Get a job offer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers/{recruitingUIJobOffersUniqID}
- Get all job offers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers
Job Requisition Details
The recruitingICEJobRequisitionDetails resource provides details about how the information is shown to internal 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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}
- Get all job requisition details in preview mode
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails
- Get details for a job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{Id}
- Get details for all job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails
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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/requisitionFlexFields/{requisitionFlexFieldsUniqID}
- Get a requisition flexfield in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{Id}/child/requisitionFlexFields/{requisitionFlexFieldsUniqID}
- Get all requisition flexfields in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/requisitionFlexFields
- Get all requisition flexfields in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/media/{Id2}
- Get all media in the requisition details preview
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/otherWorkLocations
- Get all other work locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{Id}/child/otherWorkLocations
- Get an other work location in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/otherWorkLocations/{RequisitionWorkLocationId}
- Get an other work location in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/primaryLocationCoordinates/{primaryLocationCoordinatesUniqID}
- Get all primary location coordinates for the requisition details
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/secondaryLocations/{RequisitionLocationId}
- Get a secondary location in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{Id}/child/secondaryLocations/{RequisitionLocationId}
- Get all secondary locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/secondaryLocations
- Get all secondary locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/skills/{skillsUniqID}
- Get the details of a skill
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{Id}/child/skills/{skillsUniqID}
- Get the details of all the skills
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/skills
- Get the details of all the skills
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/workLocation/{LocationId}
- Get a work location in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{Id}/child/workLocation/{LocationId}
- Get all work locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetails/{Id}/child/workLocation
- Get all work locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitionDetails/{Id}/child/workLocation
Job Site Posted Jobs
The recruitingJobSitePostedJobs resource provides details about the publicly posted job requisitions. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get details about a posted job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}
- Get details about all posted requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs
Job Site Posted Jobs/Recruiting Requisition Additional Attributes
The requisitionAdditionalAttributes resource provides the additional attributes of the posted job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get details about all additional attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/requisitionAdditionalAttributes
- Get details about an additional attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/requisitionAdditionalAttributes/{requisitionAdditionalAttributesUniqID}
Job Site Posted Jobs/Requisition Languages
The requisitionLanguages resource is a child of jobDistributionDetails. It includes the details of the languages mentioned in the job description.
- Get the details of all the required languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/requisitionLanguages
- Get the details of the required language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}
Job Site Posted Jobs/Requisition Languages/Other Work Locations
The otherWorkLocations resource is a child of the requisitionLanguages resource. It provides the details of the other work locations used in the job distribution. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get the details of all the other work locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/otherWorkLocations
- Get the details of the other work location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/otherWorkLocations/{otherWorkLocationsUniqID}
Job Site Posted Jobs/Requisition Languages/Requisition Media
The media resource is a child of requisitionLanguages. It includes the details of the type of media used in the job distribution.
- Get the details of all the media
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/media
- Get the details of the media
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/media/{RequisitionMediaLinkId}
Job Site Posted Jobs/Requisition Languages/Secondary Locations
The secondaryLocations resource includes all the details of the secondary preferred location for the job distribution.
- Get the details of a secondary location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/secondaryLocations/{secondaryLocationsUniqID}
- Get the details of all the secondary locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/secondaryLocations
Job Site Posted Jobs/Requisition Skills
The skills resource provides details about the skills included in the job requisition.
- Get details about a skill
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/skills/{skillsUniqID}
- Get details about all the skills
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSitePostedJobs/{recruitingJobSitePostedJobsUniqID}/child/skills
Jobs
The jobs resource provides the details of all jobs as on a specified date. You can retrieve, create, and update the jobs.
- Effective start date for the jobs to be provided when using alternate key finder on jobs valid grades.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobs/{jobsUniqID}
- Identifier of the job valid grade to be provided when using alternate key finder on jobs valid grades.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobs
Jobs/Jobs V2 Descriptive Flexfields
Jobs/Jobs Valid Grades
Finds all the jobs valid grades that match the specified job identifier.
- Get a job valid grade
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobs/{jobsUniqID}/child/validGrades/{validGradesUniqID}
- Get all job valid grades
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations
- Delete a journey assignment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}
- Find an assigned journey
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/action/findByAdvancedSearchQuery
- Get a journey assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}
- Get all journey assignments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations
- Update a journey assignment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}
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: postPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/criteria
- Delete a journey assignment based on criteria
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/criteria/{criteriaUniqID}
- Get all assigned journeys based on criteria
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/criteria
- Get an assigned journey based on criteria
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/criteria/{criteriaUniqID}
- Update a journey assignment based on criteria
- Method: patchPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workerCounts/{JourneyAllocationId}
- Get all counts of workers in a journey allocation
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workers/{JourneyAllocationWorkerId}
- Get all workers with assigned journeys
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workers
Journey Allocations/Workers/Large Object (LOB) Attributes - ErrorDetails
- Get an ErrorDetails
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyAllocations/{journeyAllocationsUniqID}/child/workers/{JourneyAllocationWorkerId}/enclosure/ErrorDetails
Journey Counts
The journeyCounts resource provides counts of a worker journey.
- Get a journey count
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}
- Get all journey counts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyCounts
Journey Counts/Facets
The facets resource is a child of the journeyCounts resource and includes all the search filters in the worker journey.
- Get a facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}/child/facets/{facetsUniqID}
- Get all facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}/child/facets
Journey Counts/Facets/Values
The values resource is a child of the journeyCounts resource and includes all the values for the search filters in the worker journey.
- Get a value
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}/child/facets/{facetsUniqID}/child/values/{valuesUniqID}
- Get all values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyCounts/{SearchId}/child/facets/{facetsUniqID}/child/values
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: postPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary
- Delete a personal library task
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}
- Get a library task
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}
- Get all library tasks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary
- Update a personal library task
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{documentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{documentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{documentsUniqID}
Journey Task Library/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/notifications/{LibraryJourneyTaskNotificationId}
- Get all notification overrides for library task
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/notifications
- Update a notification override for library task
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/properties
- Get a library task property
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/properties/{propertiesUniqID}
- Get all library task properties
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/properties
- Update a library task property
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/properties/{propertiesUniqID}
Journey Task Library/Large Object (LOB) Attributes - Notes
- Delete a Notes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/enclosure/Notes
- Get a Notes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/enclosure/Notes
- Replace a Notes
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/enclosure/Notes
Journeys
The journeys resource includes all assignable journey templates.
- Create a journey template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys
- Delete a journey template
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}
- Duplicate a journey template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/action/duplicateJourney
- Find an assigned journey
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/action/findByAdvancedSearchQuery
- Find favorite journeys
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/action/toggleFavourite
- Find popular development journeys
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/action/findPopularJourneys
- Get a contextual action in a journey template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/action/contextualActionLabel
- Get a default journey template property
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/action/defaultProperties
- Get a default task type property in a journey template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/action/defaultTaskTypeProperties
- Get a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}
- Get all journey templates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys
- Update a journey template
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}
Journeys/All Step Tasks
The allStepTasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.
- Get a step task in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/allStepTasks/{JourneyTaskId}
- Get all step tasks in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/allStepTasks
Journeys/All Step Tasks/Large Object (LOB) Attributes - Notes
- Get a Notes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/allStepTasks/{JourneyTaskId}/enclosure/Notes
Journeys/Contacts
The contacts resource is a child of the journeys resource. It includes a list of contacts associated with the parent journey template.
- Create a contact in a journey template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts
- Get a contact in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts/{JourneyContactId}
- Get all contacts in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/contacts
Journeys/Events
The events resource is a child of the journeys resource. It includes all events associated with the parent journey template.
- Create an event in a journey template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/events
- Get all events in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/events
- Get an event in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/events/{JourneyEventId}
Journeys/Large Object (LOB) Attributes - BackgroundImage
- Delete a BackgroundImage
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/BackgroundImage
- Get a BackgroundImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/BackgroundImage
- Replace a BackgroundImage
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/BackgroundImage
Journeys/Large Object (LOB) Attributes - CroppedBackgroundImage
- Delete a CroppedBackgroundImage
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/CroppedBackgroundImage
- Get a CroppedBackgroundImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/CroppedBackgroundImage
- Replace a CroppedBackgroundImage
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/enclosure/CroppedBackgroundImage
Journeys/Notes
The notes resource is a child of the journeys resource. It includes all the notes associated with the parent journey template.
- Create a note in a journey template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/notes
- Get a note in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/notes/{JourneyNoteId}
- Get all notes in a journey template
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties
- Create all properties in a journey template
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties/{propertiesUniqID}
- Get a property in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties/{propertiesUniqID}
- Get all properties in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/properties
Journeys/Task Types
The taskTypes resource is the child of the journeys resource. It includes all the task types associated with the parent journey template.
- Create a task type in a journey template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes
- Create all task types in a journey template
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}
- Get a task type in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}
- Get all task types in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes
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: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties
- Get a task type property in an assigned journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties/{propertiesUniqID}
- Get all task type properties in an assigned journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties
- Update a task type property in an assigned journey
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/taskTypes/{Code}/child/properties/{propertiesUniqID}
Journeys/Tasks
The tasks resource is a child of the journeys resource. It includes all the tasks in the parent journey template.
- Create a task in a journey template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks
- Delete a task in a journey template
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}
- Get a task in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}
- Get all tasks in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks
- Update a task in a journey template
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}
Journeys/Tasks/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}
Journeys/Tasks/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileContents
Journeys/Tasks/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/documents/{documentsUniqID}/enclosure/FileWebImage
Journeys/Tasks/Large Object (LOB) Attributes - Notes
- Delete a Notes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/enclosure/Notes
- Get a Notes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/enclosure/Notes
- Replace a Notes
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/enclosure/Notes
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 in a journey template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/notifications
- Get a notification in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/notifications/{JourneyTaskNotificationId}
- Get all notifications in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/notifications
- Update a notification in a journey template
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/properties
- Create all task properties in a journey template
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId2}/child/properties/{propertiesUniqID}
- Get a task property in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId2}/child/properties/{propertiesUniqID}
- Get all task properties in a journey template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/tasks/{JourneyTaskId}/child/properties
Learner Learning Records
The learnerLearningRecords resource includes a single assignment or collection of assignments when queried with an assignment record ID. This is a functional user REST resource and applies to a learner and not a learning specialist. The voluntary and required assignments are included for the learning course, specialization, video, or tutorial. Recommended assignments are ignored.
- Create an assignment record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords
- Get all assignment records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords
- Get an assignment record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}
- Update an assignment record
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}
Learner Learning Records/Active Learner Comments
The comments resource provides details of all comments by active and completed learners for the learning item.
- Create an active learner comment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments
- Get all active learner comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments
- Get an active learner comment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
- Update an active learner comment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Learner Learning Records/Active Learner Comments/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/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 - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: getPath:
/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 provides details of the likes for comments by active and completed learners for the learning item.
- Create a like
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
- Get a like
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes/{likeId}
- Get all likes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
- Update a like
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes/{likeId}
Learner Learning Records/Active Learner Comments/Replies
The replies resource provides details of the replies to comments by active and completed learners for the learning item.
- Create a reply
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
- Get a reply
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}
- Get all replies
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
- Update a reply
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}
Learner Learning Records/Active Learner Comments/Replies/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/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 - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: getPath:
/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 provides details of the likes for comments by active and completed learners for the learning item.
- Create a like
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes
- Get a like
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes/{likeId}
- Get all likes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies/{commentId}/child/likes
- Update a like
- Method: patchPath:
/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 provides the approval details for the learning assignment.
- Get all approval details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/approvalDetails
- Get an approval detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/approvalDetails/{approvalDetailsUniqID}
Learner Learning Records/Completion Details
The completionDetails resource provides completion details for the learner assignment when queried with the assignment record ID. It provides the completion details for all activities that a learner has completed or will complete. The provided details are equivalent to what learning administrators see on the Manage Activities page for a learning assignment.
- Create a completion detail
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails
- Get a completion detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}
- Get all completion details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails
- Update a completion detail
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}
Learner Learning Records/Completion Details/Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint
Learner Learning Records/Completion Details/Activity Content Attempts
The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date.
- Create a content attempt detail
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
- Get a content attempt detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Get all content attempt details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
- Update a content attempt detail
- Method: patchPath:
/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 - contentLongDescription
- Get a contentLongDescription
- Method: getPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/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: deletePath:
/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: getPath:
/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: putPath:
/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: postPath:
/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: deletePath:
/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: getPath:
/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: getPath:
/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: patchPath:
/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
- Delete a FileContents
- Method: deletePath:
/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: getPath:
/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: putPath:
/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: getPath:
/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: postPath:
/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: getPath:
/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: getPath:
/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: patchPath:
/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: deletePath:
/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: getPath:
/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: putPath:
/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: postPath:
/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: deletePath:
/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: getPath:
/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: getPath:
/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: patchPath:
/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
- Delete a FileContents
- Method: deletePath:
/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: getPath:
/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: putPath:
/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: getPath:
/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 provides hints for the predecessor of the learning activity section when sequencing is enabled.
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint
Learner Learning Records/Completion Details/Classrooms
The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.
- Get a classroom
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}
- Get all classrooms
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms
Learner Learning Records/Completion Details/Classrooms/Attachments
The attachments resource provides the related learning materials for the parent resource.
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}
- Update a related material
- Method: patchPath:
/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 - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: getPath:
/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/Resource Descriptive Flexfields
The operations from the Learner Learning Records/Completion Details/Classrooms/Resource Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/classroomDFFs/{ResourceId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/classrooms/{classroomsUniqID}/child/classroomDFFs
Learner Learning Records/Completion Details/Instructors
The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
- Get all instructors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors
- Get an instructor
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorsUniqID}
Learner Learning Records/Completion Details/Instructors/Resource Descriptive Flexfields
The operations from the Learner Learning Records/Completion Details/Instructors/Resource Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorsUniqID}/child/instructorDFF/{ResourceId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/instructors/{instructorsUniqID}/child/instructorDFF
Learner Learning Records/Completion Details/Large Object (LOB) Attributes - activityDescriptionLong
- Get an activityDescriptionLong
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/enclosure/activitySectionLongDescription
Learner Learning Records/Completion Details/Learning Item Talent Profile Summary
The summary learning information from the talent profile, such as if a course is configured with prerequisites or outcomes.
- Get a talent profile summary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/learningItemTalentProfileSummary/{learningItemId}
- Get all talent profile summaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/learningItemTalentProfileSummary
Learner Learning Records/Completion Details/Observer Person Details
The person details of each configured observer when an observation checklist is configured to use named observers.
- Get all observer person details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/elearnObsPersonDetails
- Get an observer person detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/elearnObsPersonDetails/{elearnObsPersonDetailsUniqID}
Learner Learning Records/Completion Details/Offered Languages
The offeredLanguages resource provides the offering language for a learning item.
- Get all offered languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
- Get an offered language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages/{offeredLanguagesUniqID}
Learner Learning Records/Completion Details/Offered Locations
The offeredLocations resource provides the location details for a learning item.
- Get all offering locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
- Get an offering location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings
The selectedCourseOfferings resource provides all offerings of an assigned course. This resource is applicable for only courses. It's empty for all other types of learning.
- Create a selected course offering
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings
- Get a selected course offering
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
- Get a selected course offering
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}
- Get a selected course offering
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
- Get all selected course offerings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings
- Get all selected course offerings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering
- Get all selected course offerings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings
- Update a selected course offering
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
- Update a selected course offering
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}
- Update a selected course offering
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Active Learner Comments
The comments resource provides details of all comments by active and completed learners for the learning item.
- Create an active learner comment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments
- Get all active learner comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments
- Get an active learner comment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
- Update an active learner comment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Active Learner Comments/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Active Learner Comments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Learner Learning Records/Completion Details/Other Selected Course Offerings/Active Learner Comments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Completion Details/Other Selected Course Offerings/Active Learner Comments/Likes
The likes resource provides details of the likes for comments by active and completed learners for the learning item.
- Create a like
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
- Get a like
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/likes/{likeId}
- Get all likes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
- Update a like
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/likes/{likeId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Active Learner Comments/Replies
The replies resource provides details of the replies to comments by active and completed learners for the learning item.
- Create a reply
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
- Get a reply
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId}
- Get all replies
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
- Update a reply
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Active Learner Comments/Replies/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Active Learner Comments/Replies/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Learner Learning Records/Completion Details/Other Selected Course Offerings/Active Learner Comments/Replies/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Completion Details/Other Selected Course Offerings/Active Learner Comments/Replies/Likes
The likes resource provides details of the likes for comments by active and completed learners for the learning item.
- Create a like
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId}/child/likes
- Get a like
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/likes/{likeId}
- Get all likes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId}/child/likes
- Update a like
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments/{activeLearnerCommentsUniqID2}/child/replies/{commentId2}/child/likes/{likeId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Approval Details
The approvalDetails resource provides the approval details for the learning assignment.
- Get all approval details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/approvalDetails
- Get an approval detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/approvalDetails/{approvalDetailsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details
The completionDetails resource provides completion details for the learner assignment when queried with the assignment record ID. It provides the completion details for all activities that a learner has completed or will complete. The provided details are equivalent to what learning administrators see on the Manage Activities page for a learning assignment.
- Get a completion detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}
- Get a completion detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}
- Get a completion detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}
- Get all completion details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails
- Get all completion details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails
- Get all completion details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityCompletionPredecessorHint
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityCompletionPredecessorHint
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityCompletionPredecessorHint
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Activity Content Attempts
The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date.
- Create a content attempt detail
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts
- Create a content attempt detail
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts
- Create a content attempt detail
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts
- Get a content attempt detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Get a content attempt detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Get a content attempt detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Get all content attempt details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts
- Get all content attempt details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts
- Get all content attempt details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts
- Update a content attempt detail
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Update a content attempt detail
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Update a content attempt detail
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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 - contentLongDescription
- Get a contentLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription
- Get a contentLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription
- Get a contentLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/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
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/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 a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}
- Get all question responses
- Method: getPath:
/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 all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/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}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: deletePath:
/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
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/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
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/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}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/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
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/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}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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
- Delete a FileContents
- Method: deletePath:
/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
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: getPath:
/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
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/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
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get a question response
- Method: getPath:
/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 a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}
- Get all question responses
- Method: getPath:
/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 all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Update a question response
- Method: patchPath:
/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}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: deletePath:
/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
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/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
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: deletePath:
/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}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get all response attachments
- Method: getPath:
/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
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: patchPath:
/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}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_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
- Delete a FileContents
- Method: deletePath:
/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
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_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: getPath:
/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
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activityContentAttempts/{activityContentAttemptsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId2}/child/questionResponses/{QuestionResponseId3}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId4}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_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 provides hints for the predecessor of the learning activity section when sequencing is enabled.
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activitySectionCompletionPredecessorHint
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activitySectionCompletionPredecessorHint
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/activitySectionCompletionPredecessorHint
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms
The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.
- Get a classroom
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}
- Get a classroom
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}
- Get a classroom
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}
- Get all classrooms
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms
- Get all classrooms
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms
- Get all classrooms
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms/Attachments
The attachments resource provides the related learning materials for the parent resource.
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}/child/attachments
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}/child/attachments
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}/child/attachments
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}/child/attachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}/child/attachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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 - FileContents
- Delete a FileContents
- Method: deletePath:
/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
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/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 FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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 FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: getPath:
/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
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/attachments/{AttachedDocumentId}/enclosure/FileWebImage
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms/Resource Descriptive Flexfields
The operations from the Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Classrooms/Resource Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/classroomDFFs/{ResourceId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/classroomDFFs/{ResourceId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID2}/child/classroomDFFs/{ResourceId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}/child/classroomDFFs
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}/child/classroomDFFs
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/classrooms/{classroomsUniqID}/child/classroomDFFs
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Instructors
The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
- Get all instructors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors
- Get all instructors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors
- Get all instructors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors
- Get an instructor
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorsUniqID}
- Get an instructor
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorsUniqID}
- Get an instructor
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Instructors/Resource Descriptive Flexfields
The operations from the Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Instructors/Resource Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorsUniqID2}/child/instructorDFF/{ResourceId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorsUniqID2}/child/instructorDFF/{ResourceId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorsUniqID2}/child/instructorDFF/{ResourceId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorsUniqID}/child/instructorDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorsUniqID}/child/instructorDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/instructors/{instructorsUniqID}/child/instructorDFF
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activityDescriptionLong
- Get an activityDescriptionLong
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/enclosure/activityDescriptionLong
- Get an activityDescriptionLong
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/enclosure/activityDescriptionLong
- Get an activityDescriptionLong
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/enclosure/activitySectionLongDescription
- Get an activitySectionLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/enclosure/activitySectionLongDescription
- Get an activitySectionLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/enclosure/activitySectionLongDescription
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Offered Languages
The offeredLanguages resource provides the offering language for a learning item.
- Get all offered languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages
- Get all offered languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages
- Get all offered languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages
- Get an offered language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages/{offeredLanguagesUniqID}
- Get an offered language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages/{offeredLanguagesUniqID}
- Get an offered language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLanguages/{offeredLanguagesUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Offered Locations
The offeredLocations resource provides the location details for a learning item.
- Get all offering locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations
- Get all offering locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations
- Get all offering locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations
- Get an offering location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations/{offeredLocationsUniqID}
- Get an offering location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/offeredLocations/{offeredLocationsUniqID}
- Get an offering location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: deletePath:
/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
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/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
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/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}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/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
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/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}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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
- Delete a FileContents
- Method: deletePath:
/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
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: getPath:
/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
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/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
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get a question response
- Method: getPath:
/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 a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}
- Get all question responses
- Method: getPath:
/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 all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Update a question response
- Method: patchPath:
/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}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: deletePath:
/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
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/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
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/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}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get all response attachments
- Method: getPath:
/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
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/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}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_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
- Delete a FileContents
- Method: deletePath:
/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
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_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: getPath:
/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
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId3}/child/questionResponses/{QuestionResponseId5}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId6}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials
Learner Learning Records/Completion Details/Other Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails/{completionDetailsUniqID2}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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 a completion summary for a single learning assignment or a collection of assignments when queried with the assignment record ID. The summary includes completion requirements, the passing and actual scores, expected number of activities, effort for completion, and completion progress for the associated course offering.
- Get a completion summary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionSummary/{completionSummaryUniqID}
- Get a completion summary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionSummary/{completionSummaryUniqID}
- Get a completion summary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionSummary/{completionSummaryUniqID}
- Get all completion summaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionSummary
- Get all completion summaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionSummary
- Get all completion summaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionSummary
Learner Learning Records/Completion Details/Other Selected Course Offerings/Enrollment History
The enrollmentHistory resource provides the enrollment history details for the learning assignment.
- Get all enrollment history items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory
- Get all enrollment history items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory
- Get all enrollment history items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory
- Get an enrollment history item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory/{enrollmentHistoryUniqID}
- Get an enrollment history item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory/{enrollmentHistoryUniqID}
- Get an enrollment history item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory/{enrollmentHistoryUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Enrollment Related Materials
The attachments resource provides the related learning materials for the parent resource.
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Enrollment Related Materials/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Learner Learning Records/Completion Details/Other Selected Course Offerings/Enrollment Related Materials/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage
Learner Learning Records/Completion Details/Other Selected Course Offerings/Errors
The errors resource provides a list of all the errors that exist on it's parent resource. Details include error identifier, error code, and error category.
- Get all errors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/errors
- Get all errors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/errors
- Get an error
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/errors/{errorId}
- Get an error
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/errors/{errorId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Large Object (LOB) Attributes - liLongDescription
- Get a liLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/enclosure/liLongDescription
- Get a liLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/enclosure/liLongDescription
- Get a liLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/enclosure/liLongDescription
Learner Learning Records/Completion Details/Other Selected Course Offerings/Learning Item Descriptive Flexfields
The operations from the Learner Learning Records/Completion Details/Other Selected Course Offerings/Learning Item Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF/{learningItemDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF/{learningItemDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF/{learningItemDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF
Learner Learning Records/Completion Details/Other Selected Course Offerings/Learning Item Rating Details
The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status.
- Create a rating
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Create a rating
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Create a rating
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Get a rating
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Get a rating
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Get a rating
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Get all ratings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Get all ratings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Get all ratings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Update a rating
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Update a rating
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Update a rating
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Learning Item Rating Details/User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails/{personId}
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails/{personId}
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails/{personId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Learning Request Descriptive Flexfields
The operations from the Learner Learning Records/Completion Details/Other Selected Course Offerings/Learning Request Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.
- Edit a message
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages/{messagesUniqID}
- Edit a message
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/messages/{messagesUniqID}
- Edit a message
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages/{messagesUniqID}
- Get a message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages/{messagesUniqID}
- Get a message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/messages/{messagesUniqID}
- Get a message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages/{messagesUniqID}
- Get all messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages
- Get all messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/messages
- Get all messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages
Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Descriptive Flexfields
The operations from the Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF/{offeringDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF/{offeringDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF/{offeringDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF
Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Primary Classrooms
The offeringPrimaryClassroom resource provides primary classroom details for the ILT or blended learning offering.
- Get a primary classroom
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}
- Get all primary classrooms
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom
Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Primary Classrooms/Attachments
The attachments resource provides the related learning materials for the parent resource.
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Primary Classrooms/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId}/enclosure/FileContents
Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Primary Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/attachments/{AttachedDocumentId}/enclosure/FileWebImage
Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Primary Classrooms/Resource Descriptive Flexfields
The operations from the Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Primary Classrooms/Resource Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/classroomDFFs/{ResourceId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom/{classroomId}/child/classroomDFFs
Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Primary Instructors
The offeringPrimaryInstructor resource provides the details for the primary instructor of the learning offering. Details include instructor identifier, display name, and email address
- Get a primary instructor
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}
- Get all primary instructors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor
Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Primary Instructors/Resource Descriptive Flexfields
The operations from the Learner Learning Records/Completion Details/Other Selected Course Offerings/Offering Primary Instructors/Resource Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF/{ResourceId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF
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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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
- Delete a FileContents
- Method: deletePath:
/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
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: getPath:
/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
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/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
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get a question response
- Method: getPath:
/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 a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}
- Get all question responses
- Method: getPath:
/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 all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Update a question response
- Method: patchPath:
/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}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: deletePath:
/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
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{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: postPath:
/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
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/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}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get all response attachments
- Method: getPath:
/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
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/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}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_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
- Delete a FileContents
- Method: deletePath:
/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
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_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: getPath:
/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
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId4}/child/questionResponses/{QuestionResponseId7}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId8}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
Learner Learning Records/Completion Details/Other Selected Course Offerings/Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials
Learner Learning Records/Completion Details/Other Selected Course Offerings/Related Materials/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Learner Learning Records/Completion Details/Other Selected Course Offerings/Related Materials/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage
Learner Learning Records/Completion Details/Other Selected Course Offerings/Transaction Histories
The transactionHistory resource provides the transaction history for its parent resource. Details include transaction identifier, transaction number, transaction date, and transaction reason.
- Get a transaction history
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory/{transactionId}
- Get a transaction history
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory/{transactionId}
- Get a transaction history
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory/{transactionId}
- Get all transaction histories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory
- Get all transaction histories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory
- Get all transaction histories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory
Learner Learning Records/Completion Details/Other Selected Course Offerings/User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignerPersonDetails
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignerPersonDetails/{personId}
Learner Learning Records/Completion Details/Other Selected Course Offerings/User Action Hints
Hints for possible actions on a learner's assignment records.
- Get a user action hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/userActionHints/{userActionHintsUniqID}
- Get all user action hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/userActionHints
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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}
Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}/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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}
Learner Learning Records/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/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
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId5}/child/questionResponses/{QuestionResponseId9}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId10}/child/questionResponseAttachments/{learnerLearningRecords_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
Learner Learning Records/Completion Details/Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId}
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials
Learner Learning Records/Completion Details/Related Materials/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage
Learner Learning Records/Completion Details/User Action Hints
Hints for possible actions on a learner's assignment records.
- Get a user action hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/userActionHints/{userActionHintsUniqID}
- Get all user action hints
- Method: getPath:
/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 a completion summary for a single learning assignment or a collection of assignments when queried with the assignment record ID. The summary includes completion requirements, the passing and actual scores, expected number of activities, effort for completion, and completion progress for the associated course offering.
- Get a completion summary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionSummary/{completionSummaryUniqID}
- Get all completion summaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionSummary
Learner Learning Records/Course Descriptive Flexfields
The operations from the Learner Learning Records/Course Descriptive Flexfields category.
Learner Learning Records/Enrollment History
The enrollmentHistory resource provides the enrollment history details for the learning assignment.
- Get all enrollment history items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentHistory
- Get an enrollment history item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentHistory/{enrollmentHistoryUniqID}
Learner Learning Records/Enrollment Related Materials
The attachments resource provides the related learning materials for the parent resource.
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}
Learner Learning Records/Enrollment Related Materials/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Learner Learning Records/Enrollment Related Materials/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/enrollmentRelatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage
Learner Learning Records/Learning Item Descriptive Flexfields
The operations from the Learner Learning Records/Learning Item Descriptive Flexfields category.
Learner Learning Records/Learning Item Rating Details
The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status.
- Create a rating
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails
- Get a rating
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Get all ratings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails
- Update a rating
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
Learner Learning Records/Learning Item Rating Details/User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID2}/child/ratedByPersonDetails/{personId}
Learner Learning Records/Learning Prerequisites
The learningPrerequisites resource provides the learning prerequisites for the learning items associated with a learning assignment. This is applicable for only courses and specializations.
- Get a learning prerequisite or outcome
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningOutcomes/{profileItemId}
- Get a learning prerequisite or outcome
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningPrerequisites/{profileItemId}
- Get all learning prerequisites or outcomes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningOutcomes
- Get all learning prerequisites or outcomes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningPrerequisites
Learner Learning Records/Learning Request Descriptive Flexfields
The operations from the Learner Learning Records/Learning Request Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF/{RequestDetailId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.
- Edit a message
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/messages/{messagesUniqID}
- Get a message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/messages/{messagesUniqID}
- Get all messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/messages
Learner Learning Records/Noncatalog Learning Item
The learning item details required to create noncatalog requests or record external learning under the assignment profile.
- Add a learning item to the specified learning assignment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDetails
- Get all the learning items associated with the specified learning assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDetails
- Get the learning item associated with the specified learning assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDetails/{learningItemDetailsUniqID}
- Update a learning item associated to the specified learning assignment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDetails/{learningItemDetailsUniqID}
Learner Learning Records/Noncatalog Learning Item/Learning Item Descriptive Flexfields
The operations from the Learner Learning Records/Noncatalog Learning Item/Learning Item Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDetails/{learningItemDetailsUniqID}/child/learningItemDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDetails/{learningItemDetailsUniqID}/child/learningItemDFF/{learningItemDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDetails/{learningItemDetailsUniqID}/child/learningItemDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemDetails/{learningItemDetailsUniqID}/child/learningItemDFF/{learningItemDFFUniqID}
Learner Learning Records/Offered Languages
The offeredLanguages resource provides the offering language for a learning item.
- Get all offered languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/offeredLanguages
- Get an offered language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/offeredLanguages/{offeredLanguagesUniqID}
Learner Learning Records/Other Selected Course Offerings
The selectedCourseOfferings resource provides all offerings of an assigned course. This resource is applicable for only courses. It's empty for all other types of learning.
- Create a selected course offering
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings
- Get a selected course offering
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
- Get a selected course offering
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}
- Get a selected course offering
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
- Get all selected course offerings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings
- Get all selected course offerings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering
- Get all selected course offerings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings
- Update a selected course offering
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
- Update a selected course offering
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}
- Update a selected course offering
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}
Learner Learning Records/Other Selected Course Offerings/Active Learner Comments
The comments resource provides details of all comments by active and completed learners for the learning item.
- Create an active learner comment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments
- Get all active learner comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/activeLearnerComments
- Get an active learner comment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
- Update an active learner comment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}
Learner Learning Records/Other Selected Course Offerings/Active Learner Comments/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Other Selected Course Offerings/Active Learner Comments/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Learner Learning Records/Other Selected Course Offerings/Active Learner Comments/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Active Learner Comments/Likes
The likes resource provides details of the likes for comments by active and completed learners for the learning item.
- Create a like
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
- Get a like
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/likes/{likeId}
- Get all likes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/likes
- Update a like
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/likes/{likeId}
Learner Learning Records/Other Selected Course Offerings/Active Learner Comments/Replies
The replies resource provides details of the replies to comments by active and completed learners for the learning item.
- Create a reply
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
- Get a reply
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}
- Get all replies
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID}/child/replies
- Update a reply
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}
Learner Learning Records/Other Selected Course Offerings/Active Learner Comments/Replies/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}
Learner Learning Records/Other Selected Course Offerings/Active Learner Comments/Replies/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Learner Learning Records/Other Selected Course Offerings/Active Learner Comments/Replies/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Active Learner Comments/Replies/Likes
The likes resource provides details of the likes for comments by active and completed learners for the learning item.
- Create a like
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}/child/likes
- Get a like
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/likes/{likeId}
- Get all likes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId}/child/likes
- Update a like
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/activeLearnerComments/{activeLearnerCommentsUniqID3}/child/replies/{commentId3}/child/likes/{likeId}
Learner Learning Records/Other Selected Course Offerings/Approval Details
The approvalDetails resource provides the approval details for the learning assignment.
- Get all approval details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/approvalDetails
- Get an approval detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/approvalDetails/{approvalDetailsUniqID}
Learner Learning Records/Other Selected Course Offerings/Completion Details
The completionDetails resource provides completion details for the learner assignment when queried with the assignment record ID. It provides the completion details for all activities that a learner has completed or will complete. The provided details are equivalent to what learning administrators see on the Manage Activities page for a learning assignment.
- Get a completion detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}
- Get a completion detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}
- Get a completion detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}
- Get all completion details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails
- Get all completion details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionDetails
- Get all completion details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionDetails
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityCompletionPredecessorHint/{activityCompletionPredecessorHintUniqID}
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityCompletionPredecessorHint
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts
The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date.
- Create a content attempt detail
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
- Create a content attempt detail
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
- Create a content attempt detail
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
- Get a content attempt detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Get a content attempt detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Get a content attempt detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Get all content attempt details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
- Get all content attempt details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
- Get all content attempt details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activityContentAttempts
- Update a content attempt detail
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Update a content attempt detail
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}
- Update a content attempt detail
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Large Object (LOB) Attributes - contentLongDescription
- Get a contentLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription
- Get a contentLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription
- Get a contentLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/enclosure/contentLongDescription
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/enclosure/AnswerLargeObject
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Learner Learning Records/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Content Attempts/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}
Learner Learning Records/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: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Learner Learning Records/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: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Learner Learning Records/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
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Learner Learning Records/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activityContentAttempts/{activityContentAttemptsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId6}/child/questionResponses/{QuestionResponseId11}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID6}/child/QuestionResponses/{QuestionResponseId1}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_activityContentAttempts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Completion Details/Activity Section Completion Predecessor Hints
The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
- Get a hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/activitySectionCompletionPredecessorHint/{activitySectionCompletionPredecessorHintUniqID}
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint
- Get all hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/activitySectionCompletionPredecessorHint
Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms
The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.
- Get a classroom
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}
- Get a classroom
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}
- Get a classroom
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}
- Get all classrooms
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/classrooms
- Get all classrooms
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/classrooms
- Get all classrooms
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/classrooms
Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Attachments
The attachments resource provides the related learning materials for the parent resource.
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileContents
Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/attachments/{AttachedDocumentId10}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Resource Descriptive Flexfields
The operations from the Learner Learning Records/Other Selected Course Offerings/Completion Details/Classrooms/Resource Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/child/classroomDFFs/{ResourceId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/child/classroomDFFs/{ResourceId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID3}/child/classroomDFFs/{ResourceId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/classroomDFFs
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/classroomDFFs
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/classrooms/{classroomsUniqID}/child/classroomDFFs
Learner Learning Records/Other Selected Course Offerings/Completion Details/Instructors
The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
- Get all instructors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/instructors
- Get all instructors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/instructors
- Get all instructors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/instructors
- Get an instructor
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID}
- Get an instructor
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID}
- Get an instructor
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Instructors/Resource Descriptive Flexfields
The operations from the Learner Learning Records/Other Selected Course Offerings/Completion Details/Instructors/Resource Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID3}/child/instructorDFF/{ResourceId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID3}/child/instructorDFF/{ResourceId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID3}/child/instructorDFF/{ResourceId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID}/child/instructorDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID}/child/instructorDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/instructors/{instructorsUniqID}/child/instructorDFF
Learner Learning Records/Other Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activityDescriptionLong
- Get an activityDescriptionLong
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activityDescriptionLong
- Get an activityDescriptionLong
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activityDescriptionLong
- Get an activityDescriptionLong
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activityDescriptionLong
Learner Learning Records/Other Selected Course Offerings/Completion Details/Large Object (LOB) Attributes - activitySectionLongDescription
- Get an activitySectionLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activitySectionLongDescription
- Get an activitySectionLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activitySectionLongDescription
- Get an activitySectionLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/enclosure/activitySectionLongDescription
Learner Learning Records/Other Selected Course Offerings/Completion Details/Offered Languages
The offeredLanguages resource provides the offering language for a learning item.
- Get all offered languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
- Get all offered languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
- Get all offered languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLanguages
- Get an offered language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/offeredLanguages/{offeredLanguagesUniqID}
- Get an offered language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/offeredLanguages/{offeredLanguagesUniqID}
- Get an offered language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/offeredLanguages/{offeredLanguagesUniqID}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Offered Locations
The offeredLocations resource provides the location details for a learning item.
- Get all offering locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
- Get all offering locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
- Get all offering locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/offeredLocations
- Get an offering location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/offeredLocations/{offeredLocationsUniqID}
- Get an offering location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/offeredLocations/{offeredLocationsUniqID}
- Get an offering location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/offeredLocations/{offeredLocationsUniqID}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/enclosure/AnswerLargeObject
Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Learner Learning Records/Other Selected Course Offerings/Completion Details/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Learner Learning Records/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID3}/child/questionnaireResponses/{QuestionnaireResponseId7}/child/questionResponses/{QuestionResponseId13}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId14}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_completionDetails_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Completion Details/Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials
Learner Learning Records/Other Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileContents
Learner Learning Records/Other Selected Course Offerings/Completion Details/Related Materials/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}/child/relatedMaterials/{AttachedDocumentId11}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Completion Summaries
The completionSummary resource is a child of the learnerLearningRecords resource. It provides a completion summary for a single learning assignment or a collection of assignments when queried with the assignment record ID. The summary includes completion requirements, the passing and actual scores, expected number of activities, effort for completion, and completion progress for the associated course offering.
- Get a completion summary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionSummary/{completionSummaryUniqID}
- Get a completion summary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionSummary/{completionSummaryUniqID}
- Get a completion summary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/completionSummary/{completionSummaryUniqID}
- Get all completion summaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionSummary
- Get all completion summaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/completionSummary
- Get all completion summaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/completionSummary
Learner Learning Records/Other Selected Course Offerings/Enrollment History
The enrollmentHistory resource provides the enrollment history details for the learning assignment.
- Get all enrollment history items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory
- Get all enrollment history items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory
- Get all enrollment history items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentHistory
- Get an enrollment history item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentHistory/{enrollmentHistoryUniqID}
- Get an enrollment history item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentHistory/{enrollmentHistoryUniqID}
- Get an enrollment history item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentHistory/{enrollmentHistoryUniqID}
Learner Learning Records/Other Selected Course Offerings/Enrollment Related Materials
The attachments resource provides the related learning materials for the parent resource.
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/enrollmentRelatedMaterials
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}
Learner Learning Records/Other Selected Course Offerings/Enrollment Related Materials/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Learner Learning Records/Other Selected Course Offerings/Enrollment Related Materials/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/enrollmentRelatedMaterials/{AttachedDocumentId1}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Errors
The errors resource provides a list of all the errors that exist on it's parent resource. Details include error identifier, error code, and error category.
- Get all errors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/errors
- Get all errors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/errors
- Get an error
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/errors/{errorId}
- Get an error
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/errors/{errorId}
Learner Learning Records/Other Selected Course Offerings/Large Object (LOB) Attributes - liLongDescription
- Get a liLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/enclosure/liLongDescription
- Get a liLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/enclosure/liLongDescription
- Get a liLongDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/enclosure/liLongDescription
Learner Learning Records/Other Selected Course Offerings/Learning Item Descriptive Flexfields
The operations from the Learner Learning Records/Other Selected Course Offerings/Learning Item Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemDFF/{learningItemDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/learningItemDFF/{learningItemDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemDFF/{learningItemDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemDFF
Learner Learning Records/Other Selected Course Offerings/Learning Item Rating Details
The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status.
- Create a rating
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Create a rating
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Create a rating
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Get a rating
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Get a rating
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Get a rating
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Get all ratings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Get all ratings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Get all ratings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails
- Update a rating
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Update a rating
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
- Update a rating
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
Learner Learning Records/Other Selected Course Offerings/Learning Item Rating Details/User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}/child/ratedByPersonDetails
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID3}/child/ratedByPersonDetails/{personId}
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID3}/child/ratedByPersonDetails/{personId}
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID3}/child/ratedByPersonDetails/{personId}
Learner Learning Records/Other Selected Course Offerings/Learning Request Descriptive Flexfields
The operations from the Learner Learning Records/Other Selected Course Offerings/Learning Request Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/assignmentDFF/{RequestDetailId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/assignmentDFF/{RequestDetailId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/assignmentDFF/{RequestDetailId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignmentDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/assignmentDFF/{RequestDetailId}
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/assignmentDFF/{RequestDetailId}
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/assignmentDFF/{RequestDetailId}
Learner Learning Records/Other Selected Course Offerings/Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.
- Edit a message
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/messages/{messagesUniqID}
- Edit a message
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/messages/{messagesUniqID}
- Edit a message
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/messages/{messagesUniqID}
- Get a message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/messages/{messagesUniqID}
- Get a message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/messages/{messagesUniqID}
- Get a message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/messages/{messagesUniqID}
- Get all messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages
- Get all messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/messages
- Get all messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/messages
Learner Learning Records/Other Selected Course Offerings/Offering Descriptive Flexfields
The operations from the Learner Learning Records/Other Selected Course Offerings/Offering Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringDFF/{offeringDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/offeringDFF/{offeringDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringDFF/{offeringDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringDFF
Learner Learning Records/Other Selected Course Offerings/Offering Primary Classrooms
The offeringPrimaryClassroom resource provides primary classroom details for the ILT or blended learning offering.
- Get a primary classroom
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId}
- Get all primary classrooms
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryClassroom
Learner Learning Records/Other Selected Course Offerings/Offering Primary Classrooms/Attachments
The attachments resource provides the related learning materials for the parent resource.
- Create a related material
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId}/child/attachments
- Delete a related material
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId1}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId1}
- Update a related material
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId1}
Learner Learning Records/Other Selected Course Offerings/Offering Primary Classrooms/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId1}/enclosure/FileContents
Learner Learning Records/Other Selected Course Offerings/Offering Primary Classrooms/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/attachments/{AttachedDocumentId1}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Offering Primary Classrooms/Resource Descriptive Flexfields
The operations from the Learner Learning Records/Other Selected Course Offerings/Offering Primary Classrooms/Resource Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId2}/child/classroomDFFs/{ResourceId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryClassroom/{classroomId}/child/classroomDFFs
Learner Learning Records/Other Selected Course Offerings/Offering Primary Instructors
The offeringPrimaryInstructor resource provides the details for the primary instructor of the learning offering. Details include instructor identifier, display name, and email address
- Get a primary instructor
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryInstructor/{instructorId}
- Get all primary instructors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/offeringPrimaryInstructor
Learner Learning Records/Other Selected Course Offerings/Offering Primary Instructors/Resource Descriptive Flexfields
The operations from the Learner Learning Records/Other Selected Course Offerings/Offering Primary Instructors/Resource Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF/{ResourceId10}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/offeringPrimaryInstructor/{instructorId}/child/instructorDFF
Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}
Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}
Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}
Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/enclosure/AnswerLargeObject
Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Learner Learning Records/Other Selected Course Offerings/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Learner Learning Records/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: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_otherSelectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_primarySelectedCourseOffering_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/questionnaireResponses/{QuestionnaireResponseId8}/child/questionResponses/{QuestionResponseId15}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId16}/child/questionResponseAttachments/{learnerLearningRecords_selectedCourseOfferings_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRelatedMaterials/{AttachedDocumentId1}
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRelatedMaterials/{AttachedDocumentId1}
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/learningItemRelatedMaterials
Learner Learning Records/Other Selected Course Offerings/Related Materials/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileContents
Learner Learning Records/Other Selected Course Offerings/Related Materials/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/learningItemRelatedMaterials/{AttachedDocumentId1}/enclosure/FileWebImage
Learner Learning Records/Other Selected Course Offerings/Transaction Histories
The transactionHistory resource provides the transaction history for its parent resource. Details include transaction identifier, transaction number, transaction date, and transaction reason.
- Get a transaction history
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/transactionHistory/{transactionId}
- Get a transaction history
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/transactionHistory/{transactionId}
- Get a transaction history
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/transactionHistory/{transactionId}
- Get all transaction histories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/otherSelectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory
- Get all transaction histories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory
- Get all transaction histories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/transactionHistory
Learner Learning Records/Other Selected Course Offerings/User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/assignerPersonDetails
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/assignerPersonDetails/{personId}
Learner Learning Records/Other Selected Course Offerings/User Action Hints
Hints for possible actions on a learner's assignment records.
- Get a user action hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID2}/child/userActionHints/{userActionHintsUniqID}
- Get all user action hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{otherSelectedCourseOfferingsUniqID}/child/userActionHints
Learner Learning Records/Past Renewals
The pastRenewals resource provides a list of all past renewals for the learning assignment. Details include assignment record identifier, assignment creation date, and assignment type.
- Get a past renewal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals/{pastRenewalsUniqID}
- Get all past renewals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals
Learner Learning Records/Past Renewals/Related Learning Records
The relatedLearningRecords resource provides details of the related learning assignments for the learning assignment.
- Get a related assignment record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals/{pastRenewalsUniqID}/child/relatedLearningRecords/{assignmentRelationId}
- Get all related assignment records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/pastRenewals/{pastRenewalsUniqID}/child/relatedLearningRecords
Learner Learning Records/Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Learner Learning Records/Questionnaire Responses/Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}
Learner Learning Records/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}/enclosure/AnswerLargeObject
Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId1}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}
Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/enclosure/AnswerLargeObject
Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
- Create a response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Learner Learning Records/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId9}/child/questionResponses/{QuestionResponseId17}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId18}/child/questionResponseAttachments/{learnerLearningRecords_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
Learner Learning Records/Related Learning Records
The relatedLearningRecords resource provides details of the related learning assignments for the learning assignment.
- Get a related assignment record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/relatedLearningRecords/{assignmentRelationId}
- Get all related assignment records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/relatedLearningRecords
Learner Learning Records/Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
- Get a learning item related material
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}
- Get all learning item related materials
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials
Learner Learning Records/Related Materials/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileContents
Learner Learning Records/Related Materials/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRelatedMaterials/{AttachedDocumentId}/enclosure/FileWebImage
Learner Learning Records/Selected Course Offerings Summary
The selectedCourseOfferingsSummary resource provides a summary of all selected learning course offerings.
- Get a selected course offering summary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferingsSummary/{selectedCourseOfferingsSummaryUniqID}
- Get all selected course offering summaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferingsSummary
Learner Learning Records/Specialization Descriptive Flexfields
The operations from the Learner Learning Records/Specialization Descriptive Flexfields category.
Learner Learning Records/Transaction Histories
The transactionHistory resource provides the transaction history for its parent resource. Details include transaction identifier, transaction number, transaction date, and transaction reason.
- Get a transaction history
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/transactionHistory/{transactionId}
- Get all transaction histories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/transactionHistory
Learner Learning Records/User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignedToPersonDetails
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignerPersonDetails
- Get details about all the people associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemPublisherPersonDetails
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignedToPersonDetails/{personId}
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/assignerPersonDetails/{personId}
- Get details about the person associated with the learning item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemPublisherPersonDetails/{personId}
Learner Learning Records/User Action Hints
Hints for possible actions on a learner's assignment records.
- Get a user action hint
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/userActionHints/{userActionHintsUniqID}
- Get all user action hints
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/userActionHints
Learning Content Items
The learningContentItems resource provides learning content such as SCORM or AICC packages, PDF files, video files, and web links. This resource supports POST, PATCH, and GET operations on a single learning content item.
- Create a learning content item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/learningContentItems
- Get a learning content item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learningContentItems/{ContentId}
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/learningContentItems
- Update a learning content item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/learningContentItems/{ContentId}
Library Goal Task Translations
The libGoalTaskTranslations resource provides library goal tasks details for different languages.
- Get details for a library goal task
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libGoalTaskTranslations/{libGoalTaskTranslationsUniqID}
- Get details for all library goal tasks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libGoalTaskTranslations
- Update details of a library goal task
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/libGoalTaskTranslations/{libGoalTaskTranslationsUniqID}
Library Goal Translations
The libGoalTranslations resource provides library goal details for different languages.
- Get details for a library goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libGoalTranslations/{libGoalTranslationsUniqID}
- Get details for all library goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libGoalTranslations
- Update details of a library goal
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/libGoalTranslations/{libGoalTranslationsUniqID}
Library Goals
The libraryGoals resource provides all the library goals that the user can access.
- Create a library goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals
- Delete a library goal
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}
- Find library goals by advance search
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/action/findByAdvancedSearchQuery
- Get a library goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}
- Get all library goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals
- Update a library goal
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}
Library Goals/Library Goal Measures
The libraryGoalMeasures resource is a child of the libraryGoals resource and provides all the measurements for library goals.
- Create a library goal measurement
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalMeasures
- Delete a library goal measurement
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalMeasures/{libraryGoalMeasuresUniqID}
- Get a library goal measurement
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalMeasures/{libraryGoalMeasuresUniqID}
- Get all library goal measurements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalMeasures
- Update a library goal measurement
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalMeasures/{libraryGoalMeasuresUniqID}
Library Goals/Library Goal Target Outcomes
The libGoalTargetOutcomes resource is a child of the libraryGoals resource and provides all the target outcomes of library goals.
- Add a target outcome to a library goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libGoalTargetOutcomes
- Delete a target outcome from a library goal
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libGoalTargetOutcomes/{ContentItemRlatId}
- Get a target outcome of a library goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libGoalTargetOutcomes/{ContentItemRlatId}
- Get all target outcomes of a library goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libGoalTargetOutcomes
- Update a target outcome of a library goal
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libGoalTargetOutcomes/{ContentItemRlatId}
Library Goals/Library Goal Tasks
The libraryGoalTasks resource is a child of the libraryGoals resource and provides all the tasks for library goals.
- Create a library goal task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalTasks
- Delete a library goal task
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalTasks/{libraryGoalTasksUniqID}
- Get a library goal task
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalTasks/{libraryGoalTasksUniqID}
- Get all library goal tasks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalTasks
- Update a library goal task
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalTasks/{libraryGoalTasksUniqID}
Library Goals/libraryGoalsDFF
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalsDFF
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalsDFF/{libraryGoalsDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalsDFF/{libraryGoalsDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/libraryGoals/{libraryGoalsUniqID}/child/libraryGoalsDFF/{libraryGoalsDFFUniqID}
List of Recruiting Events
The recruitingUIEvents resource provides the list of accessible events for a user.
- Get all events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIEvents
- Get an event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIEvents/{EventId}
- Perform an action on an event
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIEvents/action/eventAction
- Search, filter and sort events
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIEvents/action/findByAdvancedSearchQuery
List of Values/Absence Business Titles List of Values
The absencesBusinessTitlesLOV resource is used for the client-side LOV component in responsive UIs. It enables you to search for business titles or assignments of a worker, and absence type for which you can add an absence. This resource is currently under controlled availability.
- Get a business title of a worker
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absenceBusinessTitlesLOV/{AssignmentPk}
- Get all business titles of a worker
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absenceBusinessTitlesLOV
List of Values/Absence Plans List of Values
The absencePlansLOV provides a list of values for absence plans. It lets you search for absence plans.
- Get all absence plans
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absencePlansLOV
- Get an absence plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absencePlansLOV/{absencePlansLOVUniqID}
List of Values/Absence Type Reasons List of Values
The absenceTypeReasonsLOV resource provides the list of values for the applicable absence reasons. It lets you search for absence reasons that are applicable when entering absences using a specific absence type.
- Get all absence reasons
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absenceTypeReasonsLOV
- Get an absence reason
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absenceTypeReasonsLOV/{absenceTypeReasonsLOVUniqID}
List of Values/Absence Types List of Values
The absenceTypesLOV resource provides the list of absence types that can be used to add an absence for a worker. It's used for the client-side LOV component in responsive UIs.
- Get all absence types for a worker
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absenceTypesLOV
- Get an absence type for a worker
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/absenceTypesLOV/{CompositeKey}
List of Values/Action Reasons List of Values
The actionReasonsLOV provides the list of values for the action reasons.
- Get all action reasons
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/actionReasonsLOV
- Get an action reason
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/actionReasonsLOV/{actionReasonsLOVUniqID}
List of Values/Actions List of Values
The actionsLOV resource provides the list of values for actions on HCM objects.
- Get all actions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/actionsLOV
- Get an action
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/actionsLOV/{ActionId}
List of Values/Active Predefined Links
The communicate predefined links resource provides the list of active predefined links.
- Get all active predefined links
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicatePredefinedLinksLOV
- Get an active predefined link
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicatePredefinedLinksLOV/{DeepLinkId}
List of Values/Alert Templates List of Values
The alertTemplatesLOV resource provides the list of values for the templates created for an alert.
- Get a template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/alertTemplatesLOV/{alertTemplatesLOV_Id}
- Get all templates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/alertTemplatesLOV
List of Values/All Reports
The totalCompensationStatementPeriodsManagerAllFeedbacksLOV resource provides the ability to display statement periods.
- Get a statement period
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementPeriodsManagerAllFeedbacksLOV/{totalCompensationStatementPeriodsManagerAllFeedbacksLOVUniqID}
- Get all feedback for a total compensation statement
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementsManagerAllFeedbacksLOV
- Get all statement periods
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementPeriodsManagerAllFeedbacksLOV
- Get feedback for a total compensation statement period
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementsManagerAllFeedbacksLOV/{totalCompensationStatementsManagerAllFeedbacksLOVUniqID}
List of Values/Assignment Status Types List of Values
The assignmentStatusTypesLov resource provides the list of values for the assignment status types.
- Get all actions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/assignmentStatusTypesLov
- Get an action
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/assignmentStatusTypesLov/{AssignmentStatusTypeId}
List of Values/Bargaining Units List of Values
The bargainingUnitLOVVO resource provides the list of values for bargaining units.
- Get a bargaining unit
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bargainingUnitsLov/{bargainingUnitsLovUniqID}
- Get all bargaining units
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bargainingUnitsLov
List of Values/Benefit Groups List of Values
The benefitGroupsLOV resource provides the list of all benefit groups. It's a setup-side entity in the Benefits product to group persons or employees for the participation, election, or maintenance processes. You also use this resource to include or exclude people in benefit plans, options, or rate values through eligibility profile criteria.
- Get a benefit group
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitGroupsLOV/{BenefitGroupName}
- Get all benefit groups
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitGroupsLOV
List of Values/Benefit Options List of Values
The benefitOptionsLOV resource includes a list of all the benefit options.
- Get a benefit option
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitOptionsLOV/{benefitOptionsLOVUniqID}
- Get all benefit options
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitOptionsLOV
List of Values/Benefit Plan Types List of Values
The benefitPlanTypesLOV resource includes a list of all the benefit plan types.
- Get a plan type
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlanTypesLOV/{benefitPlanTypesLOVUniqID}
- Get all plan types
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlanTypesLOV
List of Values/Benefit Plans List of Values
The benefitPlansLOV includes a list of all the benefit plans.
- Get a benefit plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansLOV/{benefitPlansLOVUniqID}
- Get all benefit plans
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansLOV
List of Values/Benefit Plans List of Values/Large Object (LOB) Attributes - PlanInformation
- Get a PlanInformation
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansLOV/{benefitPlansLOVUniqID}/enclosure/PlanInformation
List of Values/Benefit Programs List of Values
The benefitProgramsLOV resource includes a list of all the benefit programs.
- Get a benefit program
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitProgramsLOV/{benefitProgramsLOVUniqID}
- Get all benefit programs
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitProgramsLOV
List of Values/Benefits Comparison Plans List of Values
The benefitPlansComparison resource includes all the benefit plans for comparison based on person eligibility. You must use finders with this resource to get results.
- Get a benefit plan for comparison
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansComparisonLOV/{InstanceId}
- Get all benefit plans for comparison
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/benefitPlansComparisonLOV
List of Values/Business Units List of Values
The hcmBusinessUnitsLOV resource includes the list of values for business units.
- Get a business unit
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmBusinessUnitsLOV/{BusinessUnitId}
- Get all business units
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmBusinessUnitsLOV
List of Values/Check-In Templates List of Values
The checkInTemplatesLOV resource provides the list of check-in templates assigned to the worker. It's used to define the structure of a check-in document and if it includes a questionnaire for the worker or manager or both.
- Get a check-in template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInTemplatesLOV/{CheckInTemplateId}
- Get all check-in templates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/checkInTemplatesLOV
List of Values/Collective Agreements List of Values
The collectiveAgreementsLOVVO resource provides the list of values for collective agreements.
- Get a collective agreement
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/collectiveAgreementsLov/{collectiveAgreementsLovUniqID}
- Get all collective agreements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/collectiveAgreementsLov
List of Values/Common Lookups List of Values
The common lookups list of values resource is used to query the list of values of common lookups, which are legacy lookups or lookups that have attributes. Common lookups are defined in the common lookup view and support backward compatibility.
- Get all common lookups
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/commonLookupsLOV
List of Values/Communication Teams
The communication teams resource provides the list of all the active communication teams.
- Get a communication team
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicationTeamsLOV/{TeamId}
- Get all communication teams
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/communicationTeamsLOV
List of Values/Competition Participants List of Values
The competitionParticipantsLOV resource includes the list of participants for the employee wellness competition.
- Get a competition participant
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/competitionParticipantsLOV/{Name}
- Get all competition participants
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/competitionParticipantsLOV
List of Values/Content Items List of Values
The contentItemsLov resource provides list of content item available for a content section. Content sections are different section configured to track persons skills and qualifications.
- Get a content item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/contentItemsLov/{contentItemsLovUniqID}
- Get all content items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/contentItemsLov
- Get details for multiple content items
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/contentItemsLov/action/getMultipleContentItemDetails
List of Values/Content Types List of Values
The contentTypesLOV resource provides the list of content types defined in the profile management system. Content types are the different types of skills and qualifications tracked in the talent profiles.
- Get a content type
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/contentTypesLOV/{contentTypesLOVUniqID}
- Get all content types
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/contentTypesLOV
List of Values/Contracts List of Values
The hcmContractsLOV resource provides the list of values for the worker contracts.
- Get a contract
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContractsLOV/{hcmContractsLOVUniqID}
- Get all contracts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmContractsLOV
List of Values/Cost Centers List of Values
The hcmCostCentersLOV resource includes the list of values for cost centers.
- Get a cost center
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmCostCentersLOV/{CostCenterId}
- Get all cost centers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmCostCentersLOV
List of Values/Countries List of Values
The hcmCountriesLov resource includes the list of values for countries.
- Get a country
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmCountriesLov/{hcmCountriesLovUniqID}
- Get all countries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmCountriesLov
List of Values/Currencies
The currencies lists of values resource is used to query the ISO standard currencies.
- Get all currencies
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/currenciesLOV
List of Values/Department Tree Nodes List of Values
The departmentTreeNodesLOV resource provides the list of values for the top department nodes of a named department hierarchy for a department hierarchy type.
- Get a department tree node
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/departmentTreeNodesLOV/{departmentTreeNodesLOVUniqID}
- Get all department tree nodes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/departmentTreeNodesLOV
List of Values/Departments List of Values
The departmentsLov resource includes the list of values for departments.
- Get a department
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/departmentsLov/{departmentsLovUniqID}
- Get all departments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/departmentsLov
List of Values/Departments List of Values V2
The departmentsLovV2 resource provides the list of values for departments.
- Get a department
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/departmentsLovV2/{departmentsLovV2UniqID}
- Get all departments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/departmentsLovV2
List of Values/Descriptive Flexfield Contexts
- Get all
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts
List of Values/Direct Reports
The totalCompensationStatementPeriodsManagerDirectsFeedbacksLOV resource provides list of values for the ability to display statement periods.
- Get a statement period
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementPeriodsManagerDirectsFeedbacksLOV/{totalCompensationStatementPeriodsManagerDirectsFeedbacksLOVUniqID}
- Get all feedback for a total compensation statement
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementsManagerDirectsFeedbacksLOV
- Get all statement periods
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementPeriodsManagerDirectsFeedbacksLOV
- Get feedback for a total compensation statement period
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementsManagerDirectsFeedbacksLOV/{totalCompensationStatementsManagerDirectsFeedbacksLOVUniqID}
List of Values/Directs List of Values
The assignDirectsLOV resource provides the list of values for the direct reports who can be accessed by the specified manager.
- Get a direct report
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/assignDirectsLOV/{AssignmentId}
- Get all direct reports
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/assignDirectsLOV
List of Values/Disability Organizations List of Values
The disabilityOrganizationsLOV resource provides the list of values for the disability organizations.
- Get a disability organization
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/disabilityOrganizationsLOV/{disabilityOrganizationsLOVUniqID}
- Get all disability organizations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/disabilityOrganizationsLOV
List of Values/Document Types
The document types resource includes all the document types based on which document records are created for a person.
- Get a document type
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hrDocumentTypesLOV/{DocumentTypeId}
- Get all document types
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hrDocumentTypesLOV
List of Values/Eligibility Profiles List of Values
The eligibilityProfilesLOV includes the list of values for all active eligibility profiles.
- Get all eligibility profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibilityProfilesLOV
- Get an eligibility profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibilityProfilesLOV/{eligibilityProfilesLOVUniqID}
List of Values/Eligible Contacts List of Values
The eligibleContactsLOV includes the list of values for all eligibility contacts. This list of values is used by the employee and professional user to associate an existing person as a contact of an existing employee.
- Get all eligible contacts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibleContactsLOV
- Get all eligible contacts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibleContactsLOV/{eligibleContactsLOVUniqID}
List of Values/Eligible Options List of Values
A list of options in an individual compensation plan. Examples of options are Quarterly Spot Bonus Award or Monthly Spot Bonus Award.
- Get a plan option
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibleOptionsLOV/{ComponentId}
- Get all plan options
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligibleOptionsLOV
List of Values/Eligible Plans List of Values
A list of individual compensation plans available for the person. An individual compensation plan is used to award compensation outside of the regular compensation cycle. These awards, or allocations, can be education reimbursements or personal contributions to charitable or savings plans.
- Get all individual compensation plans
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligiblePlansLOV
- Get an individual compensation plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eligiblePlansLOV/{PlanId}
List of Values/Employee Communication Eligibility Profiles List of Values
The employeeCommunicationEligibilityProfilesLOV resource provides the list of values for the employee communication eligibility profiles.
- Get all employee communication eligibility profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/employeeCommunicationEligibilityProfilesLOV
- Get an employee communication eligibility profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/employeeCommunicationEligibilityProfilesLOV/{employeeCommunicationEligibilityProfilesLOVUniqID}
List of Values/Employee Communication Sender Profiles List of Values
The employeeCommunicationSenderProfilesLOV resource provides the list of values for employee communication sender profiles.
- Get all employee communication sender profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/employeeCommunicationSenderProfilesLOV
- Get an employee communication sender profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/employeeCommunicationSenderProfilesLOV/{employeeCommunicationSenderProfilesLOVUniqID}
List of Values/Employee Communications List of Values
The employeeCommunicationTeamsLOV resource provides the list of values for employee communications.
- Get all employee communications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/employeeCommunicationTeamsLOV
- Get an employee communication
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/employeeCommunicationTeamsLOV/{employeeCommunicationTeamsLOVUniqID}
List of Values/Event Conditions List of Values
The eventConditionsLOV resource provides the active list of event conditions defined in the application.
- Get all event conditions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eventConditionsLOV
- Get an event condition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/eventConditionsLOV/{ObjConditionId}
List of Values/Extended Lookup Codes List of Values
The hcmExtendedLookupCodesLOV resource provides the extended lookup values when creating an object. It stores subcategories of various HCM lookup codes such as visa permit type and is used in the visa and permit category field.
- Get all extended lookups
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmExtendedLookupCodesLOV
- Get an extended lookup
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmExtendedLookupCodesLOV/{ExtendedLookupCodeId}
List of Values/External Fields List of Values
The externalFieldsLOV resource provides the list of all the external fields that could be mapped to a profile item.
- Get all the external fields
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/externalFieldsLOV
- Get an external field
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/externalFieldsLOV/{externalFieldsLOVUniqID}
List of Values/Flow Instances List of Values
The flowInstancesLOV resource provides a list of all submitted payroll flows.
- Get a payroll flow instance
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/flowInstancesLOV/{FlowInstanceId}
- Get all payroll flow instances
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/flowInstancesLOV
List of Values/Flow Parameter List of Values
The flowParameterValuesLOV resource provides the list of values for a flow parameter.
- Get a flow parameter value
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/flowParameterValuesLOV/{StorageAttribute}
- Get all flow parameter values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/flowParameterValuesLOV
List of Values/Flow Patterns List of Values
The flowpatternsLOV resource provides the list of all flow patterns.
- Get a flow pattern
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/flowPatternsLOV/{FlowId}
- Get all flow patterns
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/flowPatternsLOV
List of Values/Generic Value Set Values
- Get all
- Method: getPath:
/fscmRestApi/resources/11.13.18.05/FlexFndPvsCharacterIdCharacterValues
List of Values/Geographic Hierarchies List of Values
The geographicHierarchiesLov resource provides the list of values for geographic hierarchies.
- Get a geographic hierarchy
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/geographicHierarchiesLOV/{geographicHierarchiesLOVUniqID}
- Get all geographic hierarchies
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/geographicHierarchiesLOV
List of Values/Goal Plan Sets List of Values
The goalPlanSetsLOV resource provides the list of values for the goal plan sets that can be accessed by the specified user.
- Get a goal plan set
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlanSetsLOV/{GoalPlanSetId}
- Get all goal plan sets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlanSetsLOV
List of Values/Goal Plans List of Values
The goalPlansLOV resource provides the list of values for the goal plans that can be accessed by the specified user.
- Get a goal plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlansLOV/{GoalPlanId}
- Get all goal plans
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/goalPlansLOV
List of Values/Grade Ladders List of Values
The gradeLaddersLov resource includes the list of values for grade ladders.
- Get a grade ladder
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeLaddersLov/{gradeLaddersLovUniqID}
- Get all grade ladders
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeLaddersLov
List of Values/Grade Rates List of Values
The list of values for grade rates.
- Get a grade rate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeRatesLOV/{gradeRatesLOVUniqID}
- Get all grade rates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeRatesLOV
List of Values/Grade Steps List of Values
The gradeStepsLOV resource provides the list of values for grade steps.
- Get a grade step
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeStepsLOV/{gradeStepsLOVUniqID}
- Get all grade steps
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradeStepsLOV
List of Values/Grades List of Values
The gradesLov resource includes the list of values for grades.
- Get a grade
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradesLov/{gradesLovUniqID}
- Get all grades
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/gradesLov
List of Values/HCM Groups List of Values
The hcmGroupsLOV resource provides the list of values for HCM groups.
- Get a HCM group
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmGroupsLOV/{hcmGroupsLOVUniqID}
- Get all HCM groups
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmGroupsLOV
List of Values/HCM Trees List of Values
The hcmTreesLOV resource provides the list of values for the hierarchy types of a specified hierarchy type (supported by areas of responsibility).
- Get a hierarchy name
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmTreesLOV/{hcmTreesLOVUniqID}
- Get all hierarchy names
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmTreesLOV
List of Values/Job Application Grid View Categories
The recruitingGridViewCategoriesLOV resource provides the grid view categories.
- Get a grid view category
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingGridViewCategoriesLOV/{recruitingGridViewCategoriesLOVUniqID}
- Get all grid view categories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingGridViewCategoriesLOV
List of Values/Job Families List of Values
The jobFamiliesLov resource includes the list of values for job families.
- Get a job family
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobFamiliesLov/{jobFamiliesLovUniqID}
- Get all job families
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobFamiliesLov
List of Values/Jobs List of Values
The jobsLov resource provides the list of values for jobs.
- Get a job
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobsLov/{jobsLovUniqID}
- Get all jobs
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobsLov
List of Values/Jobs List of Values V2
The jobsLovV2 resource provides the list of values for jobs.
- Get a job
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobsLovV2/{jobsLovV2UniqID}
- Get all jobs
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobsLovV2
List of Values/Journey Categories
The journeyCategoriesLOV resource provides the list of values for different categories of journeys.
- Get a journey category
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyCategoriesLOV/{LookupCode}
- Get all journey categories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyCategoriesLOV
List of Values/Journey Categories/Journey Subcategories
The subCategories resource is a child of journeyCategoriesLOV resource. It provides the list of values for different subcategories of journeys.
- Get a journey subcategory
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyCategoriesLOV/{LookupCode}/child/subCategories/{LookupCode2}
- Get all journey subcategories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/journeyCategoriesLOV/{LookupCode}/child/subCategories
List of Values/Labels List of Values
The recruitingLabelsLOV resource provides the list of values for recruiting labels.
- Get a label
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingLabelsLOV/{LabelId}
- Get all labels
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingLabelsLOV
List of Values/Legal Employers List of Values
The legalEmployersLov resource includes the list of values for legal employers.
- Get a legal employer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/legalEmployersLov/{legalEmployersLovUniqID}
- Get all legal employers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/legalEmployersLov
List of Values/Legislative Data Groups List of Values
The legislativeDataGroupsLOV resource provides the list of values for the legislative data groups.
- Get a legislative data group
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/legislativeDataGroupsLOV/{LegislativeDataGroupId}
- Get all legislative data groups
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/legislativeDataGroupsLOV
List of Values/Library Goals List of Values
The libraryGoalsLOV resource provides the list of values for library goals defined in Goal Management and Career Development.
- Get a library goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoalsLOV/{libraryGoalsLOVUniqID}
- Get all library goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/libraryGoalsLOV
List of Values/Life Event List of Values
The lifeEventsLOV resource provides the list of values for all active life events.
- Get a life event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/lifeEventsLOV/{lifeEventsLOVUniqID}
- Get all life events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/lifeEventsLOV
List of Values/Locations List of Values
The locationsLov resource includes the list of values for locations.
- Get a location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsLov/{locationsLovUniqID}
- Get all locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsLov
List of Values/Locations List of Values V2
The locationsLovV2 resource provides the list of values for locations.
- Get a location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsLovV2/{locationsLovV2UniqID}
- Get all locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsLovV2
List of Values/Majors List of Values
The majorsLOV resource provides the list of majors for education content.
- Get a major
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/majorsLOV/{majorsLOVUniqID}
- Get all majors
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/majorsLOV
List of Values/My Brand Skills List of Values
The myBrandSkillsLOV resource provides the list of values for skills used to build the personal brand skill profile of a worker.
- Get a skill
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/myBrandSkillsLOV/{myBrandSkillsLOV_Id}
- Get all skills
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/myBrandSkillsLOV
List of Values/Organization Classifications List of Values
The organizationClassificationsLOV resource provides the list of values for the organization classifications.
- Get all organization classifications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/organizationClassificationsLOV
- Get an organization classification
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/organizationClassificationsLOV/{ClassificationCode}
List of Values/Organization Payment Methods List of Values
The organizationPaymentMethodsLOV resource provides the organization payment methods as of the specified date.
- Get all organization payment methods
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/organizationPaymentMethodsLOV
- Get an organization payment method
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/organizationPaymentMethodsLOV/{organizationPaymentMethodsLOVUniqID}
List of Values/Organization Tree Nodes List of Values
The organizationTreeNodesLOV resource provides the list of values for the top organization nodes of a specified organization hierarchy for an organization hierarchy type.
- Get all organization tree nodes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/organizationTreeNodesLOV
- Get an organization tree node
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/organizationTreeNodesLOV/{organizationTreeNodesLOVUniqID}
List of Values/Payroll Balance Definitions List of Values
The payrollBalanceDefinitionsLOV resource provides a list of values for payroll balance definitions. A payroll balance accumulates net total of payroll results for an element or group of elements during a specified period of time.
- Get a payroll balance definition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollBalanceDefinitionsLOV/{BalanceTypeId}
- Get all payroll balance definitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollBalanceDefinitionsLOV
List of Values/Payroll Definitions List of Values
The payrollDefinitionsLOV resource provides the list of values for payroll definitions. A payroll definition groups employees that are processed together with the same processing frequency, such as weekly, biweekly, semimonthly, or monthly.
- Get a payroll definition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollDefinitionsLOV/{payrollDefinitionsLOVUniqID}
- Get all payroll definitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollDefinitionsLOV
List of Values/Payroll Element Definitions List of Values
The payrollElementDefinitionsLOV resource includes a list of element definitions.
- Get all element definitions.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollElementDefinitionsLOV
- Get an element definition.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollElementDefinitionsLOV/{payrollElementDefinitionsLOVUniqID}
List of Values/Payroll Input Values List of Values
The payrollInputValuesLOV resource includes a list of input values as of the given date.
- Get a payroll input value.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollInputValuesLOV/{payrollInputValuesLOVUniqID}
- Get all payroll input values.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollInputValuesLOV
List of Values/Payroll Statutory Units List of Values
The payrollStatutoryUnitsLOV resource provides the list of values for the payroll statutory unit names.
- Get a payroll statutory unit
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollStatutoryUnitsLOV/{payrollStatutoryUnitsLOVUniqID}
- Get all payroll statutory units
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollStatutoryUnitsLOV
List of Values/Payroll Time Definitions List of Values
The payrollTimeDefinitionsLOV resource provides the list of values for payroll time definitions. Time definitions are unique time spans or dates that can be used in many areas, including payroll employment management, balance dimensions, retroactive and proration events, element start and end dates, and overtime periods.
- Get a payroll time definition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollTimeDefinitionsLOV/{TimeDefinitionId}
- Get all payroll time definitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollTimeDefinitionsLOV
List of Values/Payroll Time Periods List of Values
The payrollTimePeriodsLOV resource includes a list of all time periods belonging to payrolls.
- Title for the GET standard action on a collection defined on payrollTimePeriodsLOV root resource.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollTimePeriodsLOV
- Title for the GET standard action on a singleton defined on payrollTimePeriodsLOV root resource.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollTimePeriodsLOV/{payrollTimePeriodsLOVUniqID}
List of Values/Performance Document Names List of Values
The performanceTemplateDocumentNamesLOV resource provides the list of values for performance document names.
- Get a performance document name
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceTemplateDocumentNamesLOV/{performanceTemplateDocumentNamesLOVUniqID}
- Get all performance document names
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceTemplateDocumentNamesLOV
List of Values/Performance Template Task Names List of Values
The performanceTemplateTaskNamesLOV provides the list of all available tasks in a performance template.
- Get a performance task name
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceTemplateTaskNamesLOV/{performanceTemplateTaskNamesLOVUniqID}
- Get all performance task names
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceTemplateTaskNamesLOV
List of Values/Period Name
The totalCompensationStatementPeriodsFeedbacksLOV resource provides the list of values for the ability to display statement periods.
- Get a statement period
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementPeriodsFeedbacksLOV/{StatementPeriodId}
- Get all statement periods
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementPeriodsFeedbacksLOV
List of Values/Person Notes Visibility List of Values
The personNotesVisibilityOptionsLOV resource provides the list of values of visibility options for person notes associated with the context type. It specifies visibility options available to users when they create person notes in a given context.
- Get a visibility option
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptionsLOV/{VisibilityCode}
- Get all visibility options
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptionsLOV
List of Values/Person Types List of Values
The personTypesLOV resource provides the list of values for the person types.
- Get a person type
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personTypesLOV/{PersonTypeId}
- Get all person types
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personTypesLOV
List of Values/Position Tree Nodes List of Values
The positionTreeNodesLOV resource provides the list of values for the top position nodes of a named position hierarchy type.
- Get a position tree node
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/positionTreeNodesLOV/{positionTreeNodesLOVUniqID}
- Get all position tree nodes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/positionTreeNodesLOV
List of Values/Positions List of Values
The positionsLov resource includes the list of values for positions.
- Get a position
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/positionsLov/{positionsLovUniqID}
- Get all positions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/positionsLov
List of Values/Positions List of Values V2
The positionsLovV2 resource provides the list of values for positions.
- Get a position
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/positionsLovV2/{positionsLovV2UniqID}
- Get all positions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/positionsLovV2
List of Values/Profile Type Sections List of Values
The profileTypeSectionsLOV resource includes the list of sections for a specific profile type.
- Get a profile type section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/profileTypeSectionsLOV/{profileTypeSectionsLOVUniqID}
- Get all profile type sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/profileTypeSectionsLOV
List of Values/Profiles List of Values
The profilesLov resource includes the list of values for profiles for a given profile type.
- Get a profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/profilesLov/{ProfileId}
- Get all profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/profilesLov
List of Values/Question Answers List of Values
The questionAnswersLOV resource provides a list of answer choices defined for single or multiple choice questions that match the specified criteria.
- Get all answer choices
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionAnswersLOV
- Get an answer choice
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionAnswersLOV/{questionAnswersLOVUniqID}
List of Values/Questionnaire Folders List of Values
The questionnaireFoldersLOV resource provides the list of values for folders in which questionnaires and questions are saved.
- Get a questionnaire folder
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireFoldersLOV/{questionnaireFoldersLOVUniqID}
- Get all questionnaire folders
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireFoldersLOV
List of Values/Questionnaire Questions List of Values
The questionnaireQuestionsLOV includes a list of all questions within questionnaires that match the attributes provided when calling the service.
- Get a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireQuestionsLOV/{questionnaireQuestionsLOVUniqID}
- Get all questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireQuestionsLOV
List of Values/Questionnaire Response Types List of Values
The questionnaireResponseTypesLOV resource provides the list of values for response types available for a question.
- Get a response type
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireResponseTypesLOV/{questionnaireResponseTypesLOVUniqID}
- Get all response types
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireResponseTypesLOV
List of Values/Questionnaire Subscribers List of Values
The questionnaireSubscribersLOV resource provides the list of subscribers that use the questionnaire and the associated objects.
- Get a subscriber
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireSubscribersLOV/{questionnaireSubscribersLOVUniqID}
- Get all subscribers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireSubscribersLOV
List of Values/Questionnaire Templates List of Values
The questionnaireTemplatesLOV resource provides the list of questionnaire templates for a specific subscriber.
- Get a questionnaire template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplatesLOV/{questionnaireTemplatesLOVUniqID}
- Get all questionnaire templates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplatesLOV
List of Values/Questionnaires List of Values
The questionnairesLOV resource provides the list of values for questionnaires.
- Get a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnairesLOV/{questionnairesLOVUniqID}
- Get all questionnaires
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnairesLOV
List of Values/Questions List of Values
The questionsLOV resource provides the list of values for questions.
- Get a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionsLOV/{questionsLOVUniqID}
- Get all questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionsLOV
List of Values/Rating Levels List of Values
The ratingLevelsLOV resource provides the qualitative values for a rating model.
- Get a rating level
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/ratingLevelsLOV/{ratingLevelsLOVUniqID}
- Get all rating levels
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/ratingLevelsLOV
List of Values/Rating Models List of Values
The ratingModelsLOV resource provides the list of rating models for the question setup of the questionnaire.
- Get a rating model
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/ratingModelsLOV/{ratingModelsLOVUniqID}
- Get all rating models
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/ratingModelsLOV
List of Values/Reasons List of Values
Reasons List of Values
- Get all action reasons
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/reasonsLOV
- Get an action reason
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/reasonsLOV/{ActionReasonId}
List of Values/Recruiting Agency Candidates
The recruitingAgencyCandidatesLOV resource includes the details of all the LOV items for the recruiting agency candidates.
- Get a candidate from the recruiting agency.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAgencyCandidatesLOV/{PersonId}
- Get all candidates from the recruiting agency.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAgencyCandidatesLOV
List of Values/Recruiting Agents
The recruitingAgentsLOV resource includes all details of the recruiting agents.
- Get a recruiting agent
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAgentsLOV/{AgentId}
- Get all recruiting agents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAgentsLOV
List of Values/Recruiting Agents/Agent Job Family on Job Requisition
The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.
- Get all job families of the agent in the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAgentsLOV/{AgentId}/child/agentJobFamilies
- Get the job family of the agent in the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAgentsLOV/{AgentId}/child/agentJobFamilies/{agentJobFamiliesUniqID}
List of Values/Recruiting Agents/Agent Location on Job Requisition
The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.
- Get all locations of the agent in the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAgentsLOV/{AgentId}/child/agentLocations
- Get the location of the agent in the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAgentsLOV/{AgentId}/child/agentLocations/{agentLocationsUniqID}
List of Values/Recruiting Application Flow List of Values
The recruitingApplyFlowsLOV resource provides the list of values for the application flows that can be selected in recruiting.
- Get all application flows
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingApplyFlowsLOV
- Get an application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingApplyFlowsLOV/{ApplyFlowId}
List of Values/Recruiting Assessment Packages List of Values
The recruitingAssessmentAccountPackagesLOV resource provides the list of values for the assessment screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get all assessment screening packages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackagesLOV
- Get an assessment screening package
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackagesLOV/{recruitingAssessmentAccountPackagesLOVUniqID}
List of Values/Recruiting Background Check Screening Packages List
The recruitingBGCAccountPackagesLOV resource provides the background check screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a background check screening package
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingBGCAccountPackagesLOV/{recruitingBGCAccountPackagesLOVUniqID}
- Get all background check screening packages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingBGCAccountPackagesLOV
List of Values/Recruiting Campaign Email Sender Profiles List of Values
The recruitingCampaignsEmailSenderProfilesLOV resource provides the list of values for the recruiting campaign email sender profiles.
- Get a list of values for the recruiting campaign email sender profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignsEmailSenderProfilesLOV/{ConfigId}
- Get all the list of values for the recruiting campaign email sender profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignsEmailSenderProfilesLOV
List of Values/Recruiting Candidate Pools LOV
The recruitingCandidatePoolsLOV resource provides the list of values for the candidate pools.
- Get a candidate pool list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidatePoolsLOV/{recruitingCandidatePoolsLOVUniqID}
- Get all candidate pools list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidatePoolsLOV
List of Values/Recruiting Candidate Saved Searches List of Values
The recruitingCandidateSavedSearchesLOV resource provides details about candidate saved searches list of values.
- Get a candidate saved searches list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateSavedSearchesLOV/{SearchId}
- Get all the candidate saved searches list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateSavedSearchesLOV
List of Values/Recruiting Candidate Security Profile List of Values
The recruitingCandidatesSecurityProfilesLOV resource provides the list of values for the candidate security profile.
- Get a candidate security profile list of values.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidatesSecurityProfilesLOV/{CandSecProfileId}
- Get all candidate security profiles list of values.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidatesSecurityProfilesLOV
List of Values/Recruiting Candidate Security Profile List of Values/Large Object (LOB) Attributes - Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidatesSecurityProfilesLOV/{CandSecProfileId}/enclosure/Description
List of Values/Recruiting Candidates List of Values
The recruitingCandidatesLOV resource includes all the metadata for the candidates.
- Get a metadata detail for the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidatesLOV/{PersonId}
- Get all metadata details for the candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidatesLOV
List of Values/Recruiting Career Sites List of Values
The recruitingCESitesLOV resource provides the list of values for the recruiting career sites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a recruiting career site
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESitesLOV/{SiteId}
- Get all recruiting career sites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESitesLOV
List of Values/Recruiting Content Library Items LOV
The recruitingContentLibraryItemsLOV resource provides the list of values for the details about the content library items.
- Get a content library item LOV
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}
- Get all content library items LOV
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV
List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values
The recruitingContentLibraryItemsLOVdescriptions resource provides the list of values for the descriptions for a given recruiting content library item.
- Get a content library item description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}
- Get all content library item descriptions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions
List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values/Large Object (LOB) Attributes - Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}/enclosure/Description
List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values/Large Object (LOB) Attributes - Qualifications
- Get a Qualifications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}/enclosure/Qualifications
List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values/Large Object (LOB) Attributes - Responsibilities
- Get a Responsibilities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}/enclosure/Responsibilities
List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values/Large Object (LOB) Attributes - ShortDescription
- Get a ShortDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}/enclosure/ShortDescription
List of Values/Recruiting Content Library Items LOV/Recruiting Content Library Items Descriptions List of Values/Large Object (LOB) Attributes - TxtDescription
- Get a TxtDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingContentLibraryItemsLOV/{recruitingContentLibraryItemsLOVUniqID}/child/descriptions/{DescriptionVersionId}/enclosure/TxtDescription
List of Values/Recruiting Descriptive Flexfield Contexts List of Values
The recruitingFlexContextsLOV resource provides the list of values for descriptive flexfield context selection.
- Get a descriptive flexfield context
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingFlexContextsLOV/{recruitingFlexContextsLOVUniqID}
- Get all descriptive flexfield contexts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingFlexContextsLOV
List of Values/Recruiting Event Interview Participants List of Values
The resource provides details about all the candidates who are attending an interview.
- Get all the event attendees
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingEventParticipantsLOV
- Get an event attendee
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingEventParticipantsLOV/{EventPoolMemberId}
List of Values/Recruiting Event Owners List of Values
The recruitingEventOwnersLOV resource provides the list of values for the owners of the events.
- Get all event owners
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingEventOwnersLOV
- Get an event owner
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingEventOwnersLOV/{EventOwnerId}
List of Values/Recruiting Events List of Values
The recruiting events resource displays all the events which the logged-in user can access.
- Get all events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingEventsLOV
- Get an event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingEventsLOV/{recruitingEventsLOVUniqID}
List of Values/Recruiting Flexfield Segment Values
The recruitingFlexSegmentValuesLOV resource includes all details about job application flexfield segment values.
- Get a job application flexfield segment value
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingFlexSegmentValuesLOV/{Code}
- Get all job application flexfield segment values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingFlexSegmentValuesLOV
List of Values/Recruiting Flexfield Segments
The recruitingFlexSegmentsLOV resource includes all details about job application flexfield segments.
- Get a job application flexfield segment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingFlexSegmentsLOV/{recruitingFlexSegmentsLOVUniqID}
- Get all job application flexfield segments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingFlexSegmentsLOV
List of Values/Recruiting Geography Hierarchy Locations LOV
The geographyHierarchyLocationsLOV resource includes the details of geography hierarchy locations LOV.
- Get the details of a geography hierarchy location LOV
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingGeographyHierarchyLocationsLOV/{GeographyNodeId}
- Get the details of all geography hierarchy locations LOV
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingGeographyHierarchyLocationsLOV
List of Values/Recruiting Interview Feedback Questionnaires in Requisitions
The recruitingRequisitionQuestionnairesLOV resource includes the list of recruiting interview feedback questionnaires in a requisition.
- Get a requisition interview feedback questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingRequisitionQuestionnairesLOV/{recruitingRequisitionQuestionnairesLOVUniqID}
- Get all requisition interview feedback questionnaires
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingRequisitionQuestionnairesLOV
List of Values/Recruiting Job Application Filter Autosuggest List of Values
The recruitingJobApplicationFilterAutoSuggestLOV resource provides the list of values for the job application filters.
- Get all autosuggest values for job application filters.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplicationFilterAutoSuggestLOV
- Get an autosuggest value for a job application filter.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplicationFilterAutoSuggestLOV/{recruitingJobApplicationFilterAutoSuggestLOVUniqID}
List of Values/Recruiting Job Application Grid View Fields
The recruitingGridViewFieldsLOV root resource provides the grid view fields.
- Get a grid view field.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingGridViewFieldsLOV/{recruitingGridViewFieldsLOVUniqID}
- Get all grid view fields.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingGridViewFieldsLOV
List of Values/Recruiting Job Requisition Template LOV
The recruitingJobRequisitionTemplatesLOV resource includes the details of the job requisitions templates LOV.
- Get details of a job requisitions template LOV
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitionTemplatesLOV/{RequisitionId}
- Get details of all job requisitions templates LOV
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitionTemplatesLOV
List of Values/Recruiting Job Requisitions LOV
The recruitingJobRequisitionsLOV resource provides the list of values for the job requisition.
- Get details of a job requisitions list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitionsLOV/{recruitingJobRequisitionsLOVUniqID}
- Get details of all job requisitions list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitionsLOV
List of Values/Recruiting Locations LOV
The recruitingLocationsLOV resource includes all the locations for recruiting as a list to the user.
- Get a recruitingLocation
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingLocationsLOV/{LocationFQN}
- Get all recruitingLocations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingLocationsLOV
List of Values/Recruiting Organizations LOV
The recruitingOrganizationsLOV includes details about the list of values.
- Get a recruiting organizations LOV
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOrganizationsLOV/{OrganizationId}
- Get all recruiting organizations LOV
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOrganizationsLOV
List of Values/Recruiting Representatives LOV
The recruitingRepresentativesLOV resource includes the list of representatives.
- Get a representative in the list
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingRepresentativesLOV/{PersonId}
- Get all representatives in the list
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingRepresentativesLOV
List of Values/Recruiting Requisition Questions LOV
The recruitingRequisitionQuestionsLOV resource includes the details of the list of requisition questions.
- Get a requisition question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingRequisitionQuestionsLOV/{QstnAnswerId}
- Get all the requisition questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingRequisitionQuestionsLOV
List of Values/Recruiting Requisition Security Profile List of Values
The recruitingReqSecurityProfilesLOV provides the list of values for the job requisition security profiles.
- Get a job requisition security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingReqSecurityProfilesLOV/{RequisitionSecurityProfileId}
- Get all job requisition security profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingReqSecurityProfilesLOV
List of Values/Recruiting Tax Credit Packages List of Values
The recruitingTCAccountPackagesLOV resource provides the list of values for the tax credit screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a tax credit screening package
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTCAccountPackagesLOV/{recruitingTCAccountPackagesLOVUniqID}
- Get all tax credit screening packages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTCAccountPackagesLOV
List of Values/Reporting Establishments List of Values
The reportingEstablishmentsLOV resource provides the list of values for reporting establishments.
- Get a reporting establishment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/reportingEstablishmentsLOV/{reportingEstablishmentsLOVUniqID}
- Get all reporting establishments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/reportingEstablishmentsLOV
List of Values/Responsibility Templates List of Values
The responsibilityTemplatesLOV resource provides the list of values for a responsibility template such as name, code, and, responsibility type. Responsibility templates are used to define areas of responsibility.
- Get a responsibility template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/responsibilityTemplatesLOV/{responsibilityTemplatesLOVUniqID}
- Get all responsibility templates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/responsibilityTemplatesLOV
List of Values/Review Periods List of Values
The reviewPeriodsLOV resource provides the list of values for the review periods used in Talent Management.
- Get a review period
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/reviewPeriodsLOV/{ReviewPeriodId}
- Get all review periods
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/reviewPeriodsLOV
List of Values/Roles List of Values
The rolesLOV resource includes the list of values for roles.
- Get a role
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/rolesLOV/{RoleId}
- Get all roles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/rolesLOV
List of Values/Salary Basis List of Values
A list of salary bases available for workers. A salary basis identifies the currency and period of the quoted base pay and the factor used to annualize base pay. It optionally identifies components used to itemize salary adjustments as well as the grade rate and differential profile used to validate salary.
- Get a salary basis
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaryBasisLov/{SalaryBasisId}
- Get all salary bases
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaryBasisLov
List of Values/Salary Basis List of Values/Salary Basis Components
A child of the salaryBasisLov resource, this resource itemizes salary adjustments into different reasons, such as merit, adjustment, and location. Component itemization is for reporting purposes only.
- Get a component
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaryBasisLov/{SalaryBasisId}/child/salaryBasisComponents/{LookupUsageId}
- Get all components
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaryBasisLov/{SalaryBasisId}/child/salaryBasisComponents
List of Values/Scheduling Shifts List of Values
The list of values for all the scheduling shifts. The attributes listed are displayed out of the box to help managers and schedulers select the correct shift.
- Get a shift
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/schedulingShiftsLOV/{ShiftId}
- Get all shifts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/schedulingShiftsLOV
List of Values/Sets List of Values
The setsLov resource includes the list of values for sets.
- Get a set
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmSetsLOV/{SetId}
- Get all sets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/hcmSetsLOV
List of Values/Shared Performance Goals List of Values
The sharedPerformanceGoalsLOV resource provides the list of values for the performance goals that are shared with a specified user.
- Get a shared performance goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/sharedPerformanceGoalsLOV/{GoalId}
- Get all shared performance goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/sharedPerformanceGoalsLOV
List of Values/Source Mediums List of Values
The recruitingSourceMediumsLOV resource includes the details of source mediums list of values. Note that the service endpoints in the resource category are for internal use.
- Get details of a source medium list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingSourceMediumsLOV/{SourceMedium}
- Get details of all the source mediums list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingSourceMediumsLOV
List of Values/Sources List of Values
The recruitingSourcesLOV resource provides the list of values for recruiting sources.
- Get details of a list of values for recruiting sources
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingSourcesLOV/{recruitingSourcesLOVUniqID}
- Get details of all lists of values for recruiting sources
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingSourcesLOV
List of Values/Statement Name
The totalCompensationStatementsFeedbacksLOV resource provides the list of values for the ability to display statement feedback.
- Get all feedback for a total compensation statement
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementsFeedbacksLOV
- Get feedback for a total compensation statement period
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationStatementsFeedbacksLOV/{StatementId}
List of Values/Succession Plans List of Values
The successionPlansLOV resource includes the list of values for succession plans to which the logged in user has access either through ownership or through derived incumbent access.
- Get a plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/successionPlansLOV/{PlanId}
- Get all plans
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/successionPlansLOV
List of Values/Talent External Candidates List of Values
The talentExternalCandidatesLOV resource provides a list of external succession candidates.
- Get all external candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentExternalCandidatesLOV
- Get an external candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentExternalCandidatesLOV/{ExternalCandidateId}
List of Values/Talent Pool Security Profiles List of Values
The talentPoolSecurityProfilesLOV resource provides the list of values for the security profiles configured for talent pools.
- Get a talent pool security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfilesLOV/{PoolSecurityProfileId}
- Get all talent pool security profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfilesLOV
List of Values/Talent Pools List of Values
The talentPoolsLOV resource includes the list of talent pools for which the logged in user is named as an owner.
- Get a talent pool
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolsLOV/{PoolId}
- Get all talent pools
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolsLOV
List of Values/Talent Profile Section Subscribers List of Values
The talentProfileSectionSubscribersLOV resource provides the list of all subscribers of talent profile sections.
- Get a talent profile section subscriber
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentProfileSectionSubscribersLOV/{talentProfileSectionSubscribersLOVUniqID}
- Get all talent profile section subscribers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentProfileSectionSubscribersLOV
List of Values/Talent Review Managers List of Values
The talentReviewManagersLOV resource includes the list of values for all workers who are managers for a talent review.
- Get a manager
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewManagersLOV/{talentReviewManagersLOVUniqID}
- Get all managers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewManagersLOV
List of Values/Tax Reporting Units List of Values
The taxReportingUnitsLOV resource provides the list of values for the tax reporting unit names.
- Get a tax reporting unit
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/taxReportingUnitsLOV/{taxReportingUnitsLOVUniqID}
- Get all tax reporting units
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/taxReportingUnitsLOV
List of Values/Team Members List of Values
The worklifeTeamMembersLOV resource provides a list of all active members within the same business group.
- Get a team member
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/worklifeTeamMembersLOV/{PersonId}
- Get all team members
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/worklifeTeamMembersLOV
List of Values/Third Party Partners List of Values
The recruitingTPPartnersLOV resource provides the list of values for active partners.
- Get a third party partner
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTPPartnersLOV/{PartnerId}
- Get all third party partners
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTPPartnersLOV
List of Values/Third Party Partners List of Values/Assessment Partner Specific Configurations
The AssessmentPartnerConfig resource is a child of the recruitingTPPartnersLOV resource and contains assessment partner specific configurations.
- Get a third party assessment partner configuration
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTPPartnersLOV/{PartnerId}/child/AssessmentPartnerConfig/{AssessmentPartnerConfigUniqID}
- Get all third party assessment partner configurations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTPPartnersLOV/{PartnerId}/child/AssessmentPartnerConfig
List of Values/Third Party Partners List of Values/Large Object (LOB) Attributes - Logo
- Get a Logo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTPPartnersLOV/{PartnerId}/enclosure/Logo
List of Values/Third Party User Accounts List of Values
The recruitingTPAccountsLOV resource provides the list of values for active partner account names.
- Get a third party partner account
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTPAccountsLOV/{AccountId}
- Get all third party partner accounts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTPAccountsLOV
List of Values/Time Card Fields List of Values
The timeCardFieldValuesLOV resource includes the list of values for time card fields.
- Get a time card field value
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeCardFieldValuesLOV/{Id}
- Get all time card field values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeCardFieldValuesLOV
List of Values/Time Cards List of Values
The timeCardsLOV resource uses the REST API to return all of an employee's time cards that match the specified search criteria.
- Get a time card
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeCardsLOV/{timeCardsLOVUniqID}
- Get all time cards
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeCardsLOV
List of Values/Time Zone List of Values
The recruitingTimezonesLOV resource provides the list of values for getting all the time zones available.
- Get a time zone
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTimezonesLOV/{TimezoneId}
- Get all time zones
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTimezonesLOV
List of Values/Unions List of Values
The unionsLov resource includes the list of values for worker unions.
- Get a union
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/unionsLov/{unionsLovUniqID}
- Get all unions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/unionsLov
List of Values/User Accounts List of Values
The userAccountsLOV resource includes the list of values for user accounts.
- Get a user account
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userAccountsLOV/{UserId}
- Get all user accounts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userAccountsLOV
List of Values/User Roles List of Values
The userRolesLov resource includes the list of values for the roles that can be requested, self-requested, or delegated by the specified user.
- Get a user role
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userRolesLOV/{userRolesLOVUniqID}
- Get all user roles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userRolesLOV
List of Values/User Table Details
The userTableDetails resource returns a list of user defined tables.
- Get a user defined table.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/fastFormulasLOV/{FormulaId}
- Get all user defined tables.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/fastFormulasLOV
List of Values/Wellness Activities List of Values
The wellnessActivitiesLOV resource provides a list of all wellness user activities within the same business group.
- Get a wellness user activity
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/wellnessActivitiesLOV/{TopicId}
- Get all wellness user activities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/wellnessActivitiesLOV
List of Values/Work Life Teams List of Values
The worklifeTeamsLOV resource provides the list of values for teams in the same business group.
- Get a team
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/worklifeTeamsLOV/{TeamId}
- Get all teams
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/worklifeTeamsLOV
Locations
The locations resource provides all the locations as of the specified date. By default, the current date is retained. With this resource, users can retrieve, create, and update the locations.
- Get a location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locations/{locationsUniqID}
- Get all locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locations
Locations V2
The locationsV2 resource provides all the locations as of the specified date. By default, the current date is retained. With this resource, users can retrieve, create, and update the locations. Operations to create and update locations in Oracle HCM Cloud involve various postprocessing steps. Therefore, these operations may take several minutes to complete. For bulk load and extract operations, it's recommended to use HCM Data Loader and HCM Extracts, respectively.
- Change the effective start date
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/action/changeEffectiveStartDate
- Create a date-effective update on the job when only a child record is updated
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/action/splitLocationForChildUpdate
- Create a location
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2
- Delete a location
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}
- Delete the other addresses
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/action/deleteLocationOtherAddresses
- Get a location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}
- Get all locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2
- Mark the location record explicitly as dirty, to be used when only its child data has been modified.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/action/modifyLocationRowForChildCorrect
- Reload the location extensible flexfield child data
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/action/getReloadedEFFData
- Update a location
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}
Locations V2/Addresses
The addresses resource is a child of the locations resource. It provides all the addresses of the location including the main address as of the specified date. By default, the current date is retained.
- Create a location address
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses
- Delete a location address
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses/{addressesUniqID}
- Get a location address
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses/{addressesUniqID}
- Get all location addresses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses
- Update a location address
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/addresses/{addressesUniqID}
Locations V2/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}
Locations V2/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Locations V2/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Locations V2/Banner Override Messages
The bannerOverrideMessages resource provides all the status information and related messages for an object.
- Get a message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/bannerOverrideMessages/{ObjectId}
- Get all messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/bannerOverrideMessages
Locations V2/Locations Descriptive Flexfields
The operations from the Locations V2/Locations Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsDFF
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsDFF/{locationsDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsDFF/{locationsDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsDFF/{locationsDFFUniqID}
Locations V2/Locations Extensible Flexfields Container
The locationEFFContainer resource is a child of the locations resource. It's a container for the locations extensible flexfields.
- Create a flexfield container
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer
- Get all flexfield containers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer
- Get an extensible flexfield container of location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}
Locations V2/Locations Extensible Flexfields Container/Locations Extensible Flexfields
The operations from the Locations V2/Locations Extensible Flexfields Container/Locations Extensible Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF/{locationsEFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF/{locationsEFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationsEFFContainer/{locationsEFFContainerUniqID}/child/locationsEFF/{locationsEFFUniqID}
Locations V2/Locations Legislative Extensible Flexfields
The operations from the Locations V2/Locations Legislative Extensible Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFF
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFF/{locationLegislativeEFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFF/{locationLegislativeEFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/locationsV2/{locationsV2UniqID}/child/locationLegislativeEFF/{locationLegislativeEFFUniqID}
Locations/Locations Descriptive Flexfields
The operations from the Locations/Locations Descriptive Flexfields category.
My Attachments
The recruitingMyAttachments resource includes details about the resume uploaded by the candidate as an attachment.
- Create a candidate attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyAttachments
- Delete a candidate attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingMyAttachments/{Id}
- Get a candidate attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyAttachments/{Id}
- Get all candidate attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyAttachments
My Job Applications
The recruitingMyJobApplications resource provides details about employee job applications in opportunity marketplace.
- Create a job application in opportunity marketplace
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications
- Get all my job applications in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications
- Get one of my job application in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}
My Job Applications/Scheduled Interviews
The SubmissionScheduleInterviews resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the interview schedule requests.
- Create a scheduled interview request in opportunity marketplace
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/SubmissionScheduledInterviews
- Get a request for a scheduled interview in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/SubmissionScheduledInterviews/{IntrvwRequestsId}
- Get all requests for scheduled interviews in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/SubmissionScheduledInterviews
My Job Applications/Unscheduled Job Interviews
The UnScheduleInterviewRequests resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the unscheduled interview requests.
- Create an unscheduled interview request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/UnscheduledInterviewRequests
- Get a request for an unscheduled interview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/UnscheduledInterviewRequests/{IntrvwRequestsId}
- Get all the unscheduled interview requests
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications/{SubmissionId}/child/UnscheduledInterviewRequests
My Team Details
The myTeamDetails resource includes all the employment, talent, and compensation details of all the workers in a manager's team.
- Find team details
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/myTeamDetails/action/findByObject
- Get the details of a member in a manager's team
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/myTeamDetails/{PersonId}
- Get the details of all the members in a manager's team
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/myTeamDetails
Object Snapshots
The objectSnapshots resource retrieves data for a specific key attribute synchronously based on the data structure configured using HCM Extracts.
- Extract an object snapshot
- Method: postPath:
/hcmRestApi/objectSnapshots
Opportunities Applications in Opportunity Marketplace
The recruitingOppMktUserAppliedOpportunities resource provides the applications to opportunities in opportunity marketplace.
- Get all applications for an opportunity in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktUserAppliedOpportunities
- Get an application for an opportunity in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktUserAppliedOpportunities/{GigApplicationId}
Opportunities Created by User in Opportunity Marketplace
The recruitingOppMktUserCreatedOpportunities resource provides opportunities created by a user in opportunity marketplace.
- Get a user-created opportunity in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktUserCreatedOpportunities/{GigId}
- Get all user-created opportunities in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktUserCreatedOpportunities
Opportunity Marketplace Opportunities
The recruitingOppMktOpportunities resource provides opportunities in opportunity marketplace.
- Get all opportunities in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities
- Get an opportunity in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities/{SearchId}
Opportunity Marketplace Opportunities/Categories Facet in Opportunity Marketplace
The categoriesFacetCategories resource is the child of recruitingOppMktOpportunities resource and provides categories facets in opportunity marketplace.
- Get a category facet in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities/{SearchId}/child/categoriesFacet/{CategoryCode}
- Get all categories facets in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities/{SearchId}/child/categoriesFacet
Opportunity Marketplace Opportunities/Opportunities List in Opportunity Marketplace
The opportunityList resource is the child of recruitingOppMktOpportunities resource and provides a list of opportunities in opportunity marketplace.
- Get all opportunity lists in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities/{SearchId}/child/opportunityList
- Get an opportunity list in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktOpportunities/{SearchId}/child/opportunityList/{OpportunityId}
Pay Advance Request and Payment Based on Eligibility
The payAdvances resource allows employees to request early payment of the hours worked in the current pay period. It allows pay advance requests to be processed and paid in a timely manner.
- Create a pay advance request.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/payAdvances/action/requestAdvance
- Create the employee's eligibility check to pay advance.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/payAdvances/action/checkEligibility
- Get a pay advance.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payAdvances/{User}
- Get all pay advances.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payAdvances
Payroll Document Records
The payroll document records resource is used to get all the payroll tax document records for a person.
- Get a payroll tax document record.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}
- Get all payroll tax document records.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollDocumentRecords
Payroll Document Records/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}
Payroll Document Records/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Payroll Document Records/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollDocumentRecords/{DocumentsOfRecordId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Payroll Relationships
The payrollRelationship resource includes a list of all payroll relationships as of the specified date. It returns information on the payroll relationship data. By default, the current date is retained.
- Get a payroll relationship
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}
- Get all payroll relationships
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships
- Update a payroll relationship
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}
Payroll Relationships/Payroll Assignments
The payrollAssignments resource is a child of the payrollRelationships resource.It includes a list of all payroll assignments for a given payroll relationship.
- Get a payroll assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}
- Get all payroll assignments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments
- Update a payroll assignment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}
- Update a tax reporting unit
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/action/updateTRU
Payroll Relationships/Payroll Assignments/Assigned Payrolls
The assignedPayrolls resource is a child of the payrollAssignments resource.It includes a list of all payrolls assigned for a given assignment.
- Create an assigned payroll
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls
- Delete an assigned payroll
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}
- Get all assigned payrolls
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls
- Get an assigned payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}
- Transfer a payroll
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/action/transferPayroll
- Update an assigned payroll
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}
Payroll Relationships/Payroll Assignments/Assigned Payrolls/Assigned Payroll Dates
The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.
- Get all assigned payroll dates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/child/assignedPayrollDates
- Get an assigned payroll date
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/child/assignedPayrollDates/{PayDateId}
- Update an assigned payroll date
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/child/assignedPayrollDates/{PayDateId}
Payroll Relationships/Payroll Assignments/Payroll Assignment Dates
The payrollAssignmentDates resource is a child of the payrollAssignments resource. It includes a list of all element duration dates for a given payroll assignment.
- Get a payroll assignment date
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/payrollAssignmentDates/{PayDateId}
- Get all payroll assignment dates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/payrollAssignmentDates
- Update a payroll assignment date
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/payrollAssignmentDates/{PayDateId}
Payroll Relationships/Payroll Assignments/Payroll Assignment Developer Descriptive Flexfields
The operations from the Payroll Relationships/Payroll Assignments/Payroll Assignment Developer Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/PayrollRelationshipGroupsDDF/{PayrollRelationshipGroupsDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/PayrollRelationshipGroupsDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/PayrollRelationshipGroupsDDF/{PayrollRelationshipGroupsDDFUniqID}
Payroll Relationships/Payroll Relationship Dates
The payrollRelationshipDates resource is a child of the payrollRelationships resource. It includes a list of all element duration dates for the given payroll relationship.
- Get a payroll relationship date
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollRelationshipDates/{PayDateId}
- Get all payroll relationship dates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollRelationshipDates
Payroll Relationships/Payroll Relationship Developer Descriptive Flexfields
The operations from the Payroll Relationships/Payroll Relationship Developer Descriptive Flexfields category.
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/PayRelationshipsDDF/{PayRelationshipsDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/PayRelationshipsDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/PayRelationshipsDDF/{PayRelationshipsDDFUniqID}
Payslips
The documents resource is a child of the payslips resource. It includes all the attachments for a payslip.
- Download attachments for a document record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/payslips/action/downloadAttachments
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips
Payslips/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}
Payslips/Attachments/Attachment Previews
The attachments preview resource is used to preview the attachment pages.
- Get all attachment preview pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview
- Get an attachment preview page
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}
Payslips/Attachments/Attachment Previews/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}
Payslips/Attachments/Attachment Previews/Attachments/Attachment Previews
The attachments preview resource is used to preview the attachment pages.
- Get all attachment preview pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview
- Get an attachment preview page
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/child/AttachmentsPreview/{payslips_documents_AttachmentsPreview_Attachment_AttachmentsPreview_Id}
Payslips/Attachments/Attachment Previews/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Payslips/Attachments/Attachment Previews/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/child/AttachmentsPreview/{AttachmentsPreviewUniqID}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage
Payslips/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/enclosure/FileContents
Payslips/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/documents/{documentsUniqID}/enclosure/FileWebImage
Payslips/Payslip History
The payslipHistory resource is a child of the payslips resource. It includes all the historical payment details made to the employee.
- Get all earnings and deductions for a payslip.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/payslipHistory
- Get an earning and deduction for a payslip.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/payslipHistory/{payslipHistoryUniqID}
Payslips/Payslips Summary
Payslips/Payslips Summary/Net Pay Distribution
The netPayDistribution resource is a child of the payslips resource. It includes all the payment details made to the employee.
- Get a payment for a payslip.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/PayslipSummary/{PayrollRelActionId}/child/NetPayDistribution/{NetPayDistributionUniqID}
- Get all payments for a payslip.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/payslips/{payslipsUniqID}/child/PayslipSummary/{PayrollRelActionId}/child/NetPayDistribution
Performance Cycles
The perfCycles resource provides all the performance cycles in performance management.
- Create a performance cycle
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/perfCycles
- Delete a performance cycle
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}
- Get a performance cycle
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}
- Get all performance cycles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/perfCycles
- Update a performance cycle
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}
Performance Cycles/Performance Cycle Groups
The perfCycleGroups resource is a child of the perfCycles resource and provides all the groups associated with the performance cycle. A group can be a group of goal plans or a group of check-ins.
- Create a performance cycle group
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups
- Delete a performance cycle group
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}
- Get a performance cycle group
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}
- Get all performance cycle groups
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups
- Update a performance cycle group
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}
Performance Cycles/Performance Cycle Groups/Performance Cycle Group Objects
The perfCycleGroupObjects resource is a child of the perfCycleGroups resource and provides all the objects associated with the performance cycle group. The objects can be individual goal plans of a group or individual check-ins of a group.
- Create a performance cycle group object
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}/child/perfCycleGroupObjects
- Delete a performance cycle group object
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}/child/perfCycleGroupObjects/{PerfCycleObjectId}
- Get a performance cycle group object
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}/child/perfCycleGroupObjects/{PerfCycleObjectId}
- Get all performance cycle group objects
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}/child/perfCycleGroupObjects
- Update a performance cycle group object
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}/child/perfCycleGroupObjects/{PerfCycleObjectId}
Performance Cycles/Performance Cycle Groups/Performance Cycle Group Phases
The perfCycleGroupPhases resource is a child of the perfCycleGroups resource and provides all the phases associated with the performance cycle group.
- Create a performance cycle group phase
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}/child/perfCycleGroupPhases
- Delete a performance cycle group phase
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}/child/perfCycleGroupPhases/{PerfCyclePhaseId}
- Get a performance cycle group phase
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}/child/perfCycleGroupPhases/{PerfCyclePhaseId}
- Get all performance cycle group phases
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}/child/perfCycleGroupPhases
- Update a performance cycle group phase
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/perfCycles/{PerfCycleId}/child/perfCycleGroups/{PerfCycleGroupId}/child/perfCycleGroupPhases/{PerfCyclePhaseId}
Performance Evaluations
The performanceEvaluations resource retrieves information about performance documents.
- Get a performance document
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}
- Get all performance documents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceEvaluations
Performance Evaluations/Performance Roles
The Roles resource is a child of the performanceEvaluations resource. It retrieves information about the evaluation roles in a performance document.
- Get a performance role
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles/{EvalRoleId}
- Get all performance roles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles
Performance Evaluations/Performance Roles/Performance Document Participants
The Participants resource is a child of the roles resource. It retrieves information about participants in a performance document.
- Get a performance document participant
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles/{EvalRoleId}/child/Participants/{EvalParticipantId}
- Get all performance document participants
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles/{EvalRoleId}/child/Participants
Performance Evaluations/Performance Roles/Performance Document Participants/Performance Document Tasks
The Tasks resource is a child of the participants resource. It retrieves information about the tasks available for a performance document.
- Get a performance document task
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles/{EvalRoleId}/child/Participants/{EvalParticipantId}/child/Tasks/{TasksUniqID}
- Get all performance document tasks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceEvaluations/{performanceEvaluationsUniqID}/child/Roles/{EvalRoleId}/child/Participants/{EvalParticipantId}/child/Tasks
Performance Goals
The performanceGoals resource provides the performance goals of a worker.
- Get a performance goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceGoals/{performanceGoalsUniqID}
- Get all performance goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceGoals
Performance Goals/Associated Goal Plans
The associatedGoalPlans resource returns all goal plans associated with the performance goal.
- Get all associated goal plans
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceGoals/{performanceGoalsUniqID}/child/associatedGoalPlans
- Get an associated goal plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/performanceGoals/{performanceGoalsUniqID}/child/associatedGoalPlans/{GoalPlanGoalId}
Person Notes
The personNotes resource is used to view and create notes about a person. For example, you can include information such as feedback or kudos in the note.
- Create a person note
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personNotes
- Decrement the reference count
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/action/decrementReferenceCount
- Delete a person note
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}
- Find out if a user has the privilege to view a person's public notes
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personNotes/action/getViewPubPersonNotePrivilege
- Generate a printable feedback document
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personNotes/action/getBipReportUrlPrintFeedback
- Get a person note
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}
- Get all person notes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotes
- Increment the reference count
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/action/incrementReferenceCount
- Returns the context name
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/action/getContextName
- Send thank you note
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/action/sendThankYou
- Update a person note
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}
Person Notes Visibility Option
The personNotesVisibilityOptions resource includes the configuration of visibility options for person notes associated with the context type. It's used for setting up the visibility of person notes. It specifies visibility options available to users when they create person notes in a given context.
- Get a visibility option
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptions/{personNotesVisibilityOptionsUniqID}
- Get all visibility options
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotesVisibilityOptions
Person Notes/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}
Person Notes/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Person Notes/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Person Notes/Large Object (LOB) Attributes - NoteText
- Delete a NoteText
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/enclosure/NoteText
- Get a NoteText
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/enclosure/NoteText
- Replace a NoteText
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/personNotes/{personNotesUniqID}/enclosure/NoteText
Person Process Results
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}
- Unique identifier for the payroll
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/action/performObjectAction
Person Process Results/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/attachments/{personProcessResults_attachments_Id}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/attachments/{personProcessResults_attachments_Id}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/attachments/{personProcessResults_attachments_Id}
Person Process Results/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/attachments/{personProcessResults_attachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/attachments/{personProcessResults_attachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/attachments/{personProcessResults_attachments_Id}/enclosure/FileContents
Person Process Results/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/attachments/{personProcessResults_attachments_Id}/enclosure/FileWebImage
Person Process Results/Payslips Summary
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/costAdjustments
- Unique identifier for the payroll
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/costAdjustments/action/createCostAdjustment
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/costAdjustments/{CostAdjustmentId}
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/costingResults
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/costingResults/{CostAdjustmentId}
Person Process Results/Person Process Results Assignment
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/PayrollAssignmentLOV
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/PayrollAssignmentLOV/{PayrollAssignmentId}
Person Process Results/Person Process Results Balance Group
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceGroupLOV
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceGroupLOV/{BalGrpUsageId}
Person Process Results/Person Process Results Balance Type
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceTypeLOV
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceTypeLOV/{BalanceTypeId}
Person Process Results/Person Process Results Balance View
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceView
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceView/{BalanceViewUniqID}
Person Process Results/Person Process Results Balance View/Person Process Results Balance Context
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceView/{BalanceViewUniqID}/child/BalanceContext
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceView/{BalanceViewUniqID}/child/BalanceContext/{ContextBaseName}
Person Process Results/Person Process Results Balance View/Person Process Results Balance Feed
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceView/{BalanceViewUniqID}/child/BalanceFeed
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceView/{BalanceViewUniqID}/child/BalanceFeed/{BalanceFeedUniqID}
Person Process Results/Person Process Results Balance View/Person Process Results Employment Balance
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceView/{BalanceViewUniqID}/child/EmploymentBalance
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/BalanceView/{BalanceViewUniqID}/child/EmploymentBalance/{EmploymentId}
Person Process Results/Person Process Results Calculation Breakdown
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/CalculationBreakdown
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/CalculationBreakdown/{CalcBreakdownId}
Person Process Results/Person Process Results Messages
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/messages
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/messages/{messagesUniqID}
Person Process Results/Person Process Results Prepayment
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/Payments
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/Payments/{PaymentsUniqID}
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/Prepayments
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/Prepayments/{PaymentsUniqID}
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/VoidPayment
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/VoidPayment/{PaymentsUniqID}
Person Process Results/Person Process Results Primary Classification
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/PrimaryClassificationLOV
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/PrimaryClassificationLOV/{ClassificationId}
Person Process Results/Person Process Results Process Configuration Group
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/PersonProcessPCG
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/PersonProcessPCG/{PersonProcessPCGUniqID}
Person Process Results/Person Process Results Rate Detail
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/RunResultRateDetail
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/RunResultRateDetail/{RunResultId}
Person Process Results/Person Process Results Run Result
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/RunResult
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/RunResult/{RunResultUniqID}
Person Process Results/Person Process Results Statements of Earnings
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/SOEBalanceView
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/SOEBalanceView/{RowIndex}
Person Process Results/Person Process Results Tax Reporting Unit
Unique identifier for the payroll
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/TaxReportingUnitLOV
- Unique identifier for the payroll
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personProcessResults/{ObjectActionId}/child/TaxReportingUnitLOV/{TaxReportingUnitId}
Personal Intents
The personalIntents resource provides all the personal intents of an employee.
- Create a personal intent
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personalIntents
- Delete a personal intent
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/personalIntents/{PersonalIntentId}
- Get a personal intent
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personalIntents/{PersonalIntentId}
- Get all personal intents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personalIntents
- Update a personal intent
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/personalIntents/{PersonalIntentId}
Personal Payment Methods
The personalPaymentMethods resource includes a list of all personal payment methods for a given payroll relationship.
- Create a personal payment method
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/personalPaymentMethods
- Delete a personal payment method
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/personalPaymentMethods/{personalPaymentMethodsUniqID}
- Get a personal payment method
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personalPaymentMethods/{personalPaymentMethodsUniqID}
- Get all personal payment methods
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/personalPaymentMethods
- Update a personal payment method
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/personalPaymentMethods/{personalPaymentMethodsUniqID}
Plan Balances
The planBalances resource provides the remaining balance on a worker's absence plan enrollments, along with summary-level or detailed information on all transactions that have impacted the balance on the plan.
- Get a plan balance
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}
- Get all plan balances
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances
Plan Balances/Details
The details resource is a child of the planBalances resource and provides details of each transaction type available for the absence plan.
- Get a plan balance transaction
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/details/{planBalanceDetailsId}
- Get all plan balance transactions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/details
Plan Balances/Plan Balance Details
The planBalanceDetails resource is a child of the planBalances resource and provides detailed information on all transactions that impact the balance on the plan.
- Get a plan balance detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/planBalanceDetails/{personAccrualEntryDtlId}
- Get all plan balance details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/planBalanceDetails
Plan Balances/Plan Balance Summaries
The planBalanceSummary resource is a child of the planBalances resource and provides summary-level information on all transactions that impact the balance on the plan.
- Get a plan balance summary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/planBalanceSummary/{transactionTypeCode}
- Get all plan balance summaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/planBalanceSummary
Plan Balances/Unvested Balance Details
The unvestedBalanceDetails resource is a child of the planBalances resource and provides the details of balance transactions that are unvested.
- Get all unvested balance transactions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/unvestedDetails
- Get an unvested balance transaction
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/unvestedDetails/{unvestedDetailsId}
Plan Balances/Year End Details
The yearEndDetails resource is a child of the planBalances resource and provides the details for the plan year end transactions.
- Get a year-end detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/yearEndDetails/{planBalanceYearEndId}
- Get all year-end details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/planBalances/{planBalancesUniqID}/child/yearEndDetails
Positions
The positions resource retrieves the details of all the positions as on a specified date.
- Get a position
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}
- Get all positions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/positions
Positions/Positions Descriptive Flexfields
The operations from the Positions/Positions Descriptive Flexfields category.
Positions/Positions Extensible Flexfields
The operations from the Positions/Positions Extensible Flexfields category.
Positions/Positions Legislative Extensible Flexfields
The operations from the Positions/Positions Legislative Extensible Flexfields category.
Positions/Positions Valid Grade
The validGrades resource is a child of the positions resource. It includes all valid grades for the position, as of the specified date.
- Get a position valid grade
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/validGrades/{validGradesUniqID}
- Get all position valid grades
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/positions/{positionsUniqID}/child/validGrades
Product Settings in Opportunity Marketplace
The recruitingOppMktSettings resource provides the product settings in opportunity marketplace.
- Get a setting for opportunity marketplace.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktSettings/{SettingKey}
- Get all settings for opportunity marketplace.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktSettings
Prospect Candidates
The recruitingUIProspects resource provides details about prospect candidates.
- Create a prospect candidate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIProspects
- Create a prospect candidate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIProspects/action/createProspects
- Delete a prospect candidate action isn't supported
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIProspects/{ProspectId}
- Get a prospect candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIProspects/{ProspectId}
- Get all prospect candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIProspects
- Update a prospect candidate action isn't supported
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIProspects/{ProspectId}
- Update a prospect candidate to not interested in the job requisition
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIProspects/action/markProspectAsNotInterested
Public Workers
The publicWorkers resource provides all the active workers as of the current date and returns public information about workers. Worker types include employee, contingent worker, pending worker, and nonworker. For bulk extract operations, you must use HCM Extracts. Also, you must not use REST APIs for detecting data changes in the application. Instead, use Atom feeds to detect or identify changes made to data for key transactions in Oracle Fusion Cloud HCM. For example, you may use Atom feeds to detect changes in employee's personal details, employment data, new hires, and terminations. See the Atom Feeds section for details about delivered feeds in Oracle Fusion Cloud HCM.
- Get a worker
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}
- Get all workers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers
Public Workers/Assignments
The assignments resource is a child of the publicWorkers resource. It includes all the active assignments of a worker as of the current date.
- Get a worker assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}
- Get all workers assignments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments
Public Workers/Assignments/All Reports
The allReports resource is a child of the assignments resource. It includes all the reports of a worker as of the current date for a specific assignment.
- Get a worker report
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports/{allReportsUniqID}
- Get all worker reports
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports
Public Workers/Assignments/All Reports Departments
The allReportsDepartments resource is a child of the assignments resource. It includes all the distinct departments that all the reports of a worker belong to, as of the system date for a specific assignment.
- Get a department
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReportsDepartments/{DepartmentId}
- Get all departments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReportsDepartments
Public Workers/Assignments/All Reports Locations
The allReportsLocations resource is a child of the assignments resource. It includes all the distinct locations that all the reports of a worker belong to, as of the system date for a specific assignment.
- Get a location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReportsLocations/{LocationId}
- Get all locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReportsLocations
Public Workers/Assignments/All Reports/Large Object (LOB) Attributes - Photo
- Delete a Photo
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports/{allReportsUniqID}/enclosure/Photo
- Get a Photo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports/{allReportsUniqID}/enclosure/Photo
- Replace a Photo
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/allReports/{allReportsUniqID}/enclosure/Photo
Public Workers/Assignments/Direct Reports
The directReports resource is a child of the assignments resource. It includes all the direct reports of a worker as of the system date for a specific assignment.
- Get a direct report
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports/{directReportsUniqID}
- Get all direct reports
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports
Public Workers/Assignments/Direct Reports/Large Object (LOB) Attributes - Photo
- Delete a Photo
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports/{directReportsUniqID}/enclosure/Photo
- Get a Photo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports/{directReportsUniqID}/enclosure/Photo
- Replace a Photo
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/directReports/{directReportsUniqID}/enclosure/Photo
Public Workers/Assignments/Employment History
The employmentHistory resource is a child of the assignments resource. It includes the employment history of a worker.
- Get a worker employment history
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/employmentHistory/{AssignmentId2}
- Get all worker employment history
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/employmentHistory
Public Workers/Assignments/Managers
The managers resource is a child of the assignments resource. It includes all the managers of a worker.
- Get a worker manager
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers/{AssignmentSupervisorId}
- Get all worker managers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers
Public Workers/Assignments/Managers/Large Object (LOB) Attributes - Photo
- Delete a Photo
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers/{AssignmentSupervisorId}/enclosure/Photo
- Get a Photo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers/{AssignmentSupervisorId}/enclosure/Photo
- Replace a Photo
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/managers/{AssignmentSupervisorId}/enclosure/Photo
Public Workers/Assignments/Representatives
The representatives resource is a child of the assignments resource. It includes all the worker representatives as of the current date.
- Get a worker representative
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives/{AsgResponsibilityId}
- Get all workers representatives
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives
Public Workers/Assignments/Representatives/Large Object (LOB) Attributes - Photo
- Delete a Photo
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives/{AsgResponsibilityId}/enclosure/Photo
- Get a Photo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives/{AsgResponsibilityId}/enclosure/Photo
- Replace a Photo
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/assignments/{AssignmentId}/child/representatives/{AsgResponsibilityId}/enclosure/Photo
Public Workers/Messages
The messages resource is a child of the publicWorkers resource. It includes all the available messages of a worker.
- Get a worker message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/messages/{MessageId}
- Get all worker messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/messages
Public Workers/Other Communication Accounts
The otherCommunicationAccounts resource is a child of the publicWorkers resource. It includes all the other communication accounts of a worker.
- Get a worker communication account
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/otherCommunicationAccounts/{DeliveryMethodId}
- Get all worker communication accounts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/otherCommunicationAccounts
Public Workers/Phones
The phones resource is a child of the publicWorkers resource. It includes all the available phone numbers of a worker.
- Get a worker phone
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/phones/{PhoneId}
- Get all worker phones
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/phones
Public Workers/Photos
The photos resource is a child of the publicWorkers resource. It includes all the available photos of a worker.
- Get a worker photo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/photos/{PhotoId}
- Get all worker photos
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/photos
Public Workers/Photos/Large Object (LOB) Attributes - Photo
- Delete a Photo
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/photos/{PhotoId}/enclosure/Photo
- Get a Photo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/photos/{PhotoId}/enclosure/Photo
- Replace a Photo
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/publicWorkers/{PersonId}/child/photos/{PhotoId}/enclosure/Photo
Questionnaire Instructions
The questionnaireInstructions resource includes the instruction text defined for a questionnaire.
- Get all questionnaire instructions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireInstructions
- Get questionnaire instructions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}
Questionnaire Instructions/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments/{questionnaireInstructionAttachmentsUniqID}
Questionnaire Instructions/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments/{questionnaireInstructionAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments/{questionnaireInstructionAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments/{questionnaireInstructionAttachmentsUniqID}/enclosure/FileContents
Questionnaire Instructions/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireInstructions/{questionnaireInstructionsUniqID}/child/questionnaireInstructionAttachments/{questionnaireInstructionAttachmentsUniqID}/enclosure/FileWebImage
Questionnaire Participant
The questionnaireParticipants resource includes the participants responding to the questionnaire. Responses for questionnaires defined for General Surveys subscriber are supported by this resource.
- Create a questionnaire participant
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants
- Get a questionnaire participant
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}
- Get all questionnaire participants
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants
- Update a questionnaire participant
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}
Questionnaire Participant/Questionnaire Responses
The questionnaireResponses resource provides the responses by a participant for the questions in a specific version of a questionnaire.
- Create a questionnaire response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses
- Delete a questionnaire response
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Questionnaire Participant/Questionnaire Responses/Question Responses
The questionResponses resource provides the responses provided by the participant to a specific question in a questionnaire.
- Create a question response
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Questionnaire Participant/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Questionnaire Participant/Questionnaire Responses/Question Responses/Question Response Attachments
The questionResponseAttachments resource provides the attachments submitted by a participant while responding to a question.
- Create a question response attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Delete a question response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a question response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all question response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Update a question response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Questionnaire Participant/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Questionnaire Participant/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireParticipants/{questionnaireParticipantsUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Questionnaire Templates
The questionnaireTemplates resource includes all details of a questionnaire template, its sections, questions and the attachments defined in the template.
- Get a questionnaire template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}
- Get all questionnaire templates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates
Questionnaire Templates/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments/{attachmentsUniqID}
Questionnaire Templates/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Questionnaire Templates/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Questionnaire Templates/Sections
The sections resource is a child resource of the questionnaireTemplates resource that includes the details of the sections defined in the questionnaire template.
- Get a section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}
- Get all sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections
Questionnaire Templates/Sections/Questions
The questions resource is a child of the questionnaireTemplates resource. It includes details of the questions included in a section of the questionnaire template.
- Get a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}
- Get all questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions
Questionnaire Templates/Sections/Questions/Answers
The answers resource is a child of the questionnaireTemplates resource. It includes details of the answer choices defined for a question that's included in a questionnaire template section.
- Get all answer choices
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers
- Get an answer choice
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}
Questionnaire Templates/Sections/Questions/Answers/Large Object (LOB) Attributes - ResponseFeedback
- Delete a ResponseFeedback
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
- Get a ResponseFeedback
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
- Replace a ResponseFeedback
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questionnaireTemplates/{questionnaireTemplatesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
Questionnaires
The questionnaires resource provides all the details of a questionnaire, its sections, questions, and the attachments defined.
- Create a questionnaire
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questionnaires
- Delete a questionnaire
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}
- Get a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}
- Get all questionnaires
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires
- Update a questionnaire
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}
Questionnaires/Attachments
The attachments resource is a child of the questionnaires resource. It provides details of the attachments in a questionnaire.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}
Questionnaires/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Questionnaires/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Questionnaires/Sections
The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
- Create a section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections
- Delete a section
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}
- Get a section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}
- Get all sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections
- Update a section
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}
Questionnaires/Sections/Questions
The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.
- Create a question
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions
- Delete a question
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}
- Get a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}
- Get all questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions
- Update a question
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}
Questionnaires/Sections/Questions/Answers
The answers resource is a child of the questionnaires resource. It provides details of the answer choices defined for a question that's included in a questionnaire section.
- Get all answer choices
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers
- Get an answer choice
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}
- Update an answer choice
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}
Questionnaires/Sections/Questions/Answers/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments/{answerAttachmentsUniqID}
Questionnaires/Sections/Questions/Answers/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments/{answerAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments/{answerAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments/{answerAttachmentsUniqID}/enclosure/FileContents
Questionnaires/Sections/Questions/Answers/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/answerAttachments/{answerAttachmentsUniqID}/enclosure/FileWebImage
Questionnaires/Sections/Questions/Answers/Large Object (LOB) Attributes - ResponseFeedback
- Get a ResponseFeedback
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
Questionnaires/Sections/Questions/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments/{questionAttachmentsUniqID}
Questionnaires/Sections/Questions/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments/{questionAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments/{questionAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments/{questionAttachmentsUniqID}/enclosure/FileContents
Questionnaires/Sections/Questions/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questionnaires/{questionnairesUniqID}/child/sections/{sectionsUniqID}/child/questions/{questionsUniqID}/child/questionAttachments/{questionAttachmentsUniqID}/enclosure/FileWebImage
Questions
The questions resource provides text objects to ask for a response from a participant with or without a predefined list of answer choices that participants may choose from as a response.
- Create a question
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questions
- Delete a question
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}
- Get a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}
- Get all questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions
- Update a question
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}
Questions/Answers
The answers resource is a child of the questions resource. It provides a list of choices that a user can select from when answering single or multiple choice questions.
- Create an answer
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers
- Delete an answer
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}
- Get all answers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers
- Get an answer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}
- Update an answer
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}
Questions/Answers/Attachments
The attachments resource is a child of the questions resource. It includes details of the attachments in a question.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments/{attachmentsUniqID}
Questions/Answers/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Questions/Answers/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Questions/Answers/Large Object (LOB) Attributes - ResponseFeedback
- Delete a ResponseFeedback
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
- Get a ResponseFeedback
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
- Replace a ResponseFeedback
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/answers/{answersUniqID}/enclosure/ResponseFeedback
Questions/Attachments
The attachments resource is a child of the questions resource. It includes details of the attachments in a question.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}
Questions/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Questions/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Questions/Job Family Contexts
The jobFamilyContexts resource is a child of the questions resource. It provides the job family that the question applies to. This context is used only by the recruiting subscriber.
- Create a job family
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFamilyContexts
- Delete a job family
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFamilyContexts/{jobFamilyContextsUniqID}
- Get a job family
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFamilyContexts/{jobFamilyContextsUniqID}
- Get all job families
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFamilyContexts
Questions/Job Function Contexts
The jobFunctionContexts resource is a child of the questions resource. It provides the job function that the question applies to. This context is used only by the recruiting subscriber.
- Create a job function
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFunctionContexts
- Delete a job function
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFunctionContexts/{QuestionContextId}
- Get a job function
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFunctionContexts/{QuestionContextId}
- Get all job functions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/jobFunctionContexts
Questions/Location Contexts
The locationContexts resource is a child of the questions resource. It provides the recruiting location that the question applies to. This context is used only by the recruiting subscriber.
- Create a location
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/locationContexts
- Delete a location
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/locationContexts/{locationContextsUniqID}
- Get a location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/locationContexts/{locationContextsUniqID}
- Get all locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/locationContexts
Questions/Organization Contexts
The organizationContexts resource is a child of the questions resource. It provides the recruiting organization that the question applies to. This context is used only by the recruiting subscriber.
- Create an organization
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/organizationContexts
- Delete an organization
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/organizationContexts/{organizationContextsUniqID}
- Get all organization
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/organizationContexts
- Get an organization
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/questions/{questionsUniqID}/child/organizationContexts/{organizationContextsUniqID}
Recruiting Activity Center Configurations
The recruitingRACConfigurations resource provides the overview of the configuration associated with items of recruiting activity center.
- Create a value for the configuration
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingRACConfigurations
- Get a value for the configuration
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingRACConfigurations/{SubscriberRuleId}
- Get all values for the configuration
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingRACConfigurations
- Update a value of the configuration
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingRACConfigurations/{SubscriberRuleId}
Recruiting Assessment Account Packages
The recruitingAssessmentAccountPackages resource includes all the details of the recruiting assessment account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create the details of all recruiting assessment account packages.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages/{recruitingAssessmentAccountPackagesUniqID}
Recruiting Assessment Account Packages/Packages Included in the Recruiting Assessment Account Packages
The packages resource is a child of the recruitingAssessmentAccountPackages. It includes all packages of recruiting assessment account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create all packages of recruiting assessment account packages.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages/{recruitingAssessmentAccountPackagesUniqID}/child/packages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages/{recruitingAssessmentAccountPackagesUniqID}/child/packages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingAssessmentAccountPackages/{recruitingAssessmentAccountPackagesUniqID}/child/packages/{PackageCode}
Recruiting Assessment Partner Candidate Details
The recruitingPartnerCandidateDetails resource provides details about the recruiting partner in the candidate job application. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a recruiting partner candidate details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}
- Get all the recruiting partner candidate details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails
Recruiting Assessment Partner Candidate Details/Address Details in the Recruiting Assessment Partner Candidate Details
The addressDetails resource is the child of the recruitingPartnerCandidateDetails resource and provides the individual address fields used for the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get all address details of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/addressDetails
- Get an address details of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/addressDetails/{addressDetailsUniqID}
Recruiting Assessment Partner Candidate Details/Address Format in the Recruiting Assessment Partner Candidate Details
The addressFormat resource is the child of the recruitingPartnerCandidateDetails resource and provides the address format used for the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get all address formats of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/addressFormat
- Get an address format of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/addressFormat/{Attribute}
Recruiting Assessment Partner Candidate Details/Certification Related Information in the Recruiting Partner Candidate Details
The certifications resource is the child of the recruitingPartnerCandidateDetails resource and provides the certifications of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a certification of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/certifications/{CertificationId}
- Get all certifications of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/certifications
Recruiting Assessment Partner Candidate Details/Certification Related Information in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/certifications/{CertificationId}/enclosure/Comments
Recruiting Assessment Partner Candidate Details/Certification Related Information in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Restrictions
- Get a Restrictions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/certifications/{CertificationId}/enclosure/Restrictions
Recruiting Assessment Partner Candidate Details/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details
The educations resource is the child of the recruitingPartnerCandidateDetails resource and provides details about the education of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a education of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}
- Get all educations of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations
Recruiting Assessment Partner Candidate Details/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - ActivitySummary
- Get an ActivitySummary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/ActivitySummary
Recruiting Assessment Partner Candidate Details/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/Comments
Recruiting Assessment Partner Candidate Details/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/Description
Recruiting Assessment Partner Candidate Details/Educational Qualifications Mentioned in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Reimbursements
- Get a Reimbursements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/Reimbursements
Recruiting Assessment Partner Candidate Details/National Identifiers of the Candidate in the Recruiting Partner Candidate Details
The NationalIdentifiers resource is a child of the recruitingPartnerCandidateDetails resource and provides the national identifiers of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a national identifier of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/nationalIdentifiers/{NationalIdentifierNumber}
- Get all national identifiers of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/nationalIdentifiers
Recruiting Assessment Partner Candidate Details/Previous Employments Recorded in the Recruiting Partner Candidate Details
The previousEmployments resource is the child of the recruitingPartnerCandidateDetails resource and provides the previous employment details of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a previous employment of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments/{PreviousEmploymentId}
- Get all the previous employments of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments
Recruiting Assessment Partner Candidate Details/Previous Employments Recorded in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Achievements
- Get an Achievements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments/{PreviousEmploymentId}/enclosure/Achievements
Recruiting Assessment Partner Candidate Details/Previous Employments Recorded in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - AdditionalInformation
- Get an AdditionalInformation
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments/{PreviousEmploymentId}/enclosure/AdditionalInformation
Recruiting Assessment Partner Candidate Details/Previous Employments Recorded in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - LeavingReason
- Get a LeavingReason
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments/{PreviousEmploymentId}/enclosure/LeavingReason
Recruiting Assessment Partner Candidate Details/Previous Employments Recorded in the Recruiting Partner Candidate Details/Large Object (LOB) Attributes - Responsibilities
- Get a Responsibilities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/previousEmployments/{PreviousEmploymentId}/enclosure/Responsibilities
Recruiting Assessment Partner Candidate Details/Requisition Additional Attributes Recorded in the Recruiting Partner Candidate Details
The requisitionAdditionalAttributes resource is the child of the recruitingPartnerCandidateDetails resource and provides the previous employment details of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a requisition additional attribute of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/requisitionAdditionalAttributes/{AttributeName}
- Get all the requisition additional attributes of the recruiting partner candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/requisitionAdditionalAttributes
Recruiting Background Check Account Packages
The recruitingBGCheckAccountPackages resource includes the details of recruiting background check account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get all details of the recruiting background check account packages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages
- Get details of a recruiting background check account package
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages/{recruitingBGCheckAccountPackagesUniqID}
- Post all details of the recruiting background check account packages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages
Recruiting Background Check Account Packages/Packages Included in the Recruiting Background Check Account Packages
The packages resource is a child of recruitingBGCheckAccountPackages. It includes the details of the packages in the recruiting background check account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create all packages of recruiting background check account packages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages/{recruitingBGCheckAccountPackagesUniqID}/child/packages
- Get all packages of recruiting background check account packages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages/{recruitingBGCheckAccountPackagesUniqID}/child/packages
- Get packages of a recruiting background check account package
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingBGCheckAccountPackages/{recruitingBGCheckAccountPackagesUniqID}/child/packages/{PackageCode}
Recruiting Background Check Candidate Results
The bcCandidateResults resource includes all the details of the candidate background check results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateResults
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}
- Submit all candidate results
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateResults
Recruiting Background Check Candidate Results/Services About the Candidate Results
The services resource is a child of the bcCandidateResults resource. It includes the services of the candidate results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services/{ScreeningPackage}
- Submit all services of candidate results
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services
Recruiting Background Check Candidate Results/Services About the Candidate Results/Additional Candidate Background Check Results
The additionalResultsAttributes resource is a child of the bcCandidateResults resource. It includes the additional attributes of the candidate results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services/{ScreeningPackage}/child/AdditionalResultsAttributes
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services/{ScreeningPackage}/child/AdditionalResultsAttributes/{AttributeName}
- Submit additional results of candidate background check
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateResults/{PartnerId}/child/services/{ScreeningPackage}/child/AdditionalResultsAttributes
Recruiting Background Check Screening Packages
The bcScreeningPackages packages resource includes the details of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcScreeningPackages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcScreeningPackages/{bcScreeningPackagesUniqID}
- Submit all details of the screening packages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/bcScreeningPackages
Recruiting Background Check Screening Packages/Services About the Screening Packages.
The services resource is a child of the bcScreeningPackages resource. It includes the services of the screening packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcScreeningPackages/{bcScreeningPackagesUniqID}/child/services
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcScreeningPackages/{bcScreeningPackagesUniqID}/child/services/{ScreeningPackage}
- Submit all services of the screening packages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/bcScreeningPackages/{bcScreeningPackagesUniqID}/child/services
Recruiting CE Address Formats
The recruitingCEAddressFormats resource includes the format of address for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all address formats of countries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats
- Get an address format of countries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}
Recruiting CE Address Formats/Address Format Details
The addressFormatDetails resource is a child of recruitingCEAddressFormats. It includes the address format details for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all address formats details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/addressFormatDetails
- Get an address format details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/addressFormatDetails/{AttributeName}
Recruiting CE Address Formats/Geographical Hierarchies
The geoHierarchies resource is a child of recruitingCEAddressFormats. It includes the geographical hierarchies for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a geographical hierarchy
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/geoHierarchies/{geoHierarchiesUniqID}
- Get all geographical hierarchies
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/geoHierarchies
Recruiting CE Address Formats/State Provinces
The stateProvinces resource is a child of recruitingCEAddressFormats. It includes the details of the states and provinces for a given country. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a state and province
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/stateProvinces/{stateProvincesUniqID}
- Get all states and provinces
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEAddressFormats/{TerritoryCode}/child/stateProvinces
Recruiting CE Application Flows
The recruitingCEApplyFlows resource includes all the corresponding job application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a job application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}
- Get all job application flows
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows
Recruiting CE Application Flows/Requisition Flexfields
The requisitionFlexFields resource is a child of the recruitingCEApplyFlows resource. It includes all the job requisition flexfields configured for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a requisition flexfield
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/requisitionFlexFields/{ColumnName}
- Get all requisition flexfields
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/requisitionFlexFields
Recruiting CE Application Flows/Sections
The sections resource is a child of recruitingCEApplyFlows. It includes all the corresponding sections for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}
- Get all sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections
Recruiting CE Application Flows/Sections/Pages
The pages resource is a child of the recruitingCErecruitingCEApplyFlows resource. It includes all the corresponding pages for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a page
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}
- Get all pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages
Recruiting CE Application Flows/Sections/Pages/Blocks
The blocks resource is a child of the pages resources. It includes all the corresponding blocks for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a block
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}/child/blocks/{PageBlockId}
- Get all blocks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}/child/blocks
Recruiting CE Auto Suggestions on Search.
The recruitingCESearchAutoSuggestions resource gives details of auto suggestions on search. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of all auto suggestions on search
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESearchAutoSuggestions
- Get details of an auto suggestion on search
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESearchAutoSuggestions/{Name}
Recruiting CE Candidate Address Formats
The recruitingCECandidateAddressFormats returns location information to be used in the address block for a candidate address.
- Get location text for a location type.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateAddressFormats/{recruitingCECandidateAddressFormatsUniqID}
- Get location text for all location types.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateAddressFormats
Recruiting CE Candidate Certifications
The recruitingCECandidateCertificationItems resource includes the details about the certification done by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete details of the certification
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}
- Get details of a certification
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}
- Get details of all the certifications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems
- Submit a patch for the certification.
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}
- Submit details of all the certifications
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems
Recruiting CE Candidate Certifications/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Comments
Recruiting CE Candidate Certifications/Large Object (LOB) Attributes - Restrictions
- Delete a Restrictions
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Restrictions
- Get a Restrictions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Restrictions
- Replace a Restrictions
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}/enclosure/Restrictions
Recruiting CE Candidate Details
The recruitingCECandidates resource includes all the details of recruitingCECandidates. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete details of a candidate
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}
- Get all details of recruitingCECandidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates
- Get the details of a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}
- Patch details of a candidate
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}
- Post all details of recruitingCECandidates
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates
Recruiting CE Candidate Details/Candidate Details with Attachments
The attachments resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with attachments. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete details of a recruitingCECandidates attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments/{Id}
- Get all details of recruitingCECandidates attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments
- Get details of a recruitingCECandidates attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments/{Id}
- Patch details of a recruitingCECandidates attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments/{Id}
- Post all details of recruitingCECandidates attachments
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/attachments
Recruiting CE Candidate Details/Candidate Details with Extra Information Data
The CandidateExtraInformation resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create all details of recruitingCECandidates personExtraInformation
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation
- Delete a candidate extra information dictionary
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}
- Get all extra information dictionary details of candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation
- Get extra information dictionary detail of candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}
- Update all details of recruitingCECandidates personExtraInformation
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}
Recruiting CE Candidate Details/Candidate Details with Extra Information Data/Candidate Details with Extra Information Rows
The Rows resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information rows. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete an extra information row for a candidate.
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}
- Get all extra information row details for a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows
- Get an extra information row detail for a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}
- Update all details of recruitingCECandidates personExtraInformation rows
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}
- Update an extra information row record for a candidate.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows
Recruiting CE Candidate Details/Candidate Details with Extra Information Data/Candidate Details with Extra Information Rows/Candidate Details with Extra Information Attributes
The attributes resource is a child of the recruitingCECandidates resource. It includes the details of recruitingCECandidates with extra information row attributes. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create all details of recruitingCECandidates personExtraInformation row attributes
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}/child/attributes
- Delete an extra information attribute for candidate extra information row
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}/child/attributes/{AttributeId}
- Get all extra information attribute details defined for candidate extra information row
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}/child/attributes
- Get an extra information attribute detail defined for the candidate extra information row
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}/child/attributes/{AttributeId}
- Update all details of recruitingCECandidates personExtraInformation row attributes
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextName}/child/dataRows/{DataRowId}/child/attributes/{AttributeId}
Recruiting CE Candidate Details/Candidate Details with PII Data
The CandidatePIIData resource is a child of the recruitingCECandidates resource. It includes the details of the candidate national identifiers and date of birth. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create all details of recruitingCECandidates CandidatePIIData
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData
- Delete details of a recruitingCECandidates CandidatePIIData
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData/{Id}
- Get all details of recruitingCECandidates CandidatePIIData
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData
- Get details of a recruitingCECandidates CandidatePIIData
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData/{Id}
- Update details of a recruitingCECandidates CandidatePIIData
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidates/{CandidateNumber}/child/CandidatePIIData/{Id}
Recruiting CE Candidate Education
The recruitingCECandidateEducationItems resource includes details about the candidate's education. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete the details of the education items of the candidate.
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}
- Get all the education items of the candidate.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems
- Get an education item of the candidate.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}
- Submit all the details of the education items of the candidate.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems
- Update the details of the education items of the candidate.
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}
Recruiting CE Candidate Education/Large Object (LOB) Attributes - ActivitySummary
- Delete an ActivitySummary
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/ActivitySummary
- Get an ActivitySummary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/ActivitySummary
- Replace an ActivitySummary
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/ActivitySummary
Recruiting CE Candidate Education/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Comments
Recruiting CE Candidate Education/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Description
Recruiting CE Candidate Education/Large Object (LOB) Attributes - Reimbursements
- Delete a Reimbursements
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Reimbursements
- Get a Reimbursements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Reimbursements
- Replace a Reimbursements
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateEducationItems/{EducationId}/enclosure/Reimbursements
Recruiting CE Candidate Extra Information Dictionary
The recruitingCEExtraInformationDictionary resource includes all the values of dictionary as defined. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all details of the extra information dictionary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEExtraInformationDictionary
- Get details of the extra information dictionary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEExtraInformationDictionary/{ResourceName}
Recruiting CE Candidate Extra Information Dictionary/Recruiting CE Candidate Extra Information Dictionary List of Values
The CandidateEFFDictionaryList resource is a child of the recruitingCEExtraInformationDictionary resource. It provides a list of values in the current dictionary. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all details of the extra information dictionary list
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEExtraInformationDictionary/{ResourceName}/child/listOfValues
- Get details of the extra information dictionary list
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEExtraInformationDictionary/{ResourceName}/child/listOfValues/{ListId}
Recruiting CE Candidate Interview Actions
The recruitingCEInterviewActions resource provides details about the actions taken by the candidate during the interview. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a candidate interview action
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewActions
- Get a candidate interview action
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewActions/{recruitingCEInterviewActionsUniqID}
- Get all candidate interview actions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewActions
Recruiting CE Candidate Preferences
The recruitingCECandidatePreferences resource includes all the details of the job preferences of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a candidate preference
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreferences/{CandidateNumber}
- Get all candidate preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreferences
- Update a candidate preference
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreferences/{CandidateNumber}
Recruiting CE Candidate Previous Experience
The recruitingCECandidatePreviousExpItems resource includes the details of the candidate's previous experience. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete the candidate previous experience items.
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}
- Get all the candidate previous experience items.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems
- Get the candidate previous experience item.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}
- Patch the candidate previous experience items.
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}
- Post all the candidate previous experience items.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems
Recruiting CE Candidate Previous Experience/Large Object (LOB) Attributes - Achievements
- Delete an Achievements
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Achievements
- Get an Achievements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Achievements
- Replace an Achievements
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Achievements
Recruiting CE Candidate Previous Experience/Large Object (LOB) Attributes - AdditionalInformation
- Delete an AdditionalInformation
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/AdditionalInformation
- Get an AdditionalInformation
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/AdditionalInformation
- Replace an AdditionalInformation
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/AdditionalInformation
Recruiting CE Candidate Previous Experience/Large Object (LOB) Attributes - LeavingReason
- Delete a LeavingReason
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/LeavingReason
- Get a LeavingReason
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/LeavingReason
- Replace a LeavingReason
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/LeavingReason
Recruiting CE Candidate Previous Experience/Large Object (LOB) Attributes - Responsibilities
- Delete a Responsibilities
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Responsibilities
- Get a Responsibilities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Responsibilities
- Replace a Responsibilities
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems/{PreviousEmploymentId}/enclosure/Responsibilities
Recruiting CE Candidate Profile Blocks Meta Data.
The recruitingCECandidateProfileBlocksMetadata resource includes the details of the candidate profile blocks meta data. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a candidate profile blocks meta data
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileBlocksMetadata/{recruitingCECandidateProfileBlocksMetadataUniqID}
- Get all the candidate profile blocks meta data
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileBlocksMetadata
Recruiting CE Candidate Responses to Questions
The recruitingCEQuestionsResponses resource includes the details of responses provided by the candidate to the questions. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get the details of a response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEQuestionsResponses/{recruitingCEQuestionsResponsesUniqID}
- Get the details of all responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEQuestionsResponses
- Post details of all responses
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEQuestionsResponses
Recruiting CE Candidate Resume Parser
The recruitingCECandidateResumeParsers resource includes all details of the candidate resume. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a candidate resume
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports
- Create a candidate resume
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers
- Get a single candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}
- Get a single candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}
- Get all the candidate resumes in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports
- Get all the candidate resumes in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers
Recruiting CE Candidate Resume Parser/Attachments
The attachments resource is a child of recruitingCECandidateResumeParsers. It includes the details of all attachments added by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create an attachment with the candidate resume
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/attachments
- Get a single attachment of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/attachments/{Id}
- Get a single attachment of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/attachments/{Id}
- Get all the attachments of the candidate resume in a collection.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/attachments
- Get all the attachments of the candidate resume in a collection.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/attachments
Recruiting CE Candidate Resume Parser/Educations
The educations resource is a child of recruitingCECandidateResumeParsers. It includes details of the educational qualifications of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create education in the candidate resume
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/educations
- Get a single educational details of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/educations/{ProfileItemId}
- Get a single educational details of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/educations/{ProfileItemId}
- Get all the educational details of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/educations
- Get all the educational details of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/educations
Recruiting CE Candidate Resume Parser/Languages
The languages resource is a child of recruitingCECandidateResumeParsers. It includes details of the languages known to the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a language in the candidate resume
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/languages
- Get a single language of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/languages/{ProfileItemId}
- Get a single language of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/languages/{ProfileItemId}
- Get all the languages of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/languages
- Get all the languages of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/languages
Recruiting CE Candidate Resume Parser/Licenses and Certifications
The licensesAndcertifications resource is a child of recruitingCECandidateResumeParsers. It includes the details of all the licenses and certifications obtained by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a license and certification in the candidate resume
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/licensesAndCertifications
- Get a single license and certification of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/licensesAndCertifications/{ProfileItemId}
- Get a single license and certification of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/licensesAndCertifications/{ProfileItemId}
- Get all the licenses and certifications of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/licensesAndCertifications
- Get all the licenses and certifications of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/licensesAndCertifications
Recruiting CE Candidate Resume Parser/Skills
The skills resource is a child of recruitingCECandidateResumeParsers. It includes the details of all the skills obtained by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a skill in the candidate resume
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/skills
- Get a single skill of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/skills/{ProfileItemId}
- Get a single skill of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/skills/{ProfileItemId}
- Get all the skills of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/skills
- Get all the skills of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/skills
Recruiting CE Candidate Resume Parser/Work Experiences
The workExperiences resource is a child of recruitingCECandidateResumeParsers. It includes the details of all the work experiences of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a work experience in the candidate resume
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workExperiences
- Get a single work experiences of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/workExperiences/{ProfileItemId}
- Get a single work experiences of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workExperiences/{ProfileItemId}
- Get all the work experiences of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/workExperiences
- Get all the work experiences of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workExperiences
Recruiting CE Candidate Resume Parser/Work Preferences
The workPreferences resource is a child of recruitingCECandidateResumeParsers. It includes the details of the work preferences of the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a work preference in the candidate resume
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workPreferences
- Get a single work preference of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/workPreferences/{workPreferencesUniqID}
- Get a single work preference of the candidate resume
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workPreferences/{workPreferencesUniqID}
- Get all the work preferences of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateProfileImports/{ProfileId}/child/workPreferences
- Get all the work preferences of the candidate resume in a collection
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateResumeParsers/{ProfileId}/child/workPreferences
Recruiting CE Candidate Site Preferences
The recruitingCECandidateSitePreferences resource includes the details of candidate site preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a candidate site preference
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}
- Get all candidate site preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences
- Submit all candidate site preferences
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences
Recruiting CE Candidate Site Preferences/Preferred Site TC in the Site Preferences of the Recruiting Candidate
The siteTCPreferences resource is a child of recruitingCECandidateSitePreferences. It includes the details of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a candidate site TCP preference
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}
- Get all candidate site TCP preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences
- Submit all details of candidate site TCP preferences
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences
Recruiting CE Candidate Site Preferences/Preferred Site TC in the Site Preferences of the Recruiting Candidate/Preferred Job Families
The preferredJobFamilies resource is a child of siteTCPreferences. It includes the details of preferred job families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a preferred job families of candidate site TCP preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFamilies/{JobFamilyId}
- Get all preferred job families of candidate site TCP preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFamilies
- Submit all preferred job families of candidate site TCP preferences
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFamilies
Recruiting CE Candidate Site Preferences/Preferred Site TC in the Site Preferences of the Recruiting Candidate/Preferred Job Functions
The preferredJobFunctions resource is the child of the siteTCPreferences resource. It provides the details of preferred job functions of a candidate from the Talent Community Pool preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create all preferred job functions of a candidate from the Talent Community Pool preferences.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFunctions
- Get a preferred job function of a candidate from the Talent Community Pool preferences.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFunctions/{JobFunctionCode}
- Get all preferred job functions of a candidate from the Talent Community Pool preferences.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredJobFunctions
Recruiting CE Candidate Site Preferences/Preferred Site TC in the Site Preferences of the Recruiting Candidate/Preferred Locations
The preferredLocations resource is a child of preferredjobFamilies. It includes the details of preferred locations families of candidate site TCP preferences. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a preferred locations of candidate site TCP preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredLocations/{GeographyId}
- Get all preferred locations of candidate site TCP preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredLocations
- Submit all preferred locations of candidate site TCP preferences
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSitePreferences/{CandidateNumber}/child/siteTCPreferences/{SiteNumber}/child/preferredLocations
Recruiting CE Candidate Work Preferences
The recruitingCECandidateWorkPreferences resource includes the details of the work preferences of the candidates. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete details of a candidate work preference
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}
- Get the details of a candidate work preference
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}
- Get the details of all the candidate work preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences
- Patch details of a candidate work preference
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}
- Post the details of all the candidate work preferences
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences
Recruiting CE Candidate Work Preferences/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}/enclosure/Comments
Recruiting CE Dictionaries
The recruitingCEDictionaries resource includes the lookup items relevant to the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a recruiting CE dictionary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEDictionaries/{recruitingCEDictionariesUniqID}
- Get all recruiting CE dictionaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEDictionaries
Recruiting CE Interview Schedules
The recruitingCEInterviewScheduleDetails resource includes the details of the interview schedules. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all interview schedules
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails
- Get an interview schedule
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}
Recruiting CE Interview Schedules/Large Object (LOB) Attributes - PostScheduleDetails
- Delete a PostScheduleDetails
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PostScheduleDetails
- Get a PostScheduleDetails
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PostScheduleDetails
- Replace a PostScheduleDetails
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PostScheduleDetails
Recruiting CE Interview Schedules/Large Object (LOB) Attributes - PreScheduleDetails
- Delete a PreScheduleDetails
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PreScheduleDetails
- Get a PreScheduleDetails
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PreScheduleDetails
- Replace a PreScheduleDetails
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/enclosure/PreScheduleDetails
Recruiting CE Interview Schedules/Recruiting CE Interviews
The Interviews resource is a child of recruitingCEInterviewScheduleDetails. It includes the details of the interviews attended by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all interviews attended by the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews
- Get an interview attended by the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}
Recruiting CE Interview Schedules/Recruiting CE Interviews/Large Object (LOB) Attributes - CandidateNotes
- Delete a CandidateNotes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/CandidateNotes
- Get a CandidateNotes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/CandidateNotes
- Replace a CandidateNotes
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/CandidateNotes
Recruiting CE Interview Schedules/Recruiting CE Interviews/Large Object (LOB) Attributes - LocationDetails
- Delete a LocationDetails
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/LocationDetails
- Get a LocationDetails
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/LocationDetails
- Replace a LocationDetails
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/LocationDetails
Recruiting CE Interview Schedules/Recruiting CE Interviews/Large Object (LOB) Attributes - PostScheduleDetails
- Delete a PostScheduleDetails
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/PostScheduleDetails
- Get a PostScheduleDetails
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/PostScheduleDetails
- Replace a PostScheduleDetails
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/Interviews/{InterviewId}/enclosure/PostScheduleDetails
Recruiting CE Interview Schedules/Schedule Interview Participants
The ScheduleParticipantsProgrammatic resource is the child of the recruitingCEInterviewScheduleDetails resource and provides the details about the interview participants for an interview schedule. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of all interview schedule participants
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/ScheduleParticipantsProgrammatic
- Get details of an interview schedule participant
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewScheduleDetails/{ScheduleId}/child/ScheduleParticipantsProgrammatic/{ScheduleId2}
Recruiting CE Interviews
The Interviews resource is a child of recruitingCEInterviewScheduleDetails. It includes the details of the interviews attended by the candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all interviews attended by the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails
- Get an interview attended by the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}
Recruiting CE Interviews/Large Object (LOB) Attributes - CandidateNotes
- Delete a CandidateNotes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/CandidateNotes
- Get a CandidateNotes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/CandidateNotes
- Replace a CandidateNotes
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/CandidateNotes
Recruiting CE Interviews/Large Object (LOB) Attributes - LocationDetails
- Delete a LocationDetails
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/LocationDetails
- Get a LocationDetails
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/LocationDetails
- Replace a LocationDetails
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/LocationDetails
Recruiting CE Interviews/Large Object (LOB) Attributes - PostScheduleDetails
- Delete a PostScheduleDetails
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/PostScheduleDetails
- Get a PostScheduleDetails
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/PostScheduleDetails
- Replace a PostScheduleDetails
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/enclosure/PostScheduleDetails
Recruiting CE Interviews/Schedule Interview Participants
The ScheduleInterviewParticipants resource is a child of recruitingCEInterviewDetails. It includes all interview schedules for participants. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all interview schedules for participants
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/child/ScheduleInterviewParticipants
- Get the interview schedule for a participant
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEInterviewDetails/{InterviewId}/child/ScheduleInterviewParticipants/{ScheduleInterviewParticipantsUniqID}
Recruiting CE Job Referral Clicks
The recruitingCEReferralHits resource gives all details of the requisitions clicks. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of a requisitions click
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEReferralHits/{RequisitionNumber}
- Get details of all requisitions clicks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEReferralHits
- Submit all details of requisitions clicks
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEReferralHits
Recruiting CE Job Referrals
The recruitingCEReferrals resource includes all the details for recruitingCEReferrals. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a candidate referral
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEReferrals/{ReferralId}
- Get all candidate referrals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEReferrals
- Submit all details of candidate referrals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEReferrals
Recruiting CE Job Referrals/Attachments in Referrals
The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all attachments for candidate referral
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEReferrals/{ReferralId}/child/attachments
- Get an attachment for candidate referral
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEReferrals/{ReferralId}/child/attachments/{DocumentId}
Recruiting CE 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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}
- Get all job requisition details in preview mode
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews
Recruiting CE 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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/requisitionFlexFields/{requisitionFlexFieldsUniqID}
- Get all requisition flexfields in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/requisitionFlexFields
Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - ExternalDescription
- Get an ExternalDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/ExternalDescription
Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - ExternalQualifications
- Get an ExternalQualifications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/ExternalQualifications
Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - ExternalResponsibilities
- Get an ExternalResponsibilities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/ExternalResponsibilities
Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - InternalQualifications
- Get an InternalQualifications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/InternalQualifications
Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - InternalResponsibilities
- Get an InternalResponsibilities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/InternalResponsibilities
Recruiting CE Job Requisition Details/Large Object (LOB) Attributes - ShortDescription
- Get a ShortDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/enclosure/ShortDescription
Recruiting CE 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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/media/{mediaUniqID}
- Get all media in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/media
Recruiting CE Job Requisition Details/Other Work Locations
The otherWorkLocations resource is a child of 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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/otherWorkLocations
- Get an other work location in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/otherWorkLocations/{otherWorkLocationsUniqID}
Recruiting CE Job Requisition Details/Secondary Locations
The secondaryLocations resource is a child of 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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/secondaryLocations/{RequisitionLocationId}
- Get all secondary locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/secondaryLocations
Recruiting CE Job Requisition Details/Skills
The skills resource is a child of the recruitingCEJobRequisitionDetailsPreviews resource and provides the list of skills required for the job requisition. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a skill in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/skills/{skillsUniqID}
- Get all skills in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/skills
Recruiting CE 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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/workLocation/{workLocationUniqID}
- Get all work locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionDetailsPreviews/{RequisitionId}/child/workLocation
Recruiting CE Job Requisitions
The recruitingCEJobRequisitions resource includes the list of the available requisitions. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}
- Get a job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionsCoordinates/{SearchId}
- Get a job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}
- Get all job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions
- Get all job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionsCoordinates
- Get all job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions
- Provide location coordinates
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/action/getRequisitionsLocationCoordinates
- Provide location coordinates
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionsCoordinates/action/getRequisitionsLocationCoordinates
- Provide location coordinates
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/action/getRequisitionsLocationCoordinates
- Provides requisition and location details for the given Requisitions IDs
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/action/getRequisitionDetailsForMap
- Provides requisition and location details for the given Requisitions IDs
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionsCoordinates/action/getRequisitionDetailsForMap
- Provides requisition and location details for the given Requisitions IDs
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/action/getRequisitionDetailsForMap
Recruiting CE Job Requisitions/Categories Facet
The categoriesFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the categories facets. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a categories facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/categoriesFacet/{Id}
- Get a categories facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/categoriesFacet/{Id}
- Get all categories facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/categoriesFacet
- Get all categories facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/categoriesFacet
Recruiting CE Job Requisitions/Flexfields Facet
The flexFieldsFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the flexfields facets which are based on the custom flexfields configured by the users. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a flexfields facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/flexFieldsFacet/{Name}
- Get all flexfields facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/flexFieldsFacet
Recruiting CE Job Requisitions/Flexfields Facet/Flexfield Facet Values
The values resource is a child of recruitingCEJobRequisitions. It includes the details of the flexfields facets values. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a flexfields facet values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/flexFieldsFacet/{Name}/child/values/{valuesUniqID}
- Get all flexfields facets values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/flexFieldsFacet/{Name}/child/values
Recruiting CE Job Requisitions/Locations Facet
The locationsFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the locationsFacet. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a location facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/locationsFacet/{Id}
- Get a location facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/locationsFacet/{Id}
- Get all location facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/locationsFacet
- Get all location facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/locationsFacet
Recruiting CE Job Requisitions/Organizations Facet
The organizationsFacet resource is a child of the recruitingCEJobRequisitions and provides details about of the organizations facets. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all organization facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/organizationsFacet
- Get an organization facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/organizationsFacet/{Id}
Recruiting CE Job Requisitions/Posting Dates Facet
The postingDatesFacet resource is a child of recruitingCEJobRequisitions. It includes the details of the posting dates facet. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a posting date facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/postingDatesFacet/{Id}
- Get a posting date facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/postingDatesFacet/{Id}
- Get all posting date facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/postingDatesFacet
- Get all posting date facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/postingDatesFacet
Recruiting CE Job Requisitions/Requisition List
The requisitionList resource is a child of the recruitingCEJobRequisitions. It includes the details of the requisition lists. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a requisition list
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}
- Get a requisition list
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}
- Get all requisition lists
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList
- Get all requisition lists
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList
Recruiting CE Job Requisitions/Requisition List/Descriptive Flexfields
The requisitionFlexFields resource is a child of recruitingCERequisitionTemplateDetailsPreviews. It includes the details of the requisition flexfields. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a requisition descriptive flexfield
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/requisitionFlexFields/{requisitionFlexFieldsUniqID}
- Get all requisition descriptive flexfields
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/requisitionFlexFields
Recruiting CE Job Requisitions/Requisition List/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/otherWorkLocations
- Get all other work locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/otherWorkLocations
- Get an other work location in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/otherWorkLocations/{otherWorkLocationsUniqID}
- Get an other work location in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/otherWorkLocations/{otherWorkLocationsUniqID}
Recruiting CE Job Requisitions/Requisition List/Primary Location Coordinates
The primaryLocationCoordinates resource is a child of recruitingCEJobRequisitionDetails. It includes details of primary location coordinates. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a primary location coordinates for the requisition details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/primaryLocationCoordinates/{primaryLocationCoordinatesUniqID}
- Get all primary location coordinates for the requisition details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/primaryLocationCoordinates
Recruiting CE Job Requisitions/Requisition List/Secondary Locations
The secondaryLocations resource is a child of 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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/secondaryLocations/{RequisitionLocationId}
- Get a secondary location in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/secondaryLocations/{RequisitionLocationId}
- Get all secondary locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/secondaryLocations
- Get all secondary locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/secondaryLocations
Recruiting CE Job Requisitions/Requisition List/Work Locations
The workLocation resource is a child of 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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/workLocation/{workLocationUniqID}
- Get a work location in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/workLocation/{workLocationUniqID}
- Get all work locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/workLocation
- Get all work locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/requisitionList/{Id}/child/workLocation
Recruiting CE Job Requisitions/Requisition Locations Coordinates
The requisitionLocationsCoordinates resource is a child of the recruitingCEJobRequisitions resource and provides details about the coordinates of the requisition's locations. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a requisition locations coordinates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionLocationsCoordinates/{requisitionLocationsCoordinatesUniqID}
- Get a requisition locations coordinates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionsCoordinates/{SearchId}/child/requisitionLocationsCoordinates/{requisitionLocationsCoordinatesUniqID}
- Get all requisitions locations coordinates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionLocationsCoordinates
- Get all requisitions locations coordinates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionsCoordinates/{SearchId}/child/requisitionLocationsCoordinates
Recruiting CE Job Requisitions/Requisition Locations Coordinates/Location Coordinates
The locationsCoordinates resource is a child of the recruitingCEJobRequisitions resource and provides details about locations coordinates. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a location coordinates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionLocationsCoordinates/{requisitionLocationsCoordinatesUniqID}/child/locationCoordinates/{locationCoordinatesUniqID}
- Get a location coordinates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionsCoordinates/{SearchId}/child/requisitionLocationsCoordinates/{requisitionLocationsCoordinatesUniqID}/child/locationCoordinates/{locationCoordinatesUniqID}
- Get all locations coordinates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/requisitionLocationsCoordinates/{requisitionLocationsCoordinatesUniqID}/child/locationCoordinates
- Get all locations coordinates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitionsCoordinates/{SearchId}/child/requisitionLocationsCoordinates/{requisitionLocationsCoordinatesUniqID}/child/locationCoordinates
Recruiting CE Job Requisitions/Titles Facet
The titlesFacet resource is a child of the recruitingCEJobRequisitions resource. It includes the details of the titles facet. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a titles facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/titlesFacet/{Id}
- Get a titles facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/titlesFacet/{Id}
- Get all titles facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/titlesFacet
- Get all titles facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/titlesFacet
Recruiting CE Job Requisitions/Work Locations Facet
The workLocationsFacet resource is a child of the recruitingCEJobRequisitions resource. It includes the details of the all the work locations facet. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a work location facet
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
- Delete a work location facet
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
- Get a work location facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
- Get a work location facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
- Get all work location facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workLocationsFacet
- Get all work location facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/workLocationsFacet
- Submit all work location facets
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workLocationsFacet
- Submit all work location facets
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/workLocationsFacet
- Update a work location facet
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
- Update a work location facet
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobRequisitions/{SearchId}/child/workLocationsFacet/{Id}
Recruiting CE Job Requisitions/Workplace Type Facet
The workplaceTypesFacet resource is a child of the recruitingCEJobRequisitions resource. It includes the details of the workplace type facet. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a workplace type facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workplaceTypesFacet/{Id}
- Get all workplace type facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobRequisitions/{SearchId}/child/workplaceTypesFacet
Recruiting CE Languages
The recruitingCECandidateLanguageItems resource includes the details of the candidate language items. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete the language items
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}
- Get a language item for the candidate.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}
- Get all the language items for the candidate.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems
- Patch the language items
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}
- Submit all the language items.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems
Recruiting CE Languages/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateLanguageItems/{LanguageId}/enclosure/Comments
Recruiting CE Name Styles
The recruitingCENameStyles resource includes the details of the CE name styles used in recruiting. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a recruiting CE name style
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCENameStyles/{recruitingCENameStylesUniqID}
- Get all recruiting CE name style
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCENameStyles
Recruiting CE Offer Details
The offerDetails resource gets all the details about a job offer.
- Create assessment requests for a job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessments
- Get all details of job offers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails
- Get details of a job offer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}
- Get the details of all recruiting candidate assessments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessments
- Get the details of the recruiting candidate assessment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessments/{RequisitionNumber}
Recruiting CE Offer Details/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{attachmentsUniqID}
Recruiting CE Offer Details/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Recruiting CE Offer Details/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Recruiting CE Offer Details/Candidate Reasons to Decline the Job Offer
The offerDeclineReasons resource is a child of the recruitingCEOfferDetails resource. It provides the reasons that the candidate can provide while declining the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a reason that candidates can provide while declining the job offer.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/offerDeclineReasons/{ReasonId}
- Get all the reasons that candidates can provide while declining the job offer.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/offerDeclineReasons
Recruiting CE Offer Details/Job Offer Assignment
The assignment resource is a child of the recruitingCEOfferDetails resource. It describes the type of job assignment. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all the job assignment types
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/assignment
- Get the type of job assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/assignment/{assignmentUniqID}
Recruiting CE Offer Details/Job Offer Letter
The offerLetter resource is a child of the recruitingCEOfferDetails resource. It includes the details of the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a job offer letter
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/offerLetter/{OfferId2}
- Get all the job offer letters
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/offerLetter
Recruiting CE Offer Details/Media Links in the Job Offer
The mediaLink resource is a child of the recruitingCEOfferDetails resource. It gets the URL for the media link. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all media link URLs
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/mediaLinks
- Get the media link URL
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferDetails/{OfferId}/child/mediaLinks/{mediaLinksUniqID}
Recruiting CE Offer Responses
The recruitingCEOfferResponses resource includes all the details of the responses received in response to the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all offer responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferResponses
- Get an offer response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferResponses/{AccessCode}
- Submit all offer responses
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEOfferResponses
Recruiting CE Profile Import Attachments
The recruitingCEProfileImportAttachments resource includes the details for the profile import attachments. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a profile import attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEProfileImportAttachments/{AttachedDocumentId}
- Get all profile import attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEProfileImportAttachments
- Submit all profile import attachments
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEProfileImportAttachments
Recruiting CE Profile Import Configurations
The recruitingCEProfileImportConfigs resource gives all details for the profile import configuration. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of a profile import configuration
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEProfileImportConfigs/{Provider}
- Get details of all the profile import configuration
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEProfileImportConfigs
Recruiting CE Prospects
The recruitingCEProspects resource includes all the details about the recruitingCEProspects. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a prospect
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEProspects
- Get a prospect
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEProspects/{recruitingCEProspectsUniqID}
- Get all recruitingCEProspects
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEProspects
Recruiting CE Questions
The recruitingCEQuestions resource includes the details of the questions faced by a candidate while applying for a job. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEQuestions/{recruitingCEQuestionsUniqID}
- Get details of a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEQuestions/{recruitingICEQuestionsUniqID}
- Get details of all questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEQuestions
- Get details of all questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEQuestions
Recruiting CE Questions/Answers to the Questions
The answers resource is a child of the recruitingJobSiteApplicationQuestions resource and provides details about the answers provided by the candidate to the prescreening questions being asked when they apply for a job. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get details about all the answers to the questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEQuestions/{recruitingCEQuestionsUniqID}/child/answers
- Get details about all the answers to the questions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEQuestions/{recruitingICEQuestionsUniqID}/child/answers
- Get details about the answer to a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEQuestions/{recruitingCEQuestionsUniqID}/child/answers/{LookupCode}
- Get details about the answer to a question
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEQuestions/{recruitingICEQuestionsUniqID}/child/answers/{LookupCode}
Recruiting CE Regulatory Configurations
The recruitingCESecuredRegulatoryConfigs resource includes the details of the secured regulatory configurations. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a regulatory configuration
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs/{RequisitionNumber}
- Delete a regulatory configuration
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteRegulatoryConfigs/{RequisitionNumber}
- Get a secured regulatory configuration
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs/{RequisitionNumber}
- Get a secured regulatory configuration
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecuredRegulatoryConfigs/{RequisitionNumber}
- Get a secured regulatory configuration
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteRegulatoryConfigs/{RequisitionNumber}
- Get all secured regulatory configurations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs
- Get all secured regulatory configurations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecuredRegulatoryConfigs
- Get all secured regulatory configurations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteRegulatoryConfigs
- Submit all regulatory configurations
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs
- Submit all regulatory configurations
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteRegulatoryConfigs
- Update a regulatory configuration
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryConfigs/{RequisitionNumber}
- Update a regulatory configuration
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteRegulatoryConfigs/{RequisitionNumber}
Recruiting CE Sites
The recruitingCESites resource includes the details of the job recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a site
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}
- Get a site
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}
- Get all recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites
- Submit all recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites
- Update a site
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}
Recruiting CE Sites/Cookie Consent
The cookieConsent resource is a child of recruitingCESites. It includes the details of the accepted cookies. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a cookie consent in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}
- Get all cookie consent in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent
- Submit all cookie consent in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent
- Update a cookie consent in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}
Recruiting CE Sites/Cookie Consent/Header Link Translations
The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all translations of cookie consent in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations
- Get translations of cookie consent in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}
- Patch translations of cookie consent in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}
Recruiting CE Sites/Cookie Consent/Header Link Translations/Large Object (LOB) Attributes - AnalyticalCategoryMessage
- Delete an AnalyticalCategoryMessage
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/AnalyticalCategoryMessage
- Get an AnalyticalCategoryMessage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/AnalyticalCategoryMessage
- Replace an AnalyticalCategoryMessage
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/AnalyticalCategoryMessage
Recruiting CE Sites/Cookie Consent/Header Link Translations/Large Object (LOB) Attributes - CustomCategoryDescription
- Delete a CustomCategoryDescription
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/CustomCategoryDescription
- Get a CustomCategoryDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/CustomCategoryDescription
- Replace a CustomCategoryDescription
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/CustomCategoryDescription
Recruiting CE Sites/Cookie Consent/Header Link Translations/Large Object (LOB) Attributes - FunctionalCategoryMessage
- Delete a FunctionalCategoryMessage
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/FunctionalCategoryMessage
- Get a FunctionalCategoryMessage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/FunctionalCategoryMessage
- Replace a FunctionalCategoryMessage
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/FunctionalCategoryMessage
Recruiting CE Sites/Cookie Consent/Header Link Translations/Large Object (LOB) Attributes - PolicyMessage
- Delete a PolicyMessage
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/PolicyMessage
- Get a PolicyMessage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/PolicyMessage
- Replace a PolicyMessage
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/PolicyMessage
Recruiting CE Sites/Cookie Consent/Header Link Translations/Large Object (LOB) Attributes - StrictCategoryMessage
- Delete a StrictCategoryMessage
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/StrictCategoryMessage
- Get a StrictCategoryMessage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/StrictCategoryMessage
- Replace a StrictCategoryMessage
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/child/translations/{Language}/enclosure/StrictCategoryMessage
Recruiting CE Sites/Cookie Consent/Large Object (LOB) Attributes - AnalyticalCategoryMessage
- Delete an AnalyticalCategoryMessage
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/AnalyticalCategoryMessage
- Get an AnalyticalCategoryMessage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/AnalyticalCategoryMessage
- Replace an AnalyticalCategoryMessage
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/AnalyticalCategoryMessage
Recruiting CE Sites/Cookie Consent/Large Object (LOB) Attributes - CustomCategoryDescription
- Delete a CustomCategoryDescription
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/CustomCategoryDescription
- Get a CustomCategoryDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/CustomCategoryDescription
- Replace a CustomCategoryDescription
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/CustomCategoryDescription
Recruiting CE Sites/Cookie Consent/Large Object (LOB) Attributes - FunctionalCategoryMessage
- Delete a FunctionalCategoryMessage
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/FunctionalCategoryMessage
- Get a FunctionalCategoryMessage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/FunctionalCategoryMessage
- Replace a FunctionalCategoryMessage
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/FunctionalCategoryMessage
Recruiting CE Sites/Cookie Consent/Large Object (LOB) Attributes - PolicyMessage
- Delete a PolicyMessage
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/PolicyMessage
- Get a PolicyMessage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/PolicyMessage
- Replace a PolicyMessage
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/PolicyMessage
Recruiting CE Sites/Cookie Consent/Large Object (LOB) Attributes - StrictCategoryMessage
- Delete a StrictCategoryMessage
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/StrictCategoryMessage
- Get a StrictCategoryMessage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/StrictCategoryMessage
- Replace a StrictCategoryMessage
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent/{CookieId}/enclosure/StrictCategoryMessage
Recruiting CE Sites/Filters
The filters resource is a child of recruitingCESites. It includes all the filters of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete filters in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters/{DimensionKey}
- Get a filter in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters/{DimensionKey}
- Get all filters in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters
- Submit all filters in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters
- Update a filter in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/filters/{DimensionKey}
Recruiting CE Sites/Foot Links
The footerLinks resource is a child of recruitingCESites. It includes footer links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete footer links in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}
- Get a footer links in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}
- Get all footer links in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks
- Patch footer links in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}
- Submit all footer links in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks
Recruiting CE Sites/Foot Links/Header Link Translations
The translations resource is a child of headerLinks. It includes translations of the header links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a header translation in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/translations/{Language}
- Get a header translation in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/translations/{Language}
- Get all header translations in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/translations
- Submit all header translations in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/translations
- Update a header translation in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/translations/{Language}
Recruiting CE Sites/Foot Links/Sublinks
The child links resource is a child of headerLinks. It includes all the child links of each header link of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a child link used in the recruiting site
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}
- Get a child link used in the recruiting site
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}
- Get all child links used in the recruiting sites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks
- Submit all child links used in the recruiting site
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks
- Update a child link used in the recruiting site
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}
Recruiting CE Sites/Foot Links/Sublinks/Header Link Translations
The translations resource is a child of headerLinks. It includes translations of the header links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a header translation in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations/{Language}
- Get a header translation in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations/{Language}
- Get all header translations in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations
- Submit all header translations in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations
- Update a header translation in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/footerLinks/{LinkNumber}/child/sublinks/{LinkNumber2}/child/translations/{Language}
Recruiting CE Sites/Header Link Translations
The translations resource is a child of recruitingCESites. It includes the translations of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create all translations in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/translations
- Get a translation in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/translations/{Language10}
- Get all translations in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/translations
- Update a translation in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/translations/{Language10}
Recruiting CE Sites/Header Links
The headerLinks resource is a child of recruitingCESites. It includes all the header links of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a header links in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}
- Get a header link in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}
- Get all header links in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks
- Submit all header links in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks
- Update a header links in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}
Recruiting CE Sites/Header Links/Header Link Translations
The translations resource is a child of headerLinks. It includes translations of the header links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a header translation in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/child/translations/{Language}
- Get a header translation in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/child/translations/{Language}
- Get all header translations in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/translations
- Submit all header translations in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/translations
- Update a header translation in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/child/translations/{Language}
Recruiting CE Sites/Header Links/Sublinks
The child links resource is a child of headerLinks. It includes all the child links of each header link of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a child link used in the recruiting site
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber4}
- Get a child link used in the recruiting site
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber4}
- Get all child links used in the recruiting sites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks
- Submit all child links used in the recruiting site
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks
- Update a child link used in the recruiting site
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber4}
Recruiting CE Sites/Header Links/Sublinks/Header Link Translations
The translations resource is a child of headerLinks. It includes translations of the header links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a header translation in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/child/sublinks/{LinkNumber4}/child/translations/{Language}
- Get a header translation in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/child/sublinks/{LinkNumber4}/child/translations/{Language}
- Get all header translations in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber4}/child/translations
- Submit all header translations in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber4}/child/translations
- Update a header translation in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber3}/child/sublinks/{LinkNumber4}/child/translations/{Language}
Recruiting CE Sites/Job Category Links
The jobCategoryLinks resource is a child of recruitingCESites. It includes all the category specific links of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create all job category links in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/jobCategoryLinks
- Delete a job category link in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/jobCategoryLinks/{LinkNumber}
- Get a job category link in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/jobCategoryLinks/{LinkNumber}
- Get all job category links in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/jobCategoryLinks
- Update a job category link in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/jobCategoryLinks/{LinkNumber}
Recruiting CE Sites/Job Category Links/Header Link Translations
The translations resource is a child of jobCategoryLinks. It includes translations of the job category links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a job category translation in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/jobCategoryLinks/{LinkNumber5}/child/translations/{Language}
- Get a job category translation in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/jobCategoryLinks/{LinkNumber5}/child/translations/{Language}
- Get all job category translations in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/jobCategoryLinks/{LinkNumber}/child/translations
- Submit all job category translations in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/jobCategoryLinks/{LinkNumber}/child/translations
- Update a job category translation in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/jobCategoryLinks/{LinkNumber5}/child/translations/{Language}
Recruiting CE Sites/Languages
The languages resource is a child of recruitingCESites. It includes the details of languages in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a languages in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/languages/{SiteLanguage}
- Get a language in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/languages/{SiteLanguage}
- Get all languages in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/languages
- Submit all languages in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/languages
- Update a languages in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/languages/{SiteLanguage}
Recruiting CE Sites/Pages
The pages resource is a child of recruitingCESites. It includes the details of the pages in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a page in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}
- Get a page in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}
- Get all pages in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages
- Submit all pages in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages
- Update a page in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}
Recruiting CE Sites/Pages/Header Link Translations
The translations resource is a child of pages. It includes the page translations of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a page translation in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/translations/{Language}
- Get all page translations in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/translations
- Update a page translation in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/translations/{Language}
Recruiting CE Sites/Pages/Section Parameters
The sectionParams resource is a child of sections. It includes the parameters of the sections in each page of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a section parameter in the sections of pages
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/pageParams/{SettingId}
- Get a section parameter in the sections of pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/pageParams/{SettingId}
- Get all section parameters in the sections of pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/pageParams
- Submit all section parameters in the sections of pages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/pageParams
- Update a section parameter in the sections of pages
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/pageParams/{SettingId}
Recruiting CE Sites/Pages/Sections
The sections resource is a child of pages. It includes the details of the sections in each page in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a section in the pages of recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}
- Get a section in the pages of recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}
- Get all sections in the pages of recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections
- Submit all sections in the pages of recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections
- Update a section in the pages of recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}
Recruiting CE Sites/Pages/Sections/Components
The components resource is a child of sections. It includes the details of components in the sections of each page in the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a component in the sections of pages
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}
- Get a component in the sections of pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}
- Get all components in the sections of pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components
- Submit all components in the sections of pages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components
- Update a component in the sections of pages
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}
Recruiting CE Sites/Pages/Sections/Components/Component Translations
The componentTranslations resource is a child of the recruitingCESites resource. It includes the details of the translations of the components in the sections of each page in the career site. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a component translation in the sections of pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations/{Language}
- Get all component translations in the sections of pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations
- Update a component translation in the sections of pages
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations/{Language}
Recruiting CE Sites/Pages/Sections/Components/Component Translations/Large Object (LOB) Attributes - ComponentContent
- Delete a ComponentContent
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations/{Language}/enclosure/ComponentContent
- Get a ComponentContent
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations/{Language}/enclosure/ComponentContent
- Replace a ComponentContent
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentTranslations/{Language}/enclosure/ComponentContent
Recruiting CE Sites/Pages/Sections/Components/Large Object (LOB) Attributes - ComponentContent
- Delete a ComponentContent
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/enclosure/ComponentContent
- Get a ComponentContent
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/enclosure/ComponentContent
- Replace a ComponentContent
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/enclosure/ComponentContent
Recruiting CE Sites/Pages/Sections/Components/Section Parameters
The sectionParams resource is a child of sections. It includes the parameters of the sections in each page of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a section parameter in the sections of pages
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentParams/{SettingId}
- Get a section parameter in the sections of pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentParams/{SettingId}
- Get all section parameters in the sections of pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentParams
- Submit all section parameters in the sections of pages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentParams
- Update a section parameter in the sections of pages
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/components/{ElementNumber3}/child/componentParams/{SettingId}
Recruiting CE Sites/Pages/Sections/Section Parameters
The sectionParams resource is a child of sections. It includes the parameters of the sections in each page of recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a section parameter in the sections of pages
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/sectionParams/{SettingId}
- Get a section parameter in the sections of pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/sectionParams/{SettingId}
- Get all section parameters in the sections of pages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/sectionParams
- Submit all section parameters in the sections of pages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/sectionParams
- Update a section parameter in the sections of pages
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/pages/{ElementNumber}/child/sections/{ElementNumber2}/child/sectionParams/{SettingId}
Recruiting CE Sites/Settings
The settings resource is a child of recruitingCESites. It includes all the settings of the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a setting in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/settings/{SettingKey}
- Get a setting in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/settings/{SettingKey}
- Get all settings in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/settings
- Submit all settings in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/settings
- Update a setting in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/settings/{SettingKey}
Recruiting CE Sites/Site Custom Fonts
The customFonts resource is a child of recruitingCESites. It includes the details for the custom fonts. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a custom font
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}
- Get a custom font in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}
- Get all custom fonts in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts
- Submit all custom fonts in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts
- Update a custom font in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}
Recruiting CE Sites/Site Custom Fonts/Site Custom Font Settings
The customFontsSettings resource is a child of customFonts. It includes the details for the custom font settings. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a custom font setting
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}
- Get a custom font setting in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}
- Get all custom font settings in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings
- Submit all custom font settings in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings
- Update a custom font setting in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}
Recruiting CE Sites/Site Custom Fonts/Site Custom Font Settings/Site Custom Font Setting Files
The customFontsFiles resource is a child of customFontsSettings. It includes the details for the custom font files. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a custom font setting file
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}/child/customFontsFiles/{FileNumber}
- Get a custom font setting file in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}/child/customFontsFiles/{FileNumber}
- Get all custom font setting files in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}/child/customFontsFiles
- Submit all custom font setting files in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}/child/customFontsFiles
- Update a custom font setting file in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customFonts/{FontNumber}/child/customFontsSettings/{SettingNumber}/child/customFontsFiles/{FileNumber}
Recruiting CE Sites/Site Custom Icons
The customIcons resource is a child of recruitingCESites. It includes the details for the custom icons. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a custom icon
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}
- Get a custom icon in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}
- Get all custom icons in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons
- Submit all custom icons in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons
- Update a custom icon in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}
Recruiting CE Sites/Site Custom Icons/Large Object (LOB) Attributes - Image
- Delete an Image
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}/enclosure/Image
- Get an Image
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}/enclosure/Image
- Replace an Image
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}/enclosure/Image
Recruiting CE Sites/Site Custom Icons/Site Custom Icon Settings
The customIconSettings resource is a child of customIcons. It includes the details for the custom icon settings. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete a custom icon setting
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}/child/customIconSettings/{SettingId}
- Get a custom icon setting in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}/child/customIconSettings/{SettingId}
- Get all custom icon settings in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}/child/customIconSettings
- Submit all custom icon settings in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}/child/customIconSettings
- Update a custom icon setting in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/customIcons/{IconId}/child/customIconSettings/{SettingId}
Recruiting CE Sites/Site Favicon
The siteFavicon is the child resource of recruitingCESites. It includes three sizes of favorite icons for each site. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create all favorite icons in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon
- Delete a favorite icon in recruitingCESites
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}
- Get a favorite icon in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}
- Get all favorite icons in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon
- Update a favorite icon in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}
Recruiting CE Sites/Site Favicon/Large Object (LOB) Attributes - FaviconImg
- Delete a FaviconImg
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}/enclosure/FaviconImg
- Get a FaviconImg
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}/enclosure/FaviconImg
- Replace a FaviconImg
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/siteFavicon/{FaviconId}/enclosure/FaviconImg
Recruiting CE Sites/Talent Community Sign Up
The resource gives talent community sign up in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all talent community sign up in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp
- Get talent community sign up in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}
- Patch talent community sign up in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}
- Post all talent community sign up in recruitingCESites
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp
Recruiting CE Sites/Talent Community Sign Up/Header Link Translations
The translations resource is a child of talentCommunitySignUp. It includes the talent community sign up related translations in the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a talent community enrollment translation in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}/child/translations/{Language}
- Get all talent community enrollment translations in recruitingCESites
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}/child/translations
- Update a talent community enrollment translation in recruitingCESites
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}/child/translations/{Language}
Recruiting CE Skill Items
The recruitingCECandidateSkillItems resource includes the details of the candidate skill items. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete the skill items
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}
- Get a skill item for the candidate.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}
- Get all the skill items for the candidate.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems
- Submit all the skill items.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems
- Update the skill items
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}
Recruiting CE Skill Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Comments
Recruiting CE Skill Items/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateSkillItems/{SkillId}/enclosure/Description
Recruiting CE Source Tracking
The recruitingCESourceTrackings resource gives the details of recruitingCESourceTrackings. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of a tracking
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESourceTrackings/{SourceTrackingId}
- Get details of all recruitingCESourceTrackings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESourceTrackings
- Submit all details of recruitingCESourceTrackings
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESourceTrackings
Recruiting CE Tax Credits
The recruitingCETaxCredits resource includes details about the partner candidate URL for tax credits. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create all tax credit requests for a job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCETaxCredits
- Get all tax credits candidate URLs
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCETaxCredits
- Get tax credits partner candidate URL for a job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCETaxCredits/{RequisitionNumber}
Recruiting CE Themes
The themes resource is a child of recruitingCETemplates. It includes the themes in recruitingCETemplates. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of a theme in recruitingCETemplates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}
- Get details of all themes in recruitingCETemplates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes
- Submit details of all recruitingCEThemes
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes
- Update details of recruitingCEThemes
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}
Recruiting CE Themes/Brand Translations of Themes
The translations resource is a child of recruitingCETemplates. It includes the translations in recruitingCETemplates. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete recruitingCEThemes brand translation
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}
- Get details of a translation in recruitingCETemplates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}
- Get details of all translations in recruitingCETemplates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations
- Submit details of all translations in recruitingCETemplates
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations
- Update details of a translation in recruitingCETemplates
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}
Recruiting CE Themes/Brand Translations of Themes/Large Object (LOB) Attributes - WelcomeText
- Delete a WelcomeText
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}/enclosure/WelcomeText
- Get a WelcomeText
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}/enclosure/WelcomeText
- Replace a WelcomeText
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/translations/{Language}/enclosure/WelcomeText
Recruiting CE Themes/Brands in Themes
The brands resource is a child of recruitingCEThemes. It includes the details of brands in the career site themes. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete details of a brand in recruitingCEThemes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}
- Get details of a brand in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}
- Get details of all brands in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands
- Submit details of all brands in recruitingCEThemes
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands
- Update details of a brand in recruitingCEThemes
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}
Recruiting CE Themes/Brands in Themes/Brand Translations of Themes
The translation resource is a child of Brand. It includes the details of the brand translations of the recruiting CE themes. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create details of recruitingCEThemes Brand Translations
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations
- Get all details of recruitingCEThemes Brand Translation
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations
- Get details of recruitingCEThemes Brand Translation
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}
- Update details of recruitingCEThemes Brands translations
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}
Recruiting CE Themes/Brands in Themes/Brand Translations of Themes/Large Object (LOB) Attributes - CustomCSS
- Delete a CustomCSS
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/CustomCSS
- Get a CustomCSS
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/CustomCSS
- Replace a CustomCSS
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/CustomCSS
Recruiting CE Themes/Brands in Themes/Brand Translations of Themes/Large Object (LOB) Attributes - DefaultCSS
- Delete a DefaultCSS
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/DefaultCSS
- Get a DefaultCSS
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/DefaultCSS
- Replace a DefaultCSS
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/DefaultCSS
Recruiting CE Themes/Brands in Themes/Brand Translations of Themes/Large Object (LOB) Attributes - NavigationFooterHTML
- Delete a NavigationFooterHTML
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationFooterHTML
- Get a NavigationFooterHTML
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationFooterHTML
- Replace a NavigationFooterHTML
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationFooterHTML
Recruiting CE Themes/Brands in Themes/Brand Translations of Themes/Large Object (LOB) Attributes - NavigationHeaderHTML
- Delete a NavigationHeaderHTML
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationHeaderHTML
- Get a NavigationHeaderHTML
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationHeaderHTML
- Replace a NavigationHeaderHTML
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/child/translations/{Language}/enclosure/NavigationHeaderHTML
Recruiting CE Themes/Brands in Themes/Large Object (LOB) Attributes - CustomCSSCLOB
- Delete a CustomCSSCLOB
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomCSSCLOB
- Get a CustomCSSCLOB
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomCSSCLOB
- Replace a CustomCSSCLOB
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomCSSCLOB
Recruiting CE Themes/Brands in Themes/Large Object (LOB) Attributes - CustomJSCLOB
- Delete a CustomJSCLOB
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomJSCLOB
- Get a CustomJSCLOB
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomJSCLOB
- Replace a CustomJSCLOB
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/CustomJSCLOB
Recruiting CE Themes/Brands in Themes/Large Object (LOB) Attributes - DefaultCSSCLOB
- Delete a DefaultCSSCLOB
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/DefaultCSSCLOB
- Get a DefaultCSSCLOB
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/DefaultCSSCLOB
- Replace a DefaultCSSCLOB
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/DefaultCSSCLOB
Recruiting CE Themes/Brands in Themes/Large Object (LOB) Attributes - DefaultJs
- Delete a DefaultJs
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/DefaultJs
- Get a DefaultJs
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/DefaultJs
- Replace a DefaultJs
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/DefaultJs
Recruiting CE Themes/Brands in Themes/Large Object (LOB) Attributes - FooterHTMLCLOB
- Delete a FooterHTMLCLOB
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/FooterHTMLCLOB
- Get a FooterHTMLCLOB
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/FooterHTMLCLOB
- Replace a FooterHTMLCLOB
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/FooterHTMLCLOB
Recruiting CE Themes/Brands in Themes/Large Object (LOB) Attributes - HeaderHTMLCLOB
- Delete a HeaderHTMLCLOB
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/HeaderHTMLCLOB
- Get a HeaderHTMLCLOB
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/HeaderHTMLCLOB
- Replace a HeaderHTMLCLOB
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/brands/{BrandingId}/enclosure/HeaderHTMLCLOB
Recruiting CE Themes/Custom Headers of Themes
The customHeaders resource is a child of recruitingCEThemes. It includes the headers configuration. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create details of recruitingCEThemes Headers
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders
- Delete details of recruitingCEThemes Headers
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}
- Get all details of recruitingCEThemes Headers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders
- Get details of Headers in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}
- Update details of recruitingCEThemes Headers
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}
Recruiting CE Themes/Custom Headers of Themes/Brand Translations of Themes
The translations resource is a child of customHeaders. It includes the headers translations. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all details of recruitingCEThemes Header Translations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/translations
- Get details of recruitingCEThemes Header Translations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/translations/{Language}
- Update details of recruitingCEThemes Header Translations
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/translations/{Language}
Recruiting CE Themes/Custom Headers of Themes/Settings of the Header
The settings resource is a child of customHeaders. It includes the headers settings configuration. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create details of recruitingCEThemes Header Settings
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings
- Delete details of recruitingCEThemes Header Settings
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings/{SettingKey}
- Get all details of recruitingCEThemes Header Settings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings
- Get details of recruitingCEThemes Header Settings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings/{SettingKey}
- Update details of recruitingCEThemes Header Settings
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/customHeaders/{HeaderId}/child/settings/{SettingKey}
Recruiting CE Themes/Footer Links in Themes
The footerLinks resource is a child of recruitingCEThemes. It includes the details of footer links in recruitingCEThemes. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete details of a footer link in recruitingCEThemes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}
- Get details of all footer links in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks
- Get details of footer links in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}
- Submit details of all footer links in recruitingCEThemes
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks
- Update details of a footer link in recruitingCEThemes
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}
Recruiting CE Themes/Footer Links in Themes/Brand Translations of Themes
The translations resource is a child of brands. It includes the details of translations in recruitingCEThemes. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of a translation in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}/child/translations/{Language}
- Get details of all translations in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}/child/translations
- Submit details of all translations in recruitingCEThemes
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}/child/translations
- Update details of a translation in recruitingCEThemes
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/footerLinks/{LinkNumber}/child/translations/{Language}
Recruiting CE Themes/Header Links in Themes
The headerLinks resource is a child of recruitingCEThemes. It includes the details of the header links in recruitingCEThemes. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete details of a header link in recruitingCEThemes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}
- Get details of a header link in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}
- Get details of all header links in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks
- Submit details of all header links in recruitingCEThemes
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks
- Update details of a header link in recruitingCEThemes
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}
Recruiting CE Themes/Header Links in Themes/Brand Translations of Themes
The translations resource is a child of brands. It includes the details of translations in recruitingCEThemes. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of a translation in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber2}/child/translations/{Language}
- Get details of all translations in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}/child/translations
- Submit details of all translations in recruitingCEThemes
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber}/child/translations
- Update details of a translation in recruitingCEThemes
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/headerLinks/{LinkNumber2}/child/translations/{Language}
Recruiting CE Themes/Large Object (LOB) Attributes - GeneratedCustomCSS
- Delete a GeneratedCustomCSS
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/GeneratedCustomCSS
- Get a GeneratedCustomCSS
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/GeneratedCustomCSS
- Replace a GeneratedCustomCSS
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/GeneratedCustomCSS
Recruiting CE Themes/Large Object (LOB) Attributes - WelcomeText
- Delete a WelcomeText
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/WelcomeText
- Get a WelcomeText
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/WelcomeText
- Replace a WelcomeText
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/enclosure/WelcomeText
Recruiting CE Themes/Styles in Themes
The styles resource is a child of recruitingCEThemes. It includes the details of styles in recruitingCEThemes. Note that the service endpoints in this resource category are only for Oracle internal use.
- Delete details of styles in recruitingCEThemes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/styles/{stylesUniqID}
- Get details of a style in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/styles/{stylesUniqID}
- Get details of all styles in recruitingCEThemes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/styles
- Submit details of all styles in recruitingCEThemes
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/styles
- Update details of styles in recruitingCEThemes
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEThemes/{ThemeNumber}/child/styles/{stylesUniqID}
Recruiting CE User Tracking
The recruitingCEUserTrackings resource includes the details of the user's navigation paths. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a user tracking information
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEUserSettings/{UserId}
- Get a user tracking information
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEUserTrackings/{UserId}
- Get all users tracking information
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEUserSettings
- Get all users tracking information
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEUserTrackings
- Submit all the users tracking information
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEUserSettings
- Submit all the users tracking information
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEUserTrackings
- Update the user tracking information
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEUserSettings/{UserId}
- Update the user tracking information
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEUserTrackings/{UserId}
Recruiting CE Verification
The recruitingCEVerificationTokens resource includes the details of verification tokens. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of a verification token
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEVerificationTokens/{TokenId}
- Get details of all verification token
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEVerificationTokens
- Submit all details of verification token
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEVerificationTokens
Recruiting Campaign Details
The recruitingCampaignDetails resource includes all the details of the campaign.
- Get a campaign detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}
- Get all recruiting campaign details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails
Recruiting Campaign Details/Campaign Assets
The campaignAssets resource is a child of recruitingCampaignDetails. It includes all the assets of the campaign.
- Get a campaign asset
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}
- Get all campaign assets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets
- Get all campaign assets
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}
Recruiting Campaign Details/Campaign Assets/Campaign Asset Channels
The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.
- Get a campaign asset channel
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/CampaignAssetChannels/{ChannelId}
- Get all CampaignAssetChannels
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/CampaignAssetChannels
Recruiting Campaign Details/Campaign Assets/Campaign Asset Segments
The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.
- Get a campaign asset segment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/campaignAssetSegments/{campaignAssetSegmentsUniqID}
- Get all campaign asset segments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}/child/campaignAssetSegments
Recruiting Campaign Details/Campaign Business Object Association
The campaignBOAssociations resource is a child of recruitingCampaignDetails. It includes all the business object associations of the campaign.
- Get a business object association
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignBOAssociations/{campaignBOAssociationsUniqID}
- Get all business object associations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignBOAssociations
Recruiting Campaign Details/Campaign Business Object Association/Campaign Business Object Associated Items
The campaignBOAssociatedItems resource is a child of campaignBOAssociations. It includes all the associated business object items.
- Get all associated business object items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignBOAssociations/{campaignBOAssociationsUniqID}/child/campaignBOAssociatedItems
- Get an associated business object item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignBOAssociations/{campaignBOAssociationsUniqID}/child/campaignBOAssociatedItems/{campaignBOAssociatedItemsUniqID}
Recruiting Campaign Details/Campaign Goal Responses
The campaignGoalResponses resource is a child of recruitingCampaignDetails. It includes all the goal responses of the campaign.
- Get a campaign goal response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignGoalResponses/{campaignGoalResponsesUniqID}
- Get all campaign goal response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignGoalResponses
Recruiting Campaign Details/Large Object (LOB) Attributes - CampaignDescription
- Get a CampaignDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/enclosure/CampaignDescription
Recruiting Campaign Email Designs
The messageDesigns resource includes the details to get different Message Designs.
- Delete a message design
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns
- Delete a message design metadata
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}
- Get a message design
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}
- Get a message design metadata
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}
- Update a message design
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns
Recruiting Campaign Email Designs/Message Design Metadata
The messageDesignMetadata resource is a child of messageDesigns. It includes the details to get the details of different Message Design data.
- Create all message design metadata
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata
- Delete a message design type
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}
- Get a message design type
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}
- Get all message design metadata
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata
- Update a message design metadata
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}
Recruiting Campaign Email Designs/Message Design Metadata/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/Description
Recruiting Campaign Email Designs/Message Design Metadata/Large Object (LOB) Attributes - DesignMetadata
- Delete a DesignMetadata
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/DesignMetadata
- Get a DesignMetadata
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/DesignMetadata
- Replace a DesignMetadata
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/DesignMetadata
Recruiting Campaign Email Designs/Message Design Metadata/Large Object (LOB) Attributes - HTMLTemplate
- Delete a HTMLTemplate
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/HTMLTemplate
- Get a HTMLTemplate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/HTMLTemplate
- Replace a HTMLTemplate
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignMetadata/{messageDesignMetadataUniqID}/enclosure/HTMLTemplate
Recruiting Campaign Email Designs/Message DesignTypes
The resource messageDesignTypes is to get different types of message designs.
- Create all message design type
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes
- Create all message designs
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes/{messageDesignTypesUniqID}
- Get all message design type
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes
- Get all message designs
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes/{messageDesignTypesUniqID}
- Update a message design type
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesigns/{MessageDesignId}/child/messageDesignTypes/{messageDesignTypesUniqID}
Recruiting Candidate Assessment Results
The recruitingCandidateAssessmentResults resource includes the details of the recruiting candidate assessment results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}
- Submit all details of recruiting candidate assessment results
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults
Recruiting Candidate Assessment Results/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/enclosure/Comments
Recruiting Candidate Assessment Results/Packages of Recruiting Candidate Assessment Results
The packages resource is a child of recruitingCandidateAssessmentResults. It includes the details of the packages of recruiting candidate assessment results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}
- Submit all packages of recruiting candidate assessment results
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages
Recruiting Candidate Assessment Results/Packages of Recruiting Candidate Assessment Results/Additional Candidate Assessment Results
The additionalResultsAttributes resource is a child of recruitingCandidateAssessmentResults. It includes additional details of the packages of recruiting candidate assessment results. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/child/AdditionalResultsAttributes
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/child/AdditionalResultsAttributes/{AttributeName}
- Submit additional results for assessment package
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/child/AdditionalResultsAttributes
Recruiting Candidate Assessment Results/Packages of Recruiting Candidate Assessment Results/Large Object (LOB) Attributes - StatusDescription
- Delete a StatusDescription
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/enclosure/StatusDescription
- Get a StatusDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/enclosure/StatusDescription
- Replace a StatusDescription
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateAssessmentResults/{recruitingCandidateAssessmentResultsUniqID}/child/packages/{packagesUniqID}/enclosure/StatusDescription
Recruiting Candidate Details
The bcCandidateDetails resource provides details about background check in the candidate job application. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners and has been deprecated.
- Get details about a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateDetails/{bcCandidateDetailsUniqID}
- Get details about all candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/bcCandidateDetails
Recruiting Candidate Duplicate Checks
The recruitingCandidateDuplicates resource provides all the details related to a candidate duplicate check.
- Create a candidate duplicate check
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateDuplicates
- Get a candidate duplicate check
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateDuplicates/{DupChkLogId}
- Get all candidate duplicate checks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateDuplicates
Recruiting Candidate Experience Extra Information Metadata
The recruitingCECandidateExtraInformationMetadata resource provides all the metadata details of the extra information. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all extensible flexfield metadata details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateExtraInformationMetadata
- Get an extensible flexfield metadata detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateExtraInformationMetadata/{ContextName}
Recruiting Candidate Experience Extra Information Metadata/Candidate Extra Information Metadata with Attributes
The CandEffAttrMetadata resource is a child of the recruitingCECandidateExtraInformationMetadata resource. It provides metadata details of the extra information attributes. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all extensible flexfield attribute metadata details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateExtraInformationMetadata/{ContextName}/child/attributeList
- Get an extensible flexfield attribute metadata detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateExtraInformationMetadata/{ContextName}/child/attributeList/{AttributeId}
Recruiting Candidate Experience Prefill Questions
The recruitingCEPrefillQuestionResponses resource provides the responses to the questions asked to candidates when they apply for a job. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a response to a question in a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEPrefillQuestionResponses/{QuestionId}
- Get a response to a question in a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEPrefillQuestionResponses/{QuestionId}
- Get all responses to questions in a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEPrefillQuestionResponses
- Get all responses to questions in a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEPrefillQuestionResponses
Recruiting Candidate Extra Information Details
The recruitingCandidateExtraInformation resource includes all the extra information details of a candidate. It's based on EFF resource. All the actions on the EFF attributes are done based on this service.
- Get all extra information of a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation
- Get extra information of a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{recruitingCandidateExtraInformationUniqID}
Recruiting Candidate Extra Information Details/jPersonExtraInformation
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{recruitingCandidateExtraInformationUniqID}/child/jPersonExtraInformation
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{recruitingCandidateExtraInformationUniqID}/child/jPersonExtraInformation/{jPersonExtraInformationUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{recruitingCandidateExtraInformationUniqID}/child/jPersonExtraInformation/{jPersonExtraInformationUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{recruitingCandidateExtraInformationUniqID}/child/jPersonExtraInformation
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidateExtraInformation/{recruitingCandidateExtraInformationUniqID}/child/jPersonExtraInformation/{jPersonExtraInformationUniqID}
Recruiting Candidate Job Application Drafts
The recruitingCEJobApplicationDrafts resource includes the draft job applications of a candidate. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create an application draft
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts
- Delete an application draft
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}
- Get a draft
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}
- Get all application drafts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts
- Update an application draft
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}
Recruiting Candidate Job Application Drafts/Attachments of the Job Application Drafts
The attachments resource is the child of the recruitingCEJobApplicationDrafts resource and includes all the attachments of a draft job application. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create attachments for the application drafts
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachments/{Id}
- Get all attachments for application drafts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachments
- Get an attachment for application drafts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachments/{Id}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/child/attachments/{Id}
Recruiting Candidate Job Application Drafts/Large Object (LOB) Attributes - Content
- Delete a Content
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/enclosure/Content
- Get a Content
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/enclosure/Content
- Replace a Content
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplicationDrafts/{APPDraftId}/enclosure/Content
Recruiting Candidate PII Data
The recruitingCandidatePIIData resource includes all the details of the candidate national identifiers and date of birth. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create details of all candidate PII data
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidatePIIData
- Get the details of a candidate PII data
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidatePIIData/{recruitingCandidatePIIDataUniqID}
- Get the details of all the candidate PII data
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidatePIIData
Recruiting Candidate Print Metadata
The recruitingUICandidatePrintMetadata resource provides details about the candidate that can be included in a PDF.
- Get a candidate's metadata for the Save as PDF action.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidatePrintMetadata/{recruitingUICandidatePrintMetadataUniqID}
- Get all candidates' metadata for the Save as PDF action.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidatePrintMetadata
Recruiting Candidate Print Metadata/Recruiting Candidate Print Sections
The CandidatePrintSectionsUI resource is a child of the recruitingUICandidatePrintMetadata resource. It provides details about the candidate section names that can be included in a PDF.
- Get a candidate section name for the Save as PDF action.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidatePrintMetadata/{recruitingUICandidatePrintMetadataUniqID}/child/CandidatePrintSectionsUI/{SectionId}
- Get all candidate section names for the Save as PDF action.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidatePrintMetadata/{recruitingUICandidatePrintMetadataUniqID}/child/CandidatePrintSectionsUI
Recruiting Candidate Print Metadata/Recruiting Candidate Print Sections/Recruiting Candidate Print Section Items
The CandidatePrintSectionItemsUI resource is a child of the recruitingUICandidatePrintMetadata resource. It provides details about the items in the candidate sections that can be included in a PDF.
- Get a candidate section item name for the Save as PDF action.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidatePrintMetadata/{recruitingUICandidatePrintMetadataUniqID}/child/CandidatePrintSectionsUI/{SectionId}/child/CandidatePrintSectionItemsUI/{SectionItemId}
- Get all candidate section item names for the Save as PDF action.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICandidatePrintMetadata/{recruitingUICandidatePrintMetadataUniqID}/child/CandidatePrintSectionsUI/{SectionId}/child/CandidatePrintSectionItemsUI
Recruiting Candidate Responses to Regulatory Questions
The recruitingCERegulatoryResponses resource includes the regulatory related response details. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a regulatory response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryResponses/{recruitingCERegulatoryResponsesUniqID}
- Get all regulatory responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryResponses
- Submit regulatory
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERegulatoryResponses
Recruiting Candidates
The recruitingCandidates resource provides details about the candidate.
- Create a candidate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates
- Delete a candidate
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}
- Get a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}
- Get all candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates
- Update a candidate
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}
Recruiting Candidates/Address of the Recruiting Candidates
The candidateAddress resource is a child of the recruitingCandidates resource and provides details about the address of the candidate.
- Create a candidate address
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress
- Delete a candidate address
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress/{AddressId}
- Get a candidates address
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress/{AddressId}
- Get all candidate addresses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress
- Update a candidate address
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidateAddress/{AddressId}
Recruiting Candidates/Attachments of the Candidates
The attachments resource is a child of the recruitingCandidates resource and provides details about attachments provided by the candidate.
- Create an attachment for a candidate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments
- Delete an attachment of a candidate
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}
- Get all attachments of a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments
- Get an attachment of a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}
- Update an attachment of a candidate
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}
Recruiting Candidates/Attachments of the Candidates/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Recruiting Candidates/Attachments of the Candidates/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Recruiting Candidates/Education of the Recruiting Candidates
The education resource is a child of the recruitingCandidates resource and provides details about the education of the candidate.
- Create a candidate education
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education
- Delete a candidate education
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}
- Get a candidate education
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}
- Get all candidate educations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education
- Update a candidate education
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}
Recruiting Candidates/Education of the Recruiting Candidates/Large Object (LOB) Attributes - ActivitySummary
- Delete an ActivitySummary
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/ActivitySummary
- Get an ActivitySummary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/ActivitySummary
- Replace an ActivitySummary
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/ActivitySummary
Recruiting Candidates/Education of the Recruiting Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Comments
Recruiting Candidates/Education of the Recruiting Candidates/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Description
Recruiting Candidates/Education of the Recruiting Candidates/Large Object (LOB) Attributes - Reimbursements
- Delete a Reimbursements
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Reimbursements
- Get a Reimbursements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Reimbursements
- Replace a Reimbursements
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}/enclosure/Reimbursements
Recruiting Candidates/Experience of the Recruiting Candidates
The experience resource is a child of the recruitingCandidates resource and provides details about the work experience of the candidate.
- Create a candidate work experience
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience
- Delete a candidate work experience
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}
- Get a candidate work experience
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}
- Get all candidate work experiences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience
- Update a candidate work experience
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}
Recruiting Candidates/Experience of the Recruiting Candidates/Large Object (LOB) Attributes - Achievements
- Delete an Achievements
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Achievements
- Get an Achievements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Achievements
- Replace an Achievements
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Achievements
Recruiting Candidates/Experience of the Recruiting Candidates/Large Object (LOB) Attributes - AdditionalInformation
- Delete an AdditionalInformation
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation
- Get an AdditionalInformation
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation
- Replace an AdditionalInformation
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation
Recruiting Candidates/Experience of the Recruiting Candidates/Large Object (LOB) Attributes - LeavingReason
- Delete a LeavingReason
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason
- Get a LeavingReason
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason
- Replace a LeavingReason
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason
Recruiting Candidates/Experience of the Recruiting Candidates/Large Object (LOB) Attributes - Responsibilities
- Delete a Responsibilities
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities
- Get a Responsibilities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities
- Replace a Responsibilities
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities
Recruiting Candidates/Languages of the Recruiting Candidates
The languages resource is a child of the recruitingCandidates resource and provides details about the languages of the candidate.
- Create a candidate language
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages
- Delete a candidate language
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}
- Get a candidate language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}
- Get all candidate languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages
- Update a candidate language
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}
Recruiting Candidates/Languages of the Recruiting Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/languages/{LanguageId}/enclosure/Comments
Recruiting Candidates/Licenses and Certifications of the Recruiting Candidates
The licensesAndCertificates resource is a child of the recruitingCandidates resource and provides details about the licenses and certificates of the candidate.
- Create a candidate licenses and certifications
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates
- Delete a candidate licenses and certifications
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}
- Get a candidate license and certification
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}
- Get all candidate licenses and certifications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates
- Update a candidate licenses and certifications
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}
Recruiting Candidates/Licenses and Certifications of the Recruiting Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments
Recruiting Candidates/Licenses and Certifications of the Recruiting Candidates/Large Object (LOB) Attributes - Restrictions
- Delete a Restrictions
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions
- Get a Restrictions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions
- Replace a Restrictions
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions
Recruiting Candidates/Phone of the Recruiting Candidates
The candidatePhones resource is a child of the recruitingCandidates resource and provides details about the phone numbers of the candidate.
- Create a candidate phone number
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones
- Delete a candidate phone number
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones/{PhoneId}
- Get a candidate phone number
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones/{PhoneId}
- Get all candidate phone numbers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones
- Update a candidate phone number
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/candidatePhones/{PhoneId}
Recruiting Candidates/Skills of the Recruiting Candidates
The skills resource is a child of the recruitingCandidates resource and provides details about the skills of the candidate.
- Create a candidate skill
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills
- Delete a candidate skill
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}
- Get a candidate skill
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}
- Get all candidate skills
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills
- Update a candidate skill
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}
Recruiting Candidates/Skills of the Recruiting Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Comments
Recruiting Candidates/Skills of the Recruiting Candidates/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Description
Recruiting Candidates/Work Preferences of the Recruiting Candidates
The workPreferences resource is a child of the recruitingCandidates resource and provides details about the work preferences of the candidate.
- Create a candidate work preference
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences
- Delete a candidate work preference
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
- Get a candidate work preference
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
- Get all candidate work preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences
- Update a candidate work preference
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
Recruiting Candidates/Work Preferences of the Recruiting Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
Recruiting Career Site Contact Information Metadata
The recruitingCEContactInformationMetadata resource provides all the details of the candidate contact information to be entered on the recruiting career site. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all candidate contact information to be entered on the recruiting career site
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEContactInformationMetadata
- Get candidate contact information to be entered on the recruiting career site
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEContactInformationMetadata/{recruitingCEContactInformationMetadataUniqID}
Recruiting Chatbot Settings
The recruitingChatbotSettings resource includes the settings identifier for the chatbot.
- Get a setting
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingChatbotSettings/{BotSettingId}
- Get all settings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingChatbotSettings
Recruiting Chatbot Settings/Recruiting Chatbot Setting Values
The recruitingChatbotSettingValues resource is the child of the recruitingChatbotSettings resource and provides the settings value for the chatbot.
- Get a setting value
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingChatbotSettings/{BotSettingId}/child/recruitingChatbotSettingValues/{BotSettingValueId}
- Get all setting values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingChatbotSettings/{BotSettingId}/child/recruitingChatbotSettingValues
Recruiting Create or Update Job Offers
The recruitingUICreateOrUpdateJobOffers resource is used to create and update job offers.
- Create data for a job offer
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers
- Delete data of a job offer
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}
- Download a job offer letter
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/action/downloadFileActionListener
- Get data about a job offer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}
- Get data about all job offers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers
- Populate parameters when editing a job offer
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/action/populateEditOfferHCMParams
- Update data of a job offer
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}
Recruiting Create or Update Job Offers/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/candidateOfferLetter
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/internalAttachments
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/offerAttachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/candidateOfferLetter
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/internalAttachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/offerAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}
Recruiting Create or Update Job Offers/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
Recruiting Create or Update Job Offers/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}/enclosure/FileWebImage
Recruiting Create or Update Job Offers/Descriptive Flexible Field for the Job Offer
The operations from the Recruiting Create or Update Job Offers/Descriptive Flexible Field for the Job Offer category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/additionalInformationDetails
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/additionalInformationDetails/{additionalInformationDetailsUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/additionalInformationDetails
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/additionalInformationDetails/{additionalInformationDetailsUniqID}
Recruiting Create or Update Job Offers/Large Object (LOB) Attributes - EsignatureInstructions
- Delete an EsignatureInstructions
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/enclosure/EsignatureInstructions
- Get an EsignatureInstructions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/enclosure/EsignatureInstructions
- Replace an EsignatureInstructions
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/enclosure/EsignatureInstructions
Recruiting Create or Update Job Offers/Recruiting Job Offer Collaborators
The collaborators resource provides details about the collaborators of a job offer.
- Create data for a collaborator
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/collaborators
- Delete data for a collaborator
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/collaborators/{TeamMemberId}
- Get data for a collaborator
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/collaborators/{TeamMemberId}
- Get data for all collaborators
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/collaborators
- Update data for a collaborator
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/collaborators/{TeamMemberId}
Recruiting E-signatures
The recruitingUIEsignatures resource provides details about the e-signature instructions. Note that the service endpoints in the resource category are only for Oracle internal use.
- Create details for the e-signature
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIEsignatures
- Get details for all e-signature instructions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIEsignatures
- Get details for the e-signature instruction
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIEsignatures/{EsignatureId}
Recruiting Event Check In Processes
The recruitingCEEventRegistrationCheckIns validates the candidate's registration to an event and updates the candidate's status.
- Creates an update to the candidate's registration and marks the candidate's attendance.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrationCheckIns
Recruiting Event Details
The recruitingCEEventDetails resource provide details about a recruiting event. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details for a recruiting event.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventDetails/{recruitingCEEventDetailsUniqID}
- Get details for all recruiting events.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventDetails
Recruiting Event Details Preview
The recruitingCEEventDetailsPreview resource shows details in the preview screen about a recruiting event. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details for a recruiting event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventDetailsPreviews/{recruitingCEEventDetailsPreviewsUniqID}
- Get details for all recruiting events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventDetailsPreviews
Recruiting Event Registrations
The recruitingCEEventRegistrations resource provides details about registrations for a recruiting event. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a registration for a recruiting event.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations
- Get a registration for a recruiting event. Currently not supported.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations/{recruitingCEEventRegistrationsUniqID}
- Get all registrations for a recruiting event.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations
Recruiting Event Registrations/Candidate Responses to Questions
The RecruitingEventQuestionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.
- Create responses for a questionnaire
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations/{recruitingCEEventRegistrationsUniqID}/child/RecruitingEventQuestionnaireResponses
- Get the details of a response for a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations/{recruitingCEEventRegistrationsUniqID}/child/RecruitingEventQuestionnaireResponses/{QuestionnaireId}
- Get the details of all responses for a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventRegistrations/{recruitingCEEventRegistrationsUniqID}/child/RecruitingEventQuestionnaireResponses
Recruiting Events
The recruitingCEEvents resource provides details about recruiting events. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a recruiting event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}
- Get all recruiting events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents
Recruiting Events Auto Suggestions
The recruitingCEEventSearchAutoSuggestions resource shows auto suggestions on search of recruiting events. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get details of all auto suggestions through events search
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventSearchAutoSuggestions
- Get details of an auto suggestion through events search
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEventSearchAutoSuggestions/{Name}
Recruiting Events/Event Category Facets
The eventCategoriesFacet resource is a child of recruitingCEEvents. It includes the details of the event categories facets. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all event category facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventCategoriesFacet
- Get an event category facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventCategoriesFacet/{Id}
Recruiting Events/Event Format Facets
The eventFormatsFacet resource is a child of recruitingCEEvents. It includes the details of the event formats facets. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all event format facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventFormatsFacet
- Get an event format facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventFormatsFacet/{Id}
Recruiting Events/Location Facets
The locationsFacet resource is a child of recruitingCEEvents. It includes the details of the event location facets. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get all event location facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/locationsFacet
- Get an event location facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/locationsFacet/{Id}
Recruiting Events/Recruiting Events List of Values
The eventList is the child of the recruitingCEEvents resource and provides the list of values for recruiting events. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a recruiting event list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventList/{eventListUniqID}
- Get all recruiting event lists of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/eventList
Recruiting Events/Start Date Range Facets
The startDatesFacet resource is a child of recruitingCEEvents. It includes the details of the event start date facets. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a start date facet
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/startDatesFacet/{Id}
- Get all start date facets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEEvents/{SearchId}/child/startDatesFacet
Recruiting Hierarchy Locations
The recruitingHierarchyLocations resource includes the details of the hierarchy for locations.
- Get a hierarchy locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingHierarchyLocations/{GeographyId}
- Get all hierarchy locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingHierarchyLocations
Recruiting ICE Job Application Draft
The recruitingICEJobApplicationDrafts provides details of a recruiting job application draft.
- Delete a job application draft
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}
- Get a job application draft
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}
- Get all job application drafts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts
- Post all job application drafts
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts
- Update a job application draft
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}
Recruiting ICE Job Application Draft/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/attachments/{attachmentsUniqID}
Recruiting ICE Job Application Draft/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Recruiting ICE Job Application Draft/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Recruiting ICE Job Application Draft/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses
- Delete a questionnaire response
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}
Recruiting ICE Job Application Draft/Questionnaire Responses/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionnaireAttachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionnaireAttachments/{questionnaireAttachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionnaireAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionnaireAttachments/{questionnaireAttachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionnaireAttachments/{questionnaireAttachmentsUniqID}
Recruiting ICE Job Application Draft/Questionnaire Responses/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionnaireAttachments/{questionnaireAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionnaireAttachments/{questionnaireAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionnaireAttachments/{questionnaireAttachmentsUniqID}/enclosure/FileContents
Recruiting ICE Job Application Draft/Questionnaire Responses/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionnaireAttachments/{questionnaireAttachmentsUniqID}/enclosure/FileWebImage
Recruiting ICE Job Application Draft/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Delete a question response
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Recruiting ICE Job Application Draft/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Recruiting ICE Job Application Draft/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Recruiting ICE Job Application Draft/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Recruiting ICE Job Application Draft/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Recruiting ICE Job Application Draft/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Delete a question response
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}
Recruiting ICE Job Application Draft/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/enclosure/AnswerLargeObject
Recruiting ICE Job Application Draft/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{recruitingICEJobApplicationDrafts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{recruitingICEJobApplicationDrafts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{recruitingICEJobApplicationDrafts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}
Recruiting ICE Job Application Draft/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{recruitingICEJobApplicationDrafts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{recruitingICEJobApplicationDrafts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{recruitingICEJobApplicationDrafts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileContents
Recruiting ICE Job Application Draft/Questionnaire Responses/Question Responses/Question Response Attachments/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplicationDrafts/{IceDraftId}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/child/QuestionResponses/{QuestionResponseId2}/child/questionResponseAttachments/{recruitingICEJobApplicationDrafts_questionnaireResponses_questionResponses_questionResponseAttachments_QuestionResponses_questionResponseAttachments_Id}/enclosure/FileWebImage
Recruiting Interactions
The recruitingUIInteractions resource provides the details of recruiting interactions.
- Create an interaction
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions
- Create an interaction recipient
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/action/addInteraction
- Get all interactions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions
- Get an interaction
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}
Recruiting Interactions/Recruiting Interaction Recipients
The interactionRecipients resource is the child of the recruitingUIInteractions resource and provides the details of the recipients for a given recruiting interaction.
- Create an interaction recipient
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}/child/InteractionRecipients
- Get all interaction recipients
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}/child/InteractionRecipients
- Get an interaction recipient
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIInteractions/{recruitingUIInteractionsUniqID}/child/InteractionRecipients/{InteractionRecipientId}
Recruiting Internal Candidate Job Application Flows
The recruitingICEApplyFlows resource provides details about the internal candidate job application flow.
- Get all the internal candidate job application flows
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEApplyFlows
- Get an internal candidate job application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEApplyFlows/{RequisitionNumber}
Recruiting Internal Candidate Job Applications
The Recruiting ICE Job Applications resource includes the details of the internal candidate job submissions.
- Get all the internal candidate job applications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplications
- Get an internal candidate job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplications/{SubmissionId}
- Submit all internal candidate job applications
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplications
Recruiting Internal Candidate Job Applications/Candidate Responses to Questions
The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.
- Create responses for a questionnaire
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplications/{SubmissionId}/child/QuestionnaireResponses
- Get the details of a response for a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplications/{SubmissionId}/child/QuestionnaireResponses/{QuestionnaireId}
- Get the details of all responses for a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingICEJobApplications/{SubmissionId}/child/QuestionnaireResponses
Recruiting Interview Schedules
The recruitingInterviewSchedulesLOV resource includes all of the recruiting interview schedules.
- Get a recruiting interview schedule.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingInterviewSchedulesLOV/{ScheduleId}
- Get all recruiting interview schedules.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingInterviewSchedulesLOV
Recruiting Job Application Phases
The recruitingUIJobApplicationPhasesStates resource provides the ability to get the phases for job applications.
- Get details of a phase for a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplicationPhasesStates/{PhaseId}
- Get details of all phases for a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplicationPhasesStates
Recruiting Job Application Phases/Recruiting Job Application Phases and States
The recruitingUIJobApplicationPhasesStatesStates resource provides the ability to get the phases and states for job applications.
- Get details of a phase and state for a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplicationPhasesStates/{PhaseId}/child/States/{StateId}
- Get details of all phases and states for a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplicationPhasesStates/{PhaseId}/child/States
Recruiting Job Application Phases/Recruiting Job Application Phases and States/Recruiting Job Application Phases, States, and Reasons
The recruitingUIJobApplicationPhasesStatesStatesReasons resource provides the ability to get phases, states, and reasons for job applications.
- Get details of a phase, state, and reason for a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplicationPhasesStates/{PhaseId}/child/States/{StateId}/child/Reasons/{ReasonId}
- Get details of all phases, states, and reasons for a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplicationPhasesStates/{PhaseId}/child/States/{StateId}/child/Reasons
Recruiting Job Applications
The recruitingJobApplications resource includes all details about the job applications.
- Action to confirm a job application on behalf of a candidate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/action/confirm
- Action to move a job application to a specific phase and state
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/action/move
- Action to resend a notification to a candidate requesting them to confirm their job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/action/sendConfirmationRequest
- Action to withdraw a job application on behalf of the candidate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/action/withdraw
- Create a job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications
- Get a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}
- Get a job application for recruiting
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}
- Get all job applications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications
- Get all job applications for recruiting
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications
Recruiting Job Applications/Assessment Links
The assessmentLinks resource is a child of recruitingCEJobApplications. It provides the links to go to assessment partner sites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create all assessment links
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/assessmentLinks
- Get all assessment links
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/assessmentLinks
- Get an assessment link
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/assessmentLinks/{ProvisioningId}
Recruiting Job Applications/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments/{attachmentsUniqID}
Recruiting Job Applications/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Recruiting Job Applications/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Recruiting Job Applications/Background Check Links
The backgroundCheckLinks resource is a child of recruitingCEJobApplications. It provides the links to go to background check partner sites. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create all background check links
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/BackgroundCheckLinks
- Get a background check link
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/BackgroundCheckLinks/{BackgroundCheckLinksUniqID}
- Get all background check links
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/BackgroundCheckLinks
Recruiting Job Applications/Candidate Responses to Questions
The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.
- Create responses for a questionnaire
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/questionnaireResponses
- Get the details of a response for a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/questionnaireResponses/{QuestionnaireId}
- Get the details of all responses for a questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/questionnaireResponses
Recruiting Job Applications/Education Details
The education resource is a child of recruitingJobApplications. It includes the educational related details in the job application.
- Get a education information from job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}
- Get all educational information from job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education
Recruiting Job Applications/Education Details/Large Object (LOB) Attributes - ActivitySummary
- Delete an ActivitySummary
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/ActivitySummary
- Get an ActivitySummary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/ActivitySummary
- Replace an ActivitySummary
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/ActivitySummary
Recruiting Job Applications/Education Details/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Comments
Recruiting Job Applications/Education Details/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Description
Recruiting Job Applications/Education Details/Large Object (LOB) Attributes - Reimbursements
- Delete a Reimbursements
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Reimbursements
- Get a Reimbursements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Reimbursements
- Replace a Reimbursements
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/education/{EducationId}/enclosure/Reimbursements
Recruiting Job Applications/Experience Details
The experience resource is a child of recruitingJobApplications. It includes the experience related details in the job application.
- Get a job experience from job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}
- Get all job experiences from job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience
Recruiting Job Applications/Experience Details/Large Object (LOB) Attributes - Achievements
- Delete an Achievements
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Achievements
- Get an Achievements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Achievements
- Replace an Achievements
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Achievements
Recruiting Job Applications/Experience Details/Large Object (LOB) Attributes - AdditionalInformation
- Delete an AdditionalInformation
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation
- Get an AdditionalInformation
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation
- Replace an AdditionalInformation
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/AdditionalInformation
Recruiting Job Applications/Experience Details/Large Object (LOB) Attributes - LeavingReason
- Delete a LeavingReason
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason
- Get a LeavingReason
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason
- Replace a LeavingReason
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/LeavingReason
Recruiting Job Applications/Experience Details/Large Object (LOB) Attributes - Responsibilities
- Delete a Responsibilities
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities
- Get a Responsibilities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities
- Replace a Responsibilities
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experience/{PreviousEmploymentId}/enclosure/Responsibilities
Recruiting Job Applications/Language Information
The languages resource is a child of recruitingJobApplications. It includes the candidates language related details in the job application.
- Get a language from job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages/{LanguageId}
- Get all languages from job applications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages
Recruiting Job Applications/Language Information/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages/{LanguageId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages/{LanguageId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languages/{LanguageId}/enclosure/Comments
Recruiting Job Applications/Licenses and Certificates of the Candidates
The licensesAndCertificates resource is a child of recruitingJobApplications. It includes the licenses and certificate details of the candidate.
- Get a license and certificate from job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}
- Get all licenses and certificate from job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates
Recruiting Job Applications/Licenses and Certificates of the Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Comments
Recruiting Job Applications/Licenses and Certificates of the Candidates/Large Object (LOB) Attributes - Restrictions
- Delete a Restrictions
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions
- Get a Restrictions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions
- Replace a Restrictions
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/licensesAndCertificates/{CertificationId}/enclosure/Restrictions
Recruiting Job Applications/Preferred Job Locations
The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a preferred location
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/preferredLocations
- Get a preferred location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/preferredLocations/{JaPreferredLocationId}
- Get all preferred locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/preferredLocations
Recruiting Job Applications/Recruiting Candidate Responses to Regulatory Questions
The recruitingCERegulatoryResponses resource includes the regulatory related response details. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a regulatory response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/regulatoryResponses/{regulatoryResponsesUniqID}
- Get all regulatory responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/regulatoryResponses
- Submit regulatory
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/regulatoryResponses
Recruiting Job Applications/Recruiting Work Preferences
The workPreferences resource is a child of recruitingJobApplications. It includes the work preferences of the candidate.
- Get a work preference
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferences/{WorkPreferenceId}
- Get all work preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferences
Recruiting Job Applications/Recruiting Work Preferences/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
Recruiting Job Applications/Schedule Job Interviews
The ScheduleInterviews resource is a child of recruitingCEJobApplications. It includes all details about the scheduled interviews. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a scheduled interview
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/ScheduleInterviews
- Get a scheduled interview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/ScheduleInterviews/{IntrvwRequestsId}
- Get all the scheduled interviews
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/ScheduleInterviews
- Update a scheduled interview
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/ScheduleInterviews/{IntrvwRequestsId}
Recruiting Job Applications/Secondary Job Submissions
The secondaryrecruitingCEJobApplications resource includes all the secondary job applications. Note that the service endpoints in this resource category are only for Oracle internal use.
- Create a secondary job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/secondarySubmissions
- Get a secondary job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/secondarySubmissions/{SecondaryFlowId}
- Get all the secondary job applications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/secondarySubmissions
- Update a secondary job application
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/secondarySubmissions/{SecondaryFlowId}
Recruiting Job Applications/Unscheduled Job Interviews
The UnScheduleInterviewRequests resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the unscheduled interview requests.
- Create an unscheduled interview request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/UnscheduledInterviewRequests
- Get a request for an unscheduled interview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/UnscheduledInterviewRequests/{IntrvwRequestsId}
- Get all the unscheduled interview requests
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/UnscheduledInterviewRequests
- Update an unscheduled interview request
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications/{recruitingCEJobApplicationsUniqID}/child/UnscheduledInterviewRequests/{IntrvwRequestsId}
Recruiting Job Families
The recruitingJobFamilies resource includes the details to get different Recruiting Job Families.
- Get a recruiting job family
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobFamilies/{JobFamilyId}
- Get all recruiting job families
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobFamilies
Recruiting Job Offer Actions
The recruitingJobOfferActions resource provides the actions performed on recruiting job offers.
- Create a recruiting job offer action
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOfferActions
- Get a recruiting job offer action
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOfferActions/{recruitingJobOfferActionsUniqID}
- Get all recruiting job offer actions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOfferActions
Recruiting Job Offer Details
The recruitingUIJobOfferDetails resource provides details about the job offer.
- Get details about a recruiting job offer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}
- Get details about all recruiting job offers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails
Recruiting Job Offer Details/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/candidateOfferLetter
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/internalAttachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/offerAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}
Recruiting Job Offer Details/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}/enclosure/FileContents
Recruiting Job Offer Details/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/candidateOfferLetter/{candidateOfferLetterUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/internalAttachments/{candidateOfferLetterUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/offerAttachments/{candidateOfferLetterUniqID}/enclosure/FileWebImage
Recruiting Job Offer Details/Descriptive Flexible Field for the Job Offer
The operations from the Recruiting Job Offer Details/Descriptive Flexible Field for the Job Offer category.
Recruiting Job Offer Details/Recruiting Job Offer Collaborators
The collaborators resource is a child of the recruitingUIJobOfferDetails resource. It provides details about the job offer collaborators.
- Get a recruiting job offer collaborator
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/collaborators/{TeamMemberId}
- Get all recruiting job offer collaborators
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/collaborators
Recruiting Job Offer Details/Recruiting Job Offer Errors
The offerErrors resource is a child of the recruitingUIJobOfferDetails resource. It provides details about errors that occurred in the job offer.
- Get details about all errors in the job offer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/offerErrors
- Get details about an error in the job offer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/offerErrors/{ErrorId}
Recruiting Job Offer Details/Recruiting Job Offer Errors/Large Object (LOB) Attributes - ErrorMessageTokens
- Get an ErrorMessageTokens
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/offerErrors/{ErrorId}/enclosure/ErrorMessageTokens
Recruiting Job Offer Details/Recruiting Job Offer Errors/Large Object (LOB) Attributes - ErrorStack
- Get an ErrorStack
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferDetails/{OfferId}/child/offerErrors/{ErrorId}/enclosure/ErrorStack
Recruiting Job Offer Previews
The recruitingUIJobOfferPreviews resource provides details on the preview screen about a job offer.
- Create a job offer preview
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews
- Delete a job offer preview
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}
- Get a job offer preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}
- Get all job offer previews
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews
- Update a job offer preview
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}
Recruiting Job Offer Previews/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}
Recruiting Job Offer Previews/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Recruiting Job Offer Previews/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Recruiting Job Offer Previews/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/enclosure/FileContents
Recruiting Job Offer Previews/Recruiting Job Offer Media Links
The mediaLinks resource provides the media links that are available for the requisition on which the job offer is created.
- Create a media link
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/mediaLinks
- Delete a media link
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/mediaLinks/{MediaLinkId}
- Get all media links
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/mediaLinks
- Gets a media link
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/mediaLinks/{MediaLinkId}
- Update a media link
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/mediaLinks/{MediaLinkId}
Recruiting Job Offers
The recruitingJobOffers resource includes the details of the job offer extended to the candidate.
- Get a job offer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}
- Get a recruiting job offer
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffersLOV/{recruitingJobOffersLOVUniqID}
- Get all job offers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers
- Get all recruiting job offers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffersLOV
Recruiting Job Offers/Attachments
The attachments resource is used to view, create, and update attachments.
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments/{attachmentsUniqID}
Recruiting Job Offers/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Recruiting Job Offers/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Recruiting Job Offers/Collaborators
The collaborators resource includes all details about the collaborators who create and manage the job offers.
- Get a collaborator
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/collaborators/{CollaboratorId}
- Get all collaborators
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/collaborators
Recruiting Job Offers/Descriptive Flexible Field for the Job Offer
The operations from the Recruiting Job Offers/Descriptive Flexible Field for the Job Offer category.
Recruiting Job Offers/Large Object (LOB) Attributes - AdditionalTextOne
- Delete an AdditionalTextOne
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextOne
- Get an AdditionalTextOne
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextOne
- Replace an AdditionalTextOne
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextOne
Recruiting Job Offers/Large Object (LOB) Attributes - AdditionalTextTwo
- Delete an AdditionalTextTwo
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextTwo
- Get an AdditionalTextTwo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextTwo
- Replace an AdditionalTextTwo
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/AdditionalTextTwo
Recruiting Job Offers/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/Description
Recruiting Job Offers/Large Object (LOB) Attributes - EsignatureInstructions
- Delete an EsignatureInstructions
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/EsignatureInstructions
- Get an EsignatureInstructions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/EsignatureInstructions
- Replace an EsignatureInstructions
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/enclosure/EsignatureInstructions
Recruiting Job Requisition Distribution
The jobDistributionDetails resource includes all the details of the job distribution. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get the details of a job distribution
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}
- Get the details of all job distributions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails
Recruiting Job Requisition Distribution Posting Details
The jobPostingDetails resource includes all the details of the job posting. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get details of a job posting
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobPostingDetails/{RequisitionNumber}
- Get details of all job postings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobPostingDetails
- Post details of all job postings
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/jobPostingDetails
Recruiting Job Requisition Distribution Posting Details/Job Posting on the Job Boards
The jobBoards resource is a child of jobPostingDetails. It includes the details of job postings on job boards.
- Get details of a job posting on job boards
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobPostingDetails/{RequisitionNumber}/child/jobBoards/{ResultId}
- Get details of all job postings on job boards
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobPostingDetails/{RequisitionNumber}/child/jobBoards
- Post details of all job postings on job boards
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/jobPostingDetails/{RequisitionNumber}/child/jobBoards
Recruiting Job Requisition Distribution/Recruiting Requisition Additional Attributes
The requisitionAdditionalAttributes resource provides the additional attributes of the posted job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get details about all additional attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionAdditionalAttributes
- Get details about an additional attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionAdditionalAttributes/{requisitionAdditionalAttributesUniqID}
Recruiting Job Requisition Distribution/Requisition Languages
The requisitionLanguages resource is a child of jobDistributionDetails. It includes the details of the languages mentioned in the job description.
- Get the details of all the required languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages
- Get the details of the required language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}
Recruiting Job Requisition Distribution/Requisition Languages/Requisition Media
The media resource is a child of requisitionLanguages. It includes the details of the type of media used in the job distribution.
- Get the details of all the media
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/media
- Get the details of the media
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/media/{RequisitionMediaLinkId}
Recruiting Job Requisition Distribution/Requisition Languages/Secondary Locations
The secondaryLocations resource includes all the details of the secondary preferred location for the job distribution.
- Get the details of a secondary location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/secondaryLocations/{secondaryLocationsUniqID}
- Get the details of all the secondary locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/requisitionLanguages/{requisitionLanguagesUniqID}/child/secondaryLocations
Recruiting Job Requisition Distribution/Requisition Skills
The skills resource is a child of jobDistributionDetails. It includes the details of skills mentioned in the requisition.
- Get the details of a skill
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/skills/{skillsUniqID}
- Get the details of all the skills
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/jobDistributionDetails/{jobDistributionDetailsUniqID}/child/skills
Recruiting Job Requisition Template Details Preview
The recruitingCERequisitionTemplateDetailsPreviews resource includes the details about the requisition templates. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a requisition template details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}
- Get all requisition template details previews
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews
Recruiting Job Requisition Template Details Preview/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/requisitionFlexFields/{requisitionFlexFieldsUniqID}
- Get all requisition flexfields in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/requisitionFlexFields
Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - ExternalDescription
- Get an ExternalDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ExternalDescription
Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - ExternalQual
- Get an ExternalQual
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ExternalQual
Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - ExternalResp
- Get an ExternalResp
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ExternalResp
Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - InternalQual
- Get an InternalQual
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/InternalQual
Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - InternalResp
- Get an InternalResp
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/InternalResp
Recruiting Job Requisition Template Details Preview/Large Object (LOB) Attributes - ShortDescription
- Delete a ShortDescription
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ShortDescription
- Get a ShortDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ShortDescription
- Replace a ShortDescription
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/enclosure/ShortDescription
Recruiting Job Requisition Template Details Preview/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/media/{mediaUniqID}
- Get all media in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/media
Recruiting Job Requisition Template Details Preview/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/otherWorkLocations
- Get an other work location in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/otherWorkLocations/{otherWorkLocationsUniqID}
Recruiting Job Requisition Template Details Preview/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/secondaryLocations/{RequisitionLocationId}
- Get all secondary locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/secondaryLocations
Recruiting Job Requisition Template Details Preview/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: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/workLocation/{workLocationUniqID}
- Get all work locations in the requisition details preview
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCERequisitionTemplateDetailsPreviews/{RequisitionId}/child/workLocation
Recruiting Job Requisitions
The recruitingJobRequisitions resource includes the details of recruiting job requisitions.
- Delete recruiting job requisitions
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}
- Get a recruiting job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}
- Get all recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions
- Submit all recruiting job requisitions
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions
- Update recruiting job requisitions
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}
Recruiting Job Requisitions/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}
Recruiting Job Requisitions/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Recruiting Job Requisitions/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Recruiting Job Requisitions/Collaborators in Recruiting Job Requisitions
The collaborators resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions collaborators.
- Delete recruiting job requisitions collaborators
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/collaborators/{collaboratorsUniqID}
- Get a collaborator in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/collaborators/{collaboratorsUniqID}
- Get all collaborators in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/collaborators
- Submit all recruiting job requisitions collaborators
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/collaborators
Recruiting Job Requisitions/Languages in Recruiting Job Requisitions
The languages resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions languages.
- Delete recruiting job requisitions languages
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/languages/{LanguageId}
- Get a language in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/languages/{LanguageId}
- Get all languages in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/languages
- Submit all recruiting job requisitions languages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/languages
Recruiting Job Requisitions/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/Comments
Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalDescription
- Delete an ExternalDescription
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescription
- Get an ExternalDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescription
- Replace an ExternalDescription
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescription
Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalDescriptionHTML
- Delete an ExternalDescriptionHTML
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescriptionHTML
- Get an ExternalDescriptionHTML
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescriptionHTML
- Replace an ExternalDescriptionHTML
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalDescriptionHTML
Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalQual
- Delete an ExternalQual
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQual
- Get an ExternalQual
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQual
- Replace an ExternalQual
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQual
Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalQualHTML
- Delete an ExternalQualHTML
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQualHTML
- Get an ExternalQualHTML
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQualHTML
- Replace an ExternalQualHTML
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalQualHTML
Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalResp
- Delete an ExternalResp
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalResp
- Get an ExternalResp
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalResp
- Replace an ExternalResp
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalResp
Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalRespHTML
- Delete an ExternalRespHTML
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalRespHTML
- Get an ExternalRespHTML
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalRespHTML
- Replace an ExternalRespHTML
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalRespHTML
Recruiting Job Requisitions/Large Object (LOB) Attributes - ExternalShortDescription
- Delete an ExternalShortDescription
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalShortDescription
- Get an ExternalShortDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalShortDescription
- Replace an ExternalShortDescription
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/ExternalShortDescription
Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalDescription
- Delete an InternalDescription
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescription
- Get an InternalDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescription
- Replace an InternalDescription
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescription
Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalDescriptionHTML
- Delete an InternalDescriptionHTML
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescriptionHTML
- Get an InternalDescriptionHTML
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescriptionHTML
- Replace an InternalDescriptionHTML
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalDescriptionHTML
Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalQual
- Delete an InternalQual
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQual
- Get an InternalQual
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQual
- Replace an InternalQual
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQual
Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalQualHTML
- Delete an InternalQualHTML
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQualHTML
- Get an InternalQualHTML
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQualHTML
- Replace an InternalQualHTML
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalQualHTML
Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalResp
- Delete an InternalResp
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalResp
- Get an InternalResp
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalResp
- Replace an InternalResp
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalResp
Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalRespHTML
- Delete an InternalRespHTML
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalRespHTML
- Get an InternalRespHTML
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalRespHTML
- Replace an InternalRespHTML
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalRespHTML
Recruiting Job Requisitions/Large Object (LOB) Attributes - InternalShortDescription
- Delete an InternalShortDescription
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalShortDescription
- Get an InternalShortDescription
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalShortDescription
- Replace an InternalShortDescription
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/enclosure/InternalShortDescription
Recruiting Job Requisitions/Media Links in Recruiting Job Requisitions
The mediaLinks resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions media links.
- Delete recruiting job requisitions media links
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}
- Get a media link in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}
- Get all media links in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks
- Submit all recruiting job requisitions media links
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks
- Update recruiting job requisitions media links
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}
Recruiting Job Requisitions/Media Links in Recruiting Job Requisitions/Media Languages in Recruiting Job Requisitions
The mediaLanguages resource is a child of mediaLinks. It includes the details of recruiting job requisitions media languages.
- Delete recruiting job requisitions media languages
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}/child/mediaLanguages/{MediaLanguageId}
- Get a media language used in the media links
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}/child/mediaLanguages/{MediaLanguageId}
- Get all media languages used in the media links
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}/child/mediaLanguages
- Submit all recruiting job requisitions media languages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/mediaLinks/{mediaLinksUniqID}/child/mediaLanguages
Recruiting Job Requisitions/Other Locations in Recruiting Job Requisitions
The otherLocations resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions for other locations.
- Delete recruiting job requisitions other languages
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherLocations/{LocationId}
- Get all other locations in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherLocations
- Get an other location in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherLocations/{LocationId}
- Submit all recruiting job requisitions other languages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherLocations
Recruiting Job Requisitions/Other Work Locations in Recruiting Job Requisitions
The otherWorkLocations resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions in other work locations.
- Delete recruiting job requisitions other work locations
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherWorkLocations/{otherWorkLocationsUniqID}
- Get all other work locations in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherWorkLocations
- Get an other work location in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherWorkLocations/{otherWorkLocationsUniqID}
- Submit all recruiting job requisitions other work locations
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/otherWorkLocations
Recruiting Job Requisitions/Published Jobs in Recruiting Job Requisitions
The publishedJobs resource is a child of recruitingJobRequisitions. It includes the details of recruiting job requisitions published jobs.
- Get a published job in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/publishedJobs/{PublishedJobId}
- Get all published jobs in the recruiting job requisitions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/publishedJobs
Recruiting Job Requisitions/Requisition DFF in Recruiting Job Requisitions
The operations from the Recruiting Job Requisitions/Requisition DFF in Recruiting Job Requisitions category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/requisitionDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/requisitionDFF/{requisitionDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/requisitionDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/requisitionDFF/{requisitionDFFUniqID}
Recruiting Job Requisitions/Skills in Recruiting Job Requisitions
The skills resource is the child of the recruitingjobRequisitions resource and provides all the skills of the job requisition.
- Create a skill for a recruiting job requisition
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/skills
- Delete a skill for a recruiting job requisition
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/skills/{SkillId}
- Get a skill for a recruiting job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/skills/{SkillId}
- Get all skills for a recruiting job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/skills
- Update a skill for a recruiting job requisition
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobRequisitions/{recruitingJobRequisitionsUniqID}/child/skills/{SkillId}
Recruiting Job Site Candidate Extra Information Dictionary
The recruitingJobSiteCandidateExtraInformationDictionary resource provides the values defined in the dictionary. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a candidate extra information dictionary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateExtraInformationDictionary/{ResourceName}
- Get all candidate extra information dictionaries
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateExtraInformationDictionary
Recruiting Job Site Candidate Extra Information Dictionary/Recruiting Job Site Candidate Extra Information Dictionary List of Values
The listOfValues is a child of the recruitingJobSiteCandidateExtraInformationDictionary resource. It provides the list of values in the dictionary. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get all candidate extra information dictionary list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateExtraInformationDictionary/{ResourceName}/child/listOfValues
- Get the candidate extra information dictionary list of values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateExtraInformationDictionary/{ResourceName}/child/listOfValues/{ListId}
Recruiting Job Site Candidate Extra Information Metadata
The recruitingJobSiteCandidateExtraInformationMetadata resource provides metadata details about the candidate extra information. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a candidate extra information metadata
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateExtraInformationMetadata/{ContextCode}
- Get all candidate extra information metadata
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateExtraInformationMetadata
Recruiting Job Site Candidate Extra Information Metadata/Recruiting Job Site Candidate Extra Information Metadata List of Attributes
The attributeList resource is a child of the recruitingJobSiteCandidateExtraInformationMetadata resource. It provides the list of attributes for the candidate extra information metadata. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a candidate extra information metadata list of attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateExtraInformationMetadata/{ContextCode}/child/attributeList/{AttributeId}
- Get all candidate extra information metadata list of attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateExtraInformationMetadata/{ContextCode}/child/attributeList
Recruiting Job Site Candidates
The recruitingJobSiteCandidates resource provides details about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates
- Get a candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}
- Get all candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates
- Update a candidate
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}
Recruiting Job Site Candidates/Addresses of the Candidates
The addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate address
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/addresses
- Delete a candidate address
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/addresses/{AddressId}
- Get a candidate address
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/addresses/{AddressId}
- Get all candidate addresses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/addresses
- Update a candidate address
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/addresses/{AddressId}
Recruiting Job Site Candidates/Attachments of the Candidates
The attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/attachments
- Delete a candidate attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/attachments/{Id}
- Get a candidate attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/attachments/{Id}
- Get all candidate attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/attachments
- Update a candidate attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/attachments/{Id}
Recruiting Job Site Candidates/Certifications of the Candidates
The certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate certification
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications
- Delete a candidate certification
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications/{CertificationId}
- Get a candidate certification
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications/{CertificationId}
- Get all candidate certifications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications
- Update a candidate certification
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications/{CertificationId}
Recruiting Job Site Candidates/Certifications of the Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications/{CertificationId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications/{CertificationId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications/{CertificationId}/enclosure/Comments
Recruiting Job Site Candidates/Certifications of the Candidates/Large Object (LOB) Attributes - Restrictions
- Delete a Restrictions
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications/{CertificationId}/enclosure/Restrictions
- Get a Restrictions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications/{CertificationId}/enclosure/Restrictions
- Replace a Restrictions
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications/{CertificationId}/enclosure/Restrictions
Recruiting Job Site Candidates/Education of the Candidates
The educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate education
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations
- Delete a candidate education
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}
- Get all candidate educations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations
- Get candidate education
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}
- Update a candidate education
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}
Recruiting Job Site Candidates/Education of the Candidates/Large Object (LOB) Attributes - ActivitySummary
- Delete an ActivitySummary
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/ActivitySummary
- Get an ActivitySummary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/ActivitySummary
- Replace an ActivitySummary
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/ActivitySummary
Recruiting Job Site Candidates/Education of the Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/Comments
Recruiting Job Site Candidates/Education of the Candidates/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/Description
Recruiting Job Site Candidates/Education of the Candidates/Large Object (LOB) Attributes - Reimbursements
- Delete a Reimbursements
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/Reimbursements
- Get a Reimbursements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/Reimbursements
- Replace a Reimbursements
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educations/{EducationId}/enclosure/Reimbursements
Recruiting Job Site Candidates/Extra Information of the Candidates
The candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create extra information about candidates
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation
- Get all extra information about candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation
- Get extra information about candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextCode}
Recruiting Job Site Candidates/Extra Information of the Candidates/Extra Information Rows of the Candidates
The dataRows resource is a child of the recruitingJobSiteCandidates resource. It provides rows containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create extra information row about candidates
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextCode}/child/dataRows
- Get all extra information row about candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextCode}/child/dataRows
- Get extra information row about candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextCode}/child/dataRows/{DataRowId}
Recruiting Job Site Candidates/Extra Information of the Candidates/Extra Information Rows of the Candidates/Extra Information Attributes of the Candidates
The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create extra information row attribute about candidates
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextCode}/child/dataRows/{DataRowId}/child/attributes
- Get all extra information row attribute about candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextCode}/child/dataRows/{DataRowId}/child/attributes
- Get extra information row attribute about candidates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextCode}/child/dataRows/{DataRowId}/child/attributes/{AttributeId}
Recruiting Job Site Candidates/Languages of the Candidates
The languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate language
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/languages
- Delete a candidate language
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/languages/{LanguageId}
- Get a candidate language
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/languages/{LanguageId}
- Get all candidate languages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/languages
- Update a candidate language
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/languages/{LanguageId}
Recruiting Job Site Candidates/Languages of the Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/languages/{LanguageId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/languages/{LanguageId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/languages/{LanguageId}/enclosure/Comments
Recruiting Job Site Candidates/National Identifiers of the Candidates
The nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate national identifier
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/nationalIdentifiers
- Delete a candidate national identifier
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/nationalIdentifiers/{NationalIdentifierId}
- Get a candidate national identifier
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/nationalIdentifiers/{NationalIdentifierId}
- Get all candidate national identifiers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/nationalIdentifiers
- Update a candidate national identifier
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/nationalIdentifiers/{NationalIdentifierId}
Recruiting Job Site Candidates/Phone Numbers of the Candidates
The phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate phone
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/phones
- Delete a candidate phone
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/phones/{PhoneId}
- Get all candidate phones
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/phones
- Get candidate phone
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/phones/{PhoneId}
- Update a candidate phone
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/phones/{PhoneId}
Recruiting Job Site Candidates/Previous Employments of the Candidates
The previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate previous employment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments
- Delete a candidate previous employment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}
- Get a candidate previous employment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}
- Get all candidate previous employments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments
- Update a candidate previous employment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}
Recruiting Job Site Candidates/Previous Employments of the Candidates/Large Object (LOB) Attributes - Achievements
- Delete an Achievements
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/Achievements
- Get an Achievements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/Achievements
- Replace an Achievements
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/Achievements
Recruiting Job Site Candidates/Previous Employments of the Candidates/Large Object (LOB) Attributes - AdditionalInformation
- Delete an AdditionalInformation
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/AdditionalInformation
- Get an AdditionalInformation
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/AdditionalInformation
- Replace an AdditionalInformation
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/AdditionalInformation
Recruiting Job Site Candidates/Previous Employments of the Candidates/Large Object (LOB) Attributes - LeavingReason
- Delete a LeavingReason
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/LeavingReason
- Get a LeavingReason
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/LeavingReason
- Replace a LeavingReason
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/LeavingReason
Recruiting Job Site Candidates/Previous Employments of the Candidates/Large Object (LOB) Attributes - Responsibilities
- Delete a Responsibilities
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/Responsibilities
- Get a Responsibilities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/Responsibilities
- Replace a Responsibilities
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{PreviousEmploymentId}/enclosure/Responsibilities
Recruiting Job Site Candidates/Skills of the Candidates
The skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate skill
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills
- Delete a candidate skill
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills/{SkillId}
- Get a candidate skill
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills/{SkillId}
- Get all candidate skills
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills
- Update a candidate skill
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills/{SkillId}
Recruiting Job Site Candidates/Skills of the Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Comments
Recruiting Job Site Candidates/Skills of the Candidates/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skills/{SkillId}/enclosure/Description
Recruiting Job Site Candidates/Work Preferences of the Candidates
The workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create a candidate work preference
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/workPreferences
- Delete a candidate work preference
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
- Get a candidate work preference
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
- Get all candidate work preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/workPreferences
- Update a candidate work preference
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}
Recruiting Job Site Candidates/Work Preferences of the Candidates/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}/enclosure/Comments
Recruiting LinkedIn Event Notifications
The recruitingLinkedInEventNotifications resource receives notifications from LinkedIn for the push events.
- Creates an event for the notification received from LinkedIn
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingLinkedInEventNotifications
- Get details about a notification received from LinkedIn
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingLinkedInEventNotifications/{recruitingLinkedInEventNotificationsUniqID}
- Get details about all notifications received from LinkedIn
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingLinkedInEventNotifications
Recruiting LinkedIn Profile Integrations
The recruitingUILinkedInIntegrationsRest resource provides details about the LinkedIn integration in Recruiting.
- Create a LinkedIn profile URL for a job requisition
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUILinkedInIntegrations
- Delete the LinkedIn profile URL in a job requisition
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUILinkedInIntegrations/{recruitingUILinkedInIntegrationsUniqID}
- Get all LinkedIn profile URLs mapped to a job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUILinkedInIntegrations
- Get the LinkedIn applicant highlight plugin URL for a job application
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUILinkedInIntegrations/action/getLinkedinApplicantHighlightWidgetUrl
- Get the LinkedIn profile URL mapped to a job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUILinkedInIntegrations/{recruitingUILinkedInIntegrationsUniqID}
- Get the render condition for the LinkedIn profile link in the candidate profile
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUILinkedInIntegrations/action/isLiProfileEnabled
- Update the LinkedIn profile URL in a job requisition
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUILinkedInIntegrations/{recruitingUILinkedInIntegrationsUniqID}
Recruiting Message Designer Mail Services
The recruitingMessageDesignerMailServices resource includes the details for sending and receiving messages.
- Get a messageDesignerMailService
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesignerMailServices/{AssetId}
- Get all recruitingMessageDesignerMailServices
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesignerMailServices
- Submit a messageDesignerMailService
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesignerMailServices
- Update a messageDesignerMailService
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingMessageDesignerMailServices/{AssetId}
Recruiting Metadata for Sensitive Personal Information Block
The recruitingCECandidatePIIMetadata resource includes the metadata for the sensitive personal information block. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a metadata detail for the sensitive personal information block
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePIIMetadata/{AttributeName}
- Get all metadata detail for the sensitive personal information block
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePIIMetadata
Recruiting Questionnaires
The recruitingUIQuestionnaires resource provides details about Recruiting questionnaires.
- Disqualify the job application and update the questionnaire score.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/action/disqualifyCandidateAndUpdateScore
- Get a Recruiting questionnaire
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}
- Get all Recruiting questionnaires
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires
Recruiting Questionnaires/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}
Recruiting Questionnaires/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Recruiting Questionnaires/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Recruiting Questionnaires/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: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Recruiting Questionnaires/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Recruiting Questionnaires/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIQuestionnaires/{Id}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Recruiting SecondaryApply Flows
The recruitingCESecondaryApplyFlows resource provides details about the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a recruiting secondary application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}
- Get all recruiting secondary application flows
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows
Recruiting SecondaryApply Flows/Requisition Flexfields
The requisitionFlexFields resource is a child of the recruitingCEApplyFlows resource. It includes all the job requisition flexfields configured for the job application flow. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a requisition flexfield
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/requisitionFlexFields/{ColumnName}
- Get all requisition flexfields
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/requisitionFlexFields
Recruiting SecondaryApply Flows/Sections
The sections resource is a child of the recruitingCESecondaryApplyFlows resource. It provides details about the sections contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a section of a recruiting secondary application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}
- Get all sections of a recruiting secondary application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections
Recruiting SecondaryApply Flows/Sections/Pages
The pages resource is the child of the sections resource. It provides details about the pages of the sections contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a page of a recruiting secondary application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}
- Get all pages of a recruiting secondary application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages
Recruiting SecondaryApply Flows/Sections/Pages/Blocks
The blocks resource is the child of the pages resources. It provides details about the blocks of the pages contained in the recruiting secondary application flows. Note that the service endpoints in this resource category are only for Oracle internal use.
- Get a block of a recruiting secondary application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}/child/blocks/{blocksUniqID}
- Get all blocks of a recruiting secondary application flow
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingCESecondaryApplyFlows/{PrimaryKey}/child/sections/{sectionsUniqID}/child/pages/{pagesUniqID}/child/blocks
Recruiting Settings
The recruitingUISettings resource provides information about recruiting settings.
- Get a setting
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUISettings/{SettingCode}
- Not supported. Get all settings.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUISettings
Recruiting Tax Credit Accounts
The recruitingTaxCreditsAccountPackages resource includes all the details of the tax credit account packages. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create or update details of all tax credits accounts
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages/{recruitingTaxCreditsAccountPackagesUniqID}
Recruiting Tax Credit Accounts/Recruiting Tax Credit Account Packages
The packages resource is a child of the recruitingTaxCreditsAccountPackages resource. It contains details of a tax credits account package. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create or update details of tax credits account packages
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages/{recruitingTaxCreditsAccountPackagesUniqID}/child/packages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages/{recruitingTaxCreditsAccountPackagesUniqID}/child/packages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsAccountPackages/{recruitingTaxCreditsAccountPackagesUniqID}/child/packages/{PackageCode}
Recruiting Tax Credit Results
The recruitingUITaxCreditResults resource provides tax credit results.
- Cancel a tax credit request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUITaxCreditResults/action/cancelRequest
- Get a tax credit result
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUITaxCreditResults/{recruitingUITaxCreditResultsUniqID}
- Get all tax credit results
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUITaxCreditResults
- Initiate a tax credit request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUITaxCreditResults/action/initiateRequest
- View tax credit results
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUITaxCreditResults/action/viewResults
Recruiting Tax Credit Results/Recruiting Tax Credit Results Additional Attributes
The AdditionalResultAttributes resource provides additional tax credit results.
- Get all additional tax credit results
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUITaxCreditResults/{recruitingUITaxCreditResultsUniqID}/child/AdditionalResultAttributes
- Get an additional tax credit result
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUITaxCreditResults/{recruitingUITaxCreditResultsUniqID}/child/AdditionalResultAttributes/{AdditionalResultAttributesUniqID}
Recruiting Tax Credit Results/Recruiting Tax Credit Results Other Eligible Credits
The OtherEligibleCredits resource provides other eligible tax credit results.
- Get all other eligible tax credits
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUITaxCreditResults/{recruitingUITaxCreditResultsUniqID}/child/OtherEligibleCredits
- Get an other eligible tax credit
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUITaxCreditResults/{recruitingUITaxCreditResultsUniqID}/child/OtherEligibleCredits/{AdditionalResultId}
Recruiting Tax Credits Candidate Details
The recruitingTaxCreditsCandidateDetails resource provides details about tax credits in the candidate job application. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get details for a job application
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}
- Get details for all job applications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails
Recruiting Tax Credits Candidate Details/Recruiting Tax Credits Address Details
The addressDetails resource is a child of the recruitingTaxCreditsCandidateDetails and provides the individual address fields of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get all the address details of the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/addressDetails
- Get the address details of the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/addressDetails/{addressDetailsUniqID}
Recruiting Tax Credits Candidate Details/Recruiting Tax Credits Address Format
The addressFormat resource is a child of the recruitingTaxCreditsCandidateDetails and provides the address format used in the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get all address formats of the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/addressFormat
- Get an address format of the candidate
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/addressFormat/{Attribute}
Recruiting Tax Credits Candidate Details/Recruiting Tax Credits Candidate National Identifiers
The NationalIdentifiers resource is the child of the recruitingTaxCreditsCandidateDetails resource and provides the national identifiers of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a candidate national identifier
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/NationalIdentifiers/{NationalIdentifierNumber}
- Get all candidate national identifiers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/NationalIdentifiers
Recruiting Tax Credits Candidate Details/Recruiting Tax Credits Other Work Locations
The OtherWorkLocations resource is the child of the recruitingTaxCreditsCandidateDetails resource and it provides additional work locations of the job requisition. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get a job requisition other work location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/CandidatePreferredLocations/{Location}
- Get a job requisition other work location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/OtherRequisitionLocations/{Location}
- Get a job requisition other work location
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/OtherWorkLocations/{Location}
- Get all job requisition other work locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/CandidatePreferredLocations
- Get all job requisition other work locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/OtherRequisitionLocations
- Get all job requisition other work locations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/OtherWorkLocations
Recruiting Tax Credits Candidate Details/Recruiting Tax Credits Requisition Additional Attributes
The requisitionAdditionalAttributes resource is the child of the recruitingTaxCreditsCandidateDetails resource and provides the additional requisition attributes. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Get all additional attributes of a job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/requisitionAdditionalAttributes
- Get an additional attribute of the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateDetails/{recruitingTaxCreditsCandidateDetailsUniqID}/child/requisitionAdditionalAttributes/{AttributeName}
Recruiting Tax Credits Results
The recruitingTaxCreditsCandidateResults resource includes all the details of the tax credit screening results of the candidate. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create results for all tax credits screening
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}
Recruiting Tax Credits Results/Recruiting Tax Credits Package Results
The packages resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create or update results for a tax credit package
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}
Recruiting Tax Credits Results/Recruiting Tax Credits Package Results/Additional Candidate Tax Credits Results
The additionalResultsAttributes resource is a child of the recruitingTaxCreditsCandidateResults resource. It includes additional results of a tax credit screening. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/AdditionalResultsAttributes
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/AdditionalResultsAttributes/{AttributeName}
- Submit additional results for a tax credit package
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/AdditionalResultsAttributes
Recruiting Tax Credits Results/Recruiting Tax Credits Package Results/Other Eligible Credits for Recruiting Tax Credits Package Results
The otherEligibleCredits resource is a child of the packages resource. It includes all other eligible credits the candidate has been reviewed for. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
- Create results for other eligible credits for a tax credit screening
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/OtherEligibleCredits
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/OtherEligibleCredits
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingTaxCreditsCandidateResults/{recruitingTaxCreditsCandidateResultsUniqID}/child/packages/{PackageResultId}/child/OtherEligibleCredits/{AdditionalResultId}
Requisition Agents
The recruitingUIRequisitionAgents resource provides details about the recruiting agents in the job requisition.
- Create a recruiting agent in the job requisition
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents
- Delete a recruiting agent in the job requisition
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}
- Get a recruiting agent in the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}
- Get all recruiting agents in the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents
- Update a recruiting agent in the job requisition
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}
Requisition Agents/Agent Job Family on Job Requisition
The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.
- Get all job families of the agent in the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}/child/agentJobFamilies
- Get the job family of the agent in the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}/child/agentJobFamilies/{agentJobFamiliesUniqID}
Requisition Agents/Agent Location on Job Requisition
The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.
- Get all locations of the agent in the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}/child/agentLocations
- Get the location of the agent in the job requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}/child/agentLocations/{agentLocationsUniqID}
Salaries
The salaries resource includes the salary records for a given worker assignment. You can filter based on a worker's assignment and salary start date or list all of the salary records for a given assignment.
- Create a salary for a worker's assignment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries
- Delete a salary for a worker's assignment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}
- Find the worker's recalculated values on the simulate salary range page.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/getSrdTesterRecalculatedValues
- Finds the initial values for a worker in the simulate salary range page.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/initializeSRDTester
- Finds the properties of the assignment.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/getAssignmentInfo
- Finds the properties of the proposed salary basis.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/switchSalaryRow
- Get a salary for a worker's assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}
- Get all salaries for a worker's assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaries
- Get assignment attributes to default in the Change Salary action and validate salary
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/getAutoCompleteRefData
- Get salary from the offer assignment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/getOfferSalaryRow
- Get the salary details from the transaction cache.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/getTxnCacheSalary
- Initialize HCM parameters for salary history notification
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/setSalaryHistoryCache
- Post salary for the offer assignment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/postOfferSalaryRow
- Update a salary for a worker's assignment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}
- Validate the data that uses descriptive flexfields after Continue is clicked in various flows
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/coreHrSalaryRowValidationDFF
- Validate the data when the person clicks Continue.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/coreHrSalaryRowValidation
- Validate when and why section details after the person clicks Continue
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/action/whenAndWhyRowValidation
Salaries/Salary Components
The salaryComponents resource is the child of the salaries resource and includes all the components that itemize salary adjustments for a given salary record, such as Adjustment, Location, and Merit.
- Create a component
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents
- Delete a component
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents/{SalaryComponentId}
- Get a component
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents/{SalaryComponentId}
- Get all components
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents
- Update a component
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryComponents/{SalaryComponentId}
Salaries/Salary Rate Components
The salaryRateComponents resource is the child of the salaries resource and includes all of the rate components for a given salary record. This resource is currently under controlled availability.
- Create a rate component
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents
- Delete a rate component
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents/{SalaryPayComponentId}
- Get a rate component
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents/{SalaryPayComponentId}
- Get all rate components
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents
- Update a rate component
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salaryPayRateComponents/{SalaryPayComponentId}
Salaries/Salary Simple Components
The salarySimpleComponents resource is the child of the salaries resource and includes all of the simple components for a given salary record, such as Base Salary, Location Allowance, and Special Allowance.
- Create a simple component
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents
- Delete a simple component
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents/{SimpleSalaryCompntId}
- Get a simple component
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents/{SimpleSalaryCompntId}
- Get all simple components
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents
- Update a simple component
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/salaries/{SalaryId}/child/salarySimpleComponents/{SimpleSalaryCompntId}
Schedule Requests
The schedule import request sent from a specified source.
- Create a schedule request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests
- Get a schedule request
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}
- Get all schedule requests
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests
Schedule Requests/Schedule Events
The scope of schedule updates, for example, resource and time period.
- Create a schedule event
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents
- Get a schedule event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}
- Get all schedule events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents
Schedule Requests/Schedule Events/Schedule Shift Events
A list of imported values to create, update, or delete a shift.
- Create a schedule shift event
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents
- Get a schedule shift event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents/{schedShiftEventId}
- Get all schedule shift events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents
Schedule Requests/Schedule Events/Schedule Shift Events/Schedule Shift Attributes
A list of imported values of time attributes associated with a shift.
- Create a schedule shift attribute
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents/{schedShiftEventId}/child/scheduleShiftAttributes
- Get a schedule shift attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents/{schedShiftEventId}/child/scheduleShiftAttributes/{schedShiftAtrbId}
- Get all schedule shift attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/scheduleRequests/{schedRequestId}/child/scheduleEvents/{schedEventId}/child/scheduleShiftEvents/{schedShiftEventId}/child/scheduleShiftAttributes
Search Development Goals
The searchDevGoals resource provides information about development goals.
- Assign a development goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/action/goalAssignAction
- checkGoalInPDAndCheckInDoc
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/action/checkGoalInPDAndCheckInDoc
- Clear comments and attachments
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/action/prepareApprovalTxnForSubmission
- Copy a development goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/action/copyGoal
- Create intents for a development goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/action/createGoalIntents
- Find development goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/action/findByAdvancedSearchQuery
- Get a development goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}
- Get all development goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals
- Get details of a development library goal
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/action/getDevelopmentLibraryGoalDetails
- Get development goal details
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/action/getDevelopmentGoalDetails
- getMultipleDevelopmentGoalDetails
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/action/getMultipleDevelopmentGoalDetails
- Save development goal data for approval
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/action/saveDevGoalApproval
- Submit mass assignment process for development goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/action/submitEss
Search Development Goals/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/Comments
Search Development Goals/Large Object (LOB) Attributes - SuccessCriteria
- Delete a SuccessCriteria
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/SuccessCriteria
- Get a SuccessCriteria
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/SuccessCriteria
- Replace a SuccessCriteria
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/searchDevGoals/{GoalId}/enclosure/SuccessCriteria
Search Performance or Development Goals
The searchPerfGoals resource provides information about performance and development goals.
- Find performance or development goals
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/searchGoals/action/findByAdvancedSearchQuery
- Get a performance or development goal
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/searchGoals/{searchGoalsUniqID}
- Get all performance or development goals
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/searchGoals
Seeker Preferences in Opportunity Marketplace
The recruitingOppMktSeekerPreferences resource provides the preferences of the seeker in opportunity marketplace.
- Create seeker preferences in opportunity marketplace
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktSeekerPreferences
- Delete seeker preferences in opportunity marketplace
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktSeekerPreferences/{PreferenceId}
- Get a seeker preference in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktSeekerPreferences/{PreferenceId}
- Get all seeker preferences in opportunity marketplace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktSeekerPreferences
- Update seeker preferences in opportunity marketplace
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingOppMktSeekerPreferences/{PreferenceId}
Self Details
The selfDetails resource provides details of the signed in user. User details are retrieved from the security token.
- Get a self detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/selfDetails/{selfDetailsUniqID}
- Get all self details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/selfDetails
Self Details/Large Object (LOB) Attributes - Photo
- Get a Photo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/selfDetails/{selfDetailsUniqID}/enclosure/Photo
Source Tracking
The recruitingUISourceTrackings resource provides the details of the candidate source info.
- Create a source
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUISourceTrackings
- Get a source
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUISourceTrackings/{SourceTrackingId}
- Get all sources
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUISourceTrackings
- Update a source
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/recruitingUISourceTrackings/{SourceTrackingId}
Staffing Grids
The staffingGrids resource provides information about the specified staffing grids. This resource also lets people with appropriate job roles create, update, and delete staffing grids.
- Create staffing grids for the staffing plan
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids
- Delete a staffing grid
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}
- Get a single staffing grid
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}
- Get all staffing grids for the staffing plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids
- Update a single staffing grid
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}
Staffing Grids/Staffing Grid Values
The staffingGridValues resource provides information about the specified staffing grid requirement values. This resource also lets people with appropriate job roles create, update, and delete staffing grid values.
- Create staffing grid values
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster
- Delete a staffing grid value
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster/{GridValueId}
- Get a single staffing grid value
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster/{GridValueId}
- Get all staffing grid values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster
- Update a staffing grid value
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster/{GridValueId}
Staffing Grids/Staffing Grid Values/Descriptive Flexfield for Staffing Grid Values
The operations from the Staffing Grids/Staffing Grid Values/Descriptive Flexfield for Staffing Grid Values category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster/{GridValueId}/child/StaffGridValuesRestDFFVL
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster/{GridValueId}/child/StaffGridValuesRestDFFVL/{GridValueId2}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster/{GridValueId}/child/StaffGridValuesRestDFFVL/{GridValueId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster/{GridValueId}/child/StaffGridValuesRestDFFVL
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/staffingGrids/{StaffingGridId}/child/StaffGridValuesRestMaster/{GridValueId}/child/StaffGridValuesRestDFFVL/{GridValueId2}
Status Change Requests
The statusChangeRequests resource is a unique identifier for the status change request sent using the status changes REST API. This request can contain one or more status change records.
- Create status change requests
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/statusChangeRequests
- Get a status change request
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}
- Get all status change requests
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/statusChangeRequests
Status Change Requests/Status Changes
The statusChanges resource is a unique identifier for a status change record sent using the status changes REST API. It corresponds to a time record in the WFM time repository. It's a single record expressed as time buildingBlockId and time buildingBlockVersion, along with the associated attribution that details the type of work completed, such as regular or overtime.
- Create a status change record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}/child/statusChanges
- Get a status change record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}/child/statusChanges/{statusChangeId}
- Get all status change records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/statusChangeRequests/{statusRequestId}/child/statusChanges
Talent Person Profiles
The talentPersonProfiles resource provides the profile information for a person.
- Create a person profile
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles
- Get a person profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}
- Get all person profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles
- Update a person profile
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}
Talent Person Profiles/Accomplishment Sections
The accomplishmentSections resource is the child of the talentPersonProfiles resource. It provides the list of secured accomplishment sections for a person.
- Create an accomplishment section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections
- Get all accomplishment sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections
- Get an accomplishment section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}
Talent Person Profiles/Accomplishment Sections/Accomplishment Items
The accomplishmentItems resource is the child of the accomplishmentSections resource. It provides the list of accomplishment items within an accomplishment section for a person.
- Create an accomplishment item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems
- Delete an accomplishment item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}
- Get all accomplishment items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems
- Get an accomplishment item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}
- Update an accomplishment item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}
Talent Person Profiles/Accomplishment Sections/Accomplishment Items/Accomplishment Items Descriptive Flexfields
The operations from the Talent Person Profiles/Accomplishment Sections/Accomplishment Items/Accomplishment Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/child/accomplishmentItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/child/accomplishmentItemsDFF/{AccomplishmentId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/child/accomplishmentItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/child/accomplishmentItemsDFF/{AccomplishmentId2}
Talent Person Profiles/Accomplishment Sections/Accomplishment Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Comments
Talent Person Profiles/Accomplishment Sections/Accomplishment Items/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/accomplishmentSections/{ProfileSectionId}/child/accomplishmentItems/{AccomplishmentId}/enclosure/Description
Talent Person Profiles/Area of Study Sections
The areaOfStudySections resource is the child of the talentPersonProfiles resource. It provides the list of secured area of study sections for a person.
- Create an area of study section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections
- Get all area of study sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections
- Get an area of study section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}
Talent Person Profiles/Area of Study Sections/Area of Study Items
The areaOfStudyItems resource is the child of the areaOfStudySections resource. It provides the list of area of study items within an area of study section for a person.
- Create an area of study item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems
- Delete an area of study item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems/{AreaOfStudyId}
- Get all area of study items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems
- Get an area of study item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems/{AreaOfStudyId}
- Update an area of study item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems/{AreaOfStudyId}
Talent Person Profiles/Area of Study Sections/Area of Study Items/Area of Study Items Descriptive Flexfields
The operations from the Talent Person Profiles/Area of Study Sections/Area of Study Items/Area of Study Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems/{AreaOfStudyId}/child/areaOfStudyItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems/{AreaOfStudyId}/child/areaOfStudyItemsDFF/{AreaOfStudyId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems/{AreaOfStudyId}/child/areaOfStudyItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems/{AreaOfStudyId}/child/areaOfStudyItemsDFF/{AreaOfStudyId2}
Talent Person Profiles/Areas of Expertise
The areasOfExpertise resource is the child of the talentPersonProfiles resource. It provides the list of expertise items for a person.
- Create an area of expertise
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfExpertise
- Get all areas of expertise
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfExpertise
- Get an area of expertise
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfExpertise/{ExpertiseId}
- Update an area of expertise
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfExpertise/{ExpertiseId}
Talent Person Profiles/Areas of Interest
The areasOfInterest resource is the child of the talentPersonProfiles resource. It provides the list of interests for a person.
- Create an area of interest
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfInterest
- Get all areas of interest
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfInterest
- Get an area of interest
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfInterest/{InterestId}
- Update an area of interest
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areasOfInterest/{InterestId}
Talent Person Profiles/Attachments
The attachments resource is a child of talentPersonProfiles resource. It provides all the attachments for a worker profile.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}
Talent Person Profiles/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Talent Person Profiles/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Talent Person Profiles/Career Preference Sections
The careerPreferenceSections resource is the child of the talentPersonProfiles resource. It provides the list of secured career preference sections for a person.
- Create a career preference section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections
- Get a career preference section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}
- Get all career preference sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections
Talent Person Profiles/Career Preference Sections/Career Preference Items
The careerPreferenceItems resource is the child of the careerPreferenceSections resource. It provides the list of career preference Items within a career preference section for a person.
- Create a career preference item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems
- Get a career preference item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}
- Get all career preference items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems
- Update a career preference item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}
Talent Person Profiles/Career Preference Sections/Career Preference Items/Career Preference Items Descriptive Flexfields
The operations from the Talent Person Profiles/Career Preference Sections/Career Preference Items/Career Preference Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/child/careerPreferenceItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/child/careerPreferenceItemsDFF/{CareerPrefId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/child/careerPreferenceItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/child/careerPreferenceItemsDFF/{CareerPrefId}
Talent Person Profiles/Career Preference Sections/Career Preference Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/Comments
Talent Person Profiles/Career Preference Sections/Career Preference Items/Large Object (LOB) Attributes - PreferredJobDescr
- Delete a PreferredJobDescr
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/PreferredJobDescr
- Get a PreferredJobDescr
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/PreferredJobDescr
- Replace a PreferredJobDescr
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerPreferenceSections/{ProfileSectionId}/child/careerPreferenceItems/{CareerPreferenceId}/enclosure/PreferredJobDescr
Talent Person Profiles/Career Statements
The careerStatements resource includes the career statement associated with a person.
- Create a career statement
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements
- Get a career statement
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements/{CareerStatmentId}
- Get all career statements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements
- Update a career statement
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements/{CareerStatmentId}
Talent Person Profiles/Career Statements/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements/{CareerStatmentId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements/{CareerStatmentId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careerStatements/{CareerStatmentId}/enclosure/Description
Talent Person Profiles/Careers of Interest
The careersOfInterest resource includes a list of all the careers of interest associated with a person.
- Create a career of interest
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest
- Delete a career of interest
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest/{CareerInterestId}
- Get a career of interest
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest/{CareerInterestId}
- Get all careers of interest
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest
- Update a career of interest
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/careersOfInterest/{CareerInterestId}
Talent Person Profiles/Certification Sections
The certificationSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured certification sections for a person.
- Create a certification section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections
- Get a certification section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}
- Get all certification sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections
Talent Person Profiles/Certification Sections/Certification Items
The certificationItems resource is the child of the certificationSections resource. It provides the list of certification items within a certification section for a person.
- Create a certification item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems
- Delete a certification item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}
- Get a certification item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}
- Get all certification items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems
- Update a certification item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}
Talent Person Profiles/Certification Sections/Certification Items/Certification Item Attachments
The certificationItemAttachments resource is a child of certificationItems resource. It provides all the attachments for the certification item.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}
Talent Person Profiles/Certification Sections/Certification Items/Certification Item Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}/enclosure/FileContents
Talent Person Profiles/Certification Sections/Certification Items/Certification Item Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemAttachments/{certificationItemAttachmentsUniqID}/enclosure/FileWebImage
Talent Person Profiles/Certification Sections/Certification Items/Certification Items Descriptive Flexfields
The operations from the Talent Person Profiles/Certification Sections/Certification Items/Certification Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemsDFF/{CertificationId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/child/certificationItemsDFF/{CertificationId2}
Talent Person Profiles/Certification Sections/Certification Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Comments
Talent Person Profiles/Certification Sections/Certification Items/Large Object (LOB) Attributes - Restrictions
- Delete a Restrictions
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Restrictions
- Get a Restrictions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Restrictions
- Replace a Restrictions
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/certificationSections/{ProfileSectionId}/child/certificationItems/{CertificationId}/enclosure/Restrictions
Talent Person Profiles/Competency Sections
The competencySections resource is the child of the talentPersonProfiles resource. It provides the list of the secured competency sections for a person.
- Create a competency section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections
- Get a competency section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}
- Get all competency sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections
Talent Person Profiles/Competency Sections/Competency Items
The allCompetencyItems resource is the child of the competencySections resource. It provides the list of distinct competency items within a competency section for a person profile.
- Create a competency item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems
- Delete a competency item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}
- Get a competency item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}
- Get a distinct competency item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/allCompetencyItems/{allCompetencyItemsUniqID}
- Get all competency items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems
- Get all distinct competency items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/allCompetencyItems
- Update a competency item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}
Talent Person Profiles/Competency Sections/Competency Items/Behavior Items
The behaviorItems resource is the child of the competencyItems resource. It provides the list of the behavior items related to a competency item for a competency section.
- Create a behavior item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/behaviorItems
- Delete a behavior item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/behaviorItems/{BehaviorId}
- Get a behavior item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/behaviorItems/{BehaviorId}
- Get all behavior items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/behaviorItems
- Update a behavior item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/behaviorItems/{BehaviorId}
Talent Person Profiles/Competency Sections/Competency Items/Behavior Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/behaviorItems/{BehaviorId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/behaviorItems/{BehaviorId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/behaviorItems/{BehaviorId}/enclosure/Comments
Talent Person Profiles/Competency Sections/Competency Items/Competency Items Descriptive Flexfields
The operations from the Talent Person Profiles/Competency Sections/Competency Items/Competency Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/competencyItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/competencyItemsDFF/{CompetencyId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/competencyItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/child/competencyItemsDFF/{CompetencyId}
Talent Person Profiles/Competency Sections/Competency Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/enclosure/Comments
Talent Person Profiles/Competency Sections/Competency Items/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/enclosure/Description
Talent Person Profiles/Competency Sections/Competency Items/Large Object (LOB) Attributes - EvaluationComments
- Delete an EvaluationComments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/enclosure/EvaluationComments
- Get an EvaluationComments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/enclosure/EvaluationComments
- Replace an EvaluationComments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/competencySections/{ProfileSectionId}/child/competencyItems/{allCompetencyItemsUniqID}/enclosure/EvaluationComments
Talent Person Profiles/Education Level Sections
The educationLvlSections resource is the child of the talentPersonProfiles resource. It provides the list of secured education level sections for a person.
- Create an education level section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections
- Get all education level sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections
- Get an education level section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}
Talent Person Profiles/Education Level Sections/Education Level Items
The educationLvlItems resource is the child of the educationLvlSections resource. It provides the list of education level items within an education level section for a person.
- Create an education level item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems
- Delete an education level item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}
- Get all education level items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems
- Get an education level item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}
- Update an education level item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}
Talent Person Profiles/Education Level Sections/Education Level Items/Education Level Items Descriptive Flexfields
The operations from the Talent Person Profiles/Education Level Sections/Education Level Items/Education Level Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}/child/educationLvlItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}/child/educationLvlItemsDFF/{EducationLevelId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}/child/educationLvlItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}/child/educationLvlItemsDFF/{EducationLevelId2}
Talent Person Profiles/Education Level Sections/Education Level Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{ProfileSectionId}/child/educationLvlItems/{EducationLevelId}/enclosure/Comments
Talent Person Profiles/Education Sections
The educationSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured education sections for a person.
- Create an education section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections
- Get all education sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections
- Get an education section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}
Talent Person Profiles/Education Sections/Education Items
The educationItems resource is the child of the educationSections resource. It provides the list of the education items within an education section for a person.
- Create an education item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems
- Delete an education item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}
- Get all education items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems
- Get an education item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}
- Update an education item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}
Talent Person Profiles/Education Sections/Education Items/Education Item Attachments
The educationItemAttachments resource is a child of educationItems resource. It provides all the attachments for the education item.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}
Talent Person Profiles/Education Sections/Education Items/Education Item Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}/enclosure/FileContents
Talent Person Profiles/Education Sections/Education Items/Education Item Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemAttachments/{educationItemAttachmentsUniqID}/enclosure/FileWebImage
Talent Person Profiles/Education Sections/Education Items/Education Items Descriptive Flexfields
The operations from the Talent Person Profiles/Education Sections/Education Items/Education Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemsDFF/{EducationId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/child/educationItemsDFF/{EducationId2}
Talent Person Profiles/Education Sections/Education Items/Large Object (LOB) Attributes - ActivitySummary
- Delete an ActivitySummary
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/ActivitySummary
- Get an ActivitySummary
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/ActivitySummary
- Replace an ActivitySummary
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/ActivitySummary
Talent Person Profiles/Education Sections/Education Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Comments
Talent Person Profiles/Education Sections/Education Items/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Description
Talent Person Profiles/Education Sections/Education Items/Large Object (LOB) Attributes - Reimbursements
- Delete a Reimbursements
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Reimbursements
- Get a Reimbursements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Reimbursements
- Replace a Reimbursements
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationSections/{ProfileSectionId}/child/educationItems/{EducationId}/enclosure/Reimbursements
Talent Person Profiles/Favorite Links
The favoriteLinks resource is the child of the talentPersonProfiles resource. It provides the favorite links for a person.
- Create a favorite link
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/favoriteLinks
- Delete a favorite link
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/favoriteLinks/{BookmarkId}
- Get a favorite link
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/favoriteLinks/{BookmarkId}
- Get all favorite links
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/favoriteLinks
- Update a favorite link
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/favoriteLinks/{BookmarkId}
Talent Person Profiles/Highest Education Level Sections
The highestEducationLvlSections resource is the child of the talentPersonProfiles resource. It provides the list of secured highest education level sections for a person.
- Create an highest education level section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections
- Get all highest education level sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections
- Get an highest education level section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}
Talent Person Profiles/Highest Education Level Sections/Highest Education Level Items
The highestEduLvlItems resource is the child of the highestEducationLvlSections resource. It provides the list of highest education level items within an highest education level for a person.
- Create an highest education level item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems
- Delete an highest education level item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems/{HighestEduLevelId}
- Get all highest education level items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems
- Get an highest education level item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems/{HighestEduLevelId}
- Update an highest education level item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems/{HighestEduLevelId}
Talent Person Profiles/Highest Education Level Sections/Highest Education Level Items/Highest Education Level Items Descriptive Flexfields
The operations from the Talent Person Profiles/Highest Education Level Sections/Highest Education Level Items/Highest Education Level Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems/{HighestEduLevelId}/child/highestEduLvlItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems/{HighestEduLevelId}/child/highestEduLvlItemsDFF/{HighestEduLevelId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems/{HighestEduLevelId}/child/highestEduLvlItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems/{HighestEduLevelId}/child/highestEduLvlItemsDFF/{HighestEduLevelId2}
Talent Person Profiles/Highest Education Level Sections/Highest Education Level Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems/{HighestEduLevelId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems/{HighestEduLevelId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/highestEducationLvlSections/{ProfileSectionId}/child/highestEduLvlItems/{HighestEduLevelId}/enclosure/Comments
Talent Person Profiles/Honor Sections
The honorSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured honor sections for a person.
- Create an honor section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections
- Get all honor sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections
- Get an honor section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}
Talent Person Profiles/Honor Sections/Honor Items
The honorItems resource is the child of the honorSections resource. It provides the list of honor items within an honor section for a person.
- Create an honor item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems
- Delete an honor item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}
- Get all honor items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems
- Get an honor item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}
- Update an honor item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}
Talent Person Profiles/Honor Sections/Honor Items/Honor Item Attachments
The honorItemAttachments resource is a child of honorItems resource. It provides all the attachments for the honor item.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}
Talent Person Profiles/Honor Sections/Honor Items/Honor Item Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}/enclosure/FileContents
Talent Person Profiles/Honor Sections/Honor Items/Honor Item Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemAttachments/{honorItemAttachmentsUniqID}/enclosure/FileWebImage
Talent Person Profiles/Honor Sections/Honor Items/Honor Items Descriptive Flexfields
The operations from the Talent Person Profiles/Honor Sections/Honor Items/Honor Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemsDFF/{HonorId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/child/honorItemsDFF/{HonorId2}
Talent Person Profiles/Honor Sections/Honor Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Comments
Talent Person Profiles/Honor Sections/Honor Items/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/honorSections/{ProfileSectionId}/child/honorItems/{HonorId}/enclosure/Description
Talent Person Profiles/Language Sections
The languageSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured language sections for a person.
- Create a language section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections
- Get a language section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}
- Get all language sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections
Talent Person Profiles/Language Sections/Language Items
The languageItems resource is the child of the languageSections resource. It provides the list of the language items within a language section for a person.
- Create a language item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems
- Delete a language item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems/{LanguageId}
- Get a language item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems/{LanguageId}
- Get all language items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems
- Update a language item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems/{LanguageId}
Talent Person Profiles/Language Sections/Language Items/Language Items Descriptive Flexfields
The operations from the Talent Person Profiles/Language Sections/Language Items/Language Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems/{LanguageId}/child/languageItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems/{LanguageId}/child/languageItemsDFF/{LanguageId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems/{LanguageId}/child/languageItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems/{LanguageId}/child/languageItemsDFF/{LanguageId2}
Talent Person Profiles/Language Sections/Language Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems/{LanguageId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems/{LanguageId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/languageSections/{ProfileSectionId10}/child/languageItems/{LanguageId}/enclosure/Comments
Talent Person Profiles/Membership Sections
The membershipSections resource is the child of the talentPersonProfiles resource. It provides the list of secured membership sections for a person.
- Create a membership section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections
- Get a membership section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}
- Get all membership sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections
Talent Person Profiles/Membership Sections/Membership Items
The membershipItems resource is the child of the membershipSections resource. It provides the list of the membership items within a membership section for a person.
- Create a membership item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems
- Delete a membership item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}
- Get a membership item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}
- Get all membership items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems
- Update a membership item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}
Talent Person Profiles/Membership Sections/Membership Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}/enclosure/Comments
Talent Person Profiles/Membership Sections/Membership Items/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}/enclosure/Description
Talent Person Profiles/Membership Sections/Membership Items/Membership Items Descriptive Flexfields
The operations from the Talent Person Profiles/Membership Sections/Membership Items/Membership Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}/child/membershipItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}/child/membershipItemsDFF/{MembershipId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}/child/membershipItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/membershipSections/{ProfileSectionId11}/child/membershipItems/{MembershipId}/child/membershipItemsDFF/{MembershipId2}
Talent Person Profiles/Public Skills
The publicSkills resource is the child of the talentPersonProfiles resource. It provides a list of the skill items for the skill content subscribed by the skill center. This resource is currently under controlled availability.
- Create a public skill
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills
- Delete a public skill
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}
- Get a public skill
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}
- Get all public skills
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills
- Send an endorsement request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/action/sendEndorsementRequests
- Update a public skill
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}
Talent Person Profiles/Public Skills/Endorsements
The endorsements resource is a child of public skills resource. It provides a list of all endorsements for worker's public skills. This resource is currently under controlled availability.
- Create an endorsement
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/child/endorsements
- Delete an endorsement
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/child/endorsements/{EndorsementId}
- Get all endorsements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/child/endorsements
- Get an endorsement
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/child/endorsements/{EndorsementId}
- Update an endorsement
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/child/endorsements/{EndorsementId}
Talent Person Profiles/Public Skills/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/enclosure/Comments
Talent Person Profiles/Public Skills/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/publicSkills/{SkillId}/enclosure/Description
Talent Person Profiles/Skill Sections
The skillSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured skill sections for a person.
- Create a skill section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections
- Get a skill section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId1}
- Get all skill sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections
Talent Person Profiles/Skill Sections/Skill Items
The skillItemsresource is the child of the skillSections resource. It provides the list of the skill items within a skill section for a person.
- Create a skill item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId1}/child/skillItems
- Delete a skill item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}
- Get a skill item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}
- Get all skill items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId1}/child/skillItems
- Update a skill item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}
Talent Person Profiles/Skill Sections/Skill Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}/enclosure/Comments
Talent Person Profiles/Skill Sections/Skill Items/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}/enclosure/Description
Talent Person Profiles/Skill Sections/Skill Items/Skill Items Descriptive Flexfields
The operations from the Talent Person Profiles/Skill Sections/Skill Items/Skill Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}/child/skillItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}/child/skillItemsDFF/{SkillId3}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}/child/skillItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/skillSections/{ProfileSectionId12}/child/skillItems/{SkillId}/child/skillItemsDFF/{SkillId3}
Talent Person Profiles/Special Project Sections
The specialProjectSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured special project sections for a person.
- Create a special project section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections
- Get a special project section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}
- Get all special project sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections
Talent Person Profiles/Special Project Sections/Special Project Items
The specialProjectItems resource is the child of the specialProjectSections resource. It provides the list of the special project items within a special project section for a person.
- Create a special project item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems
- Delete a special project item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}
- Get a special project item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}
- Get all special project items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems
- Update a special project item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}
Talent Person Profiles/Special Project Sections/Special Project Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}/enclosure/Comments
Talent Person Profiles/Special Project Sections/Special Project Items/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}/enclosure/Description
Talent Person Profiles/Special Project Sections/Special Project Items/Special Project Items Descriptive Flexfields
The operations from the Talent Person Profiles/Special Project Sections/Special Project Items/Special Project Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}/child/specialProjectItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}/child/specialProjectItemsDFF/{ProjectId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}/child/specialProjectItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/specialProjectSections/{ProfileSectionId1}/child/specialProjectItems/{ProjectId}/child/specialProjectItemsDFF/{ProjectId2}
Talent Person Profiles/Tags
The tags resource is the child of the talentPersonProfiles resource. It provides the list of the tags associated with a person profile.
- Create a tag
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/tags
- Delete a tag
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/tags/{TagId}
- Get a tag
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/tags/{TagId}
- Get all tags
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/tags
- Update a tag
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/tags/{TagId}
Talent Person Profiles/Technical Post Details Sections
The technicalPostDetailsSections resource is the child of the talentPersonProfiles resource. It provides the list of secured technical post details sections for a person.
- Create an technical post detail section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections
- Get all technical post detail sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections
- Get an technical post detail section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections/{ProfileSectionId1}
Talent Person Profiles/Technical Post Details Sections/Technical Post Details Items
The technicalPostDetailsItems resource is the child of the technicalPostDetailsSections resource. It provides the list of technical post details items within a technical post detail section for a person.
- Create an technical post detail item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections/{ProfileSectionId1}/child/technicalPostDetailsItems
- Delete an technical post detail item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections/{ProfileSectionId1}/child/technicalPostDetailsItems/{TechPostDetailId}
- Get all technical post detail items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections/{ProfileSectionId1}/child/technicalPostDetailsItems
- Get an technical post detail item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections/{ProfileSectionId1}/child/technicalPostDetailsItems/{TechPostDetailId}
- Update an technical post detail item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections/{ProfileSectionId1}/child/technicalPostDetailsItems/{TechPostDetailId}
Talent Person Profiles/Technical Post Details Sections/Technical Post Details Items/Technical Post Details Items Descriptive Flexfields
The operations from the Talent Person Profiles/Technical Post Details Sections/Technical Post Details Items/Technical Post Details Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections/{ProfileSectionId1}/child/technicalPostDetailsItems/{TechPostDetailId}/child/technicalPostDetailItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections/{ProfileSectionId1}/child/technicalPostDetailsItems/{TechPostDetailId}/child/technicalPostDetailItemsDFF/{TechPostDetailId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections/{ProfileSectionId1}/child/technicalPostDetailsItems/{TechPostDetailId}/child/technicalPostDetailItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/technicalPostDetailsSections/{ProfileSectionId1}/child/technicalPostDetailsItems/{TechPostDetailId}/child/technicalPostDetailItemsDFF/{TechPostDetailId2}
Talent Person Profiles/Work History Sections
The workHistorySections resource is the child of the talentPersonProfiles resource. It provides the list of the secured work history sections for a person.
- Create a work history section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections
- Get all work history sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections
- Get work history section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}
Talent Person Profiles/Work History Sections/Work History Items
The workHistoryItems resource is the child of the workHistorySections resource. It provides the list of the work history items within a work history section for a person.
- Create a work history item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems
- Delete a work history item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}
- Get all work history items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems
- Get work history item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}
- Update a work history item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}
Talent Person Profiles/Work History Sections/Work History Items/Large Object (LOB) Attributes - Achievements
- Delete an Achievements
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Achievements
- Get an Achievements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Achievements
- Replace an Achievements
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Achievements
Talent Person Profiles/Work History Sections/Work History Items/Large Object (LOB) Attributes - AdditionalInformation
- Delete an AdditionalInformation
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/AdditionalInformation
- Get an AdditionalInformation
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/AdditionalInformation
- Replace an AdditionalInformation
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/AdditionalInformation
Talent Person Profiles/Work History Sections/Work History Items/Large Object (LOB) Attributes - ReasonforLeaving
- Delete a ReasonforLeaving
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/ReasonforLeaving
- Get a ReasonforLeaving
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/ReasonforLeaving
- Replace a ReasonforLeaving
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/ReasonforLeaving
Talent Person Profiles/Work History Sections/Work History Items/Large Object (LOB) Attributes - Responsibilities
- Delete a Responsibilities
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Responsibilities
- Get a Responsibilities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Responsibilities
- Replace a Responsibilities
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/enclosure/Responsibilities
Talent Person Profiles/Work History Sections/Work History Items/Work History Items Descriptive Flexfields
The operations from the Talent Person Profiles/Work History Sections/Work History Items/Work History Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/child/workHistoryItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/child/workHistoryItemsDFF/{PrevEmploymentId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/child/workHistoryItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workHistorySections/{ProfileSectionId1}/child/workHistoryItems/{workHistoryItemsUniqID}/child/workHistoryItemsDFF/{PrevEmploymentId}
Talent Person Profiles/Work Preference Sections
The workPreferenceSections resource is the child of the talentPersonProfiles resource. It provides the list of the secured work preference sections for a person.
- Create a work preference section
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections
- Get a work preference section
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}
- Get all work preference sections
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections
Talent Person Profiles/Work Preference Sections/Work Preference Items
The workPreferenceItems resource is the child of the workPreferenceSections resource. It provides the list of the work preference items within a work preference section for a person.
- Create a work preference item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems
- Get a work preference item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}
- Get all work preference items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems
- Update a work preference item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}
Talent Person Profiles/Work Preference Sections/Work Preference Items/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/enclosure/Comments
Talent Person Profiles/Work Preference Sections/Work Preference Items/Work Preference Items Descriptive Flexfields
The operations from the Talent Person Profiles/Work Preference Sections/Work Preference Items/Work Preference Items Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/child/workPreferenceItemsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/child/workPreferenceItemsDFF/{WorkPrefId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/child/workPreferenceItemsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/workPreferenceSections/{ProfileSectionId1}/child/workPreferenceItems/{workPreferenceItemsUniqID}/child/workPreferenceItemsDFF/{WorkPrefId}
Talent Pools Security Profile
The talentPoolSecurityProfiles resource secures talent pools based on some workforce structures.
- Create a talent pool security profile
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles
- Delete a talent pool security profile
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}
- Get a talent pool security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}
- Get all talent pool security profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles
- Update a talent pool security profile
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}
Talent Pools Security Profile/Business Units
The businessUnits resource provides a way to secure talent pools by business unit.
- Create a talent pool security profile with business units
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/businessUnits
- Delete a business unit on a talent pool security profile
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/businessUnits/{PoolSecProfBusUnitId}
- Get a business unit for a talent pool security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/businessUnits/{PoolSecProfBusUnitId}
- Get all business units for a talent pool security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/businessUnits
- Update a business unit on a talent pool security profile
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/businessUnits/{PoolSecProfBusUnitId}
Talent Pools Security Profile/Departments
The department resource provides a way to secure talent pools by department.
- Create a talent pool security profile with departments
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/departments
- Delete a department on a talent pool security profile
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/departments/{departmentsUniqID}
- Get a department for a talent pool security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/departments/{departmentsUniqID}
- Get all departments for a talent pool security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/departments
- Update a department on a talent pool security profile
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/departments/{departmentsUniqID}
Talent Pools Security Profile/Job Families
The jobFamilies resource provides a way to secure talent pools by jobFamilies.
- Create a talent pool security profile with job families
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/jobFamilies
- Delete a job family on a talent pool security profile
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/jobFamilies/{jobFamiliesUniqID}
- Get a job family for a talent pool security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/jobFamilies/{jobFamiliesUniqID}
- Get all job families for a talent pool security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/jobFamilies
- Update a job family on a talent pool security profile
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentPoolSecurityProfiles/{PoolSecurityProfileId}/child/jobFamilies/{jobFamiliesUniqID}
Talent Profile Sync Logs
The talentProfileSyncLogs resource provides all the profile sync logs.
- Get a sync log
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentProfileSyncLogs/{ProfileSyncLogId}
- Get all the sync logs
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentProfileSyncLogs
Talent Profile Sync Logs/Large Object (LOB) Attributes - StackTrace
- Delete a StackTrace
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentProfileSyncLogs/{ProfileSyncLogId}/enclosure/StackTrace
- Get a StackTrace
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentProfileSyncLogs/{ProfileSyncLogId}/enclosure/StackTrace
- Replace a StackTrace
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentProfileSyncLogs/{ProfileSyncLogId}/enclosure/StackTrace
Talent Profile Sync Logs/Sync Log Details
The syncLogDetails resource is the child of the talentProfileSyncLogs resource. It provides the details for the logs.
- Get a sync log detail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentProfileSyncLogs/{ProfileSyncLogId}/child/syncLogDetails/{SyncLogDetailId}
- Get all the sync log details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentProfileSyncLogs/{ProfileSyncLogId}/child/syncLogDetails
Talent Profile Sync Logs/Sync Log Details/Large Object (LOB) Attributes - ProfileItemSyncDetail
- Delete a ProfileItemSyncDetail
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentProfileSyncLogs/{ProfileSyncLogId}/child/syncLogDetails/{SyncLogDetailId}/enclosure/ProfileItemSyncDetail
- Get a ProfileItemSyncDetail
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentProfileSyncLogs/{ProfileSyncLogId}/child/syncLogDetails/{SyncLogDetailId}/enclosure/ProfileItemSyncDetail
- Replace a ProfileItemSyncDetail
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentProfileSyncLogs/{ProfileSyncLogId}/child/syncLogDetails/{SyncLogDetailId}/enclosure/ProfileItemSyncDetail
Talent Ratings
The talentRatings resource is the top-level resource that provides talent rating data for a person profile.
- Get a talent rating
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}
- Get all talent ratings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings
Talent Ratings/Advancement Readiness
The advancementReadiness resource is the child of the talentRatings resource and helps to manage an employees readiness for the next position in their career development.
- Create an advancement readiness item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness
- Delete an advancement readiness item
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}
- Get a advancement readiness item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}
- Get all advancement readiness items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness
- Update an advancement readiness item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}
Talent Ratings/Advancement Readiness/Advancement Readiness Descriptive Flexfields
The operations from the Talent Ratings/Advancement Readiness/Advancement Readiness Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/child/advancementReadinessDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/child/advancementReadinessDFF/{AdvReadinessId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/child/advancementReadinessDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/child/advancementReadinessDFF/{AdvReadinessId}
Talent Ratings/Advancement Readiness/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/advancementReadiness/{advancementReadinessUniqID}/enclosure/Comments
Talent Ratings/Career Potential
The careerPotential resource is the child of the talentRatings resource. It evaluates the career potential of a person.
- Create a career potential rating item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential
- Get a career potential rating item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}
- Get all career potential rating items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential
- Update a career potential rating item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}
Talent Ratings/Career Potential/Career Potential Descriptive Flexfields
The operations from the Talent Ratings/Career Potential/Career Potential Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/child/careerPotentialsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/child/careerPotentialsDFF/{CareerPotentialId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/child/careerPotentialsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/child/careerPotentialsDFF/{CareerPotentialId2}
Talent Ratings/Career Potential/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/careerPotential/{CareerPotentialId}/enclosure/Comments
Talent Ratings/Impact of Losses
The impactOfLosses resource is the child of the talentRatings resource. It evaluates the impact of the loss of a person.
- Create an impact of loss rating item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses
- Get all impact of loss rating items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses
- Get an impact of loss rating item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}
- Update an impact of loss rating item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}
Talent Ratings/Impact of Losses/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/impactOfLosses/{ImpactOfLossId}/enclosure/Comments
Talent Ratings/N Box Cell Assignments
The nBoxCellAssignments resource is the child of the talentRatings resource. It evaluates the nBox cell assignment of a person.
- Get all nBox cell assignments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/nBoxCellAssignments
- Get an nBox cell assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/nBoxCellAssignments/{NBoxAssignmentId}
Talent Ratings/Performance Ratings
The performanceRatings resource is the child of the talentRatings resource. It evaluates the performance of a person.
- Create a performance rating item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings
- Get a performance rating item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}
- Get all performance rating items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings
- Update a performance rating item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}
Talent Ratings/Performance Ratings/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/enclosure/Comments
Talent Ratings/Performance Ratings/Performance Rating Descriptive Flexfields
The operations from the Talent Ratings/Performance Ratings/Performance Rating Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/child/performanceRatingsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/child/performanceRatingsDFF/{PerfRatingId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/child/performanceRatingsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/performanceRatings/{PerformanceRatingId}/child/performanceRatingsDFF/{PerfRatingId}
Talent Ratings/Risk of Losses
The riskOfLosses resource is the child of the talentRatings resource. It evaluates the risk of loss of a person.
- Create a risk of loss rating item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses
- Get a risk of loss rating item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}
- Get all risks of loss rating items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses
- Update a risk of loss rating item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}
Talent Ratings/Risk of Losses/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/enclosure/Comments
Talent Ratings/Risk of Losses/Risk of Losses Descriptive Flexfields
The operations from the Talent Ratings/Risk of Losses/Risk of Losses Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/child/riskOfLossesDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/child/riskOfLossesDFF/{RiskOfLossId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/child/riskOfLossesDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/riskOfLosses/{RiskOfLossId}/child/riskOfLossesDFF/{RiskOfLossId2}
Talent Ratings/Talent Scores
The talentScores resource is the child of the talentRatings resource. It evaluates the talent score of a person.
- Create a talent score rating item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores
- Get a talent score rating item
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}
- Get all talent score rating items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores
- Update a talent score rating item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}
Talent Ratings/Talent Scores/Large Object (LOB) Attributes - Comments
- Delete a Comments
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/enclosure/Comments
- Get a Comments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/enclosure/Comments
- Replace a Comments
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/enclosure/Comments
Talent Ratings/Talent Scores/Talent Score Descriptive Flexfields
The operations from the Talent Ratings/Talent Scores/Talent Score Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/child/talentScoresDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/child/talentScoresDFF/{TalentScoreId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/child/talentScoresDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/talentScores/{TalentScoreId}/child/talentScoresDFF/{TalentScoreId2}
Talent Ratings/User Defined Rating Sections
The userDefinedRatingSections resource is the child of the talentRatings resource. It provides the list of user-defined talent rating sections associated with a person profile.
- Create a custom talent rating section for a profile
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections
- Get a custom talent rating section for a profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}
- Get all custom talent rating sections for a profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections
Talent Ratings/User Defined Rating Sections/User Defined Ratings
The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.
- Create a custom talent rating item
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings
- Get a custom talent rating item for a profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings/{RatingId}
- Get all custom talent rating items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings
- Update a custom talent rating item
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings/{RatingId}
Talent Ratings/User Defined Rating Sections/User Defined Ratings/Large Object (LOB) Attributes - Description
- Delete a Description
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings/{RatingId}/enclosure/Description
- Get a Description
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings/{RatingId}/enclosure/Description
- Replace a Description
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}/child/userDefinedRatings/{RatingId}/enclosure/Description
Talent Review Meeting Templates
The talentReviewMeetingTemplates resource provides all the talent review meeting templates created for the organization.
- Create a talent review meeting template
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates
- Delete a talent review meeting template
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}
- Get a talent review meeting template
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}
- Get all talent review meeting templates
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates
- Update a talent review meeting template
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}
Talent Review Meeting Templates/Analytic Types
The analyticTypes resource is a child of the talentReviewMeetingTemplates resource and provides all the analytic options that can be added for the box chart matrix.
- Create an analytic option
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes
- Delete an analytic option
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}
- Get all analytic options
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes
- Get an analytic option
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}
- Update an analytic option
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}
Talent Review Meeting Templates/Analytic Types/Box Labels
The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.
- Create a box label
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxLabels
- Delete a box label
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxLabels/{boxLabelsUniqID}
- Get a box label
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxLabels/{boxLabelsUniqID}
- Get all box labels
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxLabels
- Update a box label
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxLabels/{boxLabelsUniqID}
Talent Review Meeting Templates/Analytic Types/Box Ratings
The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.
- Create a box rating
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxRatings
- Delete a box rating
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxRatings/{boxRatingsUniqID}
- Get a box rating
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxRatings/{boxRatingsUniqID}
- Get all box ratings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxRatings
- Update a box rating
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxRatings/{boxRatingsUniqID}
Talent Review Meeting Templates/Display Option Preferences
The displayOptionPreferences resource is a child of the talentReviewMeetingTemplates resource and provides all the display option preferences that are configured in the template.
- Create a display option preference
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/displayOptionPreferences
- Delete a display option preference
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/displayOptionPreferences/{displayOptionPreferencesUniqID}
- Get a display option preference
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/displayOptionPreferences/{displayOptionPreferencesUniqID}
- Get all display option preferences
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/displayOptionPreferences
- Update a display option preference
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/displayOptionPreferences/{displayOptionPreferencesUniqID}
Talent Review Meeting Templates/Metric Configurations
The metricConfigs resource provides all the ratings that are included in the Talent Review template.
- Create a rating
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/metricConfigs
- Delete a rating
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/metricConfigs/{metricConfigsUniqID}
- Get a rating
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/metricConfigs/{metricConfigsUniqID}
- Get all ratings
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/metricConfigs
- Update a rating
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/metricConfigs/{metricConfigsUniqID}
Talent Review Meeting Templates/Talent Review Meeting Template Descriptive Flexfields
The operations from the Talent Review Meeting Templates/Talent Review Meeting Template Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/dashboardTemplatesDFF
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/dashboardTemplatesDFF/{dashboardTemplatesDFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/dashboardTemplatesDFF/{dashboardTemplatesDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/dashboardTemplatesDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/dashboardTemplatesDFF/{dashboardTemplatesDFFUniqID}
Talent Succession Plans
The talentSuccessionPlans resource provides details of succession plans such as the plan name, plan type, plan status, and incumbent details.
- Find succession plans
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/action/findByAdvancedSearchQuery
- Get a succession plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/{PlanId}
- Get access info for plans
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/{PlanId}/action/getLoggedInOwnerAccessToPlan
- Get AI suggested candidates
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/action/aiCandidateRecommendations
- Get all succession plans
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans
- Get start date for current job
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/action/getInCurrentJobSinceOfWorker
- Populate incumbents for plan
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/{PlanId}/action/populateIncumbentsForPlan
- Update plan incumbents
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/talentEquivalentSuccessionPlans/{PlanId}/action/updateIncumbentsForPlan
Target Date Migrations
Date migration capability that allows the application to add configuration values (target dates) to the configuration table.
- Create a target date migration
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/targetDateMigrations
- Get a target date migration
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/targetDateMigrations/{ConfigId}
- Get all target date migrations
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/targetDateMigrations
- Update a target date migration
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/targetDateMigrations/{ConfigId}
Tasks
The tasks resource includes information about Oracle HCM Cloud tasks. It provides contextual and transactional information for the task and links to applicable additional information.
- Get a task
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/tasks/{IdentificationKey}
- Get all tasks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/tasks
Tasks/Changed Attributes
The changedAttributes resource is a child of the tasks resource. It includes attribute values that changed as a result of the transaction.
- Get a changed attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/tasks/{IdentificationKey}/child/changedAttributes/{changedAttributesUniqID}
- Get all changed attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/tasks/{IdentificationKey}/child/changedAttributes
Tax Credit Configuration in Job Requisition
The recruitingUIRequisitionTaxCreditsConfigs resource provides tax credit configuration for a requisition.
- Create a tax credit configuration for a requisition
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionTaxCreditsConfigs
- Delete a tax credit configuration for a requisition
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionTaxCreditsConfigs/{TCRequisitionConfigId}
- Get a tax credit configuration for a requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionTaxCreditsConfigs/{TCRequisitionConfigId}
- Get all tax credit configurations for a requisition
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionTaxCreditsConfigs
Time Attribute Values
The timeAttributeValues resource retrieves the list of time attribute values that the time events, time records, or schedule REST services can use.
- Get a time attribute value
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeAttributeValues/{value}
- Get all time attribute values
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeAttributeValues
Time Attributes
The timeAttributes resource retrieves the list of time attributes that the time events, time records, or schedule REST services can handle.
- Get a time attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeAttributes/{timeAttributesUniqID}
- Get all time attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeAttributes
Time Attributes/Data Source Usages
The dataSourceUsages resource is a child of the time attributes resource. It retrieves the data source usage details using the time attribute field identifier. The identifier is also used to get the time attribute values.
- Get all data sources associated with the time attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeAttributes/{timeAttributesUniqID}/child/dataSourceUsages
- Get the data source associated with the time attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeAttributes/{timeAttributesUniqID}/child/dataSourceUsages/{dataSourceUsageId}
Time Attributes/Data Source Usages/Data Source Criteria Binds
The dataSourceCriteriaBinds resource is the child of the data source usages resource, and the grandchild of the time attributes resource. It exposes the bind variables and finders required to get some time attribute values.
- Get all data source criteria binds
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeAttributes/{timeAttributesUniqID}/child/dataSourceUsages/{dataSourceUsageId}/child/dataSourceCriteriaBinds
- Get the data source criterion bind
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeAttributes/{timeAttributesUniqID}/child/dataSourceUsages/{dataSourceUsageId}/child/dataSourceCriteriaBinds/{dataSourceCriteriaBindsUniqID}
Time Event Requests
The timeEventRequests resource is a unique identifier for the time event request sent by the time collection device supplier. This request can contain one or more time events.
- Create a time event request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeEventRequests
- Get a time event request
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}
- Get all time event requests
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeEventRequests
Time Event Requests/Time Events
The timeEvents resource is a child of the timeEventRequests resource. It's a single In or Out time event that the time reporter records using a time collection device.
- Create a time event
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents
- Get a time event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents/{timeEventId}
- Get all time events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents
Time Event Requests/Time Events/Time Event Attributes
The timeEventAttributes resource is a child of the timeEvents resource and the grandchild of the timeEventsRequests resource. It's a qualifier associated with the time event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates if the time for payroll consumers must be paid.
- Create a time event attribute
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents/{timeEventId}/child/timeEventAttributes
- Get a time event attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents/{timeEventId}/child/timeEventAttributes/{timeEventAttributeId}
- Get all time event attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeEventRequests/{timeEventRequestId}/child/timeEvents/{timeEventId}/child/timeEventAttributes
Time Layout Sets
The timeLayoutSets resource provides the list of existing time layout sets.
- Get a time layout set
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}
- Get all time layout sets
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeLayoutSets
Time Layout Sets/Web Clock Layouts
The webClockLayouts resource provides the web clock layout details using the time layout set identifier.
- Get a web clock layout
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}
- Get all web clock layouts for a time layout set
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts
Time Layout Sets/Web Clock Layouts/Buttons
The buttons resource provides the button details using the web clock layout identifier.
- Get a web clock button
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons/{buttonId}
- Get all buttons for a web clock layout
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons
Time Layout Sets/Web Clock Layouts/Buttons/Time Attributes
The timeAttributes resource provides the time attributes using the web clock button identifier.
- Get a time attribute for a button
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons/{buttonId}/child/timeAttributes/{attributeId}
- Get all time attributes for a button
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons/{buttonId}/child/timeAttributes
Time Layout Sets/Web Clock Layouts/Buttons/Time Card Fields
The timeCardFields resource provides the time card fields using the web clock button identifier.
- Get a time card field for a button
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons/{buttonId}/child/timeCardFields/{timeCardFieldId}
- Get all time card fields for a button
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeLayoutSets/{layoutSetId}/child/webClockLayouts/{webClockLayoutId}/child/buttons/{buttonId}/child/timeCardFields
Time Record Event Requests
The timeRecordEventRequests resource is a unique identifier for the time record event request sent using the time records REST API. This request can contain one or more time record events.
- Create a time record event request
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests
- Get a time record event request
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}
- Get all time record event requests
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests
- Identify a time card as favorite
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/action/createFavorite
- Stop identifying a time card as favorite
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/action/deleteFavorite
Time Record Event Requests/Time Record Events
The timeRecordEvents resource is a child of the timeRecordEventRequests resource. It's a unique identifier for a time record event sent using the time records REST API. It corresponds to a time record to post in the repository. It's a range expressed as start and stop times or a quantity in hours or units, along with the associated attribution that details the kind of work performed.
- Create a time record event
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent
- Get a time record event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}
- Get all time record events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent
Time Record Event Requests/Time Record Events/Time Record Event Attributes
The timeRecordEventAttribute resource is the child of the timeRecordEvents resource and the grandchild of the timeRecordEventRequests resource. It's a qualifier associated with the time record event that reflects how time is paid, costed, billed, or recorded as an information entry. For example, the Payroll Time Type attribute indicates how the payroll consumer processes the associated time..
- Create a time record event attribute
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventAttribute
- Get a time record event attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventAttribute/{timeRecordEventAttributeId}
- Get all time record event attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventAttribute
Time Record Event Requests/Time Record Events/Time Record Event Messages
The timeRecordEventMessage resource is a child of the timeRecordEvents attribute and the grandchild of the timeRecordEventRequests resource. It's a unique identifier for the message associated with the time record event. A message gives some information on the time record event resulting from rules or validations.
- Create a time record event message
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventMessage
- Get a time record event message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventMessage/{timeRecordEventMessageId}
- Get all time record event messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/{timeRecordEventRequestId}/child/timeRecordEvent/{timeRecordEventId}/child/timeRecordEventMessage
Time Record Groups
The timeRecordGroups resource is a unique identifier for the time record group sent using the time records REST API. A time record group can contain one or more time records.
- Get a time record group
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}
- Get all time record groups
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups
Time Record Groups/Time Attributes
The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.
- Get a time record group attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeAttributes/{attributeId}
- Get all time record group attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeAttributes
Time Record Groups/Time Messages
The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.
- Get a time record group message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeMessages/{messageId}
- Get all time record group messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeMessages
Time Record Groups/Time Messages/Time Message Tokens
The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.
- Get a time record group message token
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeMessages/{messageId}/child/timeMessageTokens/{messageTokenId}
- Get all time record group message tokens
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeMessages/{messageId}/child/timeMessageTokens
Time Record Groups/Time Record Groups
The timeRecordGroups resource is a unique identifier for the time record group sent using the time records REST API. A time record group can contain one or more time records.
- Get a time record group
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}
- Get all time record groups
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups
Time Record Groups/Time Record Groups/Time Attributes
The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.
- Get a time record group attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeAttributes/{attributeId}
- Get all time record group attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeAttributes
Time Record Groups/Time Record Groups/Time Messages
The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.
- Get a time record group message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeMessages/{timeRecordGroups_messageId}
- Get all time record group messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeMessages
Time Record Groups/Time Record Groups/Time Messages/Time Message Tokens
The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.
- Get a time record group message token
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeMessages/{timeRecordGroups_messageId}/child/timeMessageTokens/{messageTokenId}
- Get all time record group message tokens
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeMessages/{timeRecordGroups_messageId}/child/timeMessageTokens
Time Record Groups/Time Record Groups/Time Record Groups
The timeRecordGroups resource is a unique identifier for the time record group sent using the time records REST API. A time record group can contain one or more time records.
- Get a time record group
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroups_timeRecordGroupId}
- Get all time record groups
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecordGroups
Time Record Groups/Time Record Groups/Time Records
The timeRecords resource is a child of the timeRecordGroups resource. It's a unique identifier for the time record sent using the time records REST API. It corresponds to either a range expressed as start and stop times or a quantity in hours or units, along with any associated attribution that details the kind of work completed.
- Get a time record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}
- Get all time records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords
Time Record Groups/Time Record Groups/Time Records/Time Attributes
The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.
- Get a time record group attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeAttributes/{attributeId}
- Get all time record group attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeAttributes
Time Record Groups/Time Record Groups/Time Records/Time Messages
The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.
- Get a time record group message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeMessages/{messageId}
- Get all time record group messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeMessages
Time Record Groups/Time Record Groups/Time Records/Time Messages/Time Message Tokens
The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.
- Get a time record group message token
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeMessages/{messageId3}/child/timeMessageTokens/{messageTokenId}
- Get all time record group message tokens
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeMessages/{messageId}/child/timeMessageTokens
Time Record Groups/Time Record Groups/Time Records/Time Statuses
The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API.
- Get a time record group status
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeStatuses/{statusId}
- Get all time record group statuses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeStatuses
Time Record Groups/Time Record Groups/Time Statuses
The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API.
- Get a time record group status
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeStatuses/{timeRecordGroups_statusId4}
- Get all time record group statuses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecordGroups/{timeRecordGroups_timeRecordGroupId}/child/timeStatuses
Time Record Groups/Time Records
The timeRecords resource is a child of the timeRecordGroups resource. It's a unique identifier for the time record sent using the time records REST API. It corresponds to either a range expressed as start and stop times or a quantity in hours or units, along with any associated attribution that details the kind of work completed.
- Get a time record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId}
- Get all time records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords
Time Record Groups/Time Records/Time Attributes
The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.
- Get a time record group attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeAttributes/{attributeId}
- Get all time record group attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeAttributes
Time Record Groups/Time Records/Time Messages
The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.
- Get a time record group message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeMessages/{messageId}
- Get all time record group messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeMessages
Time Record Groups/Time Records/Time Messages/Time Message Tokens
The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.
- Get a time record group message token
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeMessages/{messageId4}/child/timeMessageTokens/{messageTokenId}
- Get all time record group message tokens
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeMessages/{messageId}/child/timeMessageTokens
Time Record Groups/Time Records/Time Statuses
The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API.
- Get a time record group status
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId2}/child/timeStatuses/{statusId}
- Get all time record group statuses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeRecords/{timeRecordId}/child/timeStatuses
Time Record Groups/Time Statuses
The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API.
- Get a time record group status
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeStatuses/{statusId}
- Get all time record group statuses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecordGroups/{timeRecordGroupId}/child/timeStatuses
Time Records
The timeRecords resource is a child of the timeRecordGroups resource. It's a unique identifier for the time record sent using the time records REST API. It corresponds to either a range expressed as start and stop times or a quantity in hours or units, along with any associated attribution that details the kind of work completed.
- Get a time record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}
- Get all time records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecords
Time Records/Time Attributes
The timeAttributes resource is a child of the timeRecordGroups resource. It's a qualifier associated with the time record group that reflects how time is recorded as an information entry. For example, a comment can be attached to the time record group.
- Get a time record group attribute
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeAttributes/{attributeId}
- Get all time record group attributes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeAttributes
Time Records/Time Messages
The timeMessages resource is a child of the timeRecordGroups resource. It's a unique identifier for the message associated with the time record group. A message gives some information on the time record group resulting from rules or validations.
- Get a time record group message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeMessages/{messageId}
- Get all time record group messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeMessages
Time Records/Time Messages/Time Message Tokens
The timeMessageTokens resource is a child of the timeMessages resource and a great-grandchild of the timeRecordGroups resource. It's a unique identifier for the token of the message associated with the time record group.
- Get a time record group message token
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeMessages/{messageId}/child/timeMessageTokens/{messageTokenId}
- Get all time record group message tokens
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeMessages/{messageId}/child/timeMessageTokens
Time Records/Time Statuses
The timeStatuses resource is a child of the timeRecords resource and a grandchild of the timeRecordGroups resource. It's a unique identifier for the status of the time record group sent using the time records REST API.
- Get a time record group status
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeStatuses/{statusId}
- Get all time record group statuses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/timeRecords/{timeRecordId}/child/timeStatuses
Total Compensation Person Statements
The totalCompensationPersonStatements resource provides the list of all the statements for a person.
- Get a person total compensation statement
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationPersonStatements/{PersonPeriodStatementId}
- Get all person total compensation statements
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationPersonStatements
- Update a person total compensation statement
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/totalCompensationPersonStatements/{PersonPeriodStatementId}
Tracking Services
The trackingServices resource includes all external services that provide wellness-related information to the product. You can retrieve existing tracking services or create new services using this resource.
- Create a tracking service
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/trackingServices
- Delete a tracking service
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}
- Get a tracking service
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}
- Get all tracking services
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/trackingServices
- Update a tracking service
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}
Tracking Services/Authorization Artifacts
The authArtifacts resource is a child of the trackingServices resource. It includes authorization information required to access a tracking service as a specific user. It's reserved for use with internal connectors.
- Delete an authorization artifact
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts/{authArtifactsUniqID}
- Get all authorization artifacts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts
- Get an authorization artifact
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts/{authArtifactsUniqID}
Tracking Services/Authorization Artifacts/Large Object (LOB) Attributes - Artifacts
- Delete an Artifacts
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts/{authArtifactsUniqID}/enclosure/Artifacts
- Get an Artifacts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts/{authArtifactsUniqID}/enclosure/Artifacts
- Replace an Artifacts
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/child/authArtifacts/{authArtifactsUniqID}/enclosure/Artifacts
Tracking Services/Large Object (LOB) Attributes - ProtocolParams
- Delete a ProtocolParams
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/enclosure/ProtocolParams
- Get a ProtocolParams
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/enclosure/ProtocolParams
- Replace a ProtocolParams
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/trackingServices/{DisplayName}/enclosure/ProtocolParams
Transaction Security Profiles
The transactionSecurityProfiles resource provides the transaction security profiles.
- Create a transaction security profile
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles
- Create or update a transaction security profile
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/action/createOrUpdateSecurityProfile
- Delete an entry for a transaction security profile along with the associated subcategories
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/action/removeTransactionSecurityProfileEntry
- Fetch all categories
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/action/fetchCategoriesByFamily
- Fetch the list of subcategories
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/action/fetchSubcategoriesByFamilyAndCategory
- Fetches the list of product families.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/action/fetchAllFamilies
- Get a transaction security profile details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}
- Get all transaction security profile details
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles
- Modify a transaction security profile entry
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/action/manageSecurityProfileEntry
- Modify a transaction security profile with basic details
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/action/manageSecurityProfileBasicDetails
- Update a transaction security profile
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}
Transaction Security Profiles List of Values
The transactionSecurityProfilesLOV resource provides the list of values for transaction security profiles.
- Create transaction security profile not supported
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfilesLOV
- Delete transaction security profile not supported
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfilesLOV/{TransactionSecurityProfileId}
- Get a transaction security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfilesLOV/{TransactionSecurityProfileId}
- Get all transaction security profiles
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfilesLOV
- Update transaction security profile not supported
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfilesLOV/{TransactionSecurityProfileId}
Transaction Security Profiles/Transaction Security Profile Entries
The transactionSecurityProfileEntries resource is a child of the transactionSecurityProfiles resource. It provides the entries for the transaction security profile.
- Create an entry for a transaction security profile
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries
- Delete an entry for a transaction security profile
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries/{TransactionSecurityProfileEntryId}
- Get all entries for a transaction security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries
- Get an entry for a transaction security profile
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries/{TransactionSecurityProfileEntryId}
- Update an entry for a transaction security profile
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries/{TransactionSecurityProfileEntryId}
Transaction Security Profiles/Transaction Security Profile Entries/Transaction Security Profile Subcategory
The transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.
- Create a subcategory
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries/{TransactionSecurityProfileEntryId}/child/transactionSecurityProfileSubCategory
- Delete a subcategory
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries/{TransactionSecurityProfileEntryId}/child/transactionSecurityProfileSubCategory/{TransactionSecurityProfileSubCategoryId}
- Get a subcategory
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries/{TransactionSecurityProfileEntryId}/child/transactionSecurityProfileSubCategory/{TransactionSecurityProfileSubCategoryId}
- Get all subcategories
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries/{TransactionSecurityProfileEntryId}/child/transactionSecurityProfileSubCategory
- Update a subcategory
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries/{TransactionSecurityProfileEntryId}/child/transactionSecurityProfileSubCategory/{TransactionSecurityProfileSubCategoryId}
User Accounts
The userAccounts resource includes all the user accounts as of the specified date. By default, the current date is retained.
- Create a user account
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/userAccounts
- Delete a user account
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}
- Get a user account
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}
- Get all user accounts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userAccounts
- Reset a user account password
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/action/resetPassword
- Trigger roles autoprovisioning process
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/action/autoprovisionRoles
- Update a user account
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}
- Update a user account password
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/action/updatePassword
User Accounts/User Account Roles
The userAccountRoles resource is a child of the userAccounts resource. It includes all the user account roles as of the specified date. By default, the current date is retained.
- Create a role assignment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/child/userAccountRoles
- Delete a role assignment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/child/userAccountRoles/{UserRoleId}
- Get a role assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/child/userAccountRoles/{UserRoleId}
- Get all role assignments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userAccounts/{GUID}/child/userAccountRoles
User Column Instances
The userColumnInstances resource returns a list of user column instances.
- Create a user column instance.
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/userColumnInstances
- Delete a user column instance.
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/userColumnInstances/{userColumnInstancesUniqID}
- Get a user column instance.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userColumnInstances/{userColumnInstancesUniqID}
- Get user column instances.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userColumnInstances
- Update user column instance.
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/userColumnInstances/{userColumnInstancesUniqID}
User Table Detail Values
The userTableDetailValues resource returns a list of user table detail values.
- Get a user table detail value.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userTableDetailValues/{UserTableId}
- Get all user table detail values.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userTableDetailValues
User Table Details
The userTableDetails resource returns a list of user defined tables.
- Get a user defined table.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userTableDetails/{UserTableId}
- Get all user defined tables.
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/userTableDetails
Web Clock Events
The webClockEvents resource lets you create and view web clock events for employees.
- Create a web clock event
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/webClockEvents
- Get a web clock event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/webClockEvents/{webClockClickId}
- Get all web clock events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/webClockEvents
Web Clock Events/Time Card Fields
The timeCardFields resource is a child of the webClockEvents resource, used to create and view the time card fields for a web clock event.
- Create a time card field
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/webClockEvents/{webClockClickId}/child/timeCardFields
- Get a time card field
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/webClockEvents/{webClockClickId}/child/timeCardFields/{timeCardFieldsUniqID}
- Get all time card fields
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/webClockEvents/{webClockClickId}/child/timeCardFields
Wellness Activities
The wellnessActivities resource includes activities that improve physical well-being. Currently, only daily activity summaries can be added using the REST API.
- Create a wellness activity
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/wellnessActivities
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/wellnessActivities
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/wellnessActivities/{wellnessActivitiesUniqID}
Wellness Activities/Activity Measures
The activityMeasures resource is a child of the wellnessActivities resource. It includes measures to track fitness activities. For example, a daily activity summary includes a value for the number of steps equivalent to the activities recorded for that day, as well as the time spent at low, moderate, and high activity levels.
- Create an activity measure
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/wellnessActivities/{wellnessActivitiesUniqID}/child/activitymeasures
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/wellnessActivities/{wellnessActivitiesUniqID}/child/activitymeasures
- GET action not supported
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/wellnessActivities/{wellnessActivitiesUniqID}/child/activitymeasures/{activitymeasuresUniqID}
Worker Journey Tasks
The workerJourneyTasks resource provides all the tasks for a worker journey, where the task performer is the logged in person.
- Check task completion
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/checkTaskCompletion
- Create a journey task
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}
- Delete a journey task
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}
- Get a journey task
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}
- Get all journey tasks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks
- Initiate a process task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/invokeProcessAutomation
- Navigate to a task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/generateNavigationURL
- Navigate to an application task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/generateNavigationDetails
- Reassign a task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/reassign
- Send a task reminder
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/sendReminder
- Update journey tasks
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks
- Upload a document
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/copyToDocumentRecords
- User-defined content of a task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/action/generateContent
Worker Journey Tasks/Allocated Checklist Task Attributes
The operations from the Worker Journey Tasks/Allocated Checklist Task Attributes category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/tasksDFF
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/tasksDFF/{AllocatedTaskId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/tasksDFF/{AllocatedTaskId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/tasksDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/tasksDFF/{AllocatedTaskId}
Worker Journey Tasks/Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/attachments
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/documents
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/attachments/{attachmentsUniqID}
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/documents/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/attachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/documents
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/attachments/{attachmentsUniqID}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/documents/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/documents/{attachmentsUniqID}
Worker Journey Tasks/Candidate Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileContents
Worker Journey Tasks/Candidate Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileWebImage
Worker Journey Tasks/Large Object (LOB) Attributes - AddToCalendar
- Get an AddToCalendar
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/enclosure/AddToCalendar
Worker Journey Tasks/Large Object (LOB) Attributes - Notes
- Delete a Notes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/enclosure/Notes
- Get a Notes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/enclosure/Notes
- Replace a Notes
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/enclosure/Notes
Worker Journey Tasks/Large Object (LOB) Attributes - SignatureImageData
- Delete a SignatureImageData
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/enclosure/SignatureImageData
- Get a SignatureImageData
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/enclosure/SignatureImageData
- Replace a SignatureImageData
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/enclosure/SignatureImageData
Worker Journey 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: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/learningItems/{workerJourneyTasks_learningItems_Id}
- Get all learning content items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/learningItems
Worker Journey 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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/notifications
- Get a notification
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/notifications/{WorkerJourneyTaskNotificationId}
- Get all notifications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/notifications
- Update a notification
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/notifications/{WorkerJourneyTaskNotificationId}
Worker Journey Tasks/Properties
The properties resource is a child of the tasks resource. It includes display property settings for a task.
- Create a task property
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/properties
- Get a task property
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/properties/{propertiesUniqID}
- Get all task properties
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/properties
- Update a task property
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/properties/{propertiesUniqID}
Worker Journey 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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Worker Journey 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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Worker Journey Tasks/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Worker Journey 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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get a response attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
- Get all response attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Worker Journey Tasks/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Worker Journey Tasks/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneyTasks/{workerJourneyTasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Worker Journeys
The workerJourneys resource includes all the journeys of a worker.
- Add a library task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/action/addTaskFromLibrary
- Allocate a journey
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/action/assignJourney
- Assign a contextual journey
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/action/assignContextualJourney
- Create a worker journey
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys
- Delete a worker journey
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}
- Find a contextual journey
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/action/findOrAssignContextualJourney
- Force complete a journey
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/action/forceComplete
- Get a worker journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}
- Get all worker journeys
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys
- Get journey allocation status details
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/action/getJourneyAllocationDetails
- Update a journey
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}
Worker 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: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks/{allStepTasksUniqID}
- Get all step tasks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks
Worker Journeys/All Step Tasks/Large Object (LOB) Attributes - Notes
- Delete a Notes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks/{allStepTasksUniqID}/enclosure/Notes
- Get a Notes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks/{allStepTasksUniqID}/enclosure/Notes
- Replace a Notes
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/allStepTasks/{allStepTasksUniqID}/enclosure/Notes
Worker Journeys/Contacts
The contacts resource is a child of the workerJourneys resource. It includes a list of contacts associated with the worker journey.
- Get a contact
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/contacts/{WorkerJourneyContactId}
- Get all contacts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/contacts
Worker Journeys/Events
The events resource is a child of the workerJourneys resource. It includes a list of events associated with the worker journey.
- Get all events
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/events
- Get an event
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/events/{WorkerJourneyEventId}
Worker Journeys/Journey Task Properties
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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/properties
- Get a property in an assigned journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/properties/{propertiesUniqID}
- Get all properties in an assigned journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/properties
- Update all properties in an assigned journey
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/properties/{propertiesUniqID}
Worker Journeys/Notes
The notes resource is a child of the workerJourneys resource. It includes the notes associated with the worker journey.
- Get a note
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/notes/{WorkerJourneyNoteId}
- Get all notes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/notes
Worker Journeys/Task Counts
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: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskCounts/{WorkerJourneyId2}
- Get all task counts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskCounts
Worker 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 an assigned journey
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes
- Get a task type in an assigned journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}
- Get all task types in an assigned journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes
- Update all task types in an assigned journey
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}
Worker Journeys/Task Types/Journey Task Properties
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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}/child/properties
- Get a task type property in an assigned journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}/child/properties/{propertiesUniqID}
- Get all task type properties in an assigned journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}/child/properties
- Update a task type property in an assigned journey
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/taskTypes/{Code}/child/properties/{propertiesUniqID}
Worker 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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/checkTaskCompletion
- Create a task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks
- Delete a task
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}
- Get a task
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}
- Get all tasks
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks
- Initiate process automation
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/invokeProcessAutomation
- Navigate to a task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/generateNavigationURL
- Navigate to an application task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/generateNavigationDetails
- Reassign a task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/reassign
- Send a task reminder
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/sendReminder
- Update a task
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}
- Update status
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/updateStatus
- Upload a document
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/copyToDocumentRecords
- User-defined content of a task
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/action/generateContent
Worker Journeys/Tasks/Allocated Checklist Task Attributes
The operations from the Worker Journeys/Tasks/Allocated Checklist Task Attributes category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/tasksDFF
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/tasksDFF/{AllocatedTaskId}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/tasksDFF/{AllocatedTaskId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/tasksDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/tasksDFF/{AllocatedTaskId}
Worker Journeys/Tasks/Candidate Attachments
The addresses resource is the child of the recruitingUICandidates resource and provides information about the addresses of a candidate.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}
Worker Journeys/Tasks/Candidate Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileContents
Worker Journeys/Tasks/Candidate Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/documents/{attachmentsUniqID}/enclosure/FileWebImage
Worker Journeys/Tasks/Journey Task Properties
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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/properties
- Get a task property in an assigned journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/properties/{propertiesUniqID}
- Get all task properties in an assigned journey
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/properties
- Update all task properties in an assigned journey
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/properties/{propertiesUniqID}
Worker Journeys/Tasks/Large Object (LOB) Attributes - AddToCalendar
- Get an AddToCalendar
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/AddToCalendar
Worker Journeys/Tasks/Large Object (LOB) Attributes - Notes
- Delete a Notes
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/Notes
- Get a Notes
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/Notes
- Replace a Notes
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/Notes
Worker Journeys/Tasks/Large Object (LOB) Attributes - SignatureImageData
- Delete a SignatureImageData
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/SignatureImageData
- Get a SignatureImageData
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/SignatureImageData
- Replace a SignatureImageData
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/enclosure/SignatureImageData
Worker 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: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/learningItems/{workerJourneys_tasks_learningItems_Id}
- Get all learning content items
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/learningItems
Worker 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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/notifications
- Get a notification
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/notifications/{WorkerJourneyTaskNotificationId}
- Get all notifications
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/notifications
- Update a notification
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/notifications/{WorkerJourneyTaskNotificationId}
Worker 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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses
- Get a questionnaire response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
- Get all questionnaire responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses
- Update a questionnaire response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}
Worker 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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Get a question response
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
- Get all question responses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses
- Update a question response
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}
Worker Journeys/Tasks/Questionnaire Responses/Question Responses/Large Object (LOB) Attributes - AnswerLargeObject
- Delete an AnswerLargeObject
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Get an AnswerLargeObject
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
- Replace an AnswerLargeObject
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/enclosure/AnswerLargeObject
Worker 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: postPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Delete a response attachment
- Method: deletePath:
/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: getPath:
/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: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments
- Update a response attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}
Worker Journeys/Tasks/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/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: getPath:
/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: putPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileContents
Worker Journeys/Tasks/Questionnaire Responses/Question Responses/Question Response Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workerJourneys/{WorkerJourneyId}/child/tasks/{tasksUniqID}/child/questionnaireResponses/{QuestionnaireResponseId}/child/questionResponses/{QuestionResponseId}/child/questionResponseAttachments/{questionResponseAttachmentsUniqID}/enclosure/FileWebImage
Workers
The workers resource provides all the worker records as of the specified date. Worker types include employee, contingent worker, and pending worker. By default, the current date is retained.
Operations to create and update worker records in Oracle Fusion Cloud HCM involve various postprocessing steps across products. Therefore, these operations may take several minutes to complete.
For bulk load and extract operations, you must use HCM Data Loader and HCM Extracts, respectively.
Also, you should not 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.
Operations to create and update worker records in Oracle Fusion Cloud HCM involve various postprocessing steps across products. Therefore, these operations may take several minutes to complete.
For bulk load and extract operations, you must use HCM Data Loader and HCM Extracts, respectively.
Also, you should not use REST APIs for detecting data changes in the application. Instead, use Atom feeds to detect or identify changes made to data for key transactions in Oracle Fusion Cloud HCM.
For example, you may use Atom feeds to detect changes in employee's personal details, employment data, new hires, and terminations. See the Atom Feeds section for details about delivered feeds in Oracle Fusion Cloud HCM.
- Create a worker
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers
- Get a worker
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}
- Get all workers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers
- Update a worker
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}
Workers/Addresses
The addresses resource is a child of the workers resource. It provides all the addresses of a worker as of the specified date. By default, the current date is retained.
- Create a worker address
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses
- Delete a worker address
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}
- Get a worker address
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}
- Get all worker addresses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses
- Update a worker address
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}
Workers/Addresses/Person Address Usage Descriptive Flexfields
The operations from the Workers/Addresses/Person Address Usage Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF/{addressesDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/addresses/{addressesUniqID}/child/addressesDFF/{addressesDFFUniqID}
Workers/Citizenships
The citizenships resource is a child of the workers resource. It provides all the citizenships of a worker as of the specified date. By default, the current date is retained.
- Create a worker citizenship
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships
- Delete a worker citizenship
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}
- Get a worker citizenship
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}
- Get all worker citizenships
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships
- Update a worker citizenship
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}
Workers/Citizenships/Person Citizenships Descriptive Flexfields
The operations from the Workers/Citizenships/Person Citizenships Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF/{CitizenshipId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/citizenships/{CitizenshipId}/child/citizenshipsDFF/{CitizenshipId2}
Workers/Disabilities
The disabilities resource is a child of the workers resource. It provides all the worker disabilities as of the specified date. By default, the current date is retained.
- Create a worker disability
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities
- Delete a worker disability
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}
- Get a worker disability
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}
- Get all worker disabilities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities
- Update a worker disability
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}
Workers/Disabilities/Attachments
The attachments resource is used to view, create, and update attachments.
- Create an attachment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments
- Delete an attachment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}
- Get all attachments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments
- Get an attachment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}
- Update an attachment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}
Workers/Disabilities/Attachments/Large Object (LOB) Attributes - FileContents
- Delete a FileContents
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Get a FileContents
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
- Replace a FileContents
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Workers/Disabilities/Attachments/Large Object (LOB) Attributes - FileWebImage
- Get a FileWebImage
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Workers/Disabilities/Person Disabilities Developer Descriptive Flexfields
The operations from the Workers/Disabilities/Person Disabilities Developer Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/disabilitiesDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/disabilitiesDDF/{disabilitiesDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/disabilitiesDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/disabilities/{disabilitiesUniqID}/child/disabilitiesDDF/{disabilitiesDDFUniqID}
Workers/Driver Licenses
The driverLicenses resource is a child of the workers resource. It provides all the driver licenses of a worker as of the specified date. By default, the current date is retained.
- Create a worker drivers license
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses
- Delete a worker drivers license
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}
- Get a worker drivers license
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}
- Get all worker drivers licenses
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses
- Update a worker drivers license
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}
Workers/Driver Licenses/Person Driver Licenses Descriptive Flexfields
The operations from the Workers/Driver Licenses/Person Driver Licenses Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF/{DriversLicenseTypeId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDFF/{DriversLicenseTypeId}
Workers/Driver Licenses/Person Driver Licenses Developer Descriptive Flexfields
The operations from the Workers/Driver Licenses/Person Driver Licenses Developer Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF/{DriversLicenseId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/driverLicenses/{driverLicensesUniqID}/child/driverLicensesDDF/{DriversLicenseId}
Workers/Emails
The emails resource is a child of the workers resource. It provides all the emails of a worker as of the specified date. By default, the current date is retained.
- Create a worker email
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails
- Delete a worker email
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}
- Get a worker email
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}
- Get all worker emails
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails
- Update a worker email
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}
Workers/Emails/Person Emails Descriptive Flexfields
The operations from the Workers/Emails/Person Emails Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}/child/emailsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}/child/emailsDFF/{EmailAddressId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}/child/emailsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/emails/{EmailAddressId}/child/emailsDFF/{EmailAddressId2}
Workers/Ethnicities
The ethnicities resource is a child of the workers resource. It provides all the ethnicities of a worker as of the specified date. By default, the current date is retained.
- Create a worker ethnicity
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities
- Delete a worker ethnicity
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}
- Get a worker ethnicity
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}
- Get all worker ethnicities
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities
- Update a worker ethnicity
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}
Workers/Ethnicities/Person Ethnicities Descriptive Flexfields
The operations from the Workers/Ethnicities/Person Ethnicities Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF/{EthnicityId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/ethnicities/{EthnicityId}/child/ethnicitiesDFF/{EthnicityId2}
Workers/External Identifiers
The externalIdentifiers resource is a child of the workers resource. It provides all the external identifiers of a worker as of the specified date. By default, the current date is retained.
- Create a worker external identifier
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers
- Delete a worker external identifier
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers/{ExternalIdentifierId}
- Get a worker external identifier
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers/{ExternalIdentifierId}
- Get all worker external identifiers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers
- Update a worker external identifier
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/externalIdentifiers/{ExternalIdentifierId}
Workers/Legislative Information
The legislativeInfo resource is a child of the workers resource. It provides the legislative information of a worker as of the specified date. By default, the current date is retained.
- Create a worker legislative record
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo
- Delete a worker legislative record
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
- Get a worker legislative record
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
- Get all worker legislative records
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo
- Update a worker legislative record
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}
Workers/Legislative Information/Person Legislative Descriptive Flexfields
The operations from the Workers/Legislative Information/Person Legislative Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF/{legislativeInfoDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDFF/{legislativeInfoDFFUniqID}
Workers/Legislative Information/Person Legislative Developer Descriptive Flexfields
The operations from the Workers/Legislative Information/Person Legislative Developer Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF/{legislativeInfoDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/legislativeInfo/{legislativeInfoUniqID}/child/legislativeInfoDDF/{legislativeInfoDDFUniqID}
Workers/Messages
The messages resource is a child of the workers resource. It provides all the available messages of a worker.
- Create a worker message
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/messages
- Delete a worker message
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/messages/{MessageId}
- Get a worker message
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/messages/{MessageId}
- Get all worker messages
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/messages
- Update a worker message
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/messages/{MessageId}
Workers/Names
The names resource is a child of the workers resource. It provides all the names of a worker as of the specified date. By default, the current date is retained.
- Create a worker name
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names
- Delete a worker name
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names/{namesUniqID}
- Get a worker name
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names/{namesUniqID}
- Get all worker names
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names
- Update a worker name
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/names/{namesUniqID}
Workers/National Identifiers
The nationalIdentifiers resource is a child of the workers resource. It provides all the national identifiers of a worker as of the specified date. By default, the current date is retained.
- Create a worker national identifier
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers
- Delete a worker national identifier
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
- Get a worker national identifier
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
- Get all worker national identifiers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers
- Update a worker national identifier
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}
Workers/National Identifiers/Person National Identifiers Descriptive Flexfields
The operations from the Workers/National Identifiers/Person National Identifiers Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF/{NationalIdentifierId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/nationalIdentifiers/{NationalIdentifierId}/child/nationalIdentifiersDFF/{NationalIdentifierId2}
Workers/Other Communication Accounts
The otherCommunicationAccounts resource is a child of the workers resource. It provides all the other communication accounts of a worker as of the specified date. By default, the current date is retained.
- Create a worker communication account
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts
- Delete a worker communication account
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
- Get a worker communication account
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
- Get all worker communication accounts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts
- Update a worker communication account
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}
Workers/Other Communication Accounts/Person Other Communication Accounts Descriptive Flexfields
The operations from the Workers/Other Communication Accounts/Person Other Communication Accounts Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF/{DeliveryMethodId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/otherCommunicationAccounts/{DeliveryMethodId}/child/otherCommunicationAccountsDFF/{DeliveryMethodId2}
Workers/Passports
The passports resource is a child of the workers resource. It provides all worker of a worker as of the specified date. By default, the current date is retained.
- Create a worker passport
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports
- Delete a worker passport
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}
- Get a worker passport
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}
- Get all worker passports
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports
- Update a worker passport
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}
Workers/Passports/Person Passports Developer Descriptive Flexfields
The operations from the Workers/Passports/Person Passports Developer Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}/child/passportsDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}/child/passportsDDF/{PassportId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}/child/passportsDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/passports/{PassportId}/child/passportsDDF/{PassportId2}
Workers/Person Descriptive Flexfields
The operations from the Workers/Person Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersDFF/{PersonId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersDFF/{PersonId}
Workers/Person Extra Information Extensible Flexfields
The operations from the Workers/Person Extra Information Extensible Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersEFF
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersEFF/{workersEFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersEFF/{workersEFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersEFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workersEFF/{workersEFFUniqID}
Workers/Phones
The phones resource is a child of the workers resource. It provides all the phones of a worker as of the specified date. By default, the current date is retained.
- Create a worker phone
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones
- Delete a worker phone
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}
- Get a worker phone
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}
- Get all worker phones
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones
- Update a worker phone
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}
Workers/Phones/Person Phones Descriptive Flexfields
The operations from the Workers/Phones/Person Phones Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}/child/phonesDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}/child/phonesDFF/{PhoneId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}/child/phonesDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/phones/{PhoneId}/child/phonesDFF/{PhoneId2}
Workers/Photos
The photo resource is a child of the workers resource. It provides the all photos of a worker as of the specified date. By default, the current date is retained.
- Create a worker photo
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos
- Delete a worker photo
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}
- Get a worker photo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}
- Get all worker photos
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos
- Update a worker photo
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}
Workers/Photos/Large Object (LOB) Attributes - Photo
- Delete a Photo
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/enclosure/Photo
- Get a Photo
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/enclosure/Photo
- Replace a Photo
- Method: putPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/enclosure/Photo
Workers/Photos/Person Photos Descriptive Flexfields
The operations from the Workers/Photos/Person Photos Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/child/photosDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/child/photosDFF/{ImageId}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/child/photosDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/photos/{PhotoId}/child/photosDFF/{ImageId}
Workers/Religions
The religions resource is a child of the workers resource. It provides all the religions of a worker as of the specified date. By default, the current date is retained.
- Create a worker religion
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions
- Delete a worker religion
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}
- Get a worker religion
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}
- Get all worker religions
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions
- Update a worker religion
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}
Workers/Religions/Person Religions Descriptive Flexfields
The operations from the Workers/Religions/Person Religions Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}/child/religionsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}/child/religionsDFF/{ReligionId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}/child/religionsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/religions/{ReligionId}/child/religionsDFF/{ReligionId2}
Workers/Visa Permits
The visasPermits resource is a child of the workers resource. It provides all the visas and permits of a worker as of the specified date. By default, the current date is retained.
- Create a worker visa permit
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits
- Delete a worker visa permit
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}
- Get a worker visa permit
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}
- Get all worker visas permits
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits
- Update a worker visa permit
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}
Workers/Visa Permits/Person Visas and Permits Descriptive Flexfields
The operations from the Workers/Visa Permits/Person Visas and Permits Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF/{visasPermitsDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDFF/{visasPermitsDFFUniqID}
Workers/Visa Permits/Person Visas and Permits Developer Descriptive Flexfields
The operations from the Workers/Visa Permits/Person Visas and Permits Developer Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF/{visasPermitsDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/visasPermits/{visasPermitsUniqID}/child/visasPermitsDDF/{visasPermitsDDFUniqID}
Workers/Work Relationships
The workRelationships resource is a child of the workers resource. It provides all the work relationships of a worker as of the specified date. By default, the current date is retained.
- Add a temporary assignment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/addTemporaryAssignment
- Cancel a work relationship
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/cancelWorkRelationship
- Change the legal employer or create a temporary assignment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/changeLegalEmployer
- Change the primary flag of a work relationship
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/changePrimaryFlag
- Change the start date of a work relationship
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/changeStartDate
- Correct a worker termination
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/correctTermination
- Create a worker work relationship
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships
- Get a worker work relationship
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}
- Get all worker work relationships
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships
- Reverse a worker termination
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/reverseTermination
- Terminate a worker
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/action/terminate
- Update a worker work relationship
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}
Workers/Work Relationships/Assignments
The assignments resource is a child of the workRelationships resource. It provides all the worker assignments as of the specified date. By default, the current date is retained.
- Create a worker assignment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments
- Delete a worker assignment
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}
- End a worker assignment
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/action/endAssignment
- Get a worker assignment
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}
- Get all worker assignments
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments
- Update a worker assignment
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}
Workers/Work Relationships/Assignments/All Reports
The allReports resource is a child of the assignments resource. It provides all the reports of a worker as of the specified date. By default, the current date is retained.
- Get a worker report
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/allReports/{allReportsUniqID}
- Get all worker reports
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/allReports
Workers/Work Relationships/Assignments/Assignment Descriptive Flexfields
The operations from the Workers/Work Relationships/Assignments/Assignment Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDDF/{assignmentsDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDDF/{assignmentsDDFUniqID}
Workers/Work Relationships/Assignments/Assignment Extensible Flexfields
The operations from the Workers/Work Relationships/Assignments/Assignment Extensible Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF
- Delete
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF/{assignmentsEFFUniqID}
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF/{assignmentsEFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsEFF/{assignmentsEFFUniqID}
Workers/Work Relationships/Assignments/Assignment Legislative Descriptive Flexfields
The operations from the Workers/Work Relationships/Assignments/Assignment Legislative Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDFF/{assignmentsDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/assignmentsDFF/{assignmentsDFFUniqID}
Workers/Work Relationships/Assignments/Grade Steps
The gradeSteps resource is a child of the assignments resource. It provides all the assignment grade steps of a worker as of the specified date. By default, the current date is retained.
- Create an assignment grade step
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/gradeSteps
- Delete an assignment grade step
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/gradeSteps/{gradeStepsUniqID}
- Get all assignment grade steps
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/gradeSteps
- Get an assignment grade step
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/gradeSteps/{gradeStepsUniqID}
- Update an assignment grade step
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/gradeSteps/{gradeStepsUniqID}
Workers/Work Relationships/Assignments/Managers
The managers resource is a child of the assignments resource. It provides all the assignment managers of a worker as of the specified date. By default, the current date is retained.
- Create an assignment manager
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/managers
- Delete an assignment manager
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/managers/{managersUniqID}
- Get all assignment managers
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/managers
- Get an assignment manager
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/managers/{managersUniqID}
- Update an assignment manager
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/managers/{managersUniqID}
Workers/Work Relationships/Assignments/Representatives
The representatives resource is a child of the assignments resource. It provides all the representatives of a worker as of the specified date. By default, the current date is retained.
- Get a worker representative
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/representatives/{AsgResponsibilityId}
- Get all worker representatives
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/representatives
Workers/Work Relationships/Assignments/Work Measures
The workMeasures resource is a child of the assignments resource. It provides all the assignment work measures of a worker as of the specified date. By default, the current date is retained.
- Create an assignment work measure
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures
- Delete an assignment work measure
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures/{workMeasuresUniqID}
- Get all assignment work measures
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures
- Get an assignment work measure
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures/{workMeasuresUniqID}
- Update an assignment work measure
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/assignments/{assignmentsUniqID}/child/workMeasures/{workMeasuresUniqID}
Workers/Work Relationships/Contracts
The contracts resource is a child of the workRelationships resource and you can create or edit a contract only with an assignment. The resource provides all the contracts of a worker as of the specified date. By default, the current date is retained.
- Create a worker contract
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts
- Delete a worker contract
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}
- Get a worker contract
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}
- Get all worker contracts
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts
- Update a worker contract
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}
Workers/Work Relationships/Contracts/Employment Contracts Descriptive Flexfields
The operations from the Workers/Work Relationships/Contracts/Employment Contracts Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDFF/{contractsDFFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDFF/{contractsDFFUniqID}
Workers/Work Relationships/Contracts/Employment Contracts Legislative Descriptive Flexfields
The operations from the Workers/Work Relationships/Contracts/Employment Contracts Legislative Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDDF/{contractsDDFUniqID}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/contracts/{contractsUniqID}/child/contractsDDF/{contractsDDFUniqID}
Workers/Work Relationships/Work Relationship Descriptive Flexfields
The operations from the Workers/Work Relationships/Work Relationship Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDDF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDDF/{PeriodOfServiceId2}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDDF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDDF/{PeriodOfServiceId2}
Workers/Work Relationships/Work Relationship Legislative Descriptive Flexfields
The operations from the Workers/Work Relationships/Work Relationship Legislative Descriptive Flexfields category.
- Create
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDFF
- Get
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDFF/{PeriodOfServiceId3}
- Get all
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDFF
- Update
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workers/{workersUniqID}/child/workRelationships/{PeriodOfServiceId}/child/workRelationshipsDFF/{PeriodOfServiceId3}
Workload Plan
Create new workload plan
- Create new workload plan
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workloadPlans
- Delete workload plan
- Method: deletePath:
/hcmRestApi/resources/11.13.18.05/workloadPlans/{WorkloadPlanId}
- Find the workload plans matching the specified criteria
- Method: postPath:
/hcmRestApi/resources/11.13.18.05/workloadPlans/action/findByAdvancedSearchQuery
- Get a single workload plan
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workloadPlans/{WorkloadPlanId}
- Get all workload plans
- Method: getPath:
/hcmRestApi/resources/11.13.18.05/workloadPlans
- Update workload plan
- Method: patchPath:
/hcmRestApi/resources/11.13.18.05/workloadPlans/{WorkloadPlanId}