Update an assignment record

patch

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Learner Learning Records resource and used to uniquely identify an instance of Learner Learning Records. The client should not generate the hash key value. Instead, the client should query on the Learner Learning Records collection resource in order to navigate to a specific instance of Learner Learning Records 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 : Assignee Person Details
Type: array
Title: Assignee Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : Assigner Person Details
Type: array
Title: Assigner 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 : courseDFF
Type: array
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 : 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 : 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 : Noncatalog Learning Item
Type: array
Title: Noncatalog Learning Item
The learning item details required to create noncatalog requests or record external learning under the assignment profile.
Show Source
Nested Schema : learningItemDFF
Type: array
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 : Learning Item Publisher Person Details
Type: array
Title: Learning Item Publisher Person Details
The personDetalis resource provides details about the person associated with the learning item.
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 : Learning Outcomes
Type: array
Title: Learning Outcomes
The learningPrerequisites resource provides the learning prerequisites for the learning items associated with a learning assignment. This is applicable for only courses and specializations.
Show Source
Nested Schema : Learning Prerequisites
Type: array
Title: Learning Prerequisites
The learningPrerequisites resource provides the learning prerequisites for the learning items associated with a learning assignment. This is applicable for only courses and specializations.
Show Source
Nested Schema : Messages
Type: array
Title: Messages
The messages resource provides the message text, code, and severity of the messages displayed for the learning item.
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 : Other Selected Course Offerings
Type: array
Title: Other Selected Course Offerings
The selectedCourseOfferings resource provides all offerings of an assigned course. This resource is applicable for only courses. It's empty for all other types of learning.
Show Source
Nested Schema : Past Renewals
Type: array
Title: Past Renewals
The pastRenewals resource provides a list of all past renewals for the learning assignment. Details include assignment record identifier, assignment creation date, and assignment type.
Show Source
Nested Schema : Primary Selected Course Offering
Type: array
Title: Primary Selected Course Offering
The selectedCourseOfferings resource provides all offerings of an assigned course. This resource is applicable for only courses. It's empty for all other types of learning.
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 Learning Records
Type: array
Title: Related Learning Records
The relatedLearningRecords resource provides details of the related learning assignments for the learning assignment.
Show Source
Nested Schema : Selected Course Offerings
Type: array
Title: Selected Course Offerings
The selectedCourseOfferings resource provides all offerings of an assigned course. This resource is applicable for only courses. It's empty for all other types of learning.
Show Source
Nested Schema : Selected Course Offerings Summary
Type: array
Title: Selected Course Offerings Summary
The selectedCourseOfferingsSummary resource provides a summary of all selected learning course offerings.
Show Source
Nested Schema : specializationDFF
Type: array
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
The userActionHints resource provides hints for possible actions on a learner's assignment records.
Show Source
Nested Schema : schema
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 : schema
Type: object
Show Source
Nested Schema : schema
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 : schema
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-activeLearnerComments-replies-attachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-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-approvalDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-assignedToPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-assignerPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
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 : Observer Person Details
Type: array
Title: Observer Person Details
The person details of each configured observer when an observation checklist is configured to use named observers.
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 : Learning Item Talent Profile Summary
Type: array
Title: Learning Item Talent Profile Summary
The summary learning information from the talent profile, such as if a course is configured with prerequisites or outcomes.
Show Source
Nested Schema : Messages
Type: array
Title: Messages
The messages resource provides the message text, code, and severity of the messages displayed for the learning item.
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 : Other Selected Course Offerings
Type: array
Title: Other Selected Course Offerings
The selectedCourseOfferings resource provides all offerings of an assigned course. This resource is applicable for only courses. It's empty for all other types of learning.
Show Source
Nested Schema : Primary Selected Course Offering
Type: array
Title: Primary Selected Course Offering
The selectedCourseOfferings resource provides all offerings of an assigned course. This resource is applicable for only courses. It's empty for all other types of learning.
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 : Selected Course Offerings
Type: array
Title: Selected Course Offerings
The selectedCourseOfferings resource provides all offerings of an assigned course. This resource is applicable for only courses. It's empty for all other types of learning.
Show Source
Nested Schema : User Action Hints
Type: array
Title: User Action Hints
The userActionHints resource provides hints for possible actions on a learner's assignment records.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-activityCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : schema
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 : 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 : 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 : learnerLearningRecords-completionDetails-activitySectionCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-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 : schema
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-classrooms-classroomDFFs-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-elearnObsPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-instructors-item-patch-request
Type: object
Show Source
Nested Schema : instructorDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-instructors-instructorDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-learningItemTalentProfileSummary-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-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-offeredLanguages-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-offeredLocations-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Offering Active Date
    Date when the learning assignment moved to an active status.
  • Title: Assigner Attribution Type
    Maximum Length: 30
    Default Value: ORA_PERSON
    Entity type for the learning assignment creator, such as person, specialist, or community. Valid values are defined in the AssignerToAttributionTypeLOV list.
  • assignmentDFF
  • Title: Due Date
    Due date for the other selected course offering assignment.
  • Title: Justification
    Maximum Length: 4000
    Justification provided by the specialist when assigning, or the learner when enrolling in, a course offering assignment.
  • Title: Enrollment Record Status
    Maximum Length: 32
    Default Value: ORA_ASSN_REC_ACTIVE
    Status for the learning enrollment, such as Active, Content Completed, Completed, Withdrawn, or Deleted. Valid values are defined in the AssignmentStatusLOV list.
  • Title: Can Edit Assignment Hint
    Maximum Length: 4000
    Assignment hint, such as Can delete, Can withdraw, or No edit, for the learning assignment. Valid values are defined in the CanEditAssignmentHintLOV list.
  • Completion Details
    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.
  • Completion Summaries
    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.
  • 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.
  • Enrollment History
    Title: Enrollment History
    The enrollmentHistory resource provides the enrollment history details for the learning assignment.
  • Unique identifier for the learning enrollment questionnaire.
  • Title: Date Learning Item Entered Pending Seat Acceptance
    Date when the learning assignment entered the pending seat acceptance status.
  • Errors
    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.
  • Title: Date Learning Item Exited Pending Seat Acceptance
    Date when the learning assignment exited the pending seat acceptance status.
  • learningItemDFF
  • Learning Item Rating Details
    Title: Learning Item Rating Details
    The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status.
  • Title: Assigned Learning Item Type
    Maximum Length: 32
    Learning item type, such as Course, Specialization, Tutorial, or Video. Valid values are defined in theAssignedLearningItemTypeLOV list.
  • Messages
    Title: Messages
    The messages resource provides the message text, code, and severity of the messages displayed for the learning item.
  • offeringDFF
  • Title: Offering Primary Classroom Type
    Maximum Length: 255
    Primary classroom type, such as Physical Classroom, Virtual Classroom, or No Location Defined.
  • Questionnaire Responses
    Title: Questionnaire Responses
    The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
  • Title: Status Change Reason Code
    Maximum Length: 30
    Reason code for the other selected course offering assignment. Valid values are defined in the ReasonCodeLOV list.
  • Title: Request Completion Date
    Learning request completion by date specified on the past renewal assignment for the selected course offering.
  • Title: Enrolled on Date
    Request start date specified for the selected learning offering assignment.
  • Title: Comments
    Maximum Length: 4000
    Status change comment for the other selected learning course offering.
  • Transaction Histories
    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.
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 : 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 : Messages
Type: array
Title: Messages
The messages resource provides the message text, code, and severity of the messages displayed for the learning item.
Show Source
Nested Schema : offeringDFF
Type: array
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 : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-assignmentDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-completionDetails-activityCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-activitySectionCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-completionDetails-classrooms-attachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-classrooms-classroomDFFs-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-instructors-item-patch-request
Type: object
Show Source
Nested Schema : instructorDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-instructors-instructorDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-offeredLanguages-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-offeredLocations-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-relatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionSummary-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-enrollmentHistory-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-errors-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-learningItemDFF-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Rater Person Details
Type: array
Title: Rater Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-learningItemRatingDetails-ratedByPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-offeringDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-transactionHistory-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
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 : 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 the message text, code, and severity of the messages displayed for the learning item.
Show Source
Nested Schema : offeringDFF
Type: array
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 : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-assignmentDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-activityCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-completionDetails-activitySectionCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-classrooms-attachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-completionDetails-classrooms-classroomDFFs-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-completionDetails-instructors-item-patch-request
Type: object
Show Source
Nested Schema : instructorDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-completionDetails-instructors-instructorDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-completionDetails-offeredLanguages-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-completionDetails-offeredLocations-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-completionDetails-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-completionDetails-relatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-completionSummary-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-enrollmentHistory-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-enrollmentRelatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemDFF-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Rater Person Details
Type: array
Title: Rater Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRelatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-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-primarySelectedCourseOffering-offeringDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-transactionHistory-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-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-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-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-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-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-relatedMaterials-item-patch-request
Type: object
Show Source
Nested 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 : Assigner Person Details
Type: array
Title: Assigner 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 the message text, code, and severity of the messages displayed for the learning item.
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
The userActionHints resource provides 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 : learnerLearningRecords-completionDetails-selectedCourseOfferings-completionDetails-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-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 : schema
Type: object
Show Source
Nested Schema : Rater Person Details
Type: array
Title: Rater 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 : learnerLearningRecords-completionDetails-selectedCourseOfferings-offeringPrimaryClassroom-attachments-item-patch-request
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 : learnerLearningRecords-completionDetails-selectedCourseOfferings-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-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-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-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.
Nested Schema : learnerLearningRecords-completionDetails-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.
Nested Schema : learnerLearningRecords-completionSummary-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-courseDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-enrollmentHistory-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-enrollmentRelatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-learningItemAuthorPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-learningItemCoordinatorPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : learningItemDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-learningItemDetails-learningItemDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-learningItemDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-learningItemInstructorPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-learningItemPublisherPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-learningItemRatingDetails-item-patch-request
Type: object
Show Source
Nested Schema : Rater Person Details
Type: array
Title: Rater Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : learnerLearningRecords-learningItemRatingDetails-ratedByPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-learningItemRelatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-learningOutcomes-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-learningPrerequisites-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-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-offeredLanguages-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-item-patch-request
Type: object
Show Source
  • Title: Offering Active Date
    Date when the learning assignment moved to an active status.
  • Title: Assigner Attribution Type
    Maximum Length: 30
    Default Value: ORA_PERSON
    Entity type for the learning assignment creator, such as person, specialist, or community. Valid values are defined in the AssignerToAttributionTypeLOV list.
  • assignmentDFF
  • Title: Due Date
    Due date for the other selected course offering assignment.
  • Title: Justification
    Maximum Length: 4000
    Justification provided by the specialist when assigning, or the learner when enrolling in, a course offering assignment.
  • Title: Enrollment Record Status
    Maximum Length: 32
    Default Value: ORA_ASSN_REC_ACTIVE
    Status for the learning enrollment, such as Active, Content Completed, Completed, Withdrawn, or Deleted. Valid values are defined in the AssignmentStatusLOV list.
  • Title: Can Edit Assignment Hint
    Maximum Length: 4000
    Assignment hint, such as Can delete, Can withdraw, or No edit, for the learning assignment. Valid values are defined in the CanEditAssignmentHintLOV list.
  • Completion Details
    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.
  • Completion Summaries
    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.
  • 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.
  • Enrollment History
    Title: Enrollment History
    The enrollmentHistory resource provides the enrollment history details for the learning assignment.
  • Unique identifier for the learning enrollment questionnaire.
  • Title: Date Learning Item Entered Pending Seat Acceptance
    Date when the learning assignment entered the pending seat acceptance status.
  • Errors
    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.
  • Title: Date Learning Item Exited Pending Seat Acceptance
    Date when the learning assignment exited the pending seat acceptance status.
  • learningItemDFF
  • Learning Item Rating Details
    Title: Learning Item Rating Details
    The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status.
  • Title: Assigned Learning Item Type
    Maximum Length: 32
    Learning item type, such as Course, Specialization, Tutorial, or Video. Valid values are defined in theAssignedLearningItemTypeLOV list.
  • Messages
    Title: Messages
    The messages resource provides the message text, code, and severity of the messages displayed for the learning item.
  • offeringDFF
  • Title: Offering Primary Classroom Type
    Maximum Length: 255
    Primary classroom type, such as Physical Classroom, Virtual Classroom, or No Location Defined.
  • Questionnaire Responses
    Title: Questionnaire Responses
    The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
  • Title: Status Change Reason Code
    Maximum Length: 30
    Reason code for the other selected course offering assignment. Valid values are defined in the ReasonCodeLOV list.
  • Title: Request Completion Date
    Learning request completion by date specified on the past renewal assignment for the selected course offering.
  • Title: Enrolled on Date
    Request start date specified for the selected learning offering assignment.
  • Title: Comments
    Maximum Length: 4000
    Status change comment for the other selected learning course offering.
  • Transaction Histories
    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.
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 : 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 : Messages
Type: array
Title: Messages
The messages resource provides the message text, code, and severity of the messages displayed for the learning item.
Show Source
Nested Schema : offeringDFF
Type: array
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 : learnerLearningRecords-otherSelectedCourseOfferings-assignmentDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-completionDetails-activityCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-completionDetails-activitySectionCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-completionDetails-classrooms-attachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-completionDetails-classrooms-classroomDFFs-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-completionDetails-instructors-item-patch-request
Type: object
Show Source
Nested Schema : instructorDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-completionDetails-instructors-instructorDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-completionDetails-offeredLanguages-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-completionDetails-offeredLocations-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-completionDetails-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-completionDetails-relatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-completionSummary-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-enrollmentHistory-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-errors-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-learningItemDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-learningItemRatingDetails-item-patch-request
Type: object
Show Source
Nested Schema : Rater Person Details
Type: array
Title: Rater Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-learningItemRatingDetails-ratedByPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-offeringDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-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-otherSelectedCourseOfferings-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-otherSelectedCourseOfferings-transactionHistory-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-pastRenewals-item-patch-request
Type: object
Show Source
Nested Schema : Related Learning Records
Type: array
Title: Related Learning Records
The relatedLearningRecords resource provides details of the related learning assignments for the learning assignment.
Show Source
Nested Schema : learnerLearningRecords-pastRenewals-relatedLearningRecords-item-patch-request
Type: object
Show Source
  • Title: Actual Effort in Hours
    Actual learner effort, in hours, to complete the related learning assignment.
  • Title: Assigner Comments to Learner
    Maximum Length: 4000
    Assigner comments to the learner made while creating the related learning assignment. It's null when there are no comments.
  • Title: Due Date
    Due date of the learning-specialist-created assignment. The value is null for voluntary assignments.
  • Title: Can Edit Assignment Hint
    Maximum Length: 4000
    Specifies whether you can edit the assignment hint, such as Can delete, Can withdraw, or No edit, for the related learning assignment. Valid values are defined in the CanEditAssignmentHintLOV list.
  • 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: Learning Item Maximum Price
    Maximum price for the learning item.
  • Title: Learning Item Minimum Price
    Minimum price for the learning item.
  • Title: Learning Item Currency
    Currency for the learning item price. Valid values are defined in the PriceCurrencyLOVVA list.
  • Title: Assigned Learning Item Title
    Maximum Length: 250
    Title of the learning item.
  • Title: Learning Item Short Description
    Maximum Length: 4000
    Short description provided while creating the learning item.
  • Title: Learning Item Total Expected Effort
    Expected effort to complete the related learning assignment item.
  • Title: Learning Item Total Expected Effort Units
    Maximum Length: 30
    Unit of measure for the expected effort to complete the related learning assignment item. Valid values are defined in the LiTotalExpectedEffortUomLOV list.
  • Title: Purchase Amount
    Purchase amount for the requested learning assignment.
  • Title: Purchase Currency
    Maximum Length: 19
    Purchase currency for the requested learning assignment. Valid values are defined in the PriceCurrencyLOVVA list.
  • Title: Requested Start By
    Learning request start date specified in the related learning assignment.
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-item-patch-request
Type: object
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 : 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 the message text, code, and severity of the messages displayed for the learning item.
Show Source
Nested Schema : offeringDFF
Type: array
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 : learnerLearningRecords-primarySelectedCourseOffering-assignmentDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-activityCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activitySectionCompletionPredecessorHint-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-classrooms-attachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-classroomDFFs-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-item-patch-request
Type: object
Show Source
Nested Schema : instructorDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-instructorDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLanguages-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLocations-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-relatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionSummary-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-enrollmentHistory-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-enrollmentRelatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemRatingDetails-item-patch-request
Type: object
Show Source
Nested Schema : Rater Person Details
Type: array
Title: Rater Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemRelatedMaterials-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-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-primarySelectedCourseOffering-offeringDFF-item-patch-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-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-primarySelectedCourseOffering-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type: object
Show Source