Update a selected course offering

patch

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the (completionDetails) resource and used to uniquely identify an instance of (completionDetails). The client should not generate the hash key value. Instead, the client should query on the (completionDetails) collection resource in order to navigate to a specific instance of (completionDetails) to get the hash key.
  • This is the hash key of the attributes which make up the composite key for the (learnerLearningRecords) resource and used to uniquely identify an instance of (learnerLearningRecords). The client should not generate the hash key value. Instead, the client should query on the (learnerLearningRecords) collection resource in order to navigate to a specific instance of (learnerLearningRecords) to get the hash key.
  • This is the hash key of the attributes which make up the composite key for the (selectedCourseOfferings) resource and used to uniquely identify an instance of (selectedCourseOfferings). The client should not generate the hash key value. Instead, the client should query on the (selectedCourseOfferings) collection resource in order to navigate to a specific instance of (selectedCourseOfferings) to get the hash key.
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Active Learner Comments
Type: array
Title: Active Learner Comments
The comments resource provides details of all comments by active and completed learners for the learning item.
Show Source
Nested Schema : Approval Details
Type: array
Title: Approval Details
The approvalDetails resource provides the approval details for the learning assignment.
Show Source
Nested Schema : User Access Person Details
Type: array
Title: User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : assignmentDFF
Type: array
Show Source
Nested Schema : Completion Details
Type: array
Title: 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.
Show Source
Nested Schema : Completion Summaries
Type: array
Title: 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.
Show Source
Nested Schema : Enrollment History
Type: array
Title: Enrollment History
The enrollmentHistory resource provides the enrollment history details for the learning assignment.
Show Source
Nested Schema : Enrollment Related Materials
Type: array
Title: Enrollment Related Materials
The attachments resource provides the related learning materials for the parent resource.
Show Source
Nested Schema : Errors
Type: array
Title: 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.
Show Source
Nested Schema : learningItemDFF
Type: array
Show Source
Nested Schema : Learning Item Rating Details
Type: array
Title: Learning Item Rating Details
The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status.
Show Source
Nested Schema : Related Materials
Type: array
Title: Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
Show Source
Nested Schema : Messages
Type: array
Title: 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.
Show Source
Nested Schema : offeringDFF
Type: array
Show Source
Nested Schema : Offering Primary Classrooms
Type: array
Title: Offering Primary Classrooms
The offeringPrimaryClassroom resource provides primary classroom details for the ILT or blended learning offering.
Show Source
Nested Schema : Offering Primary Instructors
Type: array
Title: 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
Show Source
Nested Schema : Questionnaire Responses
Type: array
Title: Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : Transaction Histories
Type: array
Title: Transaction Histories
The transactionHistory resource provides the transaction history for its parent resource. Details include transaction identifier, transaction number, transaction date, and transaction reason.
Show Source
Nested Schema : User Action Hints
Type: array
Title: User Action Hints
Hints for possible actions on a learner's assignment records.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-item-patch-request
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Comment
    Maximum Length: 4000
    Learner comment in conversations for active and completed learning item learners.
  • Title: Comment Status
    Maximum Length: 30
    Learner comment status in conversations for active and completed learning item learners. Valid values are defined in the CommentStatusLOV list.
  • Title: Data Security Privilege
    Default Value: ORA_LEARNER
    Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
  • Likes
    Title: Likes
    The likes resource provides details of the likes for comments by active and completed learners for the learning item.
  • Replies
    Title: Replies
    The replies resource provides details of the replies to comments by active and completed learners for the learning item.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Likes
Type: array
Title: Likes
The likes resource provides details of the likes for comments by active and completed learners for the learning item.
Show Source
Nested Schema : Replies
Type: array
Title: Replies
The replies resource provides details of the replies to comments by active and completed learners for the learning item.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-attachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-item-patch-request
Type: object
Show Source
  • Title: Like Status
    Maximum Length: 30
    Status for the comment like. Valid values are defined in the LikeStatusLOV list.
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-item-patch-request
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Comment
    Maximum Length: 4000
    Learner reply to a comment.
  • Title: Data Security Privilege
    Default Value: ORA_LEARNER
    Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
  • Likes
    Title: Likes
    The likes resource provides details of the likes for comments by active and completed learners for the learning item.
  • Title: Reply Status
    Maximum Length: 30
    Status of the reply to a comment. Valid values are defined in the ReplyStatusLOV list.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Likes
Type: array
Title: Likes
The likes resource provides details of the likes for comments by active and completed learners for the learning item.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-patch-request
Type: object
Show Source
  • Title: Like Status
    Maximum Length: 30
    Status for the comment like. Valid values are defined in the LikeStatusLOV list.
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-approvalDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-assignerPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-assignmentDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-item-patch-request
Type: object
Show Source
Nested Schema : Activity Completion Predecessor Hints
Type: array
Title: Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.
Show Source
Nested Schema : Activity Content Attempts
Type: array
Title: 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.
Show Source
Nested Schema : Activity Section Completion Predecessor Hints
Type: array
Title: Activity Section Completion Predecessor Hints
The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.
Show Source
Nested Schema : Classrooms
Type: array
Title: 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.
Show Source
Nested Schema : Instructors
Type: array
Title: Instructors
The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
Show Source
Nested Schema : Offered Languages
Type: array
Title: Offered Languages
The offeredLanguages resource provides the offering language for a learning item.
Show Source
Nested Schema : Offered Locations
Type: array
Title: Offered Locations
The offeredLocations resource provides the location details for a learning item.
Show Source
Nested Schema : Questionnaire Responses
Type: array
Title: Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : Related Materials
Type: array
Title: Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-item-patch-request
Type: object
Show Source
Nested Schema : Questionnaire Responses
Type: array
Title: Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-item-patch-request
Type: object
Show Source
  • Title: Questionnaire Version
    Version number of the questionnaire that the participant responds to.
  • Question Responses
    Title: Question Responses
    The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
  • Title: Response Status Code
    Maximum Length: 30
    Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-item-patch-request
Type: object
Show Source
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-patch-request
Type: object
Show Source
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activitySectionCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-classrooms-item-patch-request
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : classroomDFFs
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-classrooms-attachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-classrooms-classroomDFFs-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-instructors-item-patch-request
Type: object
Show Source
Nested Schema : instructorDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-instructors-instructorDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-offeredLanguages-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-offeredLocations-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Questionnaire Version
    Version number of the questionnaire that the participant responds to.
  • Question Responses
    Title: Question Responses
    The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
  • Title: Response Status Code
    Maximum Length: 30
    Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-questionnaireResponses-questionResponses-item-patch-request
Type: object
Show Source
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-patch-request
Type: object
Show Source
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-relatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionSummary-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-enrollmentHistory-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-enrollmentRelatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-errors-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-learningItemDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-learningItemRatingDetails-item-patch-request
Type: object
Show Source
Nested Schema : User Access Person Details
Type: array
Title: User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-learningItemRatingDetails-ratedByPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-learningItemRelatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-messages-item-patch-request
Type: object
Show Source
  • Title: Data Security Privilege
    Maximum Length: 32
    Data security privilege, such as Learner or Learner Manager, that identifies the intent and permissions for the person accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringPrimaryClassroom-item-patch-request
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : classroomDFFs
Type: array
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringPrimaryClassroom-classroomDFFs-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringPrimaryInstructor-item-patch-request
Type: object
Show Source
Nested Schema : instructorDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringPrimaryInstructor-instructorDFF-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Questionnaire Version
    Version number of the questionnaire that the participant responds to.
  • Question Responses
    Title: Question Responses
    The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
  • Title: Response Status Code
    Maximum Length: 30
    Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-patch-request
Type: object
Show Source
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-transactionHistory-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-userActionHints-item-patch-request
Type: object
Show Source
  • Title: Data Security Privilege
    Maximum Length: 32
    Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-item-response
Type: object
Show Source
Nested Schema : Active Learner Comments
Type: array
Title: Active Learner Comments
The comments resource provides details of all comments by active and completed learners for the learning item.
Show Source
Nested Schema : Approval Details
Type: array
Title: Approval Details
The approvalDetails resource provides the approval details for the learning assignment.
Show Source
Nested Schema : User Access Person Details
Type: array
Title: User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : assignmentDFF
Type: array
Show Source
Nested Schema : Completion Details
Type: array
Title: 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.
Show Source
Nested Schema : Completion Summaries
Type: array
Title: 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.
Show Source
Nested Schema : Enrollment History
Type: array
Title: Enrollment History
The enrollmentHistory resource provides the enrollment history details for the learning assignment.
Show Source
Nested Schema : Enrollment Related Materials
Type: array
Title: Enrollment Related Materials
The attachments resource provides the related learning materials for the parent resource.
Show Source
Nested Schema : Errors
Type: array
Title: 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.
Show Source
Nested Schema : learningItemDFF
Type: array
Show Source
Nested Schema : Learning Item Rating Details
Type: array
Title: Learning Item Rating Details
The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status.
Show Source
Nested Schema : Related Materials
Type: array
Title: Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
Show Source
Nested Schema : Messages
Type: array
Title: 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.
Show Source
Nested Schema : offeringDFF
Type: array
Show Source
Nested Schema : Offering Primary Classrooms
Type: array
Title: Offering Primary Classrooms
The offeringPrimaryClassroom resource provides primary classroom details for the ILT or blended learning offering.
Show Source
Nested Schema : Offering Primary Instructors
Type: array
Title: 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
Show Source
Nested Schema : Questionnaire Responses
Type: array
Title: Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : Transaction Histories
Type: array
Title: Transaction Histories
The transactionHistory resource provides the transaction history for its parent resource. Details include transaction identifier, transaction number, transaction date, and transaction reason.
Show Source
Nested Schema : User Action Hints
Type: array
Title: User Action Hints
Hints for possible actions on a learner's assignment records.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-item-response
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Commented By
    Read Only: true
    Maximum Length: 240
    Display name for the commenter.
  • Title: Commented by Person ID
    Read Only: true
    Identifier for the commenter.
  • Title: Commented by Person Image URL
    Read Only: true
    Maximum Length: 4000
    Image URL for the commenter.
  • Title: Commented by Person Number
    Read Only: true
    Maximum Length: 30
    Person number for the commenter.
  • Title: Comment
    Maximum Length: 4000
    Learner comment in conversations for active and completed learning item learners.
  • Title: Commented on Date
    Read Only: true
    Date of the comment in conversations for active and completed learning item learners.
  • Title: Comment ID
    Read Only: true
    Unique identifier for the comment.
  • Read Only: true
    Indicates whether the comment was liked by the signed in user. Valid values are Y or N. Default value is N.
  • Title: Comment Status
    Maximum Length: 30
    Learner comment status in conversations for active and completed learning item learners. Valid values are defined in the CommentStatusLOV list.
  • Title: Comment Status Description
    Read Only: true
    Maximum Length: 4000
    Description of the commentStatus attribute value.
  • Title: Data Security Privilege
    Default Value: ORA_LEARNER
    Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
  • Title: Like Count
    Read Only: true
    Like count for the comment in conversations for active and completed learning item learners.
  • Likes
    Title: Likes
    The likes resource provides details of the likes for comments by active and completed learners for the learning item.
  • Links
  • Replies
    Title: Replies
    The replies resource provides details of the replies to comments by active and completed learners for the learning item.
  • Title: Reply Count
    Read Only: true
    Reply count for the comment in conversations for active and completed learning item learners.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Likes
Type: array
Title: Likes
The likes resource provides details of the likes for comments by active and completed learners for the learning item.
Show Source
Nested Schema : Replies
Type: array
Title: Replies
The replies resource provides details of the replies to comments by active and completed learners for the learning item.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-attachments-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-likes-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Likes
Type: array
Title: Likes
The likes resource provides details of the likes for comments by active and completed learners for the learning item.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-attachments-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-activeLearnerComments-replies-likes-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-approvalDetails-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-assignerPersonDetails-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-assignmentDFF-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-item-response
Type: object
Show Source
  • Title: Activity Assignment Record ID
    Read Only: true
    Activity assignment record ID for the activity attempt.
  • Title: Actual Effort
    Read Only: true
    Actual learner effort to complete the activity.
  • Title: Activity Attempt Actual Score
    Read Only: true
    Actual learner score for the activity attempt.
  • Title: Actual Effort Units
    Read Only: true
    Maximum Length: 120
    Actual units of learner effort to complete the activity. Valid values are defined in the ActivityAttemptActualEffortUnitsLOV list.
  • Title: Actual Effort Units Description
    Read Only: true
    Maximum Length: 4000
    Description of the activityAttemptAEUnitsMeaning attribute value.
  • Title: Activity Attempt Assignee
    Read Only: true
    Maximum Length: 30
    Display name of the learning activity attempt assignee.
  • Title: Activity Attempt Assignee Person ID
    Read Only: true
    Friendly number identifying the learning activity attempt assignee.
  • Title: Activity Attempt Assignee Person Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the learning activity attempt assignee.
  • Title: Activity Attempt Assignee Type
    Read Only: true
    Maximum Length: 30
    Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list.
  • Title: Activity Attempt Assignee Type Description
    Read Only: true
    Description of the activity attempt assigned to type.
  • Title: Activity Attempt Completed Date
    Read Only: true
    Completion date of the activity attempt.
  • Title: Activity Attempt Exempted Date
    Read Only: true
    Attempt exemption date for the learning activity attempt.
  • Title: Activity Attempt Exempted Reason Code
    Read Only: true
    Maximum Length: 30
    Reason for the activity attempt exemption, such as Exempted - completed elsewhere, Exempted - higher level certification attained, or Completed offline and status verified. Valid values are defined in the AttemptExemptedReasonLOV list.
  • Title: Activity Attempt Exempted Reason Code Description
    Read Only: true
    Maximum Length: 4000
    Description of the activityAttemptExemptedRCMeaning attribute value.
  • Title: Activity Attempt ID
    Read Only: true
    Application-generated primary key.
  • Title: Activity Attempt Locked
    Read Only: true
    Maximum Length: 1
    Indicates whether the learning activity attempt is locked. Valid values are Y and N. Default value is N.
  • Title: Activity Attempt Next Action
    Read Only: true
    Maximum Length: 19
    Next activity action when the learner is working on the activity.
  • Title: Activity Attempt Number
    Read Only: true
    Maximum Length: 30
    Number of attempts for the self-paced learning activity.
  • Title: Activity Attempt Started Date
    Read Only: true
    Date when the learner attempted the activity.
  • Title: Activity Attempt Status
    Maximum Length: 32
    Status for the activity the learner is working on. Valid values include ORA_ASSN_TASK_COMPLETED, ORA_ASSN_TASK_EXEMPTED, ORA_ASSN_TASK_INCOMPLETE, ORA_ASSN_TASK_NOT_STARTED, and ORA_ASSN_TASK_IN_PROGRESS. Valid value are defined in the list ActivityAttemptStatusLOV.
  • Title: Activity Attempt Status Description
    Read Only: true
    Maximum Length: 4000
    Description of the activityAttemptStatusMeaning attribute value.
  • Activity Completion Predecessor Hints
    Title: Activity Completion Predecessor Hints
    The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.
  • Title: Activity Completion Requirement
    Read Only: true
    Maximum Length: 120
    Completion requirement for the learning activity. Valid values are defined in the ActivityCompletionRequirementLOV list.
  • Title: Activity Completion Requirement Description
    Read Only: true
    Maximum Length: 4000
    Description of the activityComplRequirementMeaning attribute value.
  • Activity Content Attempts
    Title: 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.
  • Read Only: true
    Maximum Length: 30
    Determines how learners see the content, such as embedded.
  • Title: Activity Date
    Read Only: true
    Date when the ILT activity is worked on. Doesn't apply to any other types of activities.
  • Title: Activity Description
    Read Only: true
    Maximum Length: 4000
    Description of the learning activity.
  • Read Only: true
    Long description of the learning activity.
  • Title: Activity Position
    Read Only: true
    Display order for the learning activities.
  • Title: Activity Effort Units
    Read Only: true
    Maximum Length: 120
    Unit used to measure the effort required to complete the learning activity, such as hour, minute, or month. Valid values are defined in the ActivityExpectedEffortUnitsLOV list.
  • Title: Activity Effort Units Description
    Read Only: true
    Maximum Length: 4000
    Description of the learning activity effort units.
  • Title: Activity End Date
    Read Only: true
    Learning activity end time expressed in UTC format.
  • Title: Activity End Time
    Read Only: true
    Maximum Length: 32
    ILT activity end time in the user's preferred time zone. Doesn't apply to any other types of activities.
  • Title: Expected Effort
    Read Only: true
    Maximum Length: 83
    Expected effort for the learning activity.
  • Title: Activity ID
    Read Only: true
    Application-generated primary key of the learning activity.
  • Title: Learner Can Mark Activity Complete
    Read Only: true
    Maximum Length: 1
    Indicates whether the learner can mark the activity as completed.
  • Title: Activity Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the learning activity in the user interface.
  • Title: Passing Score
    Read Only: true
    Passing score for the learning activity.
  • Title: Activity Section Required Activities
    Read Only: true
    Completion requirement for the learning activity section.
  • Title: Activity Section Attempt Completion Progress
    Read Only: true
    Number of learning activities completed in a section.
  • Title: Activity Section Attempt Locked
    Read Only: true
    Maximum Length: 1
    Indicates whether the attempt on the learning activity section is locked. Valid values are Y and N. Default value is N.
  • Title: Activity Section Attempt Status
    Read Only: true
    Maximum Length: 32
    Status of the attempt on the learning activity section. Valid values are defined in the learning activitySectionAttemptStatusLOV list.
  • Title: Activity Section Attempt Status Description
    Read Only: true
    Maximum Length: 4000
    Description of the activitySectionAttemptStatus attribute value.
  • Activity Section Completion Predecessor Hints
    Title: Activity Section Completion Predecessor Hints
    The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.
  • Title: Activity Section Description
    Read Only: true
    Maximum Length: 4000
    Description of the learning activity section.
  • Title: Activity Section Position
    Read Only: true
    Display order for the learning activity section.
  • Title: Activity Section ID
    Read Only: true
    Application-generated primary key column.
  • Title: Long Description
    Read Only: true
    Long description of the learning activity.
  • Title: Activity Section Number
    Read Only: true
    Maximum Length: 30
    Number identifying the learning activity section.
  • Title: Activity Section Title
    Read Only: true
    Maximum Length: 250
    Name of the learning activity section.
  • Title: Activity Section Total Activities
    Read Only: true
    Total number of learning activities in the section.
  • Title: Activity Short Description
    Read Only: true
    Maximum Length: 4000
    Description of the learning content activity.
  • Title: Activity Start Date
    Read Only: true
    Learning activity start time expressed in UTC format.
  • Title: Activity Start Time
    Read Only: true
    Maximum Length: 32
    ILT activity start time in the user's preferred time zone. Doesn't apply to any other types of activities.
  • Title: Activity Time Zone
    Read Only: true
    Maximum Length: 30
    ILT activity time zone. Doesn't apply to any other types of activities.
  • Title: Activity Title
    Read Only: true
    Maximum Length: 250
    Title of the learning activity.
  • Title: Activity Total Attempts
    Read Only: true
    Total learner attempts on the activity.
  • Title: Activity Type
    Read Only: true
    Maximum Length: 32
    Activity type of the learning assignment. If the learning assignment is for specialization, this represents a course. If the learning assignment is for a course, this represents offering types. Valid values are defined in the ActivityTypeLOV list.
  • Title: Activity Type Description
    Read Only: true
    Maximum Length: 4000
    Description of the learning activity type.
  • Title: Allow learners to fast forward
    Read Only: true
    Maximum Length: 30
    Indicates if forward scrubbing is enabled.Valid values are Y or N.
  • Classrooms
    Title: 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.
  • Read Only: true
    Application-generated primary key of the completion item.
  • Read Only: true
    Maximum Length: 30
    Friendly number identifying for identifying the completion item.
  • Title: Data Security Privilege
    Read Only: true
    Maximum Length: 32
    Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
  • Title: Data Security Privilege Description
    Read Only: true
    Maximum Length: 4000
    Description of the value of the dataSecurityPrivilege attribute.
  • Title: eLearning Attempt Review
    Read Only: true
    Maximum Length: 120
    Indicates whether the learner can review the activity attempt. Valid values are ORA_WLF_ARAR_LAST_ATTEMPT, ORA_WLF_ARAR_DONT_ENABLE and are defined in the ELearnAttemptReviewLOV list.
  • Title: eLearning Attempt Review Description
    Read Only: true
    Maximum Length: 4000
    Description of the elearnAttemptReview attribute value.
  • Title: eLearning Attempts Allowed
    Read Only: true
    Maximum number of attempts allowed on the self-paced learning assessment activity.
  • Title: eLearning Disable Content Review
    Read Only: true
    Maximum Length: 1
    Indicates whether the content review is disabled for the self-paced learning activity. Valid values are Y and N. Default value is N for self-paced learning activity with content type such as Video, PDF, Web link, SCORM or HACP.
  • Title: eLearning Disable Review
    Read Only: true
    Maximum Length: 1
    Disable reviews for the self-paced learning activity.
  • Title: eLearning Disable Review for Passed Attempts
    Read Only: true
    Maximum Length: 1
    Indicates whether the review of passed attempts is disabled for the self-paced learning activity. Valid values are Y and N. Default value is Y.
  • Title: eLearning Hide Actual Score
    Read Only: true
    Maximum Length: 1
    Hide score for the self-paced learning activity.
  • Title: eLearning ID
    Read Only: true
    Application-generated primary key for the eLearning content of the self-paced activity.
  • Title: eLearning Mark Completion on Open
    Read Only: true
    Maximum Length: 1
    Set the eLearning to complete when it's opened.
  • Title: eLearning Number
    Read Only: true
    Maximum Length: 30
    Number for identifying the content that backs the self-paced learning activity.
  • Title: Questionnaire ID
    Read Only: true
    Unique identifier for the questionnaire that's the self-paced learning assessment activity.
  • Title: Questionnaire Number
    Read Only: true
    Maximum Length: 19
    Question number of a question in the eLearning.
  • Title: eLearning Recorded Attempts Rule
    Read Only: true
    Maximum Length: 120
    Rule for the maximum number of attempts allowed for the self-paced learning activity. Valid values are ORA_WLF_ARA_SNGL, ORA_WLF_ARA_LTD_NUM, ORA_WLF_ARA_UNLTD and are defined in the ELearnRecordedAttemptsRuleLOV list.
  • Title: eLearning Recorded Attempts Rule Description
    Read Only: true
    Maximum Length: 4000
    Description of the elearnRecordedAttemptsRule attribute value.
  • Title: eLearning Description
    Read Only: true
    Maximum Length: 4000
    Description of the learning content for the self-paced activity.
  • Title: eLearning Show Response Feedback
    Read Only: true
    Maximum Length: 1
    Show response feedback for the self-paced learning activity.
  • Title: eLearning Time per Attempt
    Read Only: true
    Time limit per attempt on the self-paced learning assessment activity.
  • Title: eLearning Time per Attempt Units
    Read Only: true
    Maximum Length: 30
    Unit of measure for the time limit per attempt on the self-paced learning assessment activity, such as Hours or Minutes. Valid values are defined in the ELearnTimePerAttemptUnitsLOV list.
  • Title: eLearning Time per Attempt Units Description
    Read Only: true
    Maximum Length: 4000
    Description of the elearnTimePERAttemptUnitsMeaning attribute value.
  • Title: eLearning Title
    Read Only: true
    Maximum Length: 250
    Name of the learning content for the self-paced activity.
  • Title: eLearning Type
    Read Only: true
    Maximum Length: 80
    Type of the self-paced learning, such as Video or SCORM. Valid values are defined in the LearnningContentTypeLOV list.
  • Title: eLearning Type Description
    Read Only: true
    Maximum Length: 4000
    Description of the elearnTypeMeaning attribute value.
  • Instructors
    Title: Instructors
    The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
  • Links
  • Offered Languages
    Title: Offered Languages
    The offeredLanguages resource provides the offering language for a learning item.
  • Offered Locations
    Title: Offered Locations
    The offeredLocations resource provides the location details for a learning item.
  • Title: Parent Assigned Learning Item Subtype
    Read Only: true
    Maximum Length: 32
    Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list.
  • Title: Parent Assigned Learning Item Subtype Description
    Read Only: true
    Maximum Length: 4000
    Description of the attribute learningItemSubType attribute value.
  • Questionnaire Responses
    Title: Questionnaire Responses
    The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
  • Related Materials
    Title: Related Materials
    The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
  • Title: Activity Section Completion Date
    Read Only: true
    Date when the learner successfully completed the learning activity section.
  • Title: Virtual Classroom Information
    Read Only: true
    Maximum Length: 19
    Additional information about the virtual classroom, if used in the learning activity.
  • Title: Virtual Classroom Type
    Read Only: true
    Maximum Length: 40
    Type of the virtual classroom, such as ad-hoc virtual classroom, named virtual classroom, or no virtual classroom. Valid values are defined in the VirtualClassroomTypeLOV list.
  • Title: Virtual Classroom Type Description
    Read Only: true
    Description of the virtual classroom type.
Nested Schema : Activity Completion Predecessor Hints
Type: array
Title: Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.
Show Source
Nested Schema : Activity Content Attempts
Type: array
Title: 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.
Show Source
Nested Schema : Activity Section Completion Predecessor Hints
Type: array
Title: Activity Section Completion Predecessor Hints
The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.
Show Source
Nested Schema : Classrooms
Type: array
Title: 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.
Show Source
Nested Schema : Instructors
Type: array
Title: Instructors
The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
Show Source
Nested Schema : Offered Languages
Type: array
Title: Offered Languages
The offeredLanguages resource provides the offering language for a learning item.
Show Source
Nested Schema : Offered Locations
Type: array
Title: Offered Locations
The offeredLocations resource provides the location details for a learning item.
Show Source
Nested Schema : Questionnaire Responses
Type: array
Title: Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : Related Materials
Type: array
Title: Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityCompletionPredecessorHint-item-response
Type: object
Show Source
  • Title: Activity Predecessor Attempt Assignee Type
    Read Only: true
    Maximum Length: 30
    Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list.
  • Title: Activity Predecessor Attempt Assignee Type Description
    Read Only: true
    Description of the type of user assigned to the learning activity attempt.
  • Title: Activity Predecessor Attempt Locked
    Read Only: true
    Maximum Length: 1
    Indicates whether the learner can attempt the activity. Valid values are Y and N. Default value is N.
  • Title: Activity Predecessor Attempt Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the learning activity attempt.
  • Title: Activity Predecessor Attempt Status
    Read Only: true
    Maximum Length: 32
    Status for the learning activity attempt. Valid values are Y and N. Default value is N. Valid values are defined in the learning activityAttemptStatusLOV list.
  • Title: Activity Predecessor Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the learning activity.
  • Title: Activity Predecessor Title
    Read Only: true
    Maximum Length: 255
    Title of the activity.
  • Links
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-item-response
Type: object
Show Source
Nested Schema : Questionnaire Responses
Type: array
Title: Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-item-response
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-item-response
Type: object
Show Source
  • Title: Answer Code
    Read Only: true
    Maximum Length: 240
    The answer code that a participant chose when responding to a single choice question.
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Answer Short Description
    Read Only: true
    Maximum Length: 240
    Text of the answer chosen by a participant when responding to a single choice question.
  • Title: Answer Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the question response.
  • Title: Creation Date
    Read Only: true
    Date on which the question response was created.
  • Title: Last Update Date
    Read Only: true
    Date on which the question response was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the question response.
  • Links
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
  • Title: Question Text
    Read Only: true
    Maximum Length: 2000
    Text of the question that a participant responds to.
  • Title: Answer Score
    Read Only: true
    Calculated score for the responses provided for a question by a participant.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-item-response
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response
Type: object
Show Source
  • Title: Answer Code
    Read Only: true
    Maximum Length: 240
    The answer code that a participant chose when responding to a single choice question.
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Answer Short Description
    Read Only: true
    Maximum Length: 240
    Text of the answer chosen by a participant when responding to a single choice question.
  • Title: Answer Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the question response.
  • Title: Creation Date
    Read Only: true
    Date on which the question response was created.
  • Title: Last Update Date
    Read Only: true
    Date on which the question response was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the question response.
  • Links
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
  • Title: Question Text
    Read Only: true
    Maximum Length: 2000
    Text of the question that a participant responds to.
  • Title: Answer Score
    Read Only: true
    Calculated score for the responses provided for a question by a participant.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-activitySectionCompletionPredecessorHint-item-response
Type: object
Show Source
  • Title: Activity Section Predecessor Attempt Assignee Type
    Read Only: true
    Maximum Length: 30
    Type of user, such as Learner or Observer, assigned to the activity section attempt. Valid values are defined in the ActivitySectionAttemptAssignedToTypeLOV list.
  • Title: Activity Section Predecessor Attempt Assignee Type Description
    Read Only: true
    Description of the type of user assigned to the learning activity section attempt.
  • Title: Activity Section Predecessor Attempt Locked
    Read Only: true
    Maximum Length: 1
    Indicates whether the learner can attempt the activity section. Valid values are Y and N. Default value is N. Valid values are defined in the ActivitySectionAttemptStatusLOV.
  • Title: Activity Section Predecessor Attempt Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the learning activity section attempt.
  • Title: Activity Section Predecessor Attempt Status
    Read Only: true
    Maximum Length: 32
    Status for the learning activity section attempt. Valid values are defined in the learning activitySectionAttemptStatusLOV list.
  • Title: Activity Section Predecessor Number
    Read Only: true
    Maximum Length: 30
    Friendly number identifying the learning activity section.
  • Title: Activity Section Predecessor Title
    Read Only: true
    Maximum Length: 255
    Title of the activity section.
  • Links
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-classrooms-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : classroomDFFs
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-classrooms-attachments-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-classrooms-classroomDFFs-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-instructors-item-response
Type: object
Show Source
Nested Schema : instructorDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-instructors-instructorDFF-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-offeredLanguages-item-response
Type: object
Show Source
  • Title: Language
    Read Only: true
    Maximum Length: 255
    Language for the selected learning assignment offering.
  • Title: Language Code
    Read Only: true
    Maximum Length: 30
    Language code for the selected learning assignment offering.
  • Title: Language Code Description
    Read Only: true
    Maximum Length: 4000
    Description of the languageCode attribute value.
  • Links
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-offeredLocations-item-response
Type: object
Show Source
  • Links
  • Title: Location City
    Read Only: true
    Maximum Length: 60
    City where the selected learning assignment offering is delivered.
  • Title: Location Country
    Read Only: true
    Maximum Length: 60
    Country where the selected learning assignment offering is delivered.
  • Title: Location Name
    Read Only: true
    Maximum Length: 93
    City-state-country for the ILT type offering. For other offering types, it's Virtual Classroom or Self Paced, as applicable.
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-questionnaireResponses-item-response
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-questionnaireResponses-questionResponses-item-response
Type: object
Show Source
  • Title: Answer Code
    Read Only: true
    Maximum Length: 240
    The answer code that a participant chose when responding to a single choice question.
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Answer Short Description
    Read Only: true
    Maximum Length: 240
    Text of the answer chosen by a participant when responding to a single choice question.
  • Title: Answer Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the question response.
  • Title: Creation Date
    Read Only: true
    Date on which the question response was created.
  • Title: Last Update Date
    Read Only: true
    Date on which the question response was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the question response.
  • Links
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
  • Title: Question Text
    Read Only: true
    Maximum Length: 2000
    Text of the question that a participant responds to.
  • Title: Answer Score
    Read Only: true
    Calculated score for the responses provided for a question by a participant.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-item-response
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response
Type: object
Show Source
  • Title: Answer Code
    Read Only: true
    Maximum Length: 240
    The answer code that a participant chose when responding to a single choice question.
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Answer Short Description
    Read Only: true
    Maximum Length: 240
    Text of the answer chosen by a participant when responding to a single choice question.
  • Title: Answer Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the question response.
  • Title: Creation Date
    Read Only: true
    Date on which the question response was created.
  • Title: Last Update Date
    Read Only: true
    Date on which the question response was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the question response.
  • Links
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
  • Title: Question Text
    Read Only: true
    Maximum Length: 2000
    Text of the question that a participant responds to.
  • Title: Answer Score
    Read Only: true
    Calculated score for the responses provided for a question by a participant.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-relatedMaterials-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionSummary-item-response
Type: object
Show Source
  • Title: Actual Effort
    Read Only: true
    Actual effort by the learner.
  • Title: Actual Score
    Read Only: true
    Learner score for this learning assignment.
  • Title: Completion Progress
    Learner progress to complete the learning assignment. For a course, it's the number of activities completed. For a specialization, it's the sum of all the completed courses. For tutorials, it's the sum of all the completed sections.
  • Title: Completion Requirement
    Read Only: true
    Number of activities left to complete to complete the learning course assignment offering.
  • Title: Completion Requirement Units
    Read Only: true
    Maximum Length: 120
    Unit of measure for the completion requirement of the learning assignment, such as chapters, hours, or required activities. Valid values are defined in the CompletionRequirementUnitsLOV list.
  • Title: Completion Requirement Units Description
    Read Only: true
    Maximum Length: 4000
    Description of the completionRequirementUnits attribute value.
  • Title: Effort Units
    Read Only: true
    Maximum Length: 30
    Unit of measure for the expected and actual effort to complete the learning item, such as day, hour, or minute. Valid values are defined in the EffortUnitsLOV list.
  • Title: Effort Units Description
    Read Only: true
    Maximum Length: 4000
    Description of the effortUnits attribute value.
  • Title: Expected Effort
    Read Only: true
    Maximum Length: 32
    Expected effort to complete the learning assignment item.
  • Read Only: true
    Expected effort, in seconds, to complete the learning item.
  • Links
  • Title: Passing Score
    Read Only: true
    Passing score for the learning assignment item.
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-enrollmentHistory-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-enrollmentRelatedMaterials-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-errors-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-learningItemDFF-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-learningItemRatingDetails-item-response
Type: object
Show Source
Nested Schema : User Access Person Details
Type: array
Title: User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-learningItemRatingDetails-ratedByPersonDetails-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-learningItemRelatedMaterials-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-messages-item-response
Type: object
Show Source
  • Title: Data Security Privilege
    Maximum Length: 32
    Data security privilege, such as Learner or Learner Manager, that identifies the intent and permissions for the person accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
  • Links
  • Read Only: true
    Code to indicate the type of message.
  • Read Only: true
    User-friendly string describing the message.
  • Read Only: true
    Indicates the severity of the message like: INFO, WARN, or FATAL.
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringDFF-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringPrimaryClassroom-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : classroomDFFs
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringPrimaryClassroom-attachments-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringPrimaryClassroom-classroomDFFs-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringPrimaryInstructor-item-response
Type: object
Show Source
Nested Schema : instructorDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringPrimaryInstructor-instructorDFF-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-questionnaireResponses-item-response
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-questionnaireResponses-questionResponses-item-response
Type: object
Show Source
  • Title: Answer Code
    Read Only: true
    Maximum Length: 240
    The answer code that a participant chose when responding to a single choice question.
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Answer Short Description
    Read Only: true
    Maximum Length: 240
    Text of the answer chosen by a participant when responding to a single choice question.
  • Title: Answer Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the question response.
  • Title: Creation Date
    Read Only: true
    Date on which the question response was created.
  • Title: Last Update Date
    Read Only: true
    Date on which the question response was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the question response.
  • Links
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
  • Title: Question Text
    Read Only: true
    Maximum Length: 2000
    Text of the question that a participant responds to.
  • Title: Answer Score
    Read Only: true
    Calculated score for the responses provided for a question by a participant.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-questionnaireResponses-questionResponses-questionResponseAttachments-item-response
Type: object
Show Source
Nested Schema : Question Responses
Type: array
Title: Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response
Type: object
Show Source
  • Title: Answer Code
    Read Only: true
    Maximum Length: 240
    The answer code that a participant chose when responding to a single choice question.
  • Title: Answer Code List
    Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Comments
    Maximum Length: 4000
    Additional comments provided by the participant when responding to a question.
  • Title: Answer
    Attachment provided by the participant when responding to a question.
  • Title: Answer List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Answer Short Description
    Read Only: true
    Maximum Length: 240
    Text of the answer chosen by a participant when responding to a single choice question.
  • Title: Answer Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question.
  • Title: Choice List Code
    Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Choice Short Description
    Read Only: true
    Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the question response.
  • Title: Creation Date
    Read Only: true
    Date on which the question response was created.
  • Title: Last Update Date
    Read Only: true
    Date on which the question response was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who last updated the question response.
  • Links
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
  • Title: Question Text
    Read Only: true
    Maximum Length: 2000
    Text of the question that a participant responds to.
  • Title: Answer Score
    Read Only: true
    Calculated score for the responses provided for a question by a participant.
Nested Schema : Question Response Attachments
Type: array
Title: Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-transactionHistory-item-response
Type: object
Show Source
  • Links
  • Title: Transaction Amount
    Read Only: true
    Maximum Length: 19
    Learning transaction history item type amount.
  • Title: Transaction Comments
    Read Only: true
    Maximum Length: 4000
    Learning transaction history item comments.
  • Title: Transaction Currency
    Read Only: true
    Maximum Length: 19
    Learning transaction history item type currency. Valid values are defined in the PriceCurrencyLOVVA list.
  • Title: Transaction Date
    Read Only: true
    Transaction history date when the learning item was assigned.
  • Title: Transaction ID
    Read Only: true
    Unique identifier for the transaction history that the learning item was assigned to.
  • Title: Transaction Number
    Read Only: true
    Maximum Length: 250
    Transaction history number for the learner assigned to the learning item.
  • Title: Transaction Reason
    Read Only: true
    Maximum Length: 19
    Learning transaction history item reason. Valid values are defined in the ReasonLOV list.
  • Title: Transaction Reason Description
    Read Only: true
    Maximum Length: 4000
    Description of the transactionReason attribute value.
  • Title: Transaction Type
    Read Only: true
    Maximum Length: 30
    Transaction history item type for the learning item. Valid values are defined in the TransactionTypeLOV list.
  • Title: Transaction Type Description
    Read Only: true
    Maximum Length: 4000
    Description of the transactionType attribute value.
Nested Schema : learnerLearningRecords-completionDetails-selectedCourseOfferings-userActionHints-item-response
Type: object
Show Source
  • Title: Can Edit Assignment Hint
    Read Only: true
    Maximum Length: 4000
    Hint to identify whether a user can edit the assignment. Examples include Can delete, Can withdraw, and No edit. Valid values are defined in the CanEditAssignmentHintLOV.
  • Title: Can Manage Learning Item
    Read Only: true
    Maximum Length: 4000
    Hint to identify whether a user can manage the learning item.
  • Title: Data Security Privilege
    Maximum Length: 32
    Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
  • Title: Learner Enrollment Questionnaire ID
    Read Only: true
    Unique identifier for the enrollment questionnaire for learner self-service assignments.
  • Title: Manager Enrollment Questionnaire ID
    Read Only: true
    Unique identifier for the enrollment questionnaire for manager self-service assignments.
  • Title: Learner Enrollment Questionnaire Number
    Read Only: true
    Maximum Length: 30
    Friendly number for identifying the enrollment questionnaire for learner self-service assignments.
  • Title: Manager Enrollment Questionnaire Number
    Read Only: true
    Maximum Length: 30
    Friendly number for identifying the enrollment questionnaire for manager self-service assignments.
  • Title: Self-Assignment
    Read Only: true
    Maximum Length: 32
    Hint for the initial learning record status for learner self-service assignments.
  • Title: Self-Assignment Description
    Read Only: true
    Maximum Length: 4000
    Description of the value of the initialLearningRecordStatusHintESS attribute.
  • Title: Manager Assignment
    Read Only: true
    Maximum Length: 32
    Hint for the initial learning record status for manager self-service assignments.
  • Title: Manager Assignment Description
    Read Only: true
    Maximum Length: 4000
    Description of the value of the initialLearningRecordStatusHintMSS attribute.
  • Title: Self-Assignment
    Read Only: true
    Maximum Length: 32
    Hint for the initial learning record substatus for manager self-service assignments.
  • Title: Self-Assignment Description
    Read Only: true
    Maximum Length: 4000
    Description of the value of the initialLearningRecordSubStatusHintESS attribute.
  • Title: Enrollee Forum Enabled
    Read Only: true
    Maximum Length: 1
    Hint to identify whether the enrollee forum is enabled for the learning item.
  • Read Only: true
    Maximum Length: 1
    Hint to identify whether the manager user forum is enabled for the learning item.
  • Title: Self Service User Forum Enabled
    Read Only: true
    Maximum Length: 1
    Hint to identify whether the self-service user forum is enabled for the learning item.
  • Links
  • Title: Payment Type
    Read Only: true
    Maximum Length: 30
    Payment types accepted for the learning record, such as manual payment, online payment, or no payment. Valid values are defined in the PaymentTypesAcceptedLOV.
  • Title: Payment Type Description
    Read Only: true
    Maximum Length: 4000
    Description of the value of the paymentTypesAccepted attribute.
  • Title: Self-Assignment Pending Prerequisite Timeout in Days
    Read Only: true
    Hint for the number of days a learner has to complete prerequisites before they're withdrawn for learner self-service.
  • Title: Manager Assignment Pending Prerequisite Timeout in Days
    Read Only: true
    Hint for the number of days a learner has to complete prerequisites before they're withdrawn for manager self-service.
  • Title: Refund Rule for Instructor-Led Activity
    Read Only: true
    Maximum Length: 240
    Hint for a refund rule for the instructor-led activity.
  • Title: Refund Rule for Self-Paced Activity
    Read Only: true
    Maximum Length: 240
    Hint for a refund rule for the self-paced activity.
  • Title: Show Learner Request Form
    Read Only: true
    Maximum Length: 32
    Hint to show the learning record request form for learner self-service assignments.
  • Title: Show Learner Request Form Description
    Read Only: true
    Maximum Length: 4000
    Description of the value of the showEnrollmentFormESS attribute.
  • Title: Show Manager Request Form
    Read Only: true
    Maximum Length: 32
    Hint to show learning record request form for manager self-service assignments.
  • Title: Show Manager Request Form Description
    Read Only: true
    Maximum Length: 4000
    Description of the value of the showEnrollmentFormMSS attribute.
  • Title: View Mode
    Read Only: true
    Maximum Length: 30
    Hint for the view mode for learner self-service. Valid values are defined in the ViewModeESSLOV.
  • Title: View Mode Description
    Read Only: true
    Maximum Length: 4000
    Description of the value of the viewModeESS attribute.
Back to Top