Service Directory > v31.2 > Learning > Get_Learning_Topic_Security_Segments
 

Operation: Get_Learning_Topic_Security_Segments

Returns Learning Topic Security Segments by Reference ID, or returns all Learning Topic Security Segments if no Reference ID is provided


@ - 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_Topic_Security_Segments_Request

Contains references to find and get learning topic security segments and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Learning_Topic_Security_Segment_Request_References  [0..1]  Retrieves specific instances of learning topic security segments and their associated data.   
Request_Criteria [Choice]   Learning_Topic_Security_Segment_Request_Criteria  [0..1]  Retrieves specific instances of learning topic security segments based of certain search criterion   
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_Topic_Security_Segments_Response

Contains references to learning topic security segment and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Learning_Topic_Security_Segment_Request_References  [0..1]  Retrieves specific instances of learning topic security segments and their associated data.   
Request_Criteria  Learning_Topic_Security_Segment_Request_Criteria  [0..1]  Retrieves specific instances of learning topic security segments based of certain search criterion   
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_Security_Segment_Response_Data  [0..1]  Contains learning topic security segment 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_Security_Segment_Request_References

part of: Get_Learning_Topic_Security_Segments_Request, Get_Learning_Topic_Security_Segments_Response
Retrieves specific instances of learning topic security segments and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
Learning_Topic_Security_Segment_Reference  Learning_Topic_Security_SegmentObject  [1..*]  Retrieves specific instances of learning topic security segments and their associated data.   
top
 

Learning_Topic_Security_SegmentObject

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

Learning_Topic_Security_SegmentObjectID

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

part of: Get_Learning_Topic_Security_Segments_Request, Get_Learning_Topic_Security_Segments_Response
Retrieves specific instances of learning topic security segments based of certain search criterion
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Learning_Topic_Security_Segments_Request, Get_Learning_Topic_Security_Segments_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_Topic_Security_Segments_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_Security_Segment_Response_Data

part of: Get_Learning_Topic_Security_Segments_Response
Contains learning topic security segment 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_Security_Segment  Learning_Topic_Security_Segment  [0..*]  Contains learning topic security segment 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_Security_Segment

part of: Learning_Topic_Security_Segment_Response_Data
Contains learning topic security segment 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_Security_Segment_Reference  Learning_Topic_Security_SegmentObject  [0..1]  Reference for Learning Topic Security Segment   
Learning_Topic_Security_Segment_Data  Learning_Topic_Security_Segment_Data  [0..1]  Contains data for the specific Learning Topic Security Segment   
top
 

Learning_Topic_Security_Segment_Data

part of: Learning_Topic_Security_Segment
Contains detailed information about the learning topic security segment
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [1..1]  The Name of the learning topic security segment which acts as it's ID. This value must be unique.   
Learning_Topic_Reference  Learning_TopicObject  [1..*]  The learning topic(s) referenced by the learning topic security segment. This value is required   
top
 

Learning_TopicObject

part of: Learning_Topic_Security_Segment_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_Topic_Security_SegmentReferenceEnumeration

part of: Learning_Topic_Security_SegmentObjectID
Base Type
string
top
 

Learning_TopicReferenceEnumeration

part of: Learning_TopicObjectID
Base Type
string
top