Create an assignment record

post

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords

Request

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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Date when the assignment record moved to an active status.
  • Active Learner Comments
    Title: Active Learner Comments
    The activeLearnerComments resource is a child of the learnerLearningRecords resource. It provides details of all comments of active and completed learners for the learning item associated to a learner's assignment record.
  • Title: Actual CPE Units
    Continuing professional education units achieved by the learner for this assignment.
  • Title: Actual Effort in Hours
    Actual effort, in hours, that it took the learner to complete the assignment.
  • Title: Actual Score
    Actual Score achieved by the learner for the assignment.
  • Approval Details
    Title: Approval Details
    The approvalDetails resource is a child of the learnerLearningRecords resource. It provides the approval details information associated with the learning record.
  • Title: Enrolled on Date
    Start date of the learning that's visible to the learner in self service.
  • Title: Assignee Person ID
    Unique identifier of the person to whom the learning item was assigned.
  • Assigned To Person Details
    Title: Assigned To Person Details
    The assignedToPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assignee of the assignment records.
  • Title: Assigner Attribution Type
    Maximum Length: 30
    Default Value: ORA_PERSON
    Entity type that created the learning record, such as person, specialist, or community. Valid values are defined in the list AssignerToAttributionTypeLOV.
  • Title: Assigner Comments to Learner
    Maximum Length: 4000
    Comments specified by the assigner for the learner when creating the assignment. It's null when no comment is provided.
  • Assigner Person Details
    Title: Assigner Person Details
    The assignerPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assigner of the learner's assignment records.
  • Title: Assigner Attribution ID
    Unique identifier of the entity creating the learning record.
  • Assignment Descriptive Flexfields
    Title: Assignment Descriptive Flexfields
    The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
  • Title: Due Date
    Due date of the assignment provided by the learning specialist when enrolling for a learning item. It's null for voluntary assignment.
  • Title: Justification
    Maximum Length: 4000
    Justification provided by the learner during a request or the justification added by the specialist in the Learning Request Details during the assignment.
  • Title: Enrollment Record ID
    Unique identifier for the enrollment record.
  • Title: Enrollment Record Status
    Maximum Length: 32
    Default Value: ORA_ASSN_REC_ACTIVE
    Status of the enrollment, such as Active, Content Completed, Completed, Withdrawn and Deleted. Valid values are defined in the list AssignmentStatusLOV.
  • Title: Enrollment Record Substatus
    Maximum Length: 30
    Default Value: ORA_ASSN_REC_NOTSTARTED
    Granular status of the enrollment. For example, No Offering Selected, Not Started, In Progress, and Pending Active are various substatuses for the Active status. Valid values are defined in the list AssignmentSubStatusLOV.
  • Title: Enrollment Type
    Maximum Length: 30
    Type of the enrollment, such as required or voluntary. Valid values are defined in the list AssignmentTypeLOV.
  • Title: Can Edit Assignment Hint
    Maximum Length: 4000
    Specifies whether you can edit the assignment hint on the learning record, such as Can delete, Can withdraw, No edit. Valid values are defined in the list CanEditAssignmentHintLOV.
  • Title: Completed Date
    Date when the learning was completed.
  • Completion Details
    Title: Completion Details
    The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
  • Completion Summaries
    Title: Completion Summaries
    The completionSummary resource is a child of the learnerLearningRecords resource. It provides completion summary for assignment records as a collection or a single assignment record when queried with Assignment Record Id. It provides completion requirement and completion progress of a course offering associated to assignment record. The completion summary includes details like passing score and actual score, expected number of activities and effort for completion and completion progress of course offering associated with an assignment record.
  • Course Descriptive Flexfields
    Title: Course Descriptive Flexfields
    The courseDFF resource is a child of the learnerLearningRecords resource. It provides additional course information stored in flexfields.
  • Title: Data Security Privilege
    Maximum Length: 32
    Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
  • Enrollment History
    Title: Enrollment History
    The enrollmentHistory resource is a child of the learnerLearningRecords resource. It provides the details of the enrollment history for the learning record.
  • Unique identifier of the enrollment questionnaire.
  • Enrollment Related Materials
    Title: Enrollment Related Materials
    The enrollmentRelatedMaterials resource a child of the learnerLearningRecords resource. It provides related materials associated to a learner's assignment record.
  • Title: Date Learning Item Entered Pending Seat Acceptance
    Date when the assignment record entered the pending seat acceptance status.
  • Title: Date Learning Item Exited Pending Seat Acceptance
    Date when the assignment record exited the pending seat acceptance status.
  • Title: Learning Item Completion Certificate Link
    URL to open and download the learning item completion certificate directly from the browser. This is supported for completed and bypass completed assignments of a course, specialization, or legacy learning item type.
  • Title: Learning Item CPE Type
    Maximum Length: 30
    Continuing professional education type of the learning item. Valid values are defined in the list CpeTypeLOV.
  • Title: Learning Item Deep Link
    Maximum Length: 4000
    URL to open the learning item page directly from the browser.
  • Learning Item Descriptive Flexfields
    Title: Learning Item Descriptive Flexfields
    The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
  • Title: Assigned Learning Item ID
    Unique identifier for the learning item that's the internal primary key.
  • Title: Learning Item Maximum Price
    Maximum price for the learning item.
  • Title: Learning Item Minimum Price
    Minimum price for the learning item.
  • Title: Assigned Learning Item Number
    Maximum Length: 30
    Friendly number identifying the learning item. It's a surrogate key that's shown in the UI.
  • Title: Learning Item Currency
    Currency of the price for the learning item. Valid values are defined in the list PriceCurrencyLOVVA.
  • Learning Item Publisher Person Details
    Title: Learning Item Publisher Person Details
    The learningItemPublisherPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the publisher of the learning items associated to a learner's assignment records.
  • Learning Item Rating Details
    Title: Learning Item Rating Details
    The learningItemRatingDetails resource is a child of the learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner???s assignment record.
  • Learning Item Related Materials
    Title: Learning Item Related Materials
    The learningItemRelatedMaterials resource is a child of the learnerLearningRecords resource. It provides related materials for the learning item associated to a learner's assignment record.
  • Title: Assigned Learning Item Subtype
    Maximum Length: 30
    Learning item subtype, such as Video and Tutorial. Valid values are defined in the list AssignedLearningItemSubTypeLOV.
  • Title: Assigned Learning Item Title
    Maximum Length: 250
    Title of the learning item.
  • Title: Assigned Learning Item Type
    Maximum Length: 32
    Learning item type, such as Course, Specialization, Tutorial, and Video. Valid values are defined in the list AssignedLearningItemTypeLOV.
  • Learning Outcomes
    Title: Learning Outcomes
    The learningOutcomes resource is a child of the learnerLearningRecords resource. It provides the learning outcomes for the learning items associated to a learner's assignment records. This is applicable for course and specialization learning items.
  • Learning Prerequisites
    Title: Learning Prerequisites
    The learningPrerequisites resource is a child of the learnerLearningRecords resource. It provides the learning prerequisites for the learning items associated to learner's assignment records. This is applicable for course and specialization learning items.
  • Title: Learning Item Short Description
    Maximum Length: 4000
    Learning item short description provided while creating the learning item.
  • Title: Learning Item Total Expected Effort
    Expected effort to complete the learning item of the learning record.
  • Title: Learning Item Total Expected Effort Units
    Maximum Length: 30
    Units of measurement for the expected effort to complete the learning item of the learning record. Valid values are defined in the list LiTotalExpectedEffortUomLOV.
  • Messages
    Title: Messages
    The messages resource is a child of the learnerLearningRecords resource. It provides details of the messages that are relevant to the learning record.
  • Other Selected Course Offerings
    Title: Other Selected Course Offerings
    The otherSelectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings other than the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
  • Past Renewals
    Title: Past Renewals
    The pastRenewals resource is a child of the learnerLearningRecords resource.
  • Primary Selected Course Offerings
    Title: Primary Selected Course Offerings
    The primarySelectedCourseOffering resource is a child of the learnerLearningRecords resource. It provides the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
  • Title: Purchase Amount
    Purchase amount for the requested assignment.
  • Title: Purchase Currency
    Maximum Length: 19
    Purchase currency for the requested assignment. Valid values are defined in the list PriceCurrencyLOVVA.
  • 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
    Assignment reason code of the assignment. This attribute is used when the learner assignment is withdrawn or is marked complete by the manager. Valid values are defined in the list ReasonCodeLOV.
  • Related Learning Records
    Title: Related Learning Records
    The relatedLearningRecords resource is a child of the learnerLearningRecords resource. It provides details of the related learning records associated with a learner's assignment record.
  • Title: Request Completion Date
    Requested date by which the learner should complete the assignment.
  • Title: Requested Start By
    Learning request start date specified in the learning record.
  • Selected Course Offerings
    Title: Selected Course Offerings
    The selectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
  • Selected Course Offerings Summary
    Title: Selected Course Offerings Summary
    The selectedCourseOfferingsSummary resource is a child of the learnerLearningRecords resource. It provides a summary of all selected course offerings.
  • Specialization Descriptive Flexfields
    Title: Specialization Descriptive Flexfields
    The specializationDFF resource is a child of the learnerLearningRecords resource. It provides additional specialization information stored in flexfields.
  • Title: Comments
    Maximum Length: 4000
    Comment status change date of the this assignment.
  • Transaction Histories
    Title: Transaction Histories
    The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
  • User Action Hints
    Title: User Action Hints
    The userActionHints resource is a child of the learnerLearningRecords resource. It provides hints for possible actions on learner's assignment records.
Nested Schema : Active Learner Comments
Type: array
Title: Active Learner Comments
The activeLearnerComments resource is a child of the learnerLearningRecords resource. It provides details of all comments of active and completed learners for the learning item associated to a learner's assignment record.
Show Source
Nested Schema : Approval Details
Type: array
Title: Approval Details
The approvalDetails resource is a child of the learnerLearningRecords resource. It provides the approval details information associated with the learning record.
Show Source
Nested Schema : Assigned To Person Details
Type: array
Title: Assigned To Person Details
The assignedToPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assignee of the assignment records.
Show Source
Nested Schema : Assigner Person Details
Type: array
Title: Assigner Person Details
The assignerPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the assigner of the learner's assignment records.
Show Source
Nested Schema : Assignment Descriptive Flexfields
Type: array
Title: Assignment Descriptive Flexfields
The assignmentDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Show Source
Nested Schema : Completion Details
Type: array
Title: Completion Details
The completionDetails resource is a child of the learnerLearningRecords resource. It provides completion details for learner assignment when queried with Assignment Record Id. It provides the completion details of all the activities including Self-Paced Activity and Instructor-Led Activity that a learner has completed or will complete. The information provided is equivalent to seeing the Manage Activities of a learner's learning assignment from the Learning Administration work area.
Show Source
Nested Schema : Completion Summaries
Type: array
Title: Completion Summaries
The completionSummary resource is a child of the learnerLearningRecords resource. It provides completion summary for assignment records as a collection or a single assignment record when queried with Assignment Record Id. It provides completion requirement and completion progress of a course offering associated to assignment record. The completion summary includes details like passing score and actual score, expected number of activities and effort for completion and completion progress of course offering associated with an assignment record.
Show Source
Nested Schema : Course Descriptive Flexfields
Type: array
Title: Course Descriptive Flexfields
The courseDFF resource is a child of the learnerLearningRecords resource. It provides additional course information stored in flexfields.
Show Source
Nested Schema : Enrollment History
Type: array
Title: Enrollment History
The enrollmentHistory resource is a child of the learnerLearningRecords resource. It provides the details of the enrollment history for the learning record.
Show Source
Nested Schema : Enrollment Related Materials
Type: array
Title: Enrollment Related Materials
The enrollmentRelatedMaterials resource a child of the learnerLearningRecords resource. It provides related materials associated to a learner's assignment record.
Show Source
Nested Schema : Learning Item Descriptive Flexfields
Type: array
Title: Learning Item Descriptive Flexfields
The learningItemDFF resource is a child of the learnerLearningRecords resource. It provides additional learning item information stored in flexfields.
Show Source
Nested Schema : Learning Item Publisher Person Details
Type: array
Title: Learning Item Publisher Person Details
The learningItemPublisherPersonDetails resource is a child of the learnerLearningRecords resource. It provides details of the publisher of the learning items associated to a learner's assignment records.
Show Source
Nested Schema : Learning Item Rating Details
Type: array
Title: Learning Item Rating Details
The learningItemRatingDetails resource is a child of the learnerLearningRecords resource. It provides details of the ratings of the learning item associated to a learner???s assignment record.
Show Source
Nested Schema : Learning Item Related Materials
Type: array
Title: Learning Item Related Materials
The learningItemRelatedMaterials resource is a child of the learnerLearningRecords resource. It provides related materials for the learning item associated to a learner's assignment record.
Show Source
Nested Schema : Learning Outcomes
Type: array
Title: Learning Outcomes
The learningOutcomes resource is a child of the learnerLearningRecords resource. It provides the learning outcomes for the learning items associated to a learner's assignment records. This is applicable for course and specialization learning items.
Show Source
Nested Schema : Learning Prerequisites
Type: array
Title: Learning Prerequisites
The learningPrerequisites resource is a child of the learnerLearningRecords resource. It provides the learning prerequisites for the learning items associated to learner's assignment records. This is applicable for course and specialization learning items.
Show Source
Nested Schema : Messages
Type: array
Title: Messages
The messages resource is a child of the learnerLearningRecords resource. It provides details of the messages that are relevant to the learning record.
Show Source
Nested Schema : Other Selected Course Offerings
Type: array
Title: Other Selected Course Offerings
The otherSelectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings other than the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Show Source
Nested Schema : Past Renewals
Type: array
Title: Past Renewals
The pastRenewals resource is a child of the learnerLearningRecords resource.
Show Source
Nested Schema : Primary Selected Course Offerings
Type: array
Title: Primary Selected Course Offerings
The primarySelectedCourseOffering resource is a child of the learnerLearningRecords resource. It provides the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
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 is a child of the learnerLearningRecords resource. It provides details of the related learning records associated with a learner's assignment record.
Show Source
Nested Schema : Selected Course Offerings
Type: array
Title: Selected Course Offerings
The selectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Show Source
Nested Schema : Selected Course Offerings Summary
Type: array
Title: Selected Course Offerings Summary
The selectedCourseOfferingsSummary resource is a child of the learnerLearningRecords resource. It provides a summary of all selected course offerings.
Show Source
Nested Schema : Specialization Descriptive Flexfields
Type: array
Title: Specialization Descriptive Flexfields
The specializationDFF resource is a child of the learnerLearningRecords resource. It provides additional specialization information stored in flexfields.
Show Source
Nested Schema : Transaction Histories
Type: array
Title: Transaction Histories
The transactionHistory resource is a child of the learnerLearningRecords resource. It provides transaction history for the assignment record. In case of a course assignment record, it provides transaction history of the primary selected course offering.
Show Source
Nested Schema : User Action Hints
Type: array
Title: User Action Hints
The userActionHints resource is a child of the learnerLearningRecords resource. It provides hints for possible actions on learner's assignment records.
Show Source
Nested Schema : learnerLearningRecords-activeLearnerComments-item-post-request
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
  • Title: Comment
    Maximum Length: 4000
    Comment of the learner in conversations for active and completed learners for the learning item.
  • Title: Comment Status
    Maximum Length: 30
    Learner comment status in conversations for active and completed learners for the learning item. Valid values are defined in the list CommentStatusLOV.
  • Title: Data Security Privilege
    Default Value: ORA_LEARNER
    Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
  • Likes
    Title: Likes
    The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
  • Replies
    Title: Replies
    The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Show Source
Nested Schema : Likes
Type: array
Title: Likes
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Show Source
Nested Schema : Replies
Type: array
Title: Replies
The replies resource is a child of the activeLearnerComments resource. It provides details of the replies for comments of active and completed learners for the learning item associated to a learner's assignment record.
Show Source
Nested Schema : learnerLearningRecords-activeLearnerComments-attachments-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-activeLearnerComments-likes-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-activeLearnerComments-replies-item-post-request
Type: object
Show Source
  • Attachments
    Title: Attachments
    The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
  • Title: Comment
    Maximum Length: 4000
    Reply comment of the learner on a comment.
  • Title: Data Security Privilege
    Default Value: ORA_LEARNER
    Data security privilege, such as Learner or Learner Manager, is the intent of the user accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
  • Likes
    Title: Likes
    The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
  • Title: Reply Status
    Maximum Length: 30
    Status of the reply on a comment. Valid values are defined in the list ReplyStatusLOV.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is a child of the classrooms resource. It allows learners to download attachments of classrooms where visibility is set as self-service.
Show Source
Nested Schema : Likes
Type: array
Title: Likes
The likes resource is a child of the activeLearnerComments resource. It provides details of the likes for comments of active and completed learners for the learning item associated to a learner's assignment record.
Show Source
Nested Schema : learnerLearningRecords-activeLearnerComments-replies-attachments-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-activeLearnerComments-replies-likes-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-approvalDetails-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-assignedToPersonDetails-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-assignerPersonDetails-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-assignmentDFF-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-item-post-request
Type: object
Show Source
  • Title: Activity Attempt Status
    Maximum Length: 32
    Status of the activity when a learner does the activity. Valid values are ORA_ASSN_TASK_COMPLETED, ORA_ASSN_TASK_EXEMPTED, ORA_ASSN_TASK_INCOMPLETE, ORA_ASSN_TASK_NOT_STARTED, ORA_ASSN_TASK_IN_PROGRESS and are defined in the list ActivityAttemptStatusLOV.
  • Activity Completion Predecessor Hints
    Title: Activity Completion Predecessor Hints
    The activityCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity when sequencing is enabled.
  • Activity Content Attempts
    Title: Activity Content Attempts
    The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
  • Activity Section Completion Predecessor Hints
    Title: Activity Section Completion Predecessor Hints
    The activitySectionCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity section when sequencing is enabled.
  • Classrooms
    Title: Classrooms
    The classrooms resource is a child of the completionDetails resource. It provides classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
  • Instructors
    Title: Instructors
    The instructors resource is a child of the learnerLearningRecords resource. It provides the instructors associated with the learning record.
  • Learning Item Talent Profile Summaries
    Title: Learning Item Talent Profile Summaries
    The learningItemTalentProfileSummary resource is a child of the completionDetails resource. It provides talent profile summary for the learner???s assignment records for specialization course activities.
  • Offered Languages
    Title: Offered Languages
    The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
  • Offered Locations
    Title: Offered Locations
    The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
  • Other Selected Course Offerings
    Title: Other Selected Course Offerings
    The otherSelectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings other than the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
  • Primary Selected Course Offerings
    Title: Primary Selected Course Offerings
    The primarySelectedCourseOffering resource is a child of the learnerLearningRecords resource. It provides the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
  • Questionnaire Responses
    Title: Questionnaire Responses
    The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
  • Related Materials
    Title: Related Materials
    The relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
  • Selected Course Offerings
    Title: Selected Course Offerings
    The selectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
  • User Action Hints
    Title: User Action Hints
    The userActionHints resource is a child of the learnerLearningRecords resource. It provides hints for possible actions on learner's assignment records.
Nested Schema : Activity Completion Predecessor Hints
Type: array
Title: Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity when sequencing is enabled.
Show Source
Nested Schema : Activity Content Attempts
Type: array
Title: Activity Content Attempts
The activityContentAttempts resource is a child of the completionDetails resource. It provides the activity content and attempts details of the parent learning item type. It is a course with self-paced activity, tutorial, or video. With the Newsfeed User Experience enabled, this sub-resource will not support old videos and tutorials that have not been migrated to the new backend structure.
Show Source
Nested Schema : Activity Section Completion Predecessor Hints
Type: array
Title: Activity Section Completion Predecessor Hints
The activitySectionCompletionPredecessorHint resource is a child of the completionDetails resource. It provides hints for the predecessor of the activity section when sequencing is enabled.
Show Source
Nested Schema : Classrooms
Type: array
Title: Classrooms
The classrooms resource is a child of the completionDetails resource. It provides classroom details for Instructor-Led Activity of Instructor-Led and Blended Offering.
Show Source
Nested Schema : Instructors
Type: array
Title: Instructors
The instructors resource is a child of the learnerLearningRecords resource. It provides the instructors associated with the learning record.
Show Source
Nested Schema : Learning Item Talent Profile Summaries
Type: array
Title: Learning Item Talent Profile Summaries
The learningItemTalentProfileSummary resource is a child of the completionDetails resource. It provides talent profile summary for the learner???s assignment records for specialization course activities.
Show Source
Nested Schema : Offered Languages
Type: array
Title: Offered Languages
The offeredLanguages resource is a child of the completionDetails resource. It provides the offering language if the learning item type is a course.
Show Source
Nested Schema : Offered Locations
Type: array
Title: Offered Locations
The offeredLocations resource is a child of the completionDetails resource. It provides the offering location information if the learning type is a course.
Show Source
Nested Schema : Other Selected Course Offerings
Type: array
Title: Other Selected Course Offerings
The otherSelectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings other than the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Show Source
Nested Schema : Primary Selected Course Offerings
Type: array
Title: Primary Selected Course Offerings
The primarySelectedCourseOffering resource is a child of the learnerLearningRecords resource. It provides the primary selected offering of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
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 relatedMaterials resource is a child of the completionDetails resource. It provides related materials associated to the activity if the parent learning item type is a course or a specialization.
Show Source
Nested Schema : Selected Course Offerings
Type: array
Title: Selected Course Offerings
The selectedCourseOfferings resource is a child of the learnerLearningRecords resource. It provides all offerings of a course for which a learner has an assignment record. This resource is applicable only for a course learning item. The resource will be empty for any other learning item type.
Show Source
Nested Schema : User Action Hints
Type: array
Title: User Action Hints
The userActionHints resource is a child of the learnerLearningRecords resource. It provides hints for possible actions on learner's assignment records.
Show Source
Nested Schema : learnerLearningRecords-completionDetails-activityCompletionPredecessorHint-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-activityContentAttempts-item-post-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-activityContentAttempts-questionnaireResponses-item-post-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-activityContentAttempts-questionnaireResponses-questionResponses-item-post-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: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
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-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-item-post-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-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-post-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: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
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-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-activitySectionCompletionPredecessorHint-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-classrooms-item-post-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-classrooms-attachments-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-classrooms-classroomDFFs-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-instructors-item-post-request
Type: object
Show Source
Nested Schema : instructorDFF
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-instructors-instructorDFF-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-learningItemTalentProfileSummary-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-offeredLanguages-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-offeredLocations-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-item-post-request
Type: object
Show Source
Nested Schema : assignmentDFF
Type: array
Show Source
Nested Schema : completionDetails
Type: array
Show Source
Nested Schema : completionSummary
Type: array
Show Source
Nested Schema : enrollmentHistory
Type: array
Show Source
Nested Schema : errors
Type: array
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 is a child of the learnerLearningOfferings resource. It provides the details of the ratings for an offering.
Show Source
Nested Schema : Messages
Type: array
Title: Messages
The messages resource is a child of the learningAssignmentHints resource. It provides details of the messages that need to be displayed for the course.
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 : transactionHistory
Type: array
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-assignmentDFF-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-item-post-request
Type: object
Show Source
Nested Schema : activityCompletionPredecessorHint
Type: array
Show Source
Nested Schema : activityContentAttempts
Type: array
Show Source
Nested Schema : activitySectionCompletionPredecessorHint
Type: array
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 : offeredLanguages
Type: array
Show Source
Nested Schema : offeredLocations
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 : Attachments
Type: array
Title: Attachments
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-activityCompletionPredecessorHint-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-activityContentAttempts-item-post-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-post-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-item-post-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: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
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-post-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-post-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: Choice List
    Maximum Length: 2000
    Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses.
  • Title: Question Answer Id
    Surrogate identifier of the answer that a participant chose when responding to a single choice question.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Id
    Surrogate identifier for the question.
  • Title: Questionnaire Question Id
    Surrogate identifier for the question in a questionnaire.
  • Question Response Attachments
    Title: Question Response Attachments
    The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
  • Title: Question Response Id
    Surrogate identifier for the question response.
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-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-activitySectionCompletionPredecessorHint-item-post-request
Type: object
Show Source
Nested Schema : learnerLearningRecords-completionDetails-otherSelectedCourseOfferings-completionDetails-classrooms-item-post-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-post-request
Type: object
Show Source