Service Directory > v31.2 > Learning > Manage_Lesson
 

Operation: Manage_Lesson

Updates or creates standalone lessons. Uses the Manage Lesson 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_Lesson_Request

Contains all the request data to add or update lessons.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Manage_Lesson_Data  Put_Learning_Lessons_Request  [1..1]  Contains all the request data to add or update lessons.   
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_Lesson_Response

Contains references for the lessons added or updated.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Learning_Lesson_Reference  Learning_LessonObject  [0..1]  References the added or updated lessons.   
Event_Reference  Unique_IdentifierObject  [0..1]  References the lesson event for the lesson.   
top
 

Put_Learning_Lessons_Request

part of: Manage_Lesson_Request
Contains all the request data to add or update lessons.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Lesson_Reference  Learning_LessonObject  [0..1]  Identifies lessons using unique references for updates. Leave blank when adding lessons.   
Learning_Lesson_Data  Learning_Lesson_Data  [0..1]  Contains detailed information about a lesson. 
Validation Description
Lesson data is required.   
 
top
 

Learning_LessonObject

part of: Manage_Lesson_Response, Put_Learning_Lessons_Request
 
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_LessonObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Learning_LessonObjectID

part of: Learning_LessonObject
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
 

Learning_Lesson_Data

part of: Put_Learning_Lessons_Request
Contains detailed information about a lesson.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the lesson.   
Learning_Lesson_Content_Data  Learning_Lesson_Content_Data  [1..1]  Contains detailed information about the lesson. 
Validation Description
Learning Topic [topic] is not active.   
Media required for Media Course Lesson   
 
Learning_Image_Data  Learning_Image_Data  [0..1]  Contains the cover image for the course. 
Validation Description
Content Type not supported. An image is required.   
 
Validation Description
Lesson data is required.   
top
 

Learning_Lesson_Content_Data

part of: Learning_Lesson_Data
Contains detailed information about the lesson.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Lesson_Title  string  [1..1]  Title for the lesson.   
Learning_Lesson_Description  RichText  [1..1]  Description for the lesson.   
Inactive  boolean  [0..1]  Indicates whether the lesson is inactive.   
Exclude_from_Recommendations  boolean  [0..1]  Indicates whether the lesson is excluded from recommendations.   
Learning_Topic_Reference  Learning_TopicObject  [1..*]  References the topics for the lesson.   
Learning_Media_Reference  MediaObject  [1..1]  References the media for the lesson.   
Validation Description
Learning Topic [topic] is not active.   
Media required for Media Course Lesson   
top
 

Learning_TopicObject

part of: Learning_Lesson_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_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
 

MediaObject

part of: Learning_Lesson_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  MediaObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

MediaObjectID

part of: MediaObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Media_ID, Migrateable_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_Lesson_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
 

Business_Process_Parameters

part of: Manage_Lesson_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
 

WorkerObject

part of: Business_Process_Comment_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
 

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_Lesson_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_LessonReferenceEnumeration

part of: Learning_LessonObjectID
Base Type
string
top
 

RichText

part of: Learning_Lesson_Content_Data
Base Type
string
top
 

Learning_TopicReferenceEnumeration

part of: Learning_TopicObjectID
Base Type
string
top
 

MediaReferenceEnumeration

part of: MediaObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
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