Service Directory > v32.1 > Learning > Get_Learning_Topics
 

Operation: Get_Learning_Topics

Retrieves 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: Get_Learning_Topics_Request

Contains references to find and get topics and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Learning_Topic_Request_References  [0..1]  Retrieves specific instances of topics and their associated data.   
Request_Criteria [Choice]   Learning_Topic_Request_Criteria  [0..1]  Contains request criteria to get specific topics.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Learning_Topics_Response

Contains references to topics and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Learning_Topic_Request_References  [0..1]  Contains specific instances of topics and their associated data.   
Request_Criteria  Learning_Topic_Request_Criteria  [0..1]  Contains request criteria to get specific topics.   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Learning_Topic_Response_Data  [0..1]  Contains topic data for each request reference. The data is current as of the dates in the response filter, and doesn't include all historical information.   
top
 

Learning_Topic_Request_References

part of: Get_Learning_Topics_Request, Get_Learning_Topics_Response
Retrieves specific instances of topics and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Topic_Reference  Learning_TopicObject  [1..*]  Reference instances for topics.   
top
 

Learning_TopicObject

part of: Learning_Topic_Request_References, Learning_Topic
 
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_Request_Criteria

part of: Get_Learning_Topics_Request, Get_Learning_Topics_Response
Request criteria for Learning Topic
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Learning_Topics_Request, Get_Learning_Topics_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Learning_Topics_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Learning_Topic_Response_Data

part of: Get_Learning_Topics_Response
Contains topic data for each request reference. The data is current as of the dates in the response filter, and doesn't include all historical information.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Topic  Learning_Topic  [0..*]  Contains topic data for each request reference. The data is current as of the dates in the response filter, and doesn't include all historical information.   
top
 

Learning_Topic

part of: Learning_Topic_Response_Data
Contains topic data for each request reference. The data is current as of the dates in the response filter, and doesn't include all historical information.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Topic_Reference  Learning_TopicObject  [0..1]  Reference Instance for a topic.   
Learning_Topic_Data  Learning_Topic_Data  [0..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
 

Learning_Topic_Data

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