Service Directory > v32.1 > Learning > Put_Learning_Topic
 

Operation: Put_Learning_Topic

Updates or creates topics.


@ - 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: Put_Learning_Topic_Request

Contains all the request data to add or update topics.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Learning_Topic_Reference  Learning_TopicObject  [0..1]  Identifies topics using unique references for updates. Leave blank when adding topics. For update, the ID corresponds to topic name.   
Learning_Topic_Data  Learning_Topic_Data  [1..1]  Contains detailed information about a topic. 
Validation Description
Enter a topic name that’s less than or equal to 50 characters.   
You can only add 1 image per topic.   
You need to select or upload 1 image for the topic.   
 
top
 

Response Element: Put_Learning_Topic_Response

Contains references for the topics added or updated.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Learning_Topic_Reference  Learning_TopicObject  [0..1]  References the added or updated topics.   
top
 

Learning_TopicObject

part of: Put_Learning_Topic_Request, Put_Learning_Topic_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_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_Topic_Data

part of: Put_Learning_Topic_Request
Contains detailed information about a topic.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Topic_Name  string  [1..1]  Unique name for the topic. 
Validation Description
The learning topic name must be unique.   
 
Learning_Topic_Description  RichText  [0..1]  Description for the topic.   
Inactive  boolean  [0..1]  Indicates whether the topic is inactive.   
Icon_Reference  IconObject  [0..1]  Reference instance for the icon associated with the topic.   
Learning_Image_Data  Learning_Image_Data  [0..1]  Reference instance for the image associated with the topic. 
Validation Description
You can only add a file from Drive as the cover image for learning content if you're the owner of the file or it's shared with you.   
Content Type not supported. An image is required.   
 
Validation Description
Enter a topic name that’s less than or equal to 50 characters.   
You can only add 1 image per topic.   
You need to select or upload 1 image for the topic.   
top
 

IconObject

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

IconObjectID

part of: IconObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Icon_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_Topic_Data
Contains the cover image for the course.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Image_Reference [Choice]   ImageObject  [0..1]  Contains reference to an image instance for the cover image   
Learning_Image_Upload_Data [Choice]   Learning_Image_Upload_Data  [0..1]  Contains data to upload an image instance for the cover image 
Validation Description
Content Type not supported. An image is required.   
 
Workdrive_Document_Content_Reference [Choice]   Workdrive_Document_ContentObject  [0..1]  Contains reference to a Workdrive document for cover image.   
Validation Description
You can only add a file from Drive as the cover image for learning content if you're the owner of the file or it's shared with you.   
Content Type not supported. An image is required.   
top
 

ImageObject

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

ImageObjectID

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

part of: Learning_Image_Data
Contains the cover image for the learning item.
 
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
 

Workdrive_Document_ContentObject

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

Workdrive_Document_ContentObjectID

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

part of: Learning_TopicObjectID
Base Type
string
top
 

RichText

part of: Learning_Topic_Data
Base Type
string
top
 

IconReferenceEnumeration

part of: IconObjectID
Base Type
string
top
 

ImageReferenceEnumeration

part of: ImageObjectID
Base Type
string
top
 

Workdrive_Document_ContentReferenceEnumeration

part of: Workdrive_Document_ContentObjectID
Base Type
string
top