Service Directory > v31.2 > Talent > Put_Mentorship
 

Operation: Put_Mentorship

Web Service task to create and edit Mentorships.


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

Top level Put Mentorship Request element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
Mentorship_Data  Mentorship_Data  [1..1]  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
 

Response Element: Put_Mentorship_Event_Response

Response element for Put Mentorship containing the created Mentorship Event.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Mentorship_Reference  Unique_IdentifierObject  [0..1]  The reference for the Mentorship Event processed.   
top
 

Business_Process_Parameters

part of: Put_Mentorship_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

part of: Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Mentorship_Data

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

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
 

MentorshipObject

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

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
 

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Mentor_TypeReferenceEnumeration

part of: Mentor_TypeObjectID
Base Type
string
top
 

RichText

part of: Mentorship_Data
Base Type
string
top
 

MentorshipReferenceEnumeration

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top