Cmdlets for SAP Success Factors LMS

Build 25.0.9539

CurriculumItemDetails

Retrieve the details of a curriculum item.

Table-Specific Information

Select

The cmdlet uses the SAPSuccessFactorsLMS API to process WHERE clause conditions that are built with the following columns and operators:
  • CurriculaID supports the = comparison operator.
  • RootCurriculaID supports the = comparison operator.
  • UserID supports the = comparison operator.

The cmdlet processes other filters client-side within the cmdlet.

For example, the following queries are processed server-side:

SELECT [Admin].[Curriculum_Service].[CurriculumItemDetails].* FROM [Admin].[Curriculum_Service].[CurriculumItemDetails] WHERE (([curriculaID] = 'HR') AND ([rootCurriculaID] = 'HR')) AND ([UserID] = 'sabadi')

Columns

Name Type References Required for Select Description
AssignedDate Datetime The assignment date of the curriculum.
AssignmentType String The assignment type of the entity, which is enumerated in SAP SuccessFactors Learning Administration, in the References section, in the Learning group.
CurriculaDesc String The plain text description of the curriculum that the system returns.
CurriculaID String True The unique ID of a curriculum in the system.
CurriculumRequirementItems String A curriculum requirement item is one learning item for the curriculum requirement.
DisplayOrder Long The order that users progress through the learning items within a curriculum.
ExpiryDate Datetime The date that the learning item expires within the curriculum.
GlobalDisplayOrder String The order that entries for the curriculum will be displayed. Learning administrators create this order.
HourTypeID String The hour type that is a unit for numberOfHours and completedNumberOfHours. 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. 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.,CPE is an abbreviation for
HtmlCurriculaDesc String The HTML description of the curriculum that the system returns.
ItemID String The unique ID of a learning item.
ItemTitle 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.
ItemTypeID 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.
NextActionDate Datetime The next date that the user must take action on this item.
NumberOfComponents Long A number of learning items in a requirement for the curriculum. Sometimes users must complete - for example - five learning items in a curriculum to meet a requirement.
NumberOfHours Double A number of hours of the type in hourTypeID. This is the number of hours required to meet a requirement of the curriculum.
PersonGUID String An internally generated, immutable identifier for one person across all of SuccessFactors HCM Suite. This is different from an LMS user ID (often called STUDENT ID). The student ID is used only within the Learning Management System (LMS). It is also different from the PERSON ID, which is used throughout SAP SuccessFactors HCM Suite but is mutable. In most cases, you use the person ID when you want to call a single user throughout the suite.
RequiredDate Datetime The date that this is required to be complete. Users see this date as their deadline in their assignments.
RequirementDesc String A description of the requirement. This helps you understand the requirement.
RequirementGroupDesc String The description of the requirement group.
RequirementGroupID Long The unique identifier of the requirement group.
RequirementID String The unique ID of the requirement that the learning item fulfills within the curriculum.
RequirementSequenceNumber Long The order of the requirement for the learning item within the curriculum. Requirements are ordered.
RequirementTypeID String The description of a requirement type.
RevDate 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.
RootCurriculaID String True The unique ID of the curriclum at the root of the curriculum structure. Curricula can be subcurriclua and have parent curricula. This is the ID of the curriculum at the top of the hierarchy.
TotalCount Long The total number of records found for this request.
UserID String True The unique ID of a user in the Learning Management System (LMS). This is recognized within the LMS only. If you want an ID that is recognized throughout SAP SuccessFactors HCM Suite, you want to get the Person GUID or Person External ID.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539