Update a selected course offering
patch
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}
Request
Path Parameters
-
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=
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
activeDate: string
(date-time)
Title:
Offering Active Date
Date when the learning assignment moved to an active status. -
assignerAttributionType: string
Title:
Assigner Attribution Type
Maximum Length:30
Default Value:ORA_PERSON
Entity type for the learning assignment creator, such as person, specialist, or community. Valid values are defined in the AssignerToAttributionTypeLOV list. -
assignmentDFF: array
assignmentDFF
-
assignmentDueDate: string
(date-time)
Title:
Due Date
Due date for the other selected course offering assignment. -
assignmentJustification: string
Title:
Justification
Maximum Length:4000
Justification provided by the specialist when assigning, or the learner when enrolling in, a course offering assignment. -
assignmentStatus: string
Title:
Enrollment Record Status
Maximum Length:32
Default Value:ORA_ASSN_REC_ACTIVE
Status for the learning enrollment, such as Active, Content Completed, Completed, Withdrawn, or Deleted. Valid values are defined in the AssignmentStatusLOV list. -
canEditAssignmentHint: string
Title:
Can Edit Assignment Hint
Maximum Length:4000
Assignment hint, such as Can delete, Can withdraw, or No edit, for the learning assignment. Valid values are defined in the CanEditAssignmentHintLOV list. -
completionDetails: array
Completion Details
Title:
Completion Details
The completionDetails resource provides completion details for the learner assignment when queried with the assignment record ID. It provides the completion details for all activities that a learner has completed or will complete. The provided details are equivalent to what learning administrators see on the Manage Activities page for a learning assignment. -
completionSummary: array
Completion Summaries
Title:
Completion Summaries
The completionSummary resource is a child of the learnerLearningRecords resource. It provides a completion summary for a single learning assignment or a collection of assignments when queried with the assignment record ID. The summary includes completion requirements, the passing and actual scores, expected number of activities, effort for completion, and completion progress for the associated course offering. -
dataSecurityPrivilege: string
Title:
Data Security Privilege
Maximum Length:32
Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list. -
enrollmentHistory: array
Enrollment History
Title:
Enrollment History
The enrollmentHistory resource provides the enrollment history details for the learning assignment. -
enrollmentQuestionnaireId: integer
Unique identifier for the learning enrollment questionnaire.
-
enrollmentRelatedMaterials: array
Enrollment Related Materials
Title:
Enrollment Related Materials
The attachments resource provides the related learning materials for the parent resource. -
enteredPendingSeatAcceptanceDate: string
(date-time)
Title:
Date Learning Item Entered Pending Seat Acceptance
Date when the learning assignment entered the pending seat acceptance status. -
exitedPendingSeatAcceptanceDate: string
(date-time)
Title:
Date Learning Item Exited Pending Seat Acceptance
Date when the learning assignment exited the pending seat acceptance status. -
learningItemDFF: array
learningItemDFF
-
learningItemRatingDetails: array
Learning Item Rating Details
Title:
Learning Item Rating Details
The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status. -
learningItemRelatedMaterials: array
Related Materials
Title:
Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment. -
messages: array
Messages
Title:
Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description. -
offeringDFF: array
offeringDFF
-
primaryClassroomType: string
Title:
Offering Primary Classroom Type
Maximum Length:255
Primary classroom type, such as Physical Classroom, Virtual Classroom, or No Location Defined. -
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire. -
reasonCode: string
Title:
Status Change Reason Code
Maximum Length:30
Reason code for the other selected course offering assignment. Valid values are defined in the ReasonCodeLOV list. -
requestedCompleteByDate: string
(date)
Title:
Request Completion Date
Learning request completion by date specified on the past renewal assignment for the selected course offering. -
requestedStartDate: string
(date-time)
Title:
Enrolled on Date
Request start date specified for the selected learning offering assignment. -
statusChangeComment: string
Title:
Comments
Maximum Length:4000
Status change comment for the other selected learning course offering. -
transactionHistory: array
Transaction Histories
Title:
Transaction Histories
The transactionHistory resource provides the transaction history for its parent resource. Details include transaction identifier, transaction number, transaction date, and transaction reason.
Nested Schema : Completion Details
Type:
array
Title:
Completion Details
The completionDetails resource provides completion details for the learner assignment when queried with the assignment record ID. It provides the completion details for all activities that a learner has completed or will complete. The provided details are equivalent to what learning administrators see on the Manage Activities page for a learning assignment.
Show Source
Nested Schema : Completion Summaries
Type:
array
Title:
Completion Summaries
The completionSummary resource is a child of the learnerLearningRecords resource. It provides a completion summary for a single learning assignment or a collection of assignments when queried with the assignment record ID. The summary includes completion requirements, the passing and actual scores, expected number of activities, effort for completion, and completion progress for the associated course offering.
Show Source
Nested Schema : Enrollment History
Type:
array
Title:
Enrollment History
The enrollmentHistory resource provides the enrollment history details for the learning assignment.
Show Source
Nested Schema : Enrollment Related Materials
Type:
array
Title:
Enrollment Related Materials
The attachments resource provides the related learning materials for the parent resource.
Show Source
Nested Schema : Learning Item Rating Details
Type:
array
Title:
Learning Item Rating Details
The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status.
Show Source
Nested Schema : Related Materials
Type:
array
Title:
Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
Show Source
Nested Schema : Messages
Type:
array
Title:
Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.
Show Source
Nested Schema : Questionnaire Responses
Type:
array
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : Transaction Histories
Type:
array
Title:
Transaction Histories
The transactionHistory resource provides the transaction history for its parent resource. Details include transaction identifier, transaction number, transaction date, and transaction reason.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-item-patch-request
Type:
Show Source
object
-
activityAttemptCompletionReasonCode: string
Title:
Activity Attempt Exempted Reason Code
Maximum Length:30
Reason code for completion of a learning activity attempt. -
activityAttemptStatus: string
Title:
Activity Attempt Status
Maximum Length:32
Status for the activity the learner is working on. Valid values include ORA_ASSN_TASK_COMPLETED, ORA_ASSN_TASK_EXEMPTED, ORA_ASSN_TASK_INCOMPLETE, ORA_ASSN_TASK_NOT_STARTED, and ORA_ASSN_TASK_IN_PROGRESS. Valid value are defined in the list ActivityAttemptStatusLOV. -
activityCompletionPredecessorHint: array
Activity Completion Predecessor Hints
Title:
Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled. -
activityContentAttempts: array
Activity Content Attempts
Title:
Activity Content Attempts
The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date. -
activitySectionCompletionPredecessorHint: array
Activity Section Completion Predecessor Hints
Title:
Activity Section Completion Predecessor Hints
The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled. -
classrooms: array
Classrooms
Title:
Classrooms
The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings. -
instructors: array
Instructors
Title:
Instructors
The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings. -
offeredLanguages: array
Offered Languages
Title:
Offered Languages
The offeredLanguages resource provides the offering language for a learning item. -
offeredLocations: array
Offered Locations
Title:
Offered Locations
The offeredLocations resource provides the location details for a learning item. -
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire. - relatedMaterials: array Related Materials
Nested Schema : Activity Completion Predecessor Hints
Type:
array
Title:
Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.
Show Source
Nested Schema : Activity Content Attempts
Type:
array
Title:
Activity Content Attempts
The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date.
Show Source
Nested Schema : Activity Section Completion Predecessor Hints
Type:
array
Title:
Activity Section Completion Predecessor Hints
The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.
Show Source
Nested Schema : Classrooms
Type:
array
Title:
Classrooms
The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.
Show Source
Nested Schema : Instructors
Type:
array
Title:
Instructors
The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
Show Source
Nested Schema : Offered Languages
Type:
array
Title:
Offered Languages
The offeredLanguages resource provides the offering language for a learning item.
Show Source
Nested Schema : Offered Locations
Type:
array
Title:
Offered Locations
The offeredLocations resource provides the location details for a learning item.
Show Source
Nested Schema : Questionnaire Responses
Type:
array
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityCompletionPredecessorHint-item-patch-request
Type:
Show Source
object
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-item-patch-request
Type:
Show Source
object
-
actualEffort: number
Title:
Actual Effort
Quantity for the learner effort spent in the attempt. -
contentCatalogLearningItemDataLink: string
Title:
Content Catalog Learning Item Data Link
Maximum Length:4000
Data link to the catalog learning item added to the activity. -
contentCatalogLearningItemNumber: string
Title:
Content Catalog Learning Item Number
Maximum Length:250
Friendly number identifying the catalog learning item added to the activity. It's a surrogate key that's shown in the user interface. -
contentURL: string
Title:
Content URL
Maximum Length:4000
URL to open the eLearning content directly from the browser. -
elearnQuestionnaireId: integer
Unique identifier for the questionnaire that's the self-paced assessment learning activity.
-
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Nested Schema : Questionnaire Responses
Type:
array
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-item-patch-request
Type:
Show Source
object
-
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire Version
Version number of the questionnaire that the participant responds to. -
questionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Status: string
Title:
Response Status Code
Maximum Length:30
Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
QuestionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment.
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-patch-request
Type:
Show Source
object
-
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment.
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activitySectionCompletionPredecessorHint-item-patch-request
Type:
Show Source
object
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-item-patch-request
Type:
Show Source
object
-
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
classroomDFFs: array
classroomDFFs
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-attachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Expiration date of the attachment. This is a read-only attribute.
-
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
File URL of the attachment.
-
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the uploaded file. This is a read-only attribute.
-
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment.
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-classroomDFFs-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-item-patch-request
Type:
Show Source
object
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-instructors-instructorDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLanguages-item-patch-request
Type:
Show Source
object
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLocations-item-patch-request
Type:
Show Source
object
Nested Schema : schema
Type:
Show Source
object
-
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire Version
Version number of the questionnaire that the participant responds to. -
questionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Status: string
Title:
Response Status Code
Maximum Length:30
Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-item-patch-request
Type:
Show Source
object
-
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
QuestionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment.
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-patch-request
Type:
Show Source
object
-
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment.
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionSummary-item-patch-request
Type:
Show Source
object
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-enrollmentHistory-item-patch-request
Type:
Show Source
object
-
enrollmentHistoryOrderId: integer
Display order for the learning enrollment history status message.
-
enrollmentHistoryStatusMessage: string
Status message to show to the user.
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-enrollmentRelatedMaterials-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Expiration date of the attachment. This is a read-only attribute.
-
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
File URL of the attachment.
-
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the uploaded file. This is a read-only attribute.
-
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment.
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
EffectiveEndDate: string
(date)
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemRatingDetails-item-patch-request
Type:
Show Source
object
-
dataSecurityPrivilege: string
Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
-
ratedByPersonDetails: array
User Access Person Details
Title:
User Access Person Details
The personDetalis resource provides details about the person associated with the learning item. -
rating: number
Title:
Rating
The rating given on the learning item. -
ratingByPersonId: integer
(int64)
Title:
Rated by Person ID
Identifier of the person who rated the learning item. -
ratingByPersonImageURL: string
Title:
Rated by Person Image URL
Image URL of the person who rated the learning item. -
ratingComment: string
Title:
Rating Comment
Maximum Length:4000
Comment made by the learner while rating the learning item. -
ratingStatus: string
Title:
Rating Status
Maximum Length:30
Status of the rating on the learning item.
Nested Schema : User Access Person Details
Type:
array
Title:
User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-patch-request
Type:
Show Source
object
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemRelatedMaterials-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Expiration date of the attachment. This is a read-only attribute.
-
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
File URL of the attachment.
-
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the uploaded file. This is a read-only attribute.
-
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment.
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-messages-item-patch-request
Type:
Show Source
object
-
dataSecurityPrivilege: string
Title:
Data Security Privilege
Maximum Length:32
Data security privilege, such as Learner or Learner Manager, that identifies the intent and permissions for the person accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV.
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-offeringDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-questionnaireResponses-item-patch-request
Type:
Show Source
object
-
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire Version
Version number of the questionnaire that the participant responds to. -
questionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Status: string
Title:
Response Status Code
Maximum Length:30
Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response.
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-questionnaireResponses-questionResponses-item-patch-request
Type:
Show Source
object
-
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-questionnaireResponses-questionResponses-questionResponseAttachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
QuestionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment.
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-patch-request
Type:
Show Source
object
-
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment.
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-transactionHistory-item-patch-request
Type:
Show Source
object
Response
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-item-response
Type:
Show Source
object
-
activeDate: string
(date-time)
Title:
Offering Active Date
Date when the learning assignment moved to an active status. -
assignedDate: string
(date-time)
Title:
Enrolled on Date
Read Only:true
Date when the learning item was assigned. -
assignedToId: integer
(int64)
Title:
Assignee Person ID
Unique identifier for the course offering assignee. -
assignerAttributionType: string
Title:
Assigner Attribution Type
Maximum Length:30
Default Value:ORA_PERSON
Entity type for the learning assignment creator, such as person, specialist, or community. Valid values are defined in the AssignerToAttributionTypeLOV list. -
assignerAttributionTypeMeaning: string
Title:
Assigner Attribution Type Description
Read Only:true
Maximum Length:4000
Description of the assignerAttributionType attribute value. -
assignerCommentsToLearner: string
Title:
Assigner Comments to Learner
Assigner comments for the other selected course offering. -
assignerDisplayName: string
Title:
Enrolled By
Read Only:true
Maximum Length:250
Display name for the other selected course offering assigner. -
assignerId: integer
(int64)
Title:
Assigner ID
Read Only:true
Identifier for the other selected course offering assigner. -
assignerNumber: string
Title:
Assigner Number
Read Only:true
Maximum Length:30
Number for the other selected course offering assigner. -
assignerPersonImageURL: string
Title:
Assigner Person Image URL
Read Only:true
Maximum Length:32
Image URL for the learning item assigner. -
assignerPersonPrimaryEmailAddress: string
Title:
Assigner Person Primary Email Address
Read Only:true
Maximum Length:240
Primary email address for the other selected course offering assigner. -
assignerPersonPrimaryPhoneNumber: string
Title:
Assigner Person Primary Phone Number
Read Only:true
Maximum Length:60
Primary phone for the other selected course offering assigner. -
assignmentCreatedDate: string
(date-time)
Title:
Assignment Created Date
Read Only:true
Date and time when the other selected course offering assignment was created. -
assignmentDFF: array
assignmentDFF
-
assignmentDueDate: string
(date-time)
Title:
Due Date
Due date for the other selected course offering assignment. -
assignmentJustification: string
Title:
Justification
Maximum Length:4000
Justification provided by the specialist when assigning, or the learner when enrolling in, a course offering assignment. -
assignmentLastModifiedDate: string
(date-time)
Title:
Assignment Last Modified Date
Read Only:true
Date and time when the other selected course offering assignment was most recently changed. -
assignmentRecordId: integer
(int64)
Title:
Enrollment Record ID
Application-generated primary key. -
assignmentRecordNumber: string
Title:
Enrollment Number
Read Only:true
Maximum Length:30
Number for identifying the other selected course offering assignment. -
assignmentStatus: string
Title:
Enrollment Record Status
Maximum Length:32
Default Value:ORA_ASSN_REC_ACTIVE
Status for the learning enrollment, such as Active, Content Completed, Completed, Withdrawn, or Deleted. Valid values are defined in the AssignmentStatusLOV list. -
assignmentStatusMeaning: string
Title:
Enrollment Record Status Description
Read Only:true
Maximum Length:4000
Description of the assignmentStatus attribute value. -
assignmentSubStatus: string
Title:
Assignment Substatus
Read Only:true
Maximum Length:30
Substatus for the learning enrollment, such as Not Started, or In Progress. Valid values are defined in the AssignmentSubStatusLOV list. -
assignmentSubStatusMeaning: string
Title:
Assignment Substatus Description
Read Only:true
Maximum Length:4000
Description of the assignmentSubStatus attribute value. -
assignmentType: string
Title:
Enrollment Type
Maximum Length:30
Learning enrollment type for the other selected course offering, such as required or voluntary. Valid values are defined in the AssignmentTypeLOV list. -
assignmentTypeMeaning: string
Title:
Enrollment Type Description
Read Only:true
Maximum Length:4000
Description of the assignmentType attribute value. -
canEditAssignmentHint: string
Title:
Can Edit Assignment Hint
Maximum Length:4000
Assignment hint, such as Can delete, Can withdraw, or No edit, for the learning assignment. Valid values are defined in the CanEditAssignmentHintLOV list. -
canEditAssignmentHintMeaning: string
Title:
Can Edit Assignment Hint Description
Read Only:true
Maximum Length:4000
Description of the canEditAssignmentHint attribute value. -
completedDate: string
(date-time)
Title:
Completed Date
Read Only:true
Completed date for the other selected course offering assignment. -
completionDetails: array
Completion Details
Title:
Completion Details
The completionDetails resource provides completion details for the learner assignment when queried with the assignment record ID. It provides the completion details for all activities that a learner has completed or will complete. The provided details are equivalent to what learning administrators see on the Manage Activities page for a learning assignment. -
completionSummary: array
Completion Summaries
Title:
Completion Summaries
The completionSummary resource is a child of the learnerLearningRecords resource. It provides a completion summary for a single learning assignment or a collection of assignments when queried with the assignment record ID. The summary includes completion requirements, the passing and actual scores, expected number of activities, effort for completion, and completion progress for the associated course offering. -
contentCompletedDate: string
(date)
Title:
Content Completed Date
Read Only:true
Date when the content was completed for the other selected course offering assignment. -
currentWaitlistPosition: integer
(int64)
Title:
Current Waitlist Position
Read Only:true
Current waitlist position for the learner. -
dataSecurityPrivilege: string
Title:
Data Security Privilege
Maximum Length:32
Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list. -
dataSecurityPrivilegeMeaning: string
Title:
Data Security Privilege Description
Read Only:true
Maximum Length:4000
Description of the value of the dataSecurityPrivilege attribute. -
deletedDate: string
(date-time)
Title:
Deleted Date
Read Only:true
Date when the learner was removed from the waitlist. -
enrollmentHistory: array
Enrollment History
Title:
Enrollment History
The enrollmentHistory resource provides the enrollment history details for the learning assignment. -
enrollmentQuestionnaireId: integer
Unique identifier for the learning enrollment questionnaire.
-
enrollmentRelatedMaterials: array
Enrollment Related Materials
Title:
Enrollment Related Materials
The attachments resource provides the related learning materials for the parent resource. -
enteredPendingPaymentDate: string
(date)
Title:
Entered Pending Payment Date
Read Only:true
Date when the learning assignment was added to the pending payment. -
enteredPendingPrerequisitesDate: string
(date)
Title:
Date Learner Entered Pending Prerequisites
Read Only:true
Date when the other selected course offering assignment entered the pending prerequisites status. -
enteredPendingSeatAcceptanceDate: string
(date-time)
Title:
Date Learning Item Entered Pending Seat Acceptance
Date when the learning assignment entered the pending seat acceptance status. -
enteredWaitlistDate: string
(date)
Title:
Date Learner Entered Waitlist
Read Only:true
Date when the selected course offerings assignment was added to the waitlist. -
evaluationSubmittedDate: string
Title:
Evaluation Submission Date
Read Only:true
Maximum Length:19
Evaluation submitted for the requested course offerings assignments. -
exemptedDate: string
(date-time)
Title:
Exempted Date
Read Only:true
Date when the other selected course offering assignment was exempted. -
exitedPendingPrerequisitesDate: string
(date)
Title:
Date Learner Exited Pending Prerequisites
Read Only:true
Date when the other selected course offering assignment exited the pending prerequisites status. -
exitedPendingSeatAcceptanceDate: string
(date-time)
Title:
Date Learning Item Exited Pending Seat Acceptance
Date when the learning assignment exited the pending seat acceptance status. -
exitedWaitlistDate: string
(date)
Title:
Date Learner Exited Waitlist
Read Only:true
Date when the learner exited the waitlist. -
isLearnerOnLatestLIVersion: string
Read Only:
true
Maximum Length:1
Indicates whether the learning enrollment uses the most recent learning item version. Valid values are Y and N. Default value is Y. -
isPrimaryOffering: string
Title:
Primary Offering
Read Only:true
Maximum Length:1
Offering is the primary selected course offering. -
learningItemDataLink: string
Title:
Learning Item Data Link.
Read Only:true
Maximum Length:4000
Data link to the learning item. -
learningItemDeepLink: string
Title:
Learning Item Deep Link
Read Only:true
Maximum Length:4000
URL to open the offerings page directly from the browser. -
learningItemDefinitionUsedDate: string
(date-time)
Read Only:
true
Most recent updated date for the learning enrollment based on the learning item version as of this day. -
learningItemDFF: array
learningItemDFF
-
learningItemEffectiveAsOf: string
(date-time)
Title:
Assigned Learning Effective Date
Read Only:true
Effective start date for the learning item. -
learningItemEffectiveDate: string
(date-time)
Read Only:
true
Effective date for the learning item. -
learningItemEmbedLink: string
Title:
Learning Item Embed Link
Read Only:true
Maximum Length:4000
URL to embed the learning item page in other pages. It opens the isolated learning item page without the global toolbar on the top. -
learningItemId: integer
(int64)
Title:
Assigned Learning Item ID
Unique identifier for the learning item, it's the internal primary key. -
learningItemLatestChangeEventDate: string
(date-time)
Read Only:
true
Date when the learning item was most recently changed. -
learningItemNumber: string
Title:
Assigned Learning Item Number
Maximum Length:255
Friendly number identifying the learning item. It's a surrogate key that's shown in the user interface. -
learningItemRatingDetails: array
Learning Item Rating Details
Title:
Learning Item Rating Details
The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status. -
learningItemRelatedMaterials: array
Related Materials
Title:
Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment. -
learningItemTitle: string
Title:
Assigned Learning Item Title
Read Only:true
Maximum Length:250
Title of the learning item. -
learningItemType: string
Title:
Assigned Learning Item Type
Maximum Length:32
Learning item type, such as Course, Specialization, Tutorial, or Video. Valid values are defined in theAssignedLearningItemTypeLOV list. -
learningItemTypeMeaning: string
Title:
Assigned Learning Item Type Description
Read Only:true
Maximum Length:4000
Description of the learningItemType attribute value. -
liLongDescription: string
(byte)
Title:
Assigned Learning Item Long Description
Read Only:true
Long description provided while creating the learning item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
liShortDescription: string
Title:
Assigned Learning Item Short Description
Read Only:true
Maximum Length:4000
Description provided while creating the learning item. -
liTotalExpectedEffort: number
Title:
Learning Item Total Expected Effort
Read Only:true
Expected effort to complete the learning item of the other selected course offering assignment. -
liTotalExpectedEffortUOM: string
Title:
Learning Item Total Expected Effort Units
Read Only:true
Maximum Length:30
Unit of measure for the effort expected to complete the learning item of the other selected course offering assignment. Valid values are defined in the DurationLOV list. -
liTotalExpectedEffortUOMMeaning: string
Title:
Learning Item Total Expected Effort Units Description
Read Only:true
Maximum Length:4000
Description of the liTotalExpectedEffortUOM attribute value. -
maximumCapacity: integer
Title:
Maximum Capacity
Read Only:true
Maximum capacity for the learning offering. -
messages: array
Messages
Title:
Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description. -
offeringActivityDate: string
(date)
Title:
Activity Date
Read Only:true
Date when the offering activity starts. -
offeringAvailableCapacity: integer
Title:
Offering Available Capacity
Read Only:true
Available capacity for the learning offering. -
offeringCoordinatorDisplayName: string
Title:
Offering Coordinator Display Name
Read Only:true
Maximum Length:255
Display name for the learning offering coordinator. -
offeringCoordinatorEmailAddress: string
Title:
Offering Coordinator Email Address
Read Only:true
Maximum Length:255
Email address for the learning offering coordinator. -
offeringCoordinatorPersonNumber: string
Title:
Offering Coordinator Person Number
Read Only:true
Maximum Length:255
Person number for the learning offering coordinator. -
offeringDeliveryMode: string
Title:
Learning Item Delivery Mode
Read Only:true
Maximum Length:30
Learning item delivery mode, such as self-paced, instructor-led, online, or onsite. -
offeringDeliveryModeMeaning: string
Title:
Learning Item Delivery Mode Description
Read Only:true
Maximum Length:4000
Description of the learning offering delivery mode. -
offeringDFF: array
offeringDFF
-
offeringEndDate: string
(date-time)
Title:
Offering End Date
Read Only:true
Date when the learning offering was ended. -
offeringEndTime: string
Title:
Activity End Time
Read Only:true
Time when the offering activity ends. -
offeringLanguage: string
Title:
Learning Item Language
Read Only:true
Maximum Length:30
Offering languages, such as Arabic, German, Spanish, and American English. Valid values are defined in the LanguageLOV list. -
offeringLanguageMeaning: string
Title:
Learning Item Language Description
Read Only:true
Maximum Length:4000
Description of the offeringLanguage attribute value. -
offeringSelfServiceCatalogPrice: number
Title:
Offering Self Service Catalog Price
Read Only:true
Cost of the selected learning. -
offeringSelfServiceCatalogPriceCurrency: string
Title:
Offering Self Service Catalog Price
Read Only:true
Maximum Length:30
Currency for the selected learning. -
offeringStartDate: string
(date-time)
Title:
Offering Start Date
Read Only:true
Date when the learning offering was started. -
offeringStartTime: string
Title:
Activity Start Time
Read Only:true
Time when the offering activity starts. -
offeringTimeZone: string
Title:
Activity Time Zone
Read Only:true
Maximum Length:30
Time zone associated with the offering activity. -
primaryClassroomType: string
Title:
Offering Primary Classroom Type
Maximum Length:255
Primary classroom type, such as Physical Classroom, Virtual Classroom, or No Location Defined. -
primaryClassroomTypeMeaning: string
Title:
Offering Primary Classroom Type Description
Read Only:true
Maximum Length:4000
Description of the primary classroom type. -
purchaseAmount: number
Title:
Purchase Amount
Read Only:true
Purchase amount for the requested selected learning course offerings. -
purchaseCurrency: string
Title:
Purchase Currency
Read Only:true
Maximum Length:30
Purchase currency for the requested learning offering. -
purchasedDate: string
(date)
Title:
Purchased Date
Read Only:true
Date of purchase for the learning transaction, if the learning is paid. -
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire. -
reasonCode: string
Title:
Status Change Reason Code
Maximum Length:30
Reason code for the other selected course offering assignment. Valid values are defined in the ReasonCodeLOV list. -
reasonCodeMeaning: string
Title:
Status Change Reason Code Description
Read Only:true
Maximum Length:4000
Description of the reasonCode attribute value. -
refundRule: string
Title:
Refund Rule
Read Only:true
Maximum Length:240
Refund rule for the other selected course offering assignment. -
requestApprovedDate: string
(date-time)
Title:
Request Approval Date
Read Only:true
Approved date for the requested other selected course offerings assignment. -
requestedCompleteByDate: string
(date)
Title:
Request Completion Date
Learning request completion by date specified on the past renewal assignment for the selected course offering. -
requestedDate: string
(date-time)
Title:
Requested Date
Read Only:true
Date when the learning offering request was made. -
requestedStartDate: string
(date-time)
Title:
Enrolled on Date
Request start date specified for the selected learning offering assignment. -
requestRejectedDate: string
(date)
Title:
Request Rejection Date
Read Only:true
Rejected date for the requested selected course offerings assignment. -
sourceId: integer
(int64)
Title:
Enrollment Source Identifier
Unique identifier for the source where this assignment was created. -
sourceType: string
Title:
Enrollment Source Type
Maximum Length:30
Type for the source where this assignment was created, such as Recommendation or Search. -
startedDate: string
(date)
Title:
Start Date
Read Only:true
Start date for the requested selected learning course offerings. -
statusChangeComment: string
Title:
Comments
Maximum Length:4000
Status change comment for the other selected learning course offering. -
transactionHistory: array
Transaction Histories
Title:
Transaction Histories
The transactionHistory resource provides the transaction history for its parent resource. Details include transaction identifier, transaction number, transaction date, and transaction reason. -
withdrawnDate: string
(date-time)
Title:
Withdrawn Date
Read Only:true
Date when the learner withdrew from the learning item. -
withdrawnRequestedDate: string
(date-time)
Title:
Withdrawn Requested Date
Read Only:true
Withdraw requested date for the other selected course offering assignment.
Nested Schema : Completion Details
Type:
array
Title:
Completion Details
The completionDetails resource provides completion details for the learner assignment when queried with the assignment record ID. It provides the completion details for all activities that a learner has completed or will complete. The provided details are equivalent to what learning administrators see on the Manage Activities page for a learning assignment.
Show Source
Nested Schema : Completion Summaries
Type:
array
Title:
Completion Summaries
The completionSummary resource is a child of the learnerLearningRecords resource. It provides a completion summary for a single learning assignment or a collection of assignments when queried with the assignment record ID. The summary includes completion requirements, the passing and actual scores, expected number of activities, effort for completion, and completion progress for the associated course offering.
Show Source
Nested Schema : Enrollment History
Type:
array
Title:
Enrollment History
The enrollmentHistory resource provides the enrollment history details for the learning assignment.
Show Source
Nested Schema : Enrollment Related Materials
Type:
array
Title:
Enrollment Related Materials
The attachments resource provides the related learning materials for the parent resource.
Show Source
Nested Schema : Learning Item Rating Details
Type:
array
Title:
Learning Item Rating Details
The learningItemRatingDetails resource provides the rating details for it's parent resource. Details include rating identifier, comments, and status.
Show Source
Nested Schema : Related Materials
Type:
array
Title:
Related Materials
The learningItemRelatedMaterials resource provides related materials for the learning item associated with a learning assignment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Messages
Type:
array
Title:
Messages
The messages resource provides a list of all the messages that pertain to it's parent resource. Details include message code, message severity, and message description.
Show Source
Nested Schema : Questionnaire Responses
Type:
array
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : Transaction Histories
Type:
array
Title:
Transaction Histories
The transactionHistory resource provides the transaction history for its parent resource. Details include transaction identifier, transaction number, transaction date, and transaction reason.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-assignmentDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequestDetailId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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-item-response
Type:
Show Source
object
-
activityAssignmentRecordId: integer
(int64)
Title:
Activity Assignment Record ID
Read Only:true
Activity assignment record ID for the activity attempt. -
activityAttemptActualEffort: number
Title:
Actual Effort
Read Only:true
Actual learner effort to complete the activity. -
activityAttemptActualScore: number
Title:
Activity Attempt Actual Score
Read Only:true
Actual learner score for the activity attempt. -
activityAttemptAEUnits: string
Title:
Actual Effort Units
Read Only:true
Maximum Length:120
Actual units of learner effort to complete the activity. Valid values are defined in the ActivityAttemptActualEffortUnitsLOV list. -
activityAttemptAEUnitsMeaning: string
Title:
Actual Effort Units Description
Read Only:true
Maximum Length:4000
Description of the activityAttemptAEUnitsMeaning attribute value. -
activityAttemptAssignedToDisplayName: string
Title:
Activity Attempt Assignee
Read Only:true
Maximum Length:30
Display name of the learning activity attempt assignee. -
activityAttemptAssignedToId: integer
(int64)
Title:
Activity Attempt Assignee Person ID
Read Only:true
Friendly number identifying the learning activity attempt assignee. -
activityAttemptAssignedToNumber: string
Title:
Activity Attempt Assignee Person Number
Read Only:true
Maximum Length:30
Friendly number identifying the learning activity attempt assignee. -
activityAttemptAssignedToType: string
Title:
Activity Attempt Assignee Type
Read Only:true
Maximum Length:30
Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list. -
activityAttemptAssignedToTypeMeaning: string
Title:
Activity Attempt Assignee Type Description
Read Only:true
Description of the activity attempt assigned to type. -
activityAttemptComplDate: string
(date-time)
Title:
Activity Attempt Completed Date
Read Only:true
Completion date of the activity attempt. -
activityAttemptCompletionReasonCode: string
Title:
Activity Attempt Exempted Reason Code
Maximum Length:30
Reason code for completion of a learning activity attempt. -
activityAttemptDeepLink: string
Title:
Activity Attempt Deep Link
Read Only:true
Maximum Length:4000
Deep link URL for the activity when opened in a browser. It opens the learning item activity player. -
activityAttemptEmbedLink: string
Title:
Activity Attempt Embed Link
Read Only:true
Maximum Length:4000
Deep link URL to embed the learning activity page in other pages. -
activityAttemptExemptedDate: string
(date-time)
Title:
Activity Attempt Exempted Date
Read Only:true
Attempt exemption date for the learning activity attempt. -
activityAttemptExemptedRC: string
Title:
Activity Attempt Exempted Reason Code
Read Only:true
Maximum Length:30
Reason for the activity attempt exemption, such as Exempted - completed elsewhere, Exempted - higher level certification attained, or Completed offline and status verified. Valid values are defined in the AttemptExemptedReasonLOV list. -
activityAttemptExemptedRCMeaning: string
Title:
Activity Attempt Exempted Reason Code Description
Read Only:true
Maximum Length:4000
Description of the activityAttemptExemptedRCMeaning attribute value. -
activityAttemptId: number
Title:
Activity Attempt ID
Read Only:true
Application-generated primary key. -
activityAttemptLocked: string
Title:
Activity Attempt Locked
Read Only:true
Maximum Length:1
Indicates whether the learning activity attempt is locked. Valid values are Y and N. Default value is N. -
activityAttemptNextAction: string
Title:
Activity Attempt Next Action
Read Only:true
Maximum Length:19
Next activity action when the learner is working on the activity. -
activityAttemptNumber: string
Title:
Activity Attempt Number
Read Only:true
Maximum Length:30
Number of attempts for the self-paced learning activity. -
activityAttemptStartedDate: string
(date-time)
Title:
Activity Attempt Started Date
Read Only:true
Date when the learner attempted the activity. -
activityAttemptStatus: string
Title:
Activity Attempt Status
Maximum Length:32
Status for the activity the learner is working on. Valid values include ORA_ASSN_TASK_COMPLETED, ORA_ASSN_TASK_EXEMPTED, ORA_ASSN_TASK_INCOMPLETE, ORA_ASSN_TASK_NOT_STARTED, and ORA_ASSN_TASK_IN_PROGRESS. Valid value are defined in the list ActivityAttemptStatusLOV. -
activityAttemptStatusMeaning: string
Title:
Activity Attempt Status Description
Read Only:true
Maximum Length:4000
Description of the activityAttemptStatusMeaning attribute value. -
activityCompletionPredecessorHint: array
Activity Completion Predecessor Hints
Title:
Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled. -
activityComplRequirement: string
Title:
Activity Completion Requirement
Read Only:true
Maximum Length:120
Completion requirement for the learning activity. Valid values are defined in the ActivityCompletionRequirementLOV list. -
activityComplRequirementMeaning: string
Title:
Activity Completion Requirement Description
Read Only:true
Maximum Length:4000
Description of the activityComplRequirementMeaning attribute value. -
activityContentAttempts: array
Activity Content Attempts
Title:
Activity Content Attempts
The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date. -
activityContentDisplayMode: string
Read Only:
true
Maximum Length:30
Determines how learners see the content, such as embedded. -
activityCoverArtLink: string
Title:
Activity Cover Art Link
Read Only:true
Maximum Length:4000
URL to open the cover art directly from the browser. -
activityDate: string
(date)
Title:
Activity Date
Read Only:true
Date when the ILT activity is worked on. Doesn't apply to any other types of activities. -
activityDescription: string
Title:
Activity Description
Read Only:true
Maximum Length:4000
Description of the learning activity. -
activityDescriptionLong: string
(byte)
Read Only:
true
Long description of the learning activity. -
activityDisplayOrder: number
Title:
Activity Position
Read Only:true
Display order for the learning activities. -
activityEffortUnits: string
Title:
Activity Effort Units
Read Only:true
Maximum Length:120
Unit used to measure the effort required to complete the learning activity, such as hour, minute, or month. Valid values are defined in the ActivityExpectedEffortUnitsLOV list. -
activityEffortUnitsMeaning: string
Title:
Activity Effort Units Description
Read Only:true
Maximum Length:4000
Description of the learning activity effort units. -
activityEndDatetimeUTC: string
(date-time)
Title:
Activity End Date
Read Only:true
Learning activity end time expressed in UTC format. -
activityEndTime: string
Title:
Activity End Time
Read Only:true
Maximum Length:32
ILT activity end time in the user's preferred time zone. Doesn't apply to any other types of activities. -
activityExpectedEffort: string
Title:
Expected Effort
Read Only:true
Maximum Length:83
Expected effort for the learning activity. -
activityId: integer
(int64)
Title:
Activity ID
Read Only:true
Application-generated primary key of the learning activity. -
activityLearnerMarkCompl: string
Title:
Learner Can Mark Activity Complete
Read Only:true
Maximum Length:1
Indicates whether the learner can mark the activity as completed. -
activityLearnerRecordAttendance: string
Read Only:
true
Maximum Length:1
Indicates whether learners can record their attendance for an activity. -
activityNumber: string
Title:
Activity Number
Read Only:true
Maximum Length:30
Friendly number identifying the learning activity in the user interface. -
activityPassingScore: number
Title:
Passing Score
Read Only:true
Passing score for the learning activity. -
activitySecComplRequired: number
Title:
Activity Section Required Activities
Read Only:true
Completion requirement for the learning activity section. -
activitySectionAttemptCompletionProgress: number
Title:
Activity Section Attempt Completion Progress
Read Only:true
Number of learning activities completed in a section. -
activitySectionAttemptLocked: string
Title:
Activity Section Attempt Locked
Read Only:true
Maximum Length:1
Indicates whether the attempt on the learning activity section is locked. Valid values are Y and N. Default value is N. -
activitySectionAttemptStatus: string
Title:
Activity Section Attempt Status
Read Only:true
Maximum Length:32
Status of the attempt on the learning activity section. Valid values are defined in the learning activitySectionAttemptStatusLOV list. -
activitySectionAttemptStatusMeaning: string
Title:
Activity Section Attempt Status Description
Read Only:true
Maximum Length:4000
Description of the activitySectionAttemptStatus attribute value. -
activitySectionCompletionPredecessorHint: array
Activity Section Completion Predecessor Hints
Title:
Activity Section Completion Predecessor Hints
The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled. -
activitySectionDescription: string
Title:
Activity Section Description
Read Only:true
Maximum Length:4000
Description of the learning activity section. -
activitySectionDisplayOrder: number
Title:
Activity Section Position
Read Only:true
Display order for the learning activity section. -
activitySectionId: number
Title:
Activity Section ID
Read Only:true
Application-generated primary key column. -
activitySectionLongDescription: string
(byte)
Title:
Long Description
Read Only:true
Long description of the learning activity. -
activitySectionNumber: string
Title:
Activity Section Number
Read Only:true
Maximum Length:30
Number identifying the learning activity section. -
activitySectionTitle: string
Title:
Activity Section Title
Read Only:true
Maximum Length:250
Name of the learning activity section. -
activitySectionTotalActivities: number
Title:
Activity Section Total Activities
Read Only:true
Total number of learning activities in the section. -
activityShortDescription: string
Title:
Activity Short Description
Read Only:true
Maximum Length:4000
Description of the learning content activity. -
activityShortTimeZone: string
Title:
Activity Time Zone
Read Only:true
Maximum Length:30
Friendly format for the time zone. -
activityStartDatetimeUTC: string
(date-time)
Title:
Activity Start Date
Read Only:true
Learning activity start time expressed in UTC format. -
activityStartTime: string
Title:
Activity Start Time
Read Only:true
Maximum Length:32
ILT activity start time in the user's preferred time zone. Doesn't apply to any other types of activities. -
activityTimeZone: string
Title:
Activity Time Zone
Read Only:true
Maximum Length:30
ILT activity time zone. Doesn't apply to any other types of activities. -
activityTitle: string
Title:
Activity Title
Read Only:true
Maximum Length:250
Title of the learning activity. -
activityTotalAttempts: number
Title:
Activity Total Attempts
Read Only:true
Total learner attempts on the activity. -
activityType: string
Title:
Activity Type
Read Only:true
Maximum Length:32
Activity type of the learning assignment. If the learning assignment is for specialization, this represents a course. If the learning assignment is for a course, this represents offering types. Valid values are defined in the ActivityTypeLOV list. -
activityTypeMeaning: string
Title:
Activity Type Description
Read Only:true
Maximum Length:4000
Description of the learning activity type. -
addToCalendarLink: string
Title:
Add to Calendar Link
Read Only:true
Maximum Length:4000
Link 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 forward
Read Only:true
Maximum Length:30
Indicates if forward scrubbing is enabled.Valid values are Y or N. -
classrooms: array
Classrooms
Title:
Classrooms
The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings. -
completionItemId: integer
(int64)
Read Only:
true
Application-generated primary key of the completion item. -
completionItemNumber: string
Read Only:
true
Maximum Length:30
Friendly number identifying for identifying the completion item. -
dataSecurityPrivilege: string
Title:
Data Security Privilege
Read Only:true
Maximum Length:32
Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list. -
dataSecurityPrivilegeMeaning: string
Title:
Data Security Privilege Description
Read Only:true
Maximum Length:4000
Description of the value of the dataSecurityPrivilege attribute. -
elearnAttemptReview: string
Title:
eLearning Attempt Review
Read Only:true
Maximum Length:120
Indicates whether the learner can review the activity attempt. Valid values are ORA_WLF_ARAR_LAST_ATTEMPT, ORA_WLF_ARAR_DONT_ENABLE and are defined in the ELearnAttemptReviewLOV list. -
elearnAttemptReviewMeaning: string
Title:
eLearning Attempt Review Description
Read Only:true
Maximum Length:4000
Description of the elearnAttemptReview attribute value. -
elearnAttemptsAllowed: number
Title:
eLearning Attempts Allowed
Read Only:true
Maximum number of attempts allowed on the self-paced learning assessment activity. -
elearnAutoLaunchOnPageOpen: string
Read Only:
true
Maximum Length:255
Indicates whether the content needs to be automatically launched when the enrollment page opens. -
elearnCoverArtLink: string
Title:
eLearning Cover Art Link
Read Only:true
Maximum Length:4000
URL to open the eLearning cover art directly from the browser. -
elearnDisableContentReview: string
Title:
eLearning Disable Content Review
Read Only:true
Maximum Length:1
Indicates whether the content review is disabled for the self-paced learning activity. Valid values are Y and N. Default value is N for self-paced learning activity with content type such as Video, PDF, Web link, SCORM or HACP. -
elearnDisableReview: string
Title:
eLearning Disable Review
Read Only:true
Maximum Length:1
Disable reviews for the self-paced learning activity. -
elearnDisableReviewForPassedAttempts: string
Title:
eLearning Disable Review for Passed Attempts
Read Only:true
Maximum Length:1
Indicates whether the review of passed attempts is disabled for the self-paced learning activity. Valid values are Y and N. Default value is Y. -
elearnHideActualScore: string
Title:
eLearning Hide Actual Score
Read Only:true
Maximum Length:1
Hide score for the self-paced learning activity. -
elearnId: number
Title:
eLearning ID
Read Only:true
Application-generated primary key for the eLearning content of the self-paced activity. -
eLearnMarkCompletionOnOpen: string
Title:
eLearning Mark Completion on Open
Read Only:true
Maximum Length:1
Set the eLearning to complete when it's opened. -
elearnNumber: string
Title:
eLearning Number
Read Only:true
Maximum Length:30
Number for identifying the content that backs the self-paced learning activity. -
elearnQuestionnaireId: integer
(int64)
Title:
Questionnaire ID
Read Only:true
Unique identifier for the questionnaire that's the self-paced learning assessment activity. -
elearnQuestionnaireNumber: string
Title:
Questionnaire Number
Read Only:true
Maximum Length:19
Question number of a question in the eLearning. -
elearnRecordedAttemptsRule: string
Title:
eLearning Recorded Attempts Rule
Read Only:true
Maximum Length:120
Rule for the maximum number of attempts allowed for the self-paced learning activity. Valid values are ORA_WLF_ARA_SNGL, ORA_WLF_ARA_LTD_NUM, ORA_WLF_ARA_UNLTD and are defined in the ELearnRecordedAttemptsRuleLOV list. -
elearnRecordedAttemptsRuleMeaning: string
Title:
eLearning Recorded Attempts Rule Description
Read Only:true
Maximum Length:4000
Description of the elearnRecordedAttemptsRule attribute value. -
elearnRichMediaLink: string
Title:
eLearning Rich Media Link
Read Only:true
Maximum Length:4000
URL to open the video directly from the browser. -
elearnRichMediaSrcLink: string
Title:
eLearning Rich Media Source Link
Read Only:true
Maximum Length:4000
Link to the rich media source file. -
elearnShortDescription: string
Title:
eLearning Description
Read Only:true
Maximum Length:4000
Description of the learning content for the self-paced activity. -
elearnShowResponseFeedback: string
Title:
eLearning Show Response Feedback
Read Only:true
Maximum Length:1
Show response feedback for the self-paced learning activity. -
elearnTimePERAttempt: number
Title:
eLearning Time per Attempt
Read Only:true
Time limit per attempt on the self-paced learning assessment activity. -
elearnTimePERAttemptUnits: string
Title:
eLearning Time per Attempt Units
Read Only:true
Maximum Length:30
Unit of measure for the time limit per attempt on the self-paced learning assessment activity, such as Hours or Minutes. Valid values are defined in the ELearnTimePerAttemptUnitsLOV list. -
elearnTimePERAttemptUnitsMeaning: string
Title:
eLearning Time per Attempt Units Description
Read Only:true
Maximum Length:4000
Description of the elearnTimePERAttemptUnitsMeaning attribute value. -
elearnTitle: string
Title:
eLearning Title
Read Only:true
Maximum Length:250
Name of the learning content for the self-paced activity. -
elearnType: string
Title:
eLearning Type
Read Only:true
Maximum Length:80
Type of the self-paced learning, such as Video or SCORM. Valid values are defined in the LearnningContentTypeLOV list. -
elearnTypeMeaning: string
Title:
eLearning Type Description
Read Only:true
Maximum Length:4000
Description of the elearnTypeMeaning attribute value. -
instructors: array
Instructors
Title:
Instructors
The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
offeredLanguages: array
Offered Languages
Title:
Offered Languages
The offeredLanguages resource provides the offering language for a learning item. -
offeredLocations: array
Offered Locations
Title:
Offered Locations
The offeredLocations resource provides the location details for a learning item. -
parentLearningItemSubType: string
Title:
Parent Assigned Learning Item Subtype
Read Only:true
Maximum Length:32
Learning item subtype, such as Video or Tutorial. Valid values are defined in the AssignedLearningItemSubTypeLOV list. -
parentLearningItemSubTypeMeaning: string
Title:
Parent Assigned Learning Item Subtype Description
Read Only:true
Maximum Length:4000
Description of the attribute learningItemSubType attribute value. -
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire Responses
The 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 Date
Read Only:true
Date when the learner successfully completed the learning activity section. -
virtualClassroomInformation: string
Title:
Virtual Classroom Information
Read Only:true
Maximum Length:19
Additional information about the virtual classroom, if used in the learning activity. -
virtualClassroomJoinLink: string
Title:
Virtual Classroom Join Link
Read Only:true
Maximum Length:4000
Link 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 Type
Read Only:true
Maximum Length:40
Type of the virtual classroom, such as ad-hoc virtual classroom, named virtual classroom, or no virtual classroom. Valid values are defined in the VirtualClassroomTypeLOV list. -
virtualClassroomTypeMeaning: string
Title:
Virtual Classroom Type Description
Read Only:true
Description of the virtual classroom type.
Nested Schema : Activity Completion Predecessor Hints
Type:
array
Title:
Activity Completion Predecessor Hints
The activityCompletionPredecessorHint resource provides hints for the learning activity predecessor when sequencing is enabled.
Show Source
Nested Schema : Activity Content Attempts
Type:
array
Title:
Activity Content Attempts
The activityContentAttempts resource provides the content and attempts details of the parent learning item type. Content details include content identifier, content number, and content type. Attempts details include activity identifier, activity number, start date, and end date.
Show Source
Nested Schema : Activity Section Completion Predecessor Hints
Type:
array
Title:
Activity Section Completion Predecessor Hints
The activitySectionCompletionPredecessorHint provides hints for the predecessor of the learning activity section when sequencing is enabled.
Show Source
Nested Schema : Classrooms
Type:
array
Title:
Classrooms
The classrooms resource is a child of the completionDetails resource. It provides the classroom details for the instructor-led activities associated with instructor-led and blended offerings.
Show Source
Nested Schema : Instructors
Type:
array
Title:
Instructors
The instructors resource is a child of the completionDetails resource. It provides the instructors associated with instructor-led and blended offerings.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Offered Languages
Type:
array
Title:
Offered Languages
The offeredLanguages resource provides the offering language for a learning item.
Show Source
Nested Schema : Offered Locations
Type:
array
Title:
Offered Locations
The offeredLocations resource provides the location details for a learning item.
Show Source
Nested Schema : Questionnaire Responses
Type:
array
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityCompletionPredecessorHint-item-response
Type:
Show Source
object
-
activityAttemptAssignedToType: string
Title:
Activity Predecessor Attempt Assignee Type
Read Only:true
Maximum Length:30
Type of user, such as Learner or Observer, assigned to the activity attempt. Valid values are defined in the ActivityAttemptAssignedToTypeLOV list. -
activityAttemptAssignedToTypeMeaning: string
Title:
Activity Predecessor Attempt Assignee Type Description
Read Only:true
Description of the type of user assigned to the learning activity attempt. -
activityAttemptLocked: string
Title:
Activity Predecessor Attempt Locked
Read Only:true
Maximum Length:1
Indicates whether the learner can attempt the activity. Valid values are Y and N. Default value is N. -
activityAttemptNumber: string
Title:
Activity Predecessor Attempt Number
Read Only:true
Maximum Length:30
Friendly number identifying the learning activity attempt. -
activityAttemptStatus: string
Title:
Activity Predecessor Attempt Status
Read Only:true
Maximum Length:32
Status for the learning activity attempt. Valid values are Y and N. Default value is N. Valid values are defined in the learning activityAttemptStatusLOV list. -
activityNumber: string
Title:
Activity Predecessor Number
Read Only:true
Maximum Length:30
Friendly number identifying the learning activity. -
activityTitle: string
Title:
Activity Predecessor Title
Read Only:true
Maximum Length:255
Title of the activity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-item-response
Type:
Show Source
object
-
activityContentAttemptStatus: string
Title:
Content Attempt Status
Read Only:true
Maximum Length:120
Status for the content attempt. Possible values are Complete, Exempted, Incomplete, and Not Completed. -
actualEffort: number
Title:
Actual Effort
Quantity for the learner effort spent in the attempt. -
actualEffortUnits: string
Title:
Actual Effort Units
Read Only:true
Maximum Length:30
Default Value:ORA_DUR_HOUR
Unit of measure, such as hours or minutes, for the learner effort spent in the attempt. -
actualEffortUnitsMeaning: string
Title:
Actual Effort Units Description
Read Only:true
Maximum Length:4000
Description of the actualEffortUnits attribute value. -
actualScore: number
Title:
Score
Read Only:true
Score achieved in the attempt. -
attemptedByDisplayName: string
Title:
Attempted By
Read Only:true
Display name for the person who attempted the self-paced learning activity. -
attemptedById: integer
(int64)
Title:
Attempted by Person ID
Read Only:true
Unique identifier for the person who attempted the self-paced learning activity. -
attemptedByNumber: string
Title:
Attempted by Person Number
Read Only:true
Friendly number identifying the person who attempted the self-paced learning activity. -
attemptEndDate: string
(date-time)
Title:
Last Attempt
Read Only:true
Date when the attempt ended. -
attemptId: integer
(int64)
Title:
Attempt ID
Read Only:true
Unique identifier for the self-paced learning activity or tutorial content attempt. -
attemptPosition: string
Title:
Attempt Position
Read Only:true
Learner attempt position in the activity. -
attemptRelationNumber: string
Title:
Attempt Relation Number
Read Only:true
Maximum Length:30
Friendly number identifying the association between the learning activity attempt and attempt on the self-paced learning activity. -
attemptStartDate: string
(date-time)
Title:
Attempt Start Date
Read Only:true
Date when the attempt started. -
attemptStatus: string
Title:
Last Attempt Status
Read Only:true
Maximum Length:120
Status for the learning activity content attempt. Valid values are defined in the AttemptStatusLOV list. -
attemptStatusMeaning: string
Title:
Last Attempt Status Description
Read Only:true
Maximum Length:4000
Description of the attemptStatus attribute value. -
chapterLevel: number
Title:
Chapter Level
Read Only:true
Chapter level of the activity content. -
chapterPosition: string
Title:
Chapter Position
Read Only:true
Maximum Length:19
Position of the chapter in the activity. -
contentCatalogLearningItemDataLink: string
Title:
Content Catalog Learning Item Data Link
Maximum Length:4000
Data link to the catalog learning item added to the activity. -
contentCatalogLearningItemId: integer
Title:
Content Catalog Learning Item ID
Read Only:true
Unique identifier for the catalog learning item added to the activity. -
contentCatalogLearningItemNumber: string
Title:
Content Catalog Learning Item Number
Maximum Length:250
Friendly 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 Subtype
Read Only:true
Maximum Length:32
Learning item subtype for the catalog learning item added to the activity. -
contentCatalogLearningItemType: string
Title:
Content Catalog Learning Item Type
Read Only:true
Maximum Length:32
Learning item type for the catalog learning item added to the activity. -
contentCoverArtLink: string
Title:
Content Cover Art Link
Read Only:true
Maximum Length:4000
URL to open the eLearning content cover art directly from the browser. -
contentId: integer
(int64)
Title:
Content ID
Read Only:true
Unique identifier for the eLearning content. -
contentLongDescription: string
(byte)
Title:
Content Long Description
Read Only:true
Long description of the learning activity content. -
contentNumber: string
Title:
Content Number
Read Only:true
Maximum Length:30
Friendly number identifying the learning activity content. -
contentShortDescription: string
Title:
Content Short Description
Read Only:true
Maximum Length:4000
Short description of the activity content. -
contentTitle: string
Title:
Content Title
Read Only:true
Maximum Length:250
Name of the activity content. -
contentType: string
Title:
Content Type
Read Only:true
Maximum Length:32
Type of content, such as SCORM, HACP, VIDEO, or Tutorial. Valid values are defined in the ContentTypeLOV list. -
contentTypeMeaning: string
Title:
Content Type Description
Read Only:true
Maximum Length:4000
Description of the contentType attribute value. -
contentURL: string
Title:
Content URL
Maximum Length:4000
URL to open the eLearning content directly from the browser. -
disableReview: string
Title:
Disable Viewing Completed Assessments
Read Only:true
Maximum Length:1
Disable reviews on the attempt. -
effortUnits: string
Title:
Effort Units
Read Only:true
Maximum Length:30
Unit 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:
true
Maximum Length:4000
URL to open the video directly from the browser. -
elearnRichMediaSrcLink: string
Title:
eLearning Rich Media Source Link
Read Only:true
Maximum Length:4000
Source URL for the eLearning activity. -
expectedEffort: string
Title:
Expected Effort
Read Only:true
Maximum Length:40
Learner effort required to complete the activity content. -
hideActualScore: string
Title:
Hide Actual Score
Read Only:true
Maximum Length:1
Hide score on the attempt. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
passingScore: number
Title:
Passing Score
Read Only:true
Score required to pass the activity content. -
questionnaireResponses: array
Questionnaire Responses
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Questionnaire Responses
Type:
array
Title:
Questionnaire Responses
The questionnaireResponses resource includes the details of the attempts made by a participant when responding to a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-item-response
Type:
Show Source
object
-
AttemptNumber: integer
(int64)
Title:
Attempt Number
Read Only:true
The attempt number of a participant when responding to a questionnaire. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the questionnaire response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the questionnaire response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date on which the questionnaire response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the questionnaire response. -
LatestAttemptFlag: boolean
Title:
Latest Attempt
Read Only:true
Maximum Length:30
Default Value:false
Indicates if the response is the latest attempt by a participant to the questionnaire. This is a read-only attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionnaireParticipantId: integer
(int64)
Title:
Questionnaire Participant Id
Surrogate identifier for the questionnaire participant. -
QuestionnaireResponseId: integer
(int64)
Title:
Questionnaire Response Id
Surrogate identifier for the questionnaire response. -
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire Version
Version number of the questionnaire that the participant responds to. -
questionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Status: string
Title:
Response Status Code
Maximum Length:30
Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response. -
StatusMeaning: string
Title:
Response Status
Read Only:true
Maximum Length:80
Meaning of the status code. -
SubmittedDateTime: string
(date)
Title:
Submitted Time
Read Only:true
Date on which the questionnaire response was submitted. -
TotalScore: number
Title:
Total Score
Read Only:true
Total score for the responses submitted by a participant for a questionnaire.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-item-response
Type:
Show Source
object
-
AnswerCode: string
Title:
Answer Code
Read Only:true
Maximum Length:240
The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short Description
Read Only:true
Maximum Length:240
Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceList: string
Title:
Choice List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceShortDescription: string
Title:
Choice Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the question response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question Code
Maximum Length:240
Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question Id
Surrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question Id
Surrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response Id
Surrogate identifier for the question response. -
QuestionText: string
Title:
Question Text
Read Only:true
Maximum Length:2000
Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer Score
Read Only:true
Calculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
QuestionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response
Type:
Show Source
object
-
AnswerCode: string
Title:
Answer Code
Read Only:true
Maximum Length:240
The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short Description
Read Only:true
Maximum Length:240
Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceList: string
Title:
Choice List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceShortDescription: string
Title:
Choice Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the question response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question Code
Maximum Length:240
Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question Id
Surrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question Id
Surrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response Id
Surrogate identifier for the question response. -
QuestionText: string
Title:
Question Text
Read Only:true
Maximum Length:2000
Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer Score
Read Only:true
Calculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-activityContentAttempts-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Type
Read Only:true
Maximum Length:30
Type of user, such as Learner or Observer, assigned to the activity section attempt. Valid values are defined in the ActivitySectionAttemptAssignedToTypeLOV list. -
activitySectionAttemptAssignedToTypeMeaning: string
Title:
Activity Section Predecessor Attempt Assignee Type Description
Read Only:true
Description of the type of user assigned to the learning activity section attempt. -
activitySectionAttemptLocked: string
Title:
Activity Section Predecessor Attempt Locked
Read Only:true
Maximum Length:1
Indicates whether the learner can attempt the activity section. Valid values are Y and N. Default value is N. Valid values are defined in the ActivitySectionAttemptStatusLOV. -
activitySectionAttemptNumber: string
Title:
Activity Section Predecessor Attempt Number
Read Only:true
Maximum Length:30
Friendly number identifying the learning activity section attempt. -
activitySectionAttemptStatus: string
Title:
Activity Section Predecessor Attempt Status
Read Only:true
Maximum Length:32
Status for the learning activity section attempt. Valid values are defined in the learning activitySectionAttemptStatusLOV list. -
activitySectionNumber: string
Title:
Activity Section Predecessor Number
Read Only:true
Maximum Length:30
Friendly number identifying the learning activity section. -
activitySectionTitle: string
Title:
Activity Section Predecessor Title
Read Only:true
Maximum Length:255
Title of the activity section. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The 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:
Attachments
The attachments resource is used to view, create, and update attachments. -
classroomDescription: string
Title:
Classroom Description
Read Only:true
Maximum Length:4000
Description of the classroom. -
classroomDFFs: array
classroomDFFs
-
classroomId: integer
(int64)
Title:
Classroom ID
Read Only:true
System-generated primary key for a classroom. -
classroomNumber: string
Title:
Classroom Number
Read Only:true
Maximum Length:30
Friendly number for identifying a classroom. -
classroomTitle: string
Title:
Classroom Title
Read Only:true
Maximum Length:250
Name of the classroom. -
contactPersonDisplayName: string
Title:
Contact Person Display Name
Read Only:true
Maximum Length:240
Display name for the person who's the classroom contact. -
contactPersonId: integer
(int64)
Title:
Contact Person ID
Read Only:true
Identifier for the person who's the classroom contact. -
contactPersonImageURL: string
Title:
Contact Person Image URL
Read Only:true
Maximum Length:32
Image URL for the person who's the classroom contact. -
contactPersonNumber: string
Title:
Contact Person Number
Read Only:true
Maximum Length:30
Person number for the classroom contact person. -
contactPersonPrimaryEmailAddress: string
Title:
Contact Person Primary Email Address
Read Only:true
Maximum Length:60
Primary email address of the person who's the classroom contact. -
contactPersonPrimaryPhoneNumber: string
Title:
Contact Person Primary Phone Number
Read Only:true
Maximum Length:240
Primary phone number for the person who's the classroom contact. -
isPrimaryClassroom: string
Title:
Primary Classroom
Read Only:true
Maximum Length:1
Indicates whether the classroom is a primary classroom. The default value is N. Valid values are Y and N. -
isPrimaryClassroomMeaning: string
Title:
Primary Classroom Description
Read Only:true
Maximum Length:4000
Description of the value of the isPrimaryClassroom attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
locationAddressLine1: string
Title:
Location Address Line 1
Read Only:true
Maximum Length:240
Location address line 1. -
locationAddressLine2: string
Title:
Location Address Line 2
Read Only:true
Maximum Length:240
Location address line 2. -
locationAddressLine3: string
Title:
Location Address Line 3
Read Only:true
Maximum Length:240
Location address line 3. -
locationCity: string
Title:
Location City
Read Only:true
Maximum Length:60
City of the classroom. -
locationCountry: string
Title:
Location Country
Read Only:true
Maximum Length:60
Country of the classroom. -
locationDisplayString: string
Title:
Location Display String
Read Only:true
Maximum Length:32
Complete classroom address in the string format. -
locationLatitude: number
Title:
Location Latitude
Read Only:true
Latitude of the classroom. -
locationLongitude: number
Title:
Location Longitude
Read Only:true
Longitude of the classroom. -
locationName: string
Title:
Location Name
Read Only:true
Maximum Length:240
Location of the classroom. -
locationSingleLineString: string
Read Only:
true
Maximum Length:1732
Location of the classroom expressed as a single line string. -
locationZipCode: string
Title:
Location ZIP Code
Read Only:true
Maximum Length:30
Postal code of the location address.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-classrooms-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Attribute provided by the Attachment UI components to support the upload of files.
-
AttachedDocumentId: integer
(int64)
Unique identifier of the attached document.
-
attachmentId: integer
Title:
Attachment Id
Read Only:true
ID of the attachment. -
attachmentLink: string
Title:
Attachment Link
Read Only:true
Maximum Length:4000
Link to the attachment. -
attachmentName: string
Title:
Attachment Name
Read Only:true
Maximum Length:4000
Name of the attachment. -
attachmentNumber: string
Title:
Attachment Number
Read Only:true
Friendly number for identifying the attachment. -
attachmentType: string
Title:
Attachment Type
Read Only:true
Maximum Length:4000
Type of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Read Only:
true
Date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Read Only:
true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Expiration date of the attachment. This is a read-only attribute.
-
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
File URL of the attachment.
-
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when attachment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Read Only:
true
User name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the uploaded file. This is a read-only attribute.
-
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment. -
UserName: string
Read Only:
true
Maximum Length:255
URL of a web page type attachment.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The 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 ID
Read Only:true
Unique identifier for the instructor. -
instructorNumber: string
Title:
Instructor Number
Read Only:true
Maximum Length:19
Friendly number for identifying the instructor. -
isPrimaryInstructor: string
Title:
Primary Instructor
Read Only:true
Maximum Length:1
Indicates whether the person is the primary instructor. The default value is N. Valid values are Y and N. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
personDisplayName: string
Title:
Instructor
Read Only:true
Maximum Length:240
Display name for the instructor. -
personId: integer
(int64)
Title:
Instructor Person ID
Read Only:true
Identifier for the person who's the instructor. -
personImageURL: string
Title:
Instructor Image URL
Read Only:true
Maximum Length:32
Image URL for the instructor for the learning item. -
personNumber: string
Title:
Instructor Person Number
Read Only:true
Maximum Length:30
Person number for the instructor. -
personPrimaryEmailAddress: string
Title:
Instructor Primary Email Address
Read Only:true
Maximum Length:60
Primary Email address of the instructor for the learning item. -
personPrimaryPhoneNumber: string
Title:
Instructor Primary Phone Number
Read Only:true
Maximum Length:240
Phone number of the instructor of the learning item.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-offeredLanguages-item-response
Type:
Show Source
object
-
language: string
Title:
Language
Read Only:true
Maximum Length:255
Language for the selected learning assignment offering. -
languageCode: string
Title:
Language Code
Read Only:true
Maximum Length:30
Language code for the selected learning assignment offering. -
languageCodeMeaning: string
Title:
Language Code Description
Read Only:true
Maximum Length:4000
Description of the languageCode attribute value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The 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:
Links
The link relations associated with the resource instance. -
locationCity: string
Title:
Location City
Read Only:true
Maximum Length:60
City where the selected learning assignment offering is delivered. -
locationCountry: string
Title:
Location Country
Read Only:true
Maximum Length:60
Country where the selected learning assignment offering is delivered. -
locationTitle: string
Title:
Location Name
Read Only:true
Maximum Length:93
City-state-country for the ILT type offering. For other offering types, it's Virtual Classroom or Self Paced, as applicable.
Nested Schema : Links
Type:
array
Title:
Links
The 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 Number
Read Only:true
The attempt number of a participant when responding to a questionnaire. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the questionnaire response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the questionnaire response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date on which the questionnaire response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the questionnaire response. -
LatestAttemptFlag: boolean
Title:
Latest Attempt
Read Only:true
Maximum Length:30
Default Value:false
Indicates if the response is the latest attempt by a participant to the questionnaire. This is a read-only attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionnaireParticipantId: integer
(int64)
Title:
Questionnaire Participant Id
Surrogate identifier for the questionnaire participant. -
QuestionnaireResponseId: integer
(int64)
Title:
Questionnaire Response Id
Surrogate identifier for the questionnaire response. -
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire Version
Version number of the questionnaire that the participant responds to. -
questionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Status: string
Title:
Response Status Code
Maximum Length:30
Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response. -
StatusMeaning: string
Title:
Response Status
Read Only:true
Maximum Length:80
Meaning of the status code. -
SubmittedDateTime: string
(date)
Title:
Submitted Time
Read Only:true
Date on which the questionnaire response was submitted. -
TotalScore: number
Title:
Total Score
Read Only:true
Total score for the responses submitted by a participant for a questionnaire.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-item-response
Type:
Show Source
object
-
AnswerCode: string
Title:
Answer Code
Read Only:true
Maximum Length:240
The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short Description
Read Only:true
Maximum Length:240
Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceList: string
Title:
Choice List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceShortDescription: string
Title:
Choice Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the question response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question Code
Maximum Length:240
Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question Id
Surrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question Id
Surrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response Id
Surrogate identifier for the question response. -
QuestionText: string
Title:
Question Text
Read Only:true
Maximum Length:2000
Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer Score
Read Only:true
Calculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
QuestionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response
Type:
Show Source
object
-
AnswerCode: string
Title:
Answer Code
Read Only:true
Maximum Length:240
The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short Description
Read Only:true
Maximum Length:240
Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceList: string
Title:
Choice List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceShortDescription: string
Title:
Choice Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the question response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question Code
Maximum Length:240
Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question Id
Surrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question Id
Surrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response Id
Surrogate identifier for the question response. -
QuestionText: string
Title:
Question Text
Read Only:true
Maximum Length:2000
Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer Score
Read Only:true
Calculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionDetails-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-completionSummary-item-response
Type:
Show Source
object
-
actualEffort: number
Title:
Actual Effort
Read Only:true
Actual effort by the learner. -
actualScore: number
Title:
Actual Score
Read Only:true
Learner score for this learning assignment. -
completionProgress: number
Title:
Completion Progress
Learner progress to complete the learning assignment. For a course, it's the number of activities completed. For a specialization, it's the sum of all the completed courses. For tutorials, it's the sum of all the completed sections. -
completionRequirement: number
Title:
Completion Requirement
Read Only:true
Number of activities left to complete to complete the learning course assignment offering. -
completionRequirementUnits: string
Title:
Completion Requirement Units
Read Only:true
Maximum Length:120
Unit of measure for the completion requirement of the learning assignment, such as chapters, hours, or required activities. Valid values are defined in the CompletionRequirementUnitsLOV list. -
completionRequirementUnitsMeaning: string
Title:
Completion Requirement Units Description
Read Only:true
Maximum Length:4000
Description of the completionRequirementUnits attribute value. -
effortUnits: string
Title:
Effort Units
Read Only:true
Maximum Length:30
Unit of measure for the expected and actual effort to complete the learning item, such as day, hour, or minute. Valid values are defined in the EffortUnitsLOV list. -
effortUnitsMeaning: string
Title:
Effort Units Description
Read Only:true
Maximum Length:4000
Description of the effortUnits attribute value. -
expectedEffort: string
Title:
Expected Effort
Read Only:true
Maximum Length:32
Expected effort to complete the learning assignment item. -
expectedEffortInSeconds: string
Read Only:
true
Expected effort, in seconds, to complete the learning item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
passingScore: number
Title:
Passing Score
Read Only:true
Passing score for the learning assignment item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-enrollmentHistory-item-response
Type:
Show Source
object
-
enrollmentHistoryOrderId: integer
Display order for the learning enrollment history status message.
-
enrollmentHistoryStatusMessage: string
Status message to show to the user.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-enrollmentRelatedMaterials-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Attribute provided by the Attachment UI components to support the upload of files.
-
AttachedDocumentId: integer
(int64)
Unique identifier of the attached document.
-
attachmentId: integer
Title:
Attachment Id
Read Only:true
ID of the attachment. -
attachmentLink: string
Title:
Attachment Link
Read Only:true
Maximum Length:4000
Link to the attachment. -
attachmentName: string
Title:
Attachment Name
Read Only:true
Maximum Length:4000
Name of the attachment. -
attachmentNumber: string
Title:
Attachment Number
Read Only:true
Friendly number for identifying the attachment. -
attachmentType: string
Title:
Attachment Type
Read Only:true
Maximum Length:4000
Type of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Read Only:
true
Date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Read Only:
true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Expiration date of the attachment. This is a read-only attribute.
-
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
File URL of the attachment.
-
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when attachment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Read Only:
true
User name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be done after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the uploaded file. This is a read-only attribute.
-
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment. -
UserName: string
Read Only:
true
Maximum Length:255
URL of a web page type attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
LearningItemId: integer
(int64)
-
LearningItemType: string
Maximum Length:
32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemRatingDetails-item-response
Type:
Show Source
object
-
dataSecurityPrivilege: string
Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ratedByPersonDetails: array
User Access Person Details
Title:
User Access Person Details
The personDetalis resource provides details about the person associated with the learning item. -
rating: number
Title:
Rating
The rating given on the learning item. -
ratingByPersonDisplayName: string
Title:
Rated By
Read Only:true
Maximum Length:240
Display name for the person who rated the learning item. -
ratingByPersonId: integer
(int64)
Title:
Rated by Person ID
Identifier of the person who rated the learning item. -
ratingByPersonImageURL: string
Title:
Rated by Person Image URL
Image URL of the person who rated the learning item. -
ratingByPersonNumber: string
Title:
Rated by Person Number
Read Only:true
Maximum Length:30
Person number of the person who rated the learning item. -
ratingComment: string
Title:
Rating Comment
Maximum Length:4000
Comment made by the learner while rating the learning item. -
ratingDate: string
(date-time)
Title:
Rated on Date
Read Only:true
Date the rating was made on the learning item. -
ratingId: integer
(int64)
Title:
Rating ID
Unique identifier for the rating on the learning item. -
ratingNumber: string
Title:
Rating Number
Maximum Length:30
Friendly number identifying the learning item rating. -
ratingStatus: string
Title:
Rating Status
Maximum Length:30
Status of the rating on the learning item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : User Access Person Details
Type:
array
Title:
User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-response
Type:
Show Source
object
-
assignmentName: string
Read Only:
true
Maximum Length:80
Person's work assignment name. -
businessUnitId: integer
(int64)
Title:
Business Unit ID
Read Only:true
Unique identifier for the person's business unit. -
businessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the person's business unit. -
departmentId: integer
(int64)
Title:
Department ID
Read Only:true
Person's department. -
departmentName: string
Title:
Department
Read Only:true
Maximum Length:240
Person's department name. -
jobId: integer
(int64)
Title:
Job ID
Read Only:true
Person's job identifier. -
jobName: string
Title:
Job
Read Only:true
Maximum Length:240
Person's job name. -
legalEmployerId: integer
(int64)
Title:
Legal Employer ID
Read Only:true
Identifier for the person's legal employer. -
legalEmployerName: string
Title:
Legal Employer
Read Only:true
Maximum Length:240
Name of the person's legal employer. -
lineManagerDisplayName: string
Title:
Line Manager
Read Only:true
Maximum Length:240
Display name for the person's line manager. -
lineManagerId: integer
(int64)
Title:
Line Manager ID
Read Only:true
Identifier for the person's line manager. -
lineManagerNumber: string
Title:
Line Manager Number
Read Only:true
Maximum Length:30
Number for the person's line manager. -
lineManagerPrimaryEmailAddress: string
Title:
Line Manager Primary Email Address
Read Only:true
Maximum Length:240
Primary email address for the person's line manager. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
locationId: integer
(int64)
Title:
Location ID
Read Only:true
Person's location identifier. -
locationName: string
Title:
Location Name
Read Only:true
Maximum Length:240
Person's location name. -
personId: integer
(int64)
Read Only:
true
Identifier of the person who's the publisher. -
positionId: integer
(int64)
Title:
Position ID
Read Only:true
Unique identifier for the person's position. -
positionName: string
Title:
Position
Read Only:true
Maximum Length:240
Person's position name. -
primaryEmailAddress: string
Read Only:
true
Maximum Length:240
Person's primary email address. -
primaryPhoneNumber: string
Read Only:
true
Maximum Length:60
Person's primary phone number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-learningItemRelatedMaterials-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Attribute provided by the Attachment UI components to support the upload of files.
-
AttachedDocumentId: integer
(int64)
Unique identifier of the attached document.
-
attachmentId: integer
Title:
Attachment Id
Read Only:true
ID of the attachment. -
attachmentLink: string
Title:
Attachment Link
Read Only:true
Maximum Length:4000
Link to the attachment. -
attachmentName: string
Title:
Attachment Name
Read Only:true
Maximum Length:4000
Name of the attachment. -
attachmentNumber: string
Title:
Attachment Number
Read Only:true
User-friendly number for identifying the attachment. -
attachmentType: string
Title:
Attachment Type
Read Only:true
Maximum Length:4000
Type of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Read Only:
true
Date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment Type such as FILE or TEXT, or WEB_PAGE. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached. -
DmFolderPath: string
Maximum Length:
1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Read Only:
true
JSON object represented as a string that contains information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
The error status code, if any, for the attachment.
-
ErrorStatusMessage: string
The error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Expiration date of the attachment. This is a read-only attribute.
-
FileContents: string
(byte)
Title:
File Contents
Actual content of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
File URL of the attachment.
-
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
Base64 encoded image file displayed in .png format when the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when attachment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the user who last updated the attachment record. -
LastUpdatedByUserName: string
Read Only:
true
User name of the user who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be done after an attachment is uploaded. -
SourceId: integer
(int64)
Read Only:
true
Unique identifier for the source where this assignment was created. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the uploaded file. This is a read-only attribute.
-
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Name of the uploaded file. This is a read-only attribute.
-
UploadedText: string
Text uploaded in the attachment.
-
Uri: string
Maximum Length:
4000
URI of the attachment. This is a read-only attribute. -
Url: string
Maximum Length:
4000
URL of a web page type attachment. -
UserName: string
Read Only:
true
Maximum Length:255
URL of a web page type attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-messages-item-response
Type:
Show Source
object
-
dataSecurityPrivilege: string
Title:
Data Security Privilege
Maximum Length:32
Data security privilege, such as Learner or Learner Manager, that identifies the intent and permissions for the person accessing the learning assignment. Valid values are defined in the list DataSecurityPrivilegeLOV. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
message: string
Read Only:
true
Code to indicate the type of message. -
messageCode: string
Read Only:
true
User-friendly string describing the message. -
messageSecondaryText: string
Read Only:
true
Secondary text for the message. -
messageSeverity: string
Read Only:
true
Indicates the severity of the message like: INFO, WARN, or FATAL. -
visibility: string
Read Only:
true
Determines the message visibility. Valid values are Show or Hide.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-offeringDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ClassId: integer
(int64)
-
EffectiveEndDate: string
(date)
-
EffectiveStartDate: string
(date)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-questionnaireResponses-item-response
Type:
Show Source
object
-
AttemptNumber: integer
(int64)
Title:
Attempt Number
Read Only:true
The attempt number of a participant when responding to a questionnaire. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the questionnaire response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the questionnaire response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date on which the questionnaire response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the questionnaire response. -
LatestAttemptFlag: boolean
Title:
Latest Attempt
Read Only:true
Maximum Length:30
Default Value:false
Indicates if the response is the latest attempt by a participant to the questionnaire. This is a read-only attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionnaireParticipantId: integer
(int64)
Title:
Questionnaire Participant Id
Surrogate identifier for the questionnaire participant. -
QuestionnaireResponseId: integer
(int64)
Title:
Questionnaire Response Id
Surrogate identifier for the questionnaire response. -
QuestionnaireVersionNumber: integer
(int64)
Title:
Questionnaire Version
Version number of the questionnaire that the participant responds to. -
questionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Status: string
Title:
Response Status Code
Maximum Length:30
Status of the questionnaire response. I denotes the response is in progress and not submitted yet, while S denotes a submitted response. -
StatusMeaning: string
Title:
Response Status
Read Only:true
Maximum Length:80
Meaning of the status code. -
SubmittedDateTime: string
(date)
Title:
Submitted Time
Read Only:true
Date on which the questionnaire response was submitted. -
TotalScore: number
Title:
Total Score
Read Only:true
Total score for the responses submitted by a participant for a questionnaire.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-questionnaireResponses-questionResponses-item-response
Type:
Show Source
object
-
AnswerCode: string
Title:
Answer Code
Read Only:true
Maximum Length:240
The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short Description
Read Only:true
Maximum Length:240
Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceList: string
Title:
Choice List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceShortDescription: string
Title:
Choice Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the question response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question Code
Maximum Length:240
Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question Id
Surrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question Id
Surrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response Id
Surrogate identifier for the question response. -
QuestionText: string
Title:
Question Text
Read Only:true
Maximum Length:2000
Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer Score
Read Only:true
Calculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-questionnaireResponses-questionResponses-questionResponseAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
QuestionResponses: array
Question Responses
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Responses
Type:
array
Title:
Question Responses
The questionResponses resource is a child of the questionnaireResponses resource. It includes responses to specific questions within a questionnaire.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-item-response
Type:
Show Source
object
-
AnswerCode: string
Title:
Answer Code
Read Only:true
Maximum Length:240
The answer code that a participant chose when responding to a single choice question. -
AnswerCodeList: string
Title:
Answer Code List
Concatenated list of answer choices, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerComments: string
Title:
Comments
Maximum Length:4000
Additional comments provided by the participant when responding to a question. -
AnswerLargeObject: string
(byte)
Title:
Answer
Attachment provided by the participant when responding to a question. -
AnswerList: string
Title:
Answer List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
AnswerShortdescription: string
Title:
Answer Short Description
Read Only:true
Maximum Length:240
Text of the answer chosen by a participant when responding to a single choice question. -
AnswerShortDescriptionList: string
Title:
Answer Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which is selected by the participant when responding to a multiple choice question. -
ChoiceCodeList: string
Title:
Choice List Code
Concatenated list of answer codes, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceList: string
Title:
Choice List
Maximum Length:2000
Concatenated list of answer identifiers, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
ChoiceShortDescription: string
Title:
Choice Short Description
Read Only:true
Concatenated list of answer texts, separated by a semicolon as a delimiter, which are presented to the participant when responding to a question enabled for random order responses. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the question response. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the question response was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the question response was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the question response. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QuestionAnswerId: integer
(int64)
Title:
Question Answer Id
Surrogate identifier of the answer that a participant chose when responding to a single choice question. -
QuestionCode: string
Title:
Question Code
Maximum Length:240
Alphanumeric value that uniquely identifies a question defined for a subscriber. -
QuestionId: integer
(int64)
Title:
Question Id
Surrogate identifier for the question. -
QuestionnaireQuestionId: integer
(int64)
Title:
Questionnaire Question Id
Surrogate identifier for the question in a questionnaire. -
questionResponseAttachments: array
Question Response Attachments
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question. -
QuestionResponseId: integer
(int64)
Title:
Question Response Id
Surrogate identifier for the question response. -
QuestionText: string
Title:
Question Text
Read Only:true
Maximum Length:2000
Text of the question that a participant responds to. -
Score: integer
(int64)
Title:
Answer Score
Read Only:true
Calculated score for the responses provided for a question by a participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Question Response Attachments
Type:
array
Title:
Question Response Attachments
The questionResponseAttachments resource is a child of the questionResponses resource. It includes attachments added in response to a question.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-questionnaireResponses-questionResponses-questionResponseAttachments-QuestionResponses-questionResponseAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided exclusively for the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
Category name of the attachment. This is a read-only attribute. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
User name of the user who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date on which the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Attachment type supported for the question. Only the attachment type, FILE, is supported. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Surrogate identifier of the document attached to the questionnaire. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Path of the folder. -
DmVersionNumber: string
Maximum Length:
255
Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code of the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message of the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Expiration date of the attachment. This is a read-only attribute. -
FileContents: string
(byte)
Title:
File Contents
File contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
Name of the attachment file. -
FileUrl: string
Title:
File Url
File URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date on which the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the attachment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded file. This is a read-only attribute. -
UploadedFileLength: integer
Title:
File Size
Size of the uploaded file. This is a read-only attribute. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the uploaded file. This is a read-only attribute. -
UploadedText: string
Title:
Uploaded Text
Text uploaded in the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI of the attachment. This is a read-only attribute. -
Url: string
Title:
Url
Maximum Length:4000
URL of a web page attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
User name of the person who uploaded the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : learnerLearningRecords-primarySelectedCourseOffering-transactionHistory-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
transactionAmount: string
Title:
Transaction Amount
Read Only:true
Maximum Length:19
Learning transaction history item type amount. -
transactionComments: string
Title:
Transaction Comments
Read Only:true
Maximum Length:4000
Learning transaction history item comments. -
transactionCurrency: string
Title:
Transaction Currency
Read Only:true
Maximum Length:19
Learning transaction history item type currency. Valid values are defined in the PriceCurrencyLOVVA list. -
transactionDate: string
(date-time)
Title:
Transaction Date
Read Only:true
Transaction history date when the learning item was assigned. -
transactionId: integer
Title:
Transaction ID
Read Only:true
Unique identifier for the transaction history that the learning item was assigned to. -
transactionNumber: string
Title:
Transaction Number
Read Only:true
Maximum Length:250
Transaction history number for the learner assigned to the learning item. -
transactionReason: string
Title:
Transaction Reason
Read Only:true
Maximum Length:19
Learning transaction history item reason. Valid values are defined in the ReasonLOV list. -
transactionReasonMeaning: string
Title:
Transaction Reason Description
Read Only:true
Maximum Length:4000
Description of the transactionReason attribute value. -
transactionType: string
Title:
Transaction Type
Read Only:true
Maximum Length:30
Transaction history item type for the learning item. Valid values are defined in the TransactionTypeLOV list. -
transactionTypeMeaning: string
Title:
Transaction Type Description
Read Only:true
Maximum Length:4000
Description of the transactionType attribute value.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AssignerToAttributionTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ATTRIBUTION_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: assignerAttributionType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AssignmentStatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSIGN_RECORD_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: assignmentStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- AssignmentSubStatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_ASSIGN_RECORD_STATUS
The following properties are defined on the LOV link relation:- Source Attribute: assignmentSubStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CanEditAssignmentHintLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_CAN_EDIT_ASSIGNMENT_HINT
The following properties are defined on the LOV link relation:- Source Attribute: canEditAssignmentHint; 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:
- DurationLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LEARN_DURATION_UOM
The following properties are defined on the LOV link relation:- Source Attribute: liTotalExpectedEffortUOM; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- LanguageLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DPER_CORRESP_LANG
The following properties are defined on the LOV link relation:- Source Attribute: offeringLanguage; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- OfferingLearningItemTypeMeaningLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_LEARN_DELIVERY_MODE
The following properties are defined on the LOV link relation:- Source Attribute: learningItemType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PrimaryClassroomTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_CLASSROOM_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: primaryClassroomType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ReasonCodeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_WLF_WITHD_RSN_SS
The following properties are defined on the LOV link relation:- Source Attribute: reasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- assignmentDFF
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- completionDetails
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- completionSummary
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- enrollmentHistory
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- enrollmentRelatedMaterials
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- learningItemDFF
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- learningItemRatingDetails
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- learningItemRelatedMaterials
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- messages
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- offeringDFF
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- questionnaireResponses
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID:
- transactionHistory
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- otherSelectedCourseOfferingsUniqID2100:
$request.path.otherSelectedCourseOfferingsUniqID2100
- learnerLearningRecordsUniqID: