Cmdlets for SAP Success Factors LMS

Build 25.0.9539

Programs

Use the search service to search for SAP SuccessFactors Learning programs

Table-Specific Information

Select

The cmdlet uses the SAPSuccessFactorsLMS API to process WHERE clause conditions that are built with the following columns and operators:
  • ProgramID supports the =, !=, and LIKE comparison operators. Server-side support for the LIKE operator is restricted to CONTAINS clauses.
  • Active supports the =, !=, IS, and IS NOT comparison operators.
  • DomainID supports the =, !=, and LIKE comparison operators. Server-side support for the LIKE operator is restricted to CONTAINS clauses.
  • ProgramTitle supports the =, !=, and LIKE comparison operators. Server-side support for the LIKE operator is restricted to CONTAINS clauses.

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

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

SELECT [Admin].[Search_Service].[Programs].* FROM [Admin].[Search_Service].[Programs]

Columns

Name Type References Required for Select Description
ProgramID [KEY] String The unique ID of a program in SAP SuccessFactors Learning. Learning programs are bundles of learning events like formal learning items, links to videos, and documents. For example, you can create a program called Employee Onboarding. The program could bundle some required learning items that all employees must complete, a link to a welcome video, a link to onboarding forms, and so on. You can then assign the program (the bundle) to employees.
Active Bool If the value is true then the user is active. If the value is false, then the user is inactive.
AssignmentTypeID String The assignment type of the entity, which is enumerated in SAP SuccessFactors Learning Administration, in the References section, in the Learning group.
Description String A description of the program. Descriptions help users understand why they are assigned or why they might assign themselves a program.
DomainID String The security domain ID of the entity. You can associate a record with an access domain to control the administrators who can access the record. What an administrator can access and do for a record depends on how you configured the entity, function, and workflow domain restrictions of the role ID that is associated with the administrator.
Duration String When you create a program that has a duration, this is the length of the program. For example, you can create a six week program. It applies only when the program is of type DURATION_BASED.
EndDate Datetime The end date of the program. It applies only when the program type is SCHEDULE_BASED. It is a fixed date assigned by the program's creator.
ProgramTitle String The title of a program. Titles help users understand why they are assigned or why they might assign themselves a program.
ProgramType String Learning program types describe how the user goes about completing a program. SCHEDULE_BASED - A scheduled program has fixed start and end dates. Scheduled programs require that if instructor-led or blended activities are selected, you must add Scheduled Offerings to the program. DURATION_BASED - A duration-based program has a fixed time limit. The start/end dates and times are determined by when the program is assigned to the user. OPEN_ENDED - An open-ended program is self-paced with no time limitations.
StartDate Datetime The start date of the program. It applies only when the program type is SCHEDULE_BASED. It is a fixed date assigned by the program's creator.
TotalCount Long The total number of records found for this request.

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