LearningHistories
Get the learning history for the user.
Table-Specific Information
Select
The add-in uses the SAPSuccessFactorsLMS API to process WHERE clause conditions that are built with the following columns and operators:- ItemID supports the = comparison operator.
- ItemType supports the = comparison operator.
- TargetUserID supports the = comparison operator.
- PersonGUID supports the = comparison operator.
- FromDate supports the = comparison operator.
- ToDate supports the = comparison operator.
- IncludeDeepLink supports the = comparison operator.
- RevisionDate supports the =, >, <, >=, and <= comparison operators.
SELECT queries must include a filter on one of the following columns:
- ItemID
- ItemType
- TargetUserID
- PersonGUID
- FromDate
- ToDate
- IncludeDeepLink
- RevisionDate
The add-in processes other filters client-side within the add-in.
Columns
| Name | Type | References | Required for Select | Description |
| CertificateLink | String | A link to the certificate of completion report. Users can click this link to see their certificate of completion and print it. The user must have permission to print the certificate of completion. Most customers give their users permission to print certificates of completion. | ||
| Comments | String | Comments about the learning event. | ||
| CompletionDate | Datetime | The completion date when the user completed the learning item. | ||
| CompletionStatusDesc | String | The description of the completion status. | ||
| CompletionStatusID | String | The task checklist completion status ID. It is the completion status that the user is assigned if they pass the task checklist. | ||
| ComponentID | String | The unique ID of a learning item. | ||
| ComponentKey | String | The unique key for the item. It is used in some parts of application such as bookmarking where we need to save multiple entities' primary keys. It must be a long number. | ||
| ComponentTypeID | String | Item type IDs are a critical categorization in because they determine how users are marked complete for a learning item. One item type can have completion statuses of pass and fail while another might have completion statuses of pass, fail and incomplete. | ||
| ContactHours | Double | Contact hours are the total number of hours that you expect a user to have contact with an instructor. For example, if you set up a blended learning item that has 8 total hours and, for 6 of those hours, you expect the user to be in an instructor-led segment, then the contact hours equals 6. The hours can be inherited from the learning event (the course) or they can be specified when a user, supervisor, or administrator records completion with the Record Learning wizard. | ||
| CpeHours | Double | CPE is an abbreviation for | ||
| CreditHours | Double | Credit hours are the number of hours that a user earns for completing a learning event. For example, in many U.S. colleges, students attend a single class for 15 weeks, 3 days each week, and 1 hour each day. In this case, the total hours equals 45; however, the college grants 3 CREDIT HOURS for this class. The hours can be inherited from the learning event (the course) or they can be specified when a user, supervisor, or administrator records completion with the Record Learning wizard. | ||
| ItemID | String | The unique ID of the learning item to filter by. | ||
| ItemType | String | The type of learning item to filter by. | ||
| TargetUserID | String | The ID of the target user whose learning history is being retrieved. | ||
| PersonGUID | String | The Person GUID of the target user. | ||
| FromDate | Datetime | Filter to retrieve learning histories from this date onward. | ||
| ToDate | Datetime | Filter to retrieve learning histories up to this date. | ||
| FormattedRevisionDate | Date | The revision date formatted to the current users' preferences. Use it to display the format date. | ||
| IncludeDeepLink | Bool | If true, include deep links in the response.
The default value is false. | ||
| EmbeddableDeeplink | String | A deep link that can be embedded in an iframe. When users access the link, they must authenticate to the system and then the course content displays in the content player. | ||
| EnableRating | Bool | If you enable rating for a learning item, then this is true. If it is true, then when user complete the learning item, they can rate it. This rating is the stars rating that appears in the catalog to other users. If you were building a client that allows ratings, you would check this for a true value before allowing a user to rate completed learning items. | ||
| EsigMeaningCode | String | The e-signature meaning code entered by the user recording the learning event. E-signatures are a way for validated customers to verify users' identities. If you are not a validated customer, then this does not apply to you. | ||
| EsigUsername | String | The e-signature user name entered by the user recording the learning event. E-signatures are a way for validated customers to verify users' identities. If you are not a validated customer, then this does not apply to you. | ||
| Grade | String | The grade that the user earned for completing the course. Grades are defined by your company. They can be numeric (1-10) or codes (like A-F or Pass/Fail/Incomplete). | ||
| InstructorName | String | The name of the instructor who taught the course. | ||
| LastCompletionDate | Datetime | The last date that the user completed the learning item. It is stored in the user rating table. | ||
| LastUpdateTimestamp | Datetime | The last time that the history record was updated. | ||
| OnlineContentLink | String | A link to the online content so that users can review the content if they are allowed to review it. | ||
| ProvideCredit | Bool | If this value is true, then the course provided credit to the user. Your organization defines what credit means. | ||
| Rating | Double | The users' rating of the course from the course catalog. | ||
| RatingDate | Datetime | The date that the user rated the learning item. If the user has not yet rated the learning item or if the user is not allowed to rate the learning item (enableRating is false) then this is null. | ||
| RatingPending | Bool | If the value of this is true, then the user has not rated the learning item. | ||
| RecordID | String | The unique identifier of the learning history record. | ||
| ReviewContentAllowed | Bool | If the value of this is true, then the user can go back and review the content of the course. | ||
| RevisionDate | Datetime | The revision date of this entity. Learning items often have revision dates that correspond to a regulator's revision of compliance measures. Each later revision date is a later iteration of a learning item. | ||
| RevisionNumber | String | The revision number of this entity. Each revision date has a revision number. Users sometimes know the revision number of training instead of the revision date. For example, they might know that they want revision 2 of a training, regardless of the date that it was revised. | ||
| ScheduleID | Long | The unique ID of the scheduled offering that the user completed. A scheduled offering is a course that took place at one place and time. For example, you can have one course called Business Writing that is offered every month. Each month is a different instance of Business Writing, and therefore a different scheduled offering of the course. | ||
| SeqNum | String | A unique ID for each student item rating. You cannot use it. | ||
| Status | String | The task checklist completion status ID. It is the completion status that the user is assigned if they pass the task checklist. For external events, this value is null. | ||
| StudentComponentID | Long | This string is used to identify the content assigned to a user and is used to generate the review content link for the completed learning item in the users' learning history. | ||
| Title | String | The title of the learning item in the language of the current user (the user calling the web service). Titles can be translated using a key/value pair, where the key uniquely identifies a particular learning item's title and the values are each language's translation of the title.If you need the key that matches this value, and if the web service supports it, look in TitleLabelKey. | ||
| TotalHours | Double | The total hours that a user earns for completing a course. | ||
| UserCompetencyAssessments | String | The competency assessments associated with the user. | ||
| UserLearningHistoryContentObjects | String | The content objects associated with the learning history. |