Get a completion detail
get
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID2}/child/completionDetails/{completionDetailsUniqID}
Request
Path Parameters
-
completionDetailsUniqID(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
learnerLearningRecordsUniqID(required): string
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.
-
otherSelectedCourseOfferingsUniqID(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-item-response
Type:
Show Source
object-
activityAssignmentRecordId: integer
(int64)
Title:
Activity Assignment Record IDRead Only:trueActivity assignment record ID for the activity attempt. -
activityAttemptActualEffort: number
Title:
Actual EffortRead Only:trueActual learner effort to complete the activity. -
activityAttemptActualScore: number
Title:
Activity Attempt Actual ScoreRead Only:trueActual learner score for the activity attempt. -
activityAttemptAEUnits: string
Title:
Actual Effort UnitsRead Only:trueMaximum Length:120Actual units of learner effort to complete the activity. Valid values are defined in the ActivityAttemptActualEffortUnitsLOV list. -
activityAttemptAEUnitsMeaning: string
Title:
Actual Effort Units DescriptionRead Only:trueMaximum Length:4000Description of the activityAttemptAEUnitsMeaning attribute value. -
activityAttemptAssignedToDisplayName: string
Title:
Activity Attempt AssigneeRead Only:trueMaximum Length:30Display name of the learning activity attempt assignee. -
activityAttemptAssignedToId: integer
(int64)
Title:
Activity Attempt Assignee Person IDRead Only:trueFriendly number identifying the learning activity attempt assignee. -
activityAttemptAssignedToNumber: string
Title:
Activity Attempt Assignee Person NumberRead Only:trueMaximum Length:30Friendly number identifying the learning activity attempt assignee. -
activityAttemptAssignedToType: string
Title:
Activity Attempt Assignee TypeRead Only:trueMaximum Length:30Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list. -
activityAttemptAssignedToTypeMeaning: string
Title:
Activity Attempt Assignee Type DescriptionRead Only:trueDescription of the activity attempt assigned to type. -
activityAttemptComplDate: string
(date-time)
Title:
Activity Attempt Completed DateRead Only:trueCompletion date of the activity attempt. -
activityAttemptCompletionReasonCode: string
Title:
Activity Attempt Exempted Reason CodeMaximum Length:30Reason code for completion of a learning activity attempt. -
activityAttemptDeepLink: string
Title:
Activity Attempt Deep LinkRead Only:trueMaximum Length:4000Deep link URL for the activity when opened in a browser. It opens the learning item activity player. -
activityAttemptEmbedLink: string
Title:
Activity Attempt Embed LinkRead Only:trueMaximum Length:4000Deep link URL to embed the learning activity page in other pages. -
activityAttemptExemptedDate: string
(date-time)
Title:
Activity Attempt Exempted DateRead Only:trueAttempt exemption date for the learning activity attempt. -
activityAttemptExemptedRC: string
Title:
Activity Attempt Exempted Reason CodeRead Only:trueMaximum Length:30Reason for the activity attempt exemption, such as Exempted - completed elsewhere, Exempted - higher level certification attained, or Completed offline and status verified. Valid values are defined in the AttemptExemptedReasonLOV list. -
activityAttemptExemptedRCMeaning: string
Title:
Activity Attempt Exempted Reason Code DescriptionRead Only:trueMaximum Length:4000Description of the activityAttemptExemptedRCMeaning attribute value. -
activityAttemptId: number
Title:
Activity Attempt IDRead Only:trueApplication-generated primary key. -
activityAttemptLocked: string
Title:
Activity Attempt LockedRead Only:trueMaximum Length:1Indicates whether the learning activity attempt is locked. Valid values are Y and N. Default value is N. -
activityAttemptNextAction: string
Title:
Activity Attempt Next ActionRead Only:trueMaximum Length:19Next activity action when the learner is working on the activity. -
activityAttemptNumber: string
Title:
Activity Attempt NumberRead Only:trueMaximum Length:30Number of attempts for the self-paced learning activity. -
activityAttemptStartedDate: string
(date-time)
Title:
Activity Attempt Started DateRead Only:trueDate when the learner attempted the activity. -
activityAttemptStatus: string
Title:
Activity Attempt StatusMaximum Length:32Status for the activity the learner is working on. Valid values include ORA_ASSN_TASK_COMPLETED, ORA_ASSN_TASK_EXEMPTED, ORA_ASSN_TASK_INCOMPLETE, ORA_ASSN_TASK_NOT_STARTED, and ORA_ASSN_TASK_IN_PROGRESS. Valid value are defined in the list ActivityAttemptStatusLOV. -
activityAttemptStatusMeaning: string
Title:
Activity Attempt Status DescriptionRead Only:trueMaximum Length:4000Description of the activityAttemptStatusMeaning attribute value. -
activityCompletionPredecessorHint: array
Activity Completion Predecessor Hints
Title:
Activity Completion Predecessor HintsThe activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled. -
activityComplRequirement: string
Title:
Activity Completion RequirementRead Only:trueMaximum Length:120Completion requirement for the learning activity. Valid values are defined in the ActivityCompletionRequirementLOV list. -
activityComplRequirementMeaning: string
Title:
Activity Completion Requirement DescriptionRead Only:trueMaximum Length:4000Description of the activityComplRequirementMeaning attribute value. -
activityContentAttempts: array
Activity Content Attempts
Title:
Activity Content AttemptsThe 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. -
activityContentDisplayMode: string
Read Only:
trueMaximum Length:30Determines how learners see the content, such as embedded. -
activityCoverArtLink: string
Title:
Activity Cover Art LinkRead Only:trueMaximum Length:4000URL to open the cover art directly from the browser. -
activityDate: string
(date)
Title:
Activity DateRead Only:trueDate when the ILT activity is worked on. Doesn't apply to any other types of activities. -
activityDescription: string
Title:
Activity DescriptionRead Only:trueMaximum Length:4000Description of the learning activity. -
activityDescriptionLong: string
(byte)
Read Only:
trueLong description of the learning activity. -
activityDisplayOrder: number
Title:
Activity PositionRead Only:trueDisplay order for the learning activities. -
activityEffortUnits: string
Title:
Activity Effort UnitsRead Only:trueMaximum Length:120Unit used to measure the effort required to complete the learning activity, such as hour, minute, or month. Valid values are defined in the ActivityExpectedEffortUnitsLOV list. -
activityEffortUnitsMeaning: string
Title:
Activity Effort Units DescriptionRead Only:trueMaximum Length:4000Description of the learning activity effort units. -
activityEndDatetimeUTC: string
(date-time)
Title:
Activity End DateRead Only:trueLearning activity end time expressed in UTC format. -
activityEndTime: string
Title:
Activity End TimeRead Only:trueMaximum Length:32ILT activity end time in the user's preferred time zone. Doesn't apply to any other types of activities. -
activityExpectedEffort: string
Title:
Expected EffortRead Only:trueMaximum Length:83Expected effort for the learning activity. -
activityId: integer
(int64)
Title:
Activity IDRead Only:trueApplication-generated primary key of the learning activity. -
activityLearnerMarkCompl: string
Title:
Learner Can Mark Activity CompleteRead Only:trueMaximum Length:1Indicates whether the learner can mark the activity as completed. -
activityLearnerRecordAttendance: string
Read Only:
trueMaximum Length:1Indicates whether learners can record their attendance for an activity. -
activityNumber: string
Title:
Activity NumberRead Only:trueMaximum Length:30Friendly number identifying the learning activity in the user interface. -
activityPassingScore: number
Title:
Passing ScoreRead Only:truePassing score for the learning activity. -
activitySecComplRequired: number
Title:
Activity Section Required ActivitiesRead Only:trueCompletion requirement for the learning activity section. -
activitySectionAttemptCompletionProgress: number
Title:
Activity Section Attempt Completion ProgressRead Only:trueNumber of learning activities completed in a section. -
activitySectionAttemptLocked: string
Title:
Activity Section Attempt LockedRead Only:trueMaximum Length:1Indicates whether the attempt on the learning activity section is locked. Valid values are Y and N. Default value is N. -
activitySectionAttemptStatus: string
Title:
Activity Section Attempt StatusRead Only:trueMaximum Length:32Status of the attempt on the learning activity section. Valid values are defined in the learning activitySectionAttemptStatusLOV list. -
activitySectionAttemptStatusMeaning: string
Title:
Activity Section Attempt Status DescriptionRead Only:trueMaximum Length:4000Description of the activitySectionAttemptStatus attribute value. -
activitySectionCompletionPredecessorHint: array
Activity Section Completion Predecessor Hints
Title:
Activity Section Completion Predecessor HintsThe activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled. -
activitySectionDescription: string
Title:
Activity Section DescriptionRead Only:trueMaximum Length:4000Description of the learning activity section. -
activitySectionDisplayOrder: number
Title:
Activity Section PositionRead Only:trueDisplay order for the learning activity section. -
activitySectionId: number
Title:
Activity Section IDRead Only:trueApplication-generated primary key column. -
activitySectionLongDescription: string
(byte)
Title:
Long DescriptionRead Only:trueLong description of the learning activity. -
activitySectionNumber: string
Title:
Activity Section NumberRead Only:trueMaximum Length:30Number identifying the learning activity section. -
activitySectionTitle: string
Title:
Activity Section TitleRead Only:trueMaximum Length:250Name of the learning activity section. -
activitySectionTotalActivities: number
Title:
Activity Section Total ActivitiesRead Only:trueTotal number of learning activities in the section. -
activityShortDescription: string
Title:
Activity Short DescriptionRead Only:trueMaximum Length:4000Description of the learning content activity. -
activityShortTimeZone: string
Title:
Activity Time ZoneRead Only:trueMaximum Length:30Friendly format for the time zone. -
activityStartDatetimeUTC: string
(date-time)
Title:
Activity Start DateRead Only:trueLearning activity start time expressed in UTC format. -
activityStartTime: string
Title:
Activity Start TimeRead Only:trueMaximum Length:32ILT activity start time in the user's preferred time zone. Doesn't apply to any other types of activities. -
activityTimeZone: string
Title:
Activity Time ZoneRead Only:trueMaximum Length:30ILT activity time zone. Doesn't apply to any other types of activities. -
activityTitle: string
Title:
Activity TitleRead Only:trueMaximum Length:250Title of the learning activity. -
activityTotalAttempts: number
Title:
Activity Total AttemptsRead Only:trueTotal learner attempts on the activity. -
activityType: string
Title:
Activity TypeRead Only:trueMaximum Length:32Activity type of the learning assignment. If the learning assignment is for specialization, this represents a course. If the learning assignment is for a course, this represents offering types. Valid values are defined in the ActivityTypeLOV list. -
activityTypeMeaning: string
Title:
Activity Type DescriptionRead Only:trueMaximum Length:4000Description of the learning activity type. -
addToCalendarLink: string
Title:
Add to Calendar LinkRead Only:trueMaximum Length:4000Link to download the .ics file to add the ILT activity to the calendar. Doesn't apply to any other types of activities. -
allowFwdScrub: string
Title:
Allow learners to fast forwardRead Only:trueMaximum Length:30Indicates if forward scrubbing is enabled.Valid values are Y or N. -
classrooms: array
Classrooms
Title:
ClassroomsThe 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. -
completionItemId: integer
(int64)
Read Only:
trueApplication-generated primary key of the completion item. -
completionItemNumber: string
Read Only:
trueMaximum Length:30Friendly number identifying for identifying the completion item. -
dataSecurityPrivilege: string
Title:
Data Security PrivilegeRead Only:trueMaximum Length:32Data 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. -
dataSecurityPrivilegeMeaning: string
Title:
Data Security Privilege DescriptionRead Only:trueMaximum Length:4000Description of the value of the dataSecurityPrivilege attribute. -
elearnAttemptReview: string
Title:
eLearning Attempt ReviewRead Only:trueMaximum Length:120Indicates whether the learner can review the activity attempt. Valid values are ORA_WLF_ARAR_LAST_ATTEMPT, ORA_WLF_ARAR_DONT_ENABLE and are defined in the ELearnAttemptReviewLOV list. -
elearnAttemptReviewMeaning: string
Title:
eLearning Attempt Review DescriptionRead Only:trueMaximum Length:4000Description of the elearnAttemptReview attribute value. -
elearnAttemptsAllowed: number
Title:
eLearning Attempts AllowedRead Only:trueMaximum number of attempts allowed on the self-paced learning assessment activity. -
elearnAutoLaunchOnPageOpen: string
Read Only:
trueMaximum Length:255Indicates whether the content needs to be automatically launched when the enrollment page opens. -
elearnCoverArtLink: string
Title:
eLearning Cover Art LinkRead Only:trueMaximum Length:4000URL to open the eLearning cover art directly from the browser. -
elearnDisableContentReview: string
Title:
eLearning Disable Content ReviewRead Only:trueMaximum Length:1Indicates whether the content review is disabled for the self-paced learning activity. Valid values are Y and N. Default value is N for self-paced learning activity with content type such as Video, PDF, Web link, SCORM or HACP. -
elearnDisableReview: string
Title:
eLearning Disable ReviewRead Only:trueMaximum Length:1Disable reviews for the self-paced learning activity. -
elearnDisableReviewForPassedAttempts: string
Title:
eLearning Disable Review for Passed AttemptsRead Only:trueMaximum Length:1Indicates whether the review of passed attempts is disabled for the self-paced learning activity. Valid values are Y and N. Default value is Y. -
elearnHideActualScore: string
Title:
eLearning Hide Actual ScoreRead Only:trueMaximum Length:1Hide score for the self-paced learning activity. -
elearnId: number
Title:
eLearning IDRead Only:trueApplication-generated primary key for the eLearning content of the self-paced activity. -
eLearnMarkCompletionOnOpen: string
Title:
eLearning Mark Completion on OpenRead Only:trueMaximum Length:1Set the eLearning to complete when it's opened. -
elearnNumber: string
Title:
eLearning NumberRead Only:trueMaximum Length:30Number for identifying the content that backs the self-paced learning activity. -
elearnQuestionnaireId: integer
(int64)
Title:
Questionnaire IDRead Only:trueUnique identifier for the questionnaire that's the self-paced learning assessment activity. -
elearnQuestionnaireNumber: string
Title:
Questionnaire NumberRead Only:trueMaximum Length:19Question number of a question in the eLearning. -
elearnRecordedAttemptsRule: string
Title:
eLearning Recorded Attempts RuleRead Only:trueMaximum Length:120Rule for the maximum number of attempts allowed for the self-paced learning activity. Valid values are ORA_WLF_ARA_SNGL, ORA_WLF_ARA_LTD_NUM, ORA_WLF_ARA_UNLTD and are defined in the ELearnRecordedAttemptsRuleLOV list. -
elearnRecordedAttemptsRuleMeaning: string
Title:
eLearning Recorded Attempts Rule DescriptionRead Only:trueMaximum Length:4000Description of the elearnRecordedAttemptsRule attribute value. -
elearnRichMediaLink: string
Title:
eLearning Rich Media LinkRead Only:trueMaximum Length:4000URL to open the video directly from the browser. -
elearnRichMediaSrcLink: string
Title:
eLearning Rich Media Source LinkRead Only:trueMaximum Length:4000Link to the rich media source file. -
elearnShortDescription: string
Title:
eLearning DescriptionRead Only:trueMaximum Length:4000Description of the learning content for the self-paced activity. -
elearnShowResponseFeedback: string
Title:
eLearning Show Response FeedbackRead Only:trueMaximum Length:1Show response feedback for the self-paced learning activity. -
elearnTimePERAttempt: number
Title:
eLearning Time per AttemptRead Only:trueTime limit per attempt on the self-paced learning assessment activity. -
elearnTimePERAttemptUnits: string
Title:
eLearning Time per Attempt UnitsRead Only:trueMaximum Length:30Unit of measure for the time limit per attempt on the self-paced learning assessment activity, such as Hours or Minutes. Valid values are defined in the ELearnTimePerAttemptUnitsLOV list. -
elearnTimePERAttemptUnitsMeaning: string
Title:
eLearning Time per Attempt Units DescriptionRead Only:trueMaximum Length:4000Description of the elearnTimePERAttemptUnitsMeaning attribute value. -
elearnTitle: string
Title:
eLearning TitleRead Only:trueMaximum Length:250Name of the learning content for the self-paced activity. -
elearnType: string
Title:
eLearning TypeRead Only:trueMaximum Length:80Type of the self-paced learning, such as Video or SCORM. Valid values are defined in the LearnningContentTypeLOV list. -
elearnTypeMeaning: string
Title:
eLearning Type DescriptionRead Only:trueMaximum Length:4000Description of the elearnTypeMeaning attribute value. -
instructors: array
Instructors
Title:
InstructorsThe instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
offeredLanguages: array
Offered Languages
Title:
Offered LanguagesThe offeredLanguages resource provides the offering language for a learning item. -
offeredLocations: array
Offered Locations
Title:
Offered LocationsThe offeredLocations resource provides the location details for a learning item. -
parentLearningItemSubType: string
Title:
Parent Assigned Learning Item SubtypeRead Only:trueMaximum Length:32Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list. -
parentLearningItemSubTypeMeaning: string
Title:
Parent Assigned Learning Item Subtype DescriptionRead Only:trueMaximum Length:4000Description of the attribute learningItemSubType attribute value. -
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire ResponsesThe questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire. - relatedMaterials: array Related Materials
-
sectionAttemptComplDate: string
(date-time)
Title:
Activity Section Completion DateRead Only:trueDate when the learner successfully completed the learning activity section. -
virtualClassroomInformation: string
Title:
Virtual Classroom InformationRead Only:trueMaximum Length:19Additional information about the virtual classroom, if used in the learning activity. -
virtualClassroomJoinLink: string
Title:
Virtual Classroom Join LinkRead Only:trueMaximum Length:4000Link to join the virtual classroom, if used in the ILT activity. Doesn't apply to any other types of activities. -
virtualClassroomType: string
Title:
Virtual Classroom TypeRead Only:trueMaximum Length:40Type of the virtual classroom, such as ad-hoc virtual classroom, named virtual classroom, or no virtual classroom. Valid values are defined in the VirtualClassroomTypeLOV list. -
virtualClassroomTypeMeaning: string
Title:
Virtual Classroom Type DescriptionRead Only:trueDescription of the virtual classroom type.
Nested Schema : Activity Completion Predecessor Hints
Type:
arrayTitle:
Activity Completion Predecessor HintsThe activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.
Show Source
Nested Schema : Activity Content Attempts
Type:
arrayTitle:
Activity Content AttemptsThe 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:
arrayTitle:
Activity Section Completion Predecessor HintsThe activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.
Show Source
Nested Schema : Classrooms
Type:
arrayTitle:
ClassroomsThe 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:
arrayTitle:
InstructorsThe instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Offered Languages
Type:
arrayTitle:
Offered LanguagesThe offeredLanguages resource provides the offering language for a learning item.
Show Source
Nested Schema : Offered Locations
Type:
arrayTitle:
Offered LocationsThe offeredLocations resource provides the location details for a learning item.
Show Source
Nested Schema : Questionnaire Responses
Type:
arrayTitle:
Questionnaire ResponsesThe questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityCompletionPredecessorHint-item-response
Type:
Show Source
object-
activityAttemptAssignedToType: string
Title:
Activity Predecessor Attempt Assignee TypeRead Only:trueMaximum Length:30Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list. -
activityAttemptAssignedToTypeMeaning: string
Title:
Activity Predecessor Attempt Assignee Type DescriptionRead Only:trueDescription of the type of user assigned to the learning activity attempt. -
activityAttemptLocked: string
Title:
Activity Predecessor Attempt LockedRead Only:trueMaximum Length:1Indicates whether the learner can attempt the activity. Valid values are Y and N. Default value is N. -
activityAttemptNumber: string
Title:
Activity Predecessor Attempt NumberRead Only:trueMaximum Length:30Friendly number identifying the learning activity attempt. -
activityAttemptStatus: string
Title:
Activity Predecessor Attempt StatusRead Only:trueMaximum Length:32Status for the learning activity attempt. Valid values are Y and N. Default value is N. Valid values are defined in the learning activityAttemptStatusLOV list. -
activityNumber: string
Title:
Activity Predecessor NumberRead Only:trueMaximum Length:30Friendly number identifying the learning activity. -
activityTitle: string
Title:
Activity Predecessor TitleRead Only:trueMaximum Length:255Title of the activity. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-item-response
Type:
Show Source
object-
activityContentAttemptStatus: string
Title:
Content Attempt StatusRead Only:trueMaximum Length:120Status for the content attempt. Possible values are Complete, Exempted, Incomplete, and Not Completed. -
actualEffort: number
Title:
Actual EffortQuantity for the learner effort spent in the attempt. -
actualEffortUnits: string
Title:
Actual Effort UnitsRead Only:trueMaximum Length:30Default Value:ORA_DUR_HOURUnit of measure, such as hours or minutes, for the learner effort spent in the attempt. -
actualEffortUnitsMeaning: string
Title:
Actual Effort Units DescriptionRead Only:trueMaximum Length:4000Description of the actualEffortUnits attribute value. -
actualScore: number
Title:
ScoreRead Only:trueScore achieved in the attempt. -
attemptedByDisplayName: string
Title:
Attempted ByRead Only:trueDisplay name for the person who attempted the self-paced learning activity. -
attemptedById: integer
(int64)
Title:
Attempted by Person IDRead Only:trueUnique identifier for the person who attempted the self-paced learning activity. -
attemptedByNumber: string
Title:
Attempted by Person NumberRead Only:trueFriendly number identifying the person who attempted the self-paced learning activity. -
attemptEndDate: string
(date-time)
Title:
Last AttemptRead Only:trueDate when the attempt ended. -
attemptId: integer
(int64)
Title:
Attempt IDRead Only:trueUnique identifier for the self-paced learning activity or tutorial content attempt. -
attemptPosition: string
Title:
Attempt PositionRead Only:trueLearner attempt position in the activity. -
attemptRelationNumber: string
Title:
Attempt Relation NumberRead Only:trueMaximum Length:30Friendly number identifying the association between the learning activity attempt and attempt on the self-paced learning activity. -
attemptStartDate: string
(date-time)
Title:
Attempt Start DateRead Only:trueDate when the attempt started. -
attemptStatus: string
Title:
Last Attempt StatusRead Only:trueMaximum Length:120Status for the learning activity content attempt. Valid values are defined in the AttemptStatusLOV list. -
attemptStatusMeaning: string
Title:
Last Attempt Status DescriptionRead Only:trueMaximum Length:4000Description of the attemptStatus attribute value. -
chapterLevel: number
Title:
Chapter LevelRead Only:trueChapter level of the activity content. -
chapterPosition: string
Title:
Chapter PositionRead Only:trueMaximum Length:19Position of the chapter in the activity. -
contentCatalogLearningItemDataLink: string
Title:
Content Catalog Learning Item Data LinkMaximum Length:4000Data link to the catalog learning item added to the activity. -
contentCatalogLearningItemId: integer
Title:
Content Catalog Learning Item IDRead Only:trueUnique identifier for the catalog learning item added to the activity. -
contentCatalogLearningItemNumber: string
Title:
Content Catalog Learning Item NumberMaximum Length:250Friendly number identifying the catalog learning item added to the activity. It's a surrogate key that's shown in the user interface. -
contentCatalogLearningItemSubType: string
Title:
Content Catalog Learning Item SubtypeRead Only:trueMaximum Length:32Learning item subtype for the catalog learning item added to the activity. -
contentCatalogLearningItemType: string
Title:
Content Catalog Learning Item TypeRead Only:trueMaximum Length:32Learning item type for the catalog learning item added to the activity. -
contentCoverArtLink: string
Title:
Content Cover Art LinkRead Only:trueMaximum Length:4000URL to open the eLearning content cover art directly from the browser. -
contentId: integer
(int64)
Title:
Content IDRead Only:trueUnique identifier for the eLearning content. -
contentLongDescription: string
(byte)
Title:
Content Long DescriptionRead Only:trueLong description of the learning activity content. -
contentNumber: string
Title:
Content NumberRead Only:trueMaximum Length:30Friendly number identifying the learning activity content. -
contentShortDescription: string
Title:
Content Short DescriptionRead Only:trueMaximum Length:4000Short description of the activity content. -
contentTitle: string
Title:
Content TitleRead Only:trueMaximum Length:250Name of the activity content. -
contentType: string
Title:
Content TypeRead Only:trueMaximum Length:32Type of content, such as SCORM, HACP, VIDEO, or Tutorial. Valid values are defined in the ContentTypeLOV list. -
contentTypeMeaning: string
Title:
Content Type DescriptionRead Only:trueMaximum Length:4000Description of the contentType attribute value. -
contentURL: string
Title:
Content URLMaximum Length:4000URL to open the eLearning content directly from the browser. -
disableReview: string
Title:
Disable Viewing Completed AssessmentsRead Only:trueMaximum Length:1Disable reviews on the attempt. -
effortUnits: string
Title:
Effort UnitsRead Only:trueMaximum Length:30Unit of measure for the expected effort. -
elearnQuestionnaireId: integer
Unique identifier for the questionnaire that's the self-paced assessment learning activity.
-
elearnRichMediaLink: string
Read Only:
trueMaximum Length:4000URL to open the video directly from the browser. -
elearnRichMediaSrcLink: string
Title:
eLearning Rich Media Source LinkRead Only:trueMaximum Length:4000Source URL for the eLearning activity. -
expectedEffort: string
Title:
Expected EffortRead Only:trueMaximum Length:40Learner effort required to complete the activity content. -
hideActualScore: string
Title:
Hide Actual ScoreRead Only:trueMaximum Length:1Hide score on the attempt. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
passingScore: number
Title:
Passing ScoreRead Only:trueScore required to pass the activity content. -
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire ResponsesThe questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Questionnaire Responses
Type:
arrayTitle:
Questionnaire ResponsesThe 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-response
Type:
Show Source
object-
AttemptNumber: integer
(int64)
Title:
Attempt NumberRead Only:trueThe attempt number of a participant when responding to a questionnaire. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the questionnaire response. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the questionnaire response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate on which the questionnaire response was updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the questionnaire response. -
LatestAttemptFlag: boolean
Title:
Latest AttemptRead Only:trueMaximum Length:30Default Value:falseIndicates if the response is the latest attempt by a participant to the questionnaire. This is a read-only attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
QuestionnaireParticipantId: integer
(int64)
Title:
Questionnaire Participant IdSurrogate identifier for the questionnaire participant. -
QuestionnaireResponseId: integer
(int64)
Title:
Questionnaire Response IdSurrogate identifier for the questionnaire response. -
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire VersionVersion number of the questionnaire that the participant responds to. -
questionResponses: array
Question Responses
Title:
Question ResponsesThe questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Status: string
Title:
Response Status CodeMaximum Length:30Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response. -
StatusMeaning: string
Title:
Response StatusRead Only:trueMaximum Length:80Meaning of the status code. -
SubmittedDateTime: string
(date)
Title:
Submitted TimeRead Only:trueDate on which the questionnaire response was submitted. -
TotalScore: number
Title:
Total ScoreRead Only:trueTotal score for the responses submitted by a participant for a questionnaire.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
arrayTitle:
Question ResponsesThe 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-response
Type:
Show Source
object-
AnswerCode: string
Title:
Answer CodeRead Only:trueMaximum Length:240The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code ListConcatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
CommentsMaximum Length:4000Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
AnswerAttachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer ListMaximum Length:2000Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short DescriptionRead Only:trueMaximum Length:240Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short DescriptionRead Only:trueConcatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List CodeConcatenated 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. -
ChoiceList: string
Title:
Choice ListMaximum Length:2000Concatenated 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. -
ChoiceShortDescription: string
Title:
Choice Short DescriptionRead Only:trueConcatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the question response. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer IdSurrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question CodeMaximum Length:240Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question IdSurrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question IdSurrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response AttachmentsThe questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response IdSurrogate identifier for the question response. -
QuestionText: string
Title:
Question TextRead Only:trueMaximum Length:2000Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer ScoreRead Only:trueCalculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
arrayTitle:
Question Response AttachmentsThe 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-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the attachment was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAttachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path of the folder. -
DmVersionNumber: string
Maximum Length:
255Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the attachment file. -
FileUrl: string
Title:
File UrlFile URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the attachment record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
QuestionResponses: array
Question Responses
Title:
Question ResponsesThe questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File SizeSize of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File NameName of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded TextText uploaded in the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of the attachment. This is a read-only attribute. -
Url: string
Title:
UrlMaximum Length:4000URL of a web page attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
arrayTitle:
Question ResponsesThe 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-response
Type:
Show Source
object-
AnswerCode: string
Title:
Answer CodeRead Only:trueMaximum Length:240The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code ListConcatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
CommentsMaximum Length:4000Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
AnswerAttachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer ListMaximum Length:2000Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short DescriptionRead Only:trueMaximum Length:240Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short DescriptionRead Only:trueConcatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List CodeConcatenated 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. -
ChoiceList: string
Title:
Choice ListMaximum Length:2000Concatenated 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. -
ChoiceShortDescription: string
Title:
Choice Short DescriptionRead Only:trueConcatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the question response. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer IdSurrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question CodeMaximum Length:240Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question IdSurrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question IdSurrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response AttachmentsThe questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response IdSurrogate identifier for the question response. -
QuestionText: string
Title:
Question TextRead Only:trueMaximum Length:2000Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer ScoreRead Only:trueCalculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
arrayTitle:
Question Response AttachmentsThe 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-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the attachment was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAttachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path of the folder. -
DmVersionNumber: string
Maximum Length:
255Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the attachment file. -
FileUrl: string
Title:
File UrlFile URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the attachment record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File SizeSize of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File NameName of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded TextText uploaded in the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of the attachment. This is a read-only attribute. -
Url: string
Title:
UrlMaximum Length:4000URL of a web page attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activitySectionCompletionPredecessorHint-item-response
Type:
Show Source
object-
activitySectionAttemptAssignedToType: string
Title:
Activity Section Predecessor Attempt Assignee TypeRead Only:trueMaximum Length:30Type of user, such as Learner or Observer, assigned to the activity section attempt. Valid values are defined in the ActivitySectionAttemptAssignedToTypeLOV list. -
activitySectionAttemptAssignedToTypeMeaning: string
Title:
Activity Section Predecessor Attempt Assignee Type DescriptionRead Only:trueDescription of the type of user assigned to the learning activity section attempt. -
activitySectionAttemptLocked: string
Title:
Activity Section Predecessor Attempt LockedRead Only:trueMaximum Length:1Indicates whether the learner can attempt the activity section. Valid values are Y and N. Default value is N. Valid values are defined in the ActivitySectionAttemptStatusLOV. -
activitySectionAttemptNumber: string
Title:
Activity Section Predecessor Attempt NumberRead Only:trueMaximum Length:30Friendly number identifying the learning activity section attempt. -
activitySectionAttemptStatus: string
Title:
Activity Section Predecessor Attempt StatusRead Only:trueMaximum Length:32Status for the learning activity section attempt. Valid values are defined in the learning activitySectionAttemptStatusLOV list. -
activitySectionNumber: string
Title:
Activity Section Predecessor NumberRead Only:trueMaximum Length:30Friendly number identifying the learning activity section. -
activitySectionTitle: string
Title:
Activity Section Predecessor TitleRead Only:trueMaximum Length:255Title of the activity section. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-item-response
Type:
Show Source
object-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
classroomDescription: string
Title:
Classroom DescriptionRead Only:trueMaximum Length:4000Description of the classroom. -
classroomDFFs: array
classroomDFFs
-
classroomId: integer
(int64)
Title:
Classroom IDRead Only:trueSystem-generated primary key for a classroom. -
classroomNumber: string
Title:
Classroom NumberRead Only:trueMaximum Length:30Friendly number for identifying a classroom. -
classroomTitle: string
Title:
Classroom TitleRead Only:trueMaximum Length:250Name of the classroom. -
contactPersonDisplayName: string
Title:
Contact Person Display NameRead Only:trueMaximum Length:240Display name for the person who's the classroom contact. -
contactPersonId: integer
(int64)
Title:
Contact Person IDRead Only:trueIdentifier for the person who's the classroom contact. -
contactPersonImageURL: string
Title:
Contact Person Image URLRead Only:trueMaximum Length:32Image URL for the person who's the classroom contact. -
contactPersonNumber: string
Title:
Contact Person NumberRead Only:trueMaximum Length:30Person number for the classroom contact person. -
contactPersonPrimaryEmailAddress: string
Title:
Contact Person Primary Email AddressRead Only:trueMaximum Length:60Primary email address of the person who's the classroom contact. -
contactPersonPrimaryPhoneNumber: string
Title:
Contact Person Primary Phone NumberRead Only:trueMaximum Length:240Primary phone number for the person who's the classroom contact. -
isPrimaryClassroom: string
Title:
Primary ClassroomRead Only:trueMaximum Length:1Indicates whether the classroom is a primary classroom. The default value is N. Valid values are Y and N. -
isPrimaryClassroomMeaning: string
Title:
Primary Classroom DescriptionRead Only:trueMaximum Length:4000Description of the value of the isPrimaryClassroom attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
locationAddressLine1: string
Title:
Location Address Line 1Read Only:trueMaximum Length:240Location address line 1. -
locationAddressLine2: string
Title:
Location Address Line 2Read Only:trueMaximum Length:240Location address line 2. -
locationAddressLine3: string
Title:
Location Address Line 3Read Only:trueMaximum Length:240Location address line 3. -
locationCity: string
Title:
Location CityRead Only:trueMaximum Length:60City of the classroom. -
locationCountry: string
Title:
Location CountryRead Only:trueMaximum Length:60Country of the classroom. -
locationDisplayString: string
Title:
Location Display StringRead Only:trueMaximum Length:32Complete classroom address in the string format. -
locationLatitude: number
Title:
Location LatitudeRead Only:trueLatitude of the classroom. -
locationLongitude: number
Title:
Location LongitudeRead Only:trueLongitude of the classroom. -
locationName: string
Title:
Location NameRead Only:trueMaximum Length:240Location of the classroom. -
locationSingleLineString: string
Read Only:
trueMaximum Length:1732Location of the classroom expressed as a single line string. -
locationZipCode: string
Title:
Location ZIP CodeRead Only:trueMaximum Length:30Postal code of the location address.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided by the Attachment UI components to support the upload of files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
attachmentId: integer
Title:
Attachment IdRead Only:trueID of the attachment. -
attachmentLink: string
Title:
Attachment LinkRead Only:trueMaximum Length:4000Link to the attachment. -
attachmentName: string
Title:
Attachment NameRead Only:trueMaximum Length:4000Name of the attachment. -
attachmentNumber: string
Title:
Attachment NumberRead Only:trueFriendly number for identifying the attachment. -
attachmentType: string
Title:
Attachment TypeRead Only:trueMaximum Length:4000Type of the attachment. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the attachment was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAttachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Surrogate identifier of the document attached. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoRead Only:trueJSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error status code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File ContentsActual content of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the attachment file. -
FileUrl: string
Title:
File UrlFile URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when attachment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueUser name of the user who last updated the attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File SizeSize of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File NameName of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded TextText uploaded in the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of the attachment. This is a read-only attribute. -
Url: string
Title:
UrlMaximum Length:4000URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255URL of a web page type attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-classroomDFFs-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ResourceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-item-response
Type:
Show Source
object-
instructorDFF: array
instructorDFF
-
instructorId: integer
(int64)
Title:
Instructor IDRead Only:trueUnique identifier for the instructor. -
instructorNumber: string
Title:
Instructor NumberRead Only:trueMaximum Length:19Friendly number for identifying the instructor. -
isPrimaryInstructor: string
Title:
Primary InstructorRead Only:trueMaximum Length:1Indicates whether the person is the primary instructor. The default value is N. Valid values are Y and N. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
personDisplayName: string
Title:
InstructorRead Only:trueMaximum Length:240Display name for the instructor. -
personId: integer
(int64)
Title:
Instructor Person IDRead Only:trueIdentifier for the person who's the instructor. -
personImageURL: string
Title:
Instructor Image URLRead Only:trueMaximum Length:32Image URL for the instructor for the learning item. -
personNumber: string
Title:
Instructor Person NumberRead Only:trueMaximum Length:30Person number for the instructor. -
personPrimaryEmailAddress: string
Title:
Instructor Primary Email AddressRead Only:trueMaximum Length:60Primary Email address of the instructor for the learning item. -
personPrimaryPhoneNumber: string
Title:
Instructor Primary Phone NumberRead Only:trueMaximum Length:240Phone number of the instructor of the learning item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-instructorDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ResourceId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLanguages-item-response
Type:
Show Source
object-
language: string
Title:
LanguageRead Only:trueMaximum Length:255Language for the selected learning assignment offering. -
languageCode: string
Title:
Language CodeRead Only:trueMaximum Length:30Language code for the selected learning assignment offering. -
languageCodeMeaning: string
Title:
Language Code DescriptionRead Only:trueMaximum Length:4000Description of the languageCode attribute value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLocations-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
locationCity: string
Title:
Location CityRead Only:trueMaximum Length:60City where the selected learning assignment offering is delivered. -
locationCountry: string
Title:
Location CountryRead Only:trueMaximum Length:60Country where the selected learning assignment offering is delivered. -
locationTitle: string
Title:
Location NameRead Only:trueMaximum Length:93City-state-country for the ILT type offering. For other offering types, it's Virtual Classroom or Self Paced, as applicable.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-questionnaireResponses-item-response
Type:
Show Source
object-
AttemptNumber: integer
(int64)
Title:
Attempt NumberRead Only:trueThe attempt number of a participant when responding to a questionnaire. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the questionnaire response. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the questionnaire response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate on which the questionnaire response was updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the questionnaire response. -
LatestAttemptFlag: boolean
Title:
Latest AttemptRead Only:trueMaximum Length:30Default Value:falseIndicates if the response is the latest attempt by a participant to the questionnaire. This is a read-only attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
QuestionnaireParticipantId: integer
(int64)
Title:
Questionnaire Participant IdSurrogate identifier for the questionnaire participant. -
QuestionnaireResponseId: integer
(int64)
Title:
Questionnaire Response IdSurrogate identifier for the questionnaire response. -
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire VersionVersion number of the questionnaire that the participant responds to. -
questionResponses: array
Question Responses
Title:
Question ResponsesThe questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Status: string
Title:
Response Status CodeMaximum Length:30Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response. -
StatusMeaning: string
Title:
Response StatusRead Only:trueMaximum Length:80Meaning of the status code. -
SubmittedDateTime: string
(date)
Title:
Submitted TimeRead Only:trueDate on which the questionnaire response was submitted. -
TotalScore: number
Title:
Total ScoreRead Only:trueTotal score for the responses submitted by a participant for a questionnaire.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
arrayTitle:
Question ResponsesThe 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-response
Type:
Show Source
object-
AnswerCode: string
Title:
Answer CodeRead Only:trueMaximum Length:240The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code ListConcatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
CommentsMaximum Length:4000Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
AnswerAttachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer ListMaximum Length:2000Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short DescriptionRead Only:trueMaximum Length:240Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short DescriptionRead Only:trueConcatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List CodeConcatenated 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. -
ChoiceList: string
Title:
Choice ListMaximum Length:2000Concatenated 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. -
ChoiceShortDescription: string
Title:
Choice Short DescriptionRead Only:trueConcatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the question response. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer IdSurrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question CodeMaximum Length:240Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question IdSurrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question IdSurrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response AttachmentsThe questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response IdSurrogate identifier for the question response. -
QuestionText: string
Title:
Question TextRead Only:trueMaximum Length:2000Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer ScoreRead Only:trueCalculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
arrayTitle:
Question Response AttachmentsThe 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-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the attachment was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAttachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path of the folder. -
DmVersionNumber: string
Maximum Length:
255Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the attachment file. -
FileUrl: string
Title:
File UrlFile URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the attachment record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
QuestionResponses: array
Question Responses
Title:
Question ResponsesThe questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File SizeSize of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File NameName of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded TextText uploaded in the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of the attachment. This is a read-only attribute. -
Url: string
Title:
UrlMaximum Length:4000URL of a web page attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
arrayTitle:
Question ResponsesThe 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-response
Type:
Show Source
object-
AnswerCode: string
Title:
Answer CodeRead Only:trueMaximum Length:240The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code ListConcatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
CommentsMaximum Length:4000Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
AnswerAttachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer ListMaximum Length:2000Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short DescriptionRead Only:trueMaximum Length:240Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short DescriptionRead Only:trueConcatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List CodeConcatenated 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. -
ChoiceList: string
Title:
Choice ListMaximum Length:2000Concatenated 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. -
ChoiceShortDescription: string
Title:
Choice Short DescriptionRead Only:trueConcatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User who last updated the question response. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer IdSurrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question CodeMaximum Length:240Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question IdSurrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question IdSurrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response AttachmentsThe questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response IdSurrogate identifier for the question response. -
QuestionText: string
Title:
Question TextRead Only:trueMaximum Length:2000Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer ScoreRead Only:trueCalculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
arrayTitle:
Question Response AttachmentsThe 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-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate on which the attachment was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAttachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path of the folder. -
DmVersionNumber: string
Maximum Length:
255Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048Name of the attachment file. -
FileUrl: string
Title:
File UrlFile URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the attachment record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File SizeSize of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File NameName of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded TextText uploaded in the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI of the attachment. This is a read-only attribute. -
Url: string
Title:
UrlMaximum Length:4000URL of a web page attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- ActivityAttemptActualEffortUnitsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LEARN_DURATION_UOM
The following properties are defined on the LOV link relation:- Source Attribute: activityAttemptAEUnits; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ActivityAttemptAssignedToTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_TASK_OWNER_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: activityAttemptAssignedToType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ActivityAttemptStatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LI_TASK_SUB_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: activityAttemptStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ActivityCompletionRequirementLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ACTIVITY_COMPLETION
The following properties are defined on the LOV link relation:- Source Attribute: activityComplRequirement; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ActivityExpectedEffortUnitsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LEARN_DURATION_UOM
The following properties are defined on the LOV link relation:- Source Attribute: activityEffortUnits; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ActivityTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LI_REST_ACTIVITY_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: activityType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AssignedLearningItemSubTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ELEARNING_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: parentLearningItemSubType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- DataSecurityPrivilegeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSIGNMENT_SEC_CONTEXT
The following properties are defined on the LOV link relation:- Source Attribute: dataSecurityPrivilege; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ELearnRecordedAttemptsRuleLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSES_REC_ATTEMPTS
The following properties are defined on the LOV link relation:- Source Attribute: elearnRecordedAttemptsRule; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ELearnTimePerAttemptUnitsLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LEARN_DURATION_UOM
The following properties are defined on the LOV link relation:- Source Attribute: elearnTimePERAttemptUnits; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LearnningContentTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_CO_TRACKING_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: elearnType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- VirtualClassroomTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_VIRTUAL_CLASSROOM_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: virtualClassroomType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- activityCompletionPredecessorHint
-
Parameters:
- completionDetailsUniqID3102:
$request.path.completionDetailsUniqID3102 - learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID - otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- completionDetailsUniqID3102:
- activityContentAttempts
-
Parameters:
- completionDetailsUniqID3102:
$request.path.completionDetailsUniqID3102 - learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID - otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- completionDetailsUniqID3102:
- activitySectionCompletionPredecessorHint
-
Parameters:
- completionDetailsUniqID3102:
$request.path.completionDetailsUniqID3102 - learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID - otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- completionDetailsUniqID3102:
- classrooms
-
Parameters:
- completionDetailsUniqID3102:
$request.path.completionDetailsUniqID3102 - learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID - otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- completionDetailsUniqID3102:
- instructors
-
Parameters:
- completionDetailsUniqID3102:
$request.path.completionDetailsUniqID3102 - learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID - otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- completionDetailsUniqID3102:
- offeredLanguages
-
Parameters:
- completionDetailsUniqID3102:
$request.path.completionDetailsUniqID3102 - learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID - otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- completionDetailsUniqID3102:
- offeredLocations
-
Parameters:
- completionDetailsUniqID3102:
$request.path.completionDetailsUniqID3102 - learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID - otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- completionDetailsUniqID3102:
- questionnaireResponses
-
Parameters:
- completionDetailsUniqID3102:
$request.path.completionDetailsUniqID3102 - learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID - otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- completionDetailsUniqID3102:
- relatedMaterials
-
Parameters:
- completionDetailsUniqID3102:
$request.path.completionDetailsUniqID3102 - learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID - otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- completionDetailsUniqID3102: