Service Directory > v31.2 > Talent > Get_Mentorships
 

Operation: Get_Mentorships

Web Service task to export all Mentorships 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_Mentorships_Request

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

Wrapper element containing each Mentorship's response Data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Mentorship_Request_References  [0..1]  Container for Mentorship 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  Mentorship_Response_Data  [0..1]  Wrapper element containing each Mentorship's response Data.   
top
 

Mentorship_Request_References

part of: Get_Mentorships_Request, Get_Mentorships_Response
Container for Mentorship Request References.
 
Parameter name Type/Value Cardinality Description Validations
Mentorship_Reference  MentorshipObject  [1..*]  One or more Mentorship Request Reference ID.   
top
 

MentorshipObject

part of: Mentorship_Request_References, Mentorship, Mentorship_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  MentorshipObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

MentorshipObjectID

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

Mentorship_Response_Data

part of: Get_Mentorships_Response
Wrapper element containing each Mentorship's response Data.
 
Parameter name Type/Value Cardinality Description Validations
Mentorship  Mentorship  [0..*]  Wrapper element containing Mentorship and its data.   
top
 

Mentorship

part of: Mentorship_Response_Data
Wrapper element containing Mentorship and its data.
 
Parameter name Type/Value Cardinality Description Validations
Mentorship_Reference  MentorshipObject  [0..1]  A reference to the Mentorship being edited.   
Mentorship_Data  Mentorship_Data  [0..*]  Data element for the current Mentorship. 
Validation Description
Specify a Mentor and Mentee.   
Specify a Mentor Type.   
An active mentorship for this mentor type already exists.   
Cannot edit mentor or mentee of existing mentorship.   
Cannot edit mentor or mentee of existing mentorship.   
Specify an active Mentor Type.   
Specify an active Close Mentorship Reason.   
Enter a Mentorship End Date that is later than the Mentorship Start Date.   
You can't create a new mentorship with an end date.   
Enter a Start Date.   
You can't edit the Close Mentorship Reason for a closed mentorship.   
You can't edit the Mentor Type for a closed mentorship.   
 
top
 

Mentorship_Data

part of: Mentorship
Data element for the current Mentorship.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  A unique identifier for the Mentorship.   
Mentor_Reference  WorkerObject  [0..1]  The mentor of the Mentorship.   
Mentee_Reference  WorkerObject  [0..1]  The mentee of the Mentorship.   
Mentor_Type_Reference  Mentor_TypeObject  [0..1]  The Mentor Type of the Mentorship.   
Mentorship_Start_Date  date  [0..1]  The Start Date of the Mentorship.   
Mentorship_End_Date  date  [0..1]  The End Date of the Mentorship.   
Mentorship_Purpose  RichText  [0..1]  The Purpose of the Mentorship.   
Mentorship_Reference  MentorshipObject  [0..1]  A reference to the Mentorship being edited.   
Close_Mentorship_Reason_Reference  Close_Mentorship_ReasonObject  [0..1]  The Reason to close the Mentorship.   
Attachments_Reference  Event_AttachmentObject  [0..*]  The Attachments for the Mentorship.   
Validation Description
Specify a Mentor and Mentee.   
Specify a Mentor Type.   
An active mentorship for this mentor type already exists.   
Cannot edit mentor or mentee of existing mentorship.   
Cannot edit mentor or mentee of existing mentorship.   
Specify an active Mentor Type.   
Specify an active Close Mentorship Reason.   
Enter a Mentorship End Date that is later than the Mentorship Start Date.   
You can't create a new mentorship with an end date.   
Enter a Start Date.   
You can't edit the Close Mentorship Reason for a closed mentorship.   
You can't edit the Mentor Type for a closed mentorship.   
top
 

WorkerObject

part of: Mentorship_Data, Mentorship_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
 

Mentor_TypeObject

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

Mentor_TypeObjectID

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

Close_Mentorship_ReasonObject

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

Event_AttachmentObject

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

Event_AttachmentObjectID

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

MentorshipReferenceEnumeration

part of: MentorshipObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Mentor_TypeReferenceEnumeration

part of: Mentor_TypeObjectID
Base Type
string
top
 

RichText

part of: Mentorship_Data
Base Type
string
top
 

Close_Mentorship_ReasonReferenceEnumeration

part of: Close_Mentorship_ReasonObjectID
Base Type
string
top
 

Event_AttachmentReferenceEnumeration

part of: Event_AttachmentObjectID
Base Type
string
top