Service Directory > v31.2 > Talent > Get_Close_Mentorship_Reasons
 

Operation: Get_Close_Mentorship_Reasons

Web Service task to export all Close Mentorship Reasons from the tenant.


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

This element is the top level request element for the "Get Close Mentorship Reasons" operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Close_Mentorship_Reason_Request_References  [0..1]  Container for Close Mentorship Reason Request References.   
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_Close_Mentorship_Reasons_Response

Wrapper element containing each Close Mentorship Reasons response Data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Close_Mentorship_Reason_Request_References  [0..1]  Container for Close Mentorship Reason Request References.   
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  Close_Mentorship_Reason_Response_Data  [0..1]  Wrapper element containing each Close Mentorship Reason response Data.   
top
 

Close_Mentorship_Reason_Request_References

part of: Get_Close_Mentorship_Reasons_Request, Get_Close_Mentorship_Reasons_Response
Container for Close Mentorship Reason Request References.
 
Parameter name Type/Value Cardinality Description Validations
Close_Mentorship_Reason_Reference  Close_Mentorship_ReasonObject  [1..*]  One or more Close Mentorship Reason Request Reference ID.   
top
 

Close_Mentorship_ReasonObject

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

Close_Mentorship_ReasonObjectID

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

Response_Filter

part of: Get_Close_Mentorship_Reasons_Request, Get_Close_Mentorship_Reasons_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_Close_Mentorship_Reasons_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
 

Close_Mentorship_Reason_Response_Data

part of: Get_Close_Mentorship_Reasons_Response
Wrapper element containing each Close Mentorship Reason response Data.
 
Parameter name Type/Value Cardinality Description Validations
Close_Mentorship_Reason  Close_Mentorship_Reason  [0..*]  Wrapper element containing Close Mentorship Reason and its data.   
top
 

Close_Mentorship_Reason

part of: Close_Mentorship_Reason_Response_Data
Wrapper element containing Close Mentorship Reason and its data.
 
Parameter name Type/Value Cardinality Description Validations
Close_Mentorship_Reason_Reference  Close_Mentorship_ReasonObject  [0..1]  Reference to the Close Mentorship Reason.   
Close_Mentorship_Reason_Data  Close_Mentorship_Reason_Data  [0..*]  Data element for the current Close Mentorship Reason. 
Validation Description
Specify a name for the Close Mentorship Reason.   
You can't delete a Close Mentorship Reason that is in use.   
Enter a Close Mentorship Reason that isn't already in use.   
 
top
 

Close_Mentorship_Reason_Data

part of: Close_Mentorship_Reason
Data element for the current Close Mentorship Reason.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  A unique identifier for the Close Mentorship Reason.   
Close_Mentorship_Reason_Name  string  [0..1]  The name of the Close Mentorship Reason.   
Close_Mentorship_Reason_Description  string  [0..1]  A description of the Close Mentorship Reason.   
Inactive  boolean  [0..1]  Whether or not the Close Mentorship Reason is currently active.   
Validation Description
Specify a name for the Close Mentorship Reason.   
You can't delete a Close Mentorship Reason that is in use.   
Enter a Close Mentorship Reason that isn't already in use.   
top
 

Close_Mentorship_ReasonReferenceEnumeration

part of: Close_Mentorship_ReasonObjectID
Base Type
string
top