Service Directory > v33.1 > Learning > Manage_Equivalency_Rule
 

Operation: Manage_Equivalency_Rule

Updates or creates Equivalency Rules. Uses the Manage Equivalency Rule business process.


@ - 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: Manage_Equivalency_Rule_Request

Contains all the request data to add or update equivalency rules.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Manage_Equivalency_Rule_Data  Put_Equivalency_Rule_Request  [1..1]  Contains all the request data to add or update an equivalency rule.   
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.   
Validation Description
You can't update the equivalency rule because there are pending actions on the Manage Equivalency Rule business process. Wait for the actions to complete, then retry.   
top
 

Response Element: Manage_Equivalency_Rule_Response

Contains the references for the equivalency rule event and corresponding equivalency rule created or updated.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Equivalency_Rule_Reference  Equivalency_RuleObject  [0..1]  Contains a reference to the Equivalency Rule that was created if the BP completed immediately.   
Event_Reference  Unique_IdentifierObject  [0..1]  References the business process event that was created.   
top
 

Put_Equivalency_Rule_Request

part of: Manage_Equivalency_Rule_Request
Contains all the request data to add or update an equivalency rule.
 
Parameter name Type/Value Cardinality Description Validations
Equivalency_Rule_Reference  Equivalency_RuleObject  [0..1]  Identifies equivalency rules using unique references for updates. Leave blank when creating equivalent rule.   
Equivalency_Rule_Data  Equivalency_Rule_Data  [1..1]  Contains data for the equivalency rule content, i.e. effective from date, effective to date etc. 
Validation Description
Specify different source and target courses for the equivalency rule.   
You need to specify a course as the target of the equivalency rule.   
You can't change the content associated with this rule.   
Specify an Effective From date that's before the Effective To date.   
Workday automatically timestamps the inactivation date. You can't change the date.   
You need to specify a course as the source of the equivalency rule.   
You need to set the rule to active before you can change its values.   
You can't change the direction of the rule.   
You can't create two-way relationships for group equivalency rules.   
Learning equivalency rules must have 1 or more Source and Target values, or multiple Content values, but not both.   
You must include 2 or more content items in the group equivalency rule.   
 
top
 

Equivalency_RuleObject

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

Equivalency_RuleObjectID

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

Equivalency_Rule_Data

part of: Put_Equivalency_Rule_Request
Contains detailed information about an equivalency rule.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID for the equivalency rule.   
Source_Equivalency_Content_Reference  Equivalency_Enabled_ContentObject  [0..*]  Source content for the equivalency rule.   
Target_Equivalency_Content_Reference  Equivalency_Enabled_ContentObject  [0..*]  Target content for the equivalency rule.   
Group_Equivalency_Content_Reference  Equivalency_Enabled_ContentObject  [0..*]  Group content for the equivalency rule.   
Two-Way  boolean  [0..1]  Indicates whether the equivalency rule is two-way or singular.   
Effective_Date_From  date  [1..1]  Effective from date for the equivalency rule.   
Effective_Date_To  date  [0..1]  Effective to date for the equivalency rule.   
Inactive  boolean  [0..1]  Indicates whether the equivalency rule is inactive.   
Inactivation_Date  date  [0..1]  Inactivation date for the equivalency rule.   
Display_Equivalency_Records_on_Learning_History  boolean  [0..1]  Indicates whether the equivalency records are to appear on Learning History.   
Display_Equivalency_Options_on_Course  boolean  [0..1]  Indicates whether the equivalency options are to appear on Learning Course.   
Validation Description
Specify different source and target courses for the equivalency rule.   
You need to specify a course as the target of the equivalency rule.   
You can't change the content associated with this rule.   
Specify an Effective From date that's before the Effective To date.   
Workday automatically timestamps the inactivation date. You can't change the date.   
You need to specify a course as the source of the equivalency rule.   
You need to set the rule to active before you can change its values.   
You can't change the direction of the rule.   
You can't create two-way relationships for group equivalency rules.   
Learning equivalency rules must have 1 or more Source and Target values, or multiple Content values, but not both.   
You must include 2 or more content items in the group equivalency rule.   
top
 

Equivalency_Enabled_ContentObject

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

Equivalency_Enabled_ContentObjectID

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

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

Unique_IdentifierObject

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

Equivalency_RuleReferenceEnumeration

part of: Equivalency_RuleObjectID
Base Type
string
top
 

Equivalency_Enabled_ContentReferenceEnumeration

part of: Equivalency_Enabled_ContentObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top