Service Directory > v31.2 > Learning > Manage_Learning_Program
 

Operation: Manage_Learning_Program

Updates or creates Learning Programs. Uses the Manage Learning Program business process


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Manage_Learning_Program_Request

Contains all the request data to add or update learning programs.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Manage_Learning_Program_Data  Manage_Learning_Program_Data  [1..1]  Manage Learning Program Request 
Validation Description
You can't create or edit the program because you don't have access to all the learning content.   
 
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
top
 

Response Element: Manage_Learning_Program_Response

Contains the references for the learning program event and corresponding learning program created or updated.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Program_Event_Reference  Unique_IdentifierObject  [0..1]  Learning Program Event Reference   
Program_Reference  Learning_ProgramObject  [0..1]  Learning Program Reference   
top
 

Manage_Learning_Program_Data

part of: Manage_Learning_Program_Request
Contains all the request data to add or update learning programs.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Program_Reference  Learning_ProgramObject  [0..1]  Learning Program Secured for Web Services   
Learning_Program_Data  Learning_Program_Data  [1..1]  Manage Learning Program Data 
Validation Description
You need to set Requires Successful Completion on at least 1 item.   
Content order values must be unique.   
You can't associate inactive topics with a program. Enter 1 or more active topics.   
Title must be unique.   
Inactive sales items are not allowed   
You can't add inactive content items to the program.   
In Progress status cannot be added to Learning Programs.   
Enter an Effective Date that's on or after today's date.   
Security Categories can only be added to Programs if the Tenant Set Up flag for 'Enable Security Category' or 'Enable Topic and Security Category' is selected.   
Reference IDs must be unique.   
You can't add duplicate items to a program. Remove duplicate items before you submit.   
Add 1 or more content items.   
 
Validation Description
You can't create or edit the program because you don't have access to all the learning content.   
top
 

Learning_ProgramObject

part of: Manage_Learning_Program_Data, Manage_Learning_Program_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Learning_ProgramObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Learning_ProgramObjectID

part of: Learning_ProgramObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Learning_Course, Learning_Course_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Learning_Program_Data

part of: Manage_Learning_Program_Data
Documentation Contains detailed information about a learning program.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Specifies ID   
Effective_Date  date  [1..1]  Specifies Effective Date   
Version_Label  string  [0..1]  Specifies Learning Course Version   
Version_Notes  RichText  [0..1]  Specifies Learning Course Version Notes   
Inactive  boolean  [0..1]  Specifies Inactive   
Program_Title  string  [1..1]  Specifies Learning Course Title (Translatable)   
Skill_Level_Reference  Learning_Skill_LevelObject  [0..1]  Specifies Course Skill Level   
Description  RichText  [1..1]  Specifies Description   
Program_Number  string  [0..1]  Specifies Program Number   
Sales_Item_Reference  Sales_ItemObject  [0..*]  Specifies Sales Item Reference   
Topic_Reference  Learning_TopicObject  [1..*]  Specifies Topic Referece   
Security_Category_Reference  Learning_Security_CategoryObject  [0..*]  Specifies Security Category Reference   
Registrable_Status_Reference  Learning_Registerable_StatusObject  [1..1]  Specifies Registrable Status Reference   
Contact_Person_Reference  WorkerObject  [0..*]  Specifies Contact Person Reference   
Program_Image_Data  Learning_Image_Data  [0..1]  Specifies Program Image Data 
Validation Description
Content Type not supported. An image is required.   
 
Exclude_from_Recommendations  boolean  [0..1]  Specifies Exclude from Recommendations   
Program_Content_Data  Learning_Program_Content_Data  [1..*]  Specifies Learning Program Data 
Validation Description
If you set Recognize Previous Completions, you must set All Previous Completions, As-Of Date, or Within Date Range.  If you set Recognize Previous Completions, you must set All Previous Completions, As-Of Date, or Within Date Range. 
If you set Within Date Range, you must enter a Start Date and an End Date.  If you set Within Date Range, you must enter a Start Date and an End Date. 
Enter an End Date for previous completions that's on or before the current date.  Enter an End Date for previous completions that's on or before the current date. 
Enter a Start Date that's on or before the End Date.  Enter a Start Date that's on or before the End Date. 
If you set As-Of Date, you must enter a Start Date.  If you set As-Of Date, you must enter a Start Date. 
You must set Recognize Previous Completions, before you can set All Previous Completions, As-Of Date or Within Date Range.  You must set Recognize Previous Completions, before you can set All Previous Completions, As-Of Date or Within Date Range. 
Enter a Start Date for previous completions that's on or before the current date.  Enter a Start Date for previous completions that's on or before the current date. 
You can't set Recognize Previous Completions for stand-alone lesson content, but Workday automatically recognizes these completions.  You can't set Recognize Previous Completions for stand-alone lesson content, but Workday automatically recognizes these completions. 
If you set As-Of Date, you can't enter an End Date.  If you set As-Of Date, you can't enter an End Date. 
If you set All Previous Completions, you can't enter a Start Date or an End Date.  If you set All Previous Completions, you can't enter a Start Date or an End Date. 
 
Validation Description
You need to set Requires Successful Completion on at least 1 item.   
Content order values must be unique.   
You can't associate inactive topics with a program. Enter 1 or more active topics.   
Title must be unique.   
Inactive sales items are not allowed   
You can't add inactive content items to the program.   
In Progress status cannot be added to Learning Programs.   
Enter an Effective Date that's on or after today's date.   
Security Categories can only be added to Programs if the Tenant Set Up flag for 'Enable Security Category' or 'Enable Topic and Security Category' is selected.   
Reference IDs must be unique.   
You can't add duplicate items to a program. Remove duplicate items before you submit.   
Add 1 or more content items.   
top
 

Learning_Skill_LevelObject

part of: Learning_Program_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Learning_Skill_LevelObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Learning_Skill_LevelObjectID

part of: Learning_Skill_LevelObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Learning_Skill_Level_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Sales_ItemObject

part of: Learning_Program_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Sales_ItemObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Sales_ItemObjectID

part of: Sales_ItemObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Sales_Item_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Learning_TopicObject

part of: Learning_Program_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Learning_TopicObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Learning_TopicObjectID

part of: Learning_TopicObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Learning_Topic  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Learning_Security_CategoryObject

part of: Learning_Program_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Learning_Security_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Learning_Security_CategoryObjectID

part of: Learning_Security_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Learning_Security_Category  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Learning_Registerable_StatusObject

part of: Learning_Program_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Learning_Registerable_StatusObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Learning_Registerable_StatusObjectID

part of: Learning_Registerable_StatusObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Learning_Registerable_Status_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

WorkerObject

part of: Business_Process_Comment_Data, Learning_Program_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Learning_Image_Data

part of: Learning_Program_Data
Contains the cover image for the course.
 
Parameter name Type/Value Cardinality Description Validations
Image_ID  string  [0..1]  Text attribute identifying a unique ID for Attachment.   
File_Name  string (255)   [1..1]  Text attribute that identifies the filename of the attachment.   
Content_Type  string (80)   [1..1]  Text attribute identifying Content Type of the Attachment.   
Image  base64Binary  [1..1]  File content in binary format.   
Validation Description
Content Type not supported. An image is required.   
top
 

Learning_Program_Content_Data

part of: Learning_Program_Data
Contains information about the learning program content Data
 
Parameter name Type/Value Cardinality Description Validations
Content_Order  decimal (4, 0) >0   [1..1]  Specifies the lesson Order   
Requires_Successful_Completion  boolean  [0..1]  Specifies Requires Successful Completion   
Blended_Course_Reference [Choice]   Multi_Course_TemplateObject  [1..1]  Specifies Blended Course for Learning Program   
Digital_Course_Reference [Choice]   Enrollable_Course_BehaviourObject  [1..1]  Specifies Digital Course for Learning Program   
Lesson_Reference [Choice]   Learning_Lesson_BehaviourObject  [1..1]  Specifies Lesson for Learning Program   
Recognize_Previous_Completion  boolean  [0..1]  Indicates whether to recognize previous completions.   
All_Previous_Completions [Choice]   boolean  [0..1]  Indicates whether to recognize all previous completions.   
As-Of_Date [Choice]   boolean  [0..1]  Indicates whether to recognize previous completions as of a specific start date.   
Within_Date_Range [Choice]   boolean  [0..1]  Indicates whether to recognize previous completions within a specific date range.   
Start_Date  date  [0..1]  References the start date for recognizing previous completions.   
End_Date  date  [0..1]  References the end date for recognizing previous completions.   
Validation Description
If you set Recognize Previous Completions, you must set All Previous Completions, As-Of Date, or Within Date Range.  If you set Recognize Previous Completions, you must set All Previous Completions, As-Of Date, or Within Date Range. 
If you set Within Date Range, you must enter a Start Date and an End Date.  If you set Within Date Range, you must enter a Start Date and an End Date. 
Enter an End Date for previous completions that's on or before the current date.  Enter an End Date for previous completions that's on or before the current date. 
Enter a Start Date that's on or before the End Date.  Enter a Start Date that's on or before the End Date. 
If you set As-Of Date, you must enter a Start Date.  If you set As-Of Date, you must enter a Start Date. 
You must set Recognize Previous Completions, before you can set All Previous Completions, As-Of Date or Within Date Range.  You must set Recognize Previous Completions, before you can set All Previous Completions, As-Of Date or Within Date Range. 
Enter a Start Date for previous completions that's on or before the current date.  Enter a Start Date for previous completions that's on or before the current date. 
You can't set Recognize Previous Completions for stand-alone lesson content, but Workday automatically recognizes these completions.  You can't set Recognize Previous Completions for stand-alone lesson content, but Workday automatically recognizes these completions. 
If you set As-Of Date, you can't enter an End Date.  If you set As-Of Date, you can't enter an End Date. 
If you set All Previous Completions, you can't enter a Start Date or an End Date.  If you set All Previous Completions, you can't enter a Start Date or an End Date. 
top
 

Multi_Course_TemplateObject

part of: Learning_Program_Content_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Multi_Course_TemplateObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Multi_Course_TemplateObjectID

part of: Multi_Course_TemplateObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Learning_Course, Learning_Course_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Enrollable_Course_BehaviourObject

part of: Learning_Program_Content_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Enrollable_Course_BehaviourObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Enrollable_Course_BehaviourObjectID

part of: Enrollable_Course_BehaviourObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Learning_Course, Learning_Course_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Learning_Lesson_BehaviourObject

part of: Learning_Program_Content_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Learning_Lesson_BehaviourObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Learning_Lesson_BehaviourObjectID

part of: Learning_Lesson_BehaviourObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Learning_Lesson_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Business_Process_Parameters

part of: Manage_Learning_Program_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

part of: Business_Process_Attachment_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Event_Attachment_CategoryObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Event_Attachment_CategoryObjectID

part of: Event_Attachment_CategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Document_Category__Workday_Owned__ID, Document_Category_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Unique_IdentifierObject

part of: Manage_Learning_Program_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Unique_IdentifierObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Unique_IdentifierObjectID

part of: Unique_IdentifierObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  IID, WID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Learning_ProgramReferenceEnumeration

part of: Learning_ProgramObjectID
Base Type
string
top
 

RichText

part of: Learning_Program_Data, Learning_Program_Data
Base Type
string
top
 

Learning_Skill_LevelReferenceEnumeration

part of: Learning_Skill_LevelObjectID
Base Type
string
top
 

Sales_ItemReferenceEnumeration

part of: Sales_ItemObjectID
Base Type
string
top
 

Learning_TopicReferenceEnumeration

part of: Learning_TopicObjectID
Base Type
string
top
 

Learning_Security_CategoryReferenceEnumeration

part of: Learning_Security_CategoryObjectID
Base Type
string
top
 

Learning_Registerable_StatusReferenceEnumeration

part of: Learning_Registerable_StatusObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Multi_Course_TemplateReferenceEnumeration

part of: Multi_Course_TemplateObjectID
Base Type
string
top
 

Enrollable_Course_BehaviourReferenceEnumeration

part of: Enrollable_Course_BehaviourObjectID
Base Type
string
top
 

Learning_Lesson_BehaviourReferenceEnumeration

part of: Learning_Lesson_BehaviourObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top