Service Directory > v33.1 > Talent > Get_Qualification_Equivalence_Rules
 

Operation: Get_Qualification_Equivalence_Rules

Retrieve instances of Qualification Equivalence Rules and all data pertaining to the rules.


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

Top-level element wrapper for Get Qualification Equivalence Rules web service operation. Contains all data for the operation request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Qualification_Equivalence_Rule_Request_References  [0..1]  Wrapper Element for references to Qualification Equivalence Rules.   
Request_Criteria [Choice]   Qualification_Equivalence_Rule_Request_Criteria  [0..1]  Wrapper element for a list of elements representing the operation specific criteria needed to search for Qualification Equivalence Rule instances.   
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_Qualification_Equivalence_Rules_Response

Top-level response element for all Get Qualification Equivalence Rules operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Qualification_Equivalence_Rule_Request_References  [0..1]  Wrapper element for references to Qualification Equivalence Rules.   
Request_Criteria  Qualification_Equivalence_Rule_Request_Criteria  [0..1]  Wrapper element for a list of elements representing the operation specific criteria needed to search for Qualification Equivalence Rule instances.   
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  Qualification_Equivalence_Rule_Response_Data  [0..1]  Qualification Equivalence Rule objects returned in the get response.   
top
 

Qualification_Equivalence_Rule_Request_References

part of: Get_Qualification_Equivalence_Rules_Request, Get_Qualification_Equivalence_Rules_Response
Wrapper element for references to Qualification Equivalence Rules.
 
Parameter name Type/Value Cardinality Description Validations
Qualification_Equivalence_Rule_Reference  Qualification_Equivalence_RuleObject  [1..*]  One or more references to Qualification Equivalence Rule objects.   
top
 

Qualification_Equivalence_RuleObject

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

Qualification_Equivalence_RuleObjectID

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

Qualification_Equivalence_Rule_Request_Criteria

part of: Get_Qualification_Equivalence_Rules_Request, Get_Qualification_Equivalence_Rules_Response
Wrapper element for a list of elements representing the operation specific criteria needed to search for Qualification Equivalence Rule instances.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Qualification_Equivalence_Rules_Request, Get_Qualification_Equivalence_Rules_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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Response_Results

part of: Get_Qualification_Equivalence_Rules_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Qualification_Equivalence_Rule_Response_Data

part of: Get_Qualification_Equivalence_Rules_Response
Wrapper containing all the Qualification Equivalence Rule objects returned in the get response.
 
Parameter name Type/Value Cardinality Description Validations
Qualification_Equivalence_Rule  Qualification_Equivalence_Rule  [0..*]  Wrapper for each Qualification Equivalence Rule in the get response.   
top
 

Qualification_Equivalence_Rule

part of: Qualification_Equivalence_Rule_Response_Data
Wrapper element for each Qualification Equivalence Rule in the get response.
 
Parameter name Type/Value Cardinality Description Validations
Qualification_Equivalence_Rule_Reference  Qualification_Equivalence_RuleObject  [0..1]  Reference to the Qualification Equivalence Rule returned in the get response.   
Qualification_Equivalence_Rule_Data  Qualification_Equivalence_Rule_Data  [0..*]  Wrapper for data of the Qualification Equivalence Rule.   
top
 

Qualification_Equivalence_Rule_Data

part of: Qualification_Equivalence_Rule
Wrapper for data of the Qualification Equivalence Rule.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Text value for reference ID value for Qualification Equivalence Rule.   
Qualification_Equivalence_Rule_Inactive  boolean  [0..1]  Boolean value for inactive or not.   
Job_Profile_Reference  Job_ProfileObject  [0..*]  Reference to Job Profiles that are related to this Qualification Equivalence Rule.   
Condition_Rule_Data  Condition_Rule_Data_WWS  [1..*]  Wrapper containing data for Condition Rule.   
top
 

Job_ProfileObject

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

Job_ProfileObjectID

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

Condition_Rule_Data_WWS

part of: Qualification_Equivalence_Rule_Data
Wrapper containing data for Condition Rule.
 
Parameter name Type/Value Cardinality Description Validations
Condition_Rule_ID  string  [0..1]  Text value for reference ID for Condition Rule.   
Rule_Description  string  [1..1]  Text description of Condition Rule.   
Comment  string  [0..1]  Text comment for Condition Rule.   
Condition_Rule_Category_Reference  Condition_Rule_CategoryObject  [0..*]  Categories for Condition Rule.   
Condition_Item_Data  Condition_Item_Data_WWS  [1..*]  Data for each Condition Rule 
Validation Description
Only the Filter Boolean attribute is as a Comparison Value allowed for this Condition Item. The other Comparison Values like Filter Date, Filter Number, Filter Text, Filter Time, Filter DateTimeZone, Target CRF Reference, and Target Instance References must be empty.   
Only the Filter Date attribute is allowed as a Comparison Value for this Condition Item. The other Comparison Values like Filter Boolean, Filter Number, Filter Text, Filter Time, Filter DateTimeZone, Target CRF Reference, and Target Instance References must be empty.   
Only the Filter Number attribute is allowed as a Comparison Value for this Condition Item. The other Comparison Values like Filter Boolean, Filter Date, Filter Text, Filter Time, Filter DateTimeZone, Target CRF Reference, and Target Instance References must be empty.   
Only the Filter Text attribute is allowed as a Comparison Value for this Condition Item. The other Comparison Values like Filter Boolean, Filter Date, Filter Number, Filter Time, Filter DateTimeZone, Target CRF Reference, and Target Instance References must be empty.   
Only the Target CRF Reference element is allowed as a Comparison Value for this Condition Item. The other Comparison Values like Filter Boolean, Filter Date, Filter Number, Filter Text, Filter Time, Filter DateTimeZone, and Target Instance References must be empty.   
Only the Target Instance References element is allowed as a Comparison Value for this Condition Item. The other Comparison Values like Filter Boolean, Filter Date, Filter Number, Filter Text, Filter Time, Filter DateTimeZone, and Target CRF Reference must be empty.   
The Target External Field Reference element is required for this Condition Item.   
The Target Instance Reference element is required for this Condition Item.   
Only the Filter Time attribute is a Comparison Value for this Condition Item. The other Comparison Values like Filter Date, Filter Number, Filter Text, Filter DateTimeZone, Target CRF Reference, and Target Instance References must be empty.   
Only the Filter DateTimeZone is a Comparison Value for this Condition Item. The other Comparison Values like Filter Date, Filter Number, Filter Text, Filter Time, Target CRF Reference, and Target Instance References must be empty.   
 
Countries_Reference  CountryObject  [0..*]  Countries for Condition Rule   
top
 

Condition_Rule_CategoryObject

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

Condition_Rule_CategoryObjectID

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

Condition_Item_Data_WWS

part of: Condition_Rule_Data_WWS
Wrapper element containing data for each Condition Item.
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [1..1]  Text value for order of Condition Item.   
And_Or_Operator_Reference  And_Or_OperatorsObject  [1..1]  Reference to the And Or Operator used on this Condition Item.   
Open_Parentheses  string  [0..1]  Specify an Open Parentheses for the Condition Item by placing the "(" character here. 
Validation Description
The Open Parenthesis field can contain only "(" characters.  The Open Parenthesis field can contain only "(" characters. 
 
Relational_Operator_Reference  Relational_OperatorObject  [1..1]  Reference to the Relational Operator to use for this Condition Item.   
Condition_Entry_Option_Reference  Condition_Entry_OptionObject  [0..1]  Reference to the Condition Entry Option to use for this Condition Item.   
Close_Parentheses  string  [0..1]  Specify an Close Parentheses for the Condition Item by placing the ")" character here. 
Validation Description
The Close Parenthesis field can contain only ")" characters.   
 
Source_External_Field_Reference [Choice]   External_FieldObject  [0..1]  Reference to the External Field to use as the source for this Condition Item.   
Source_Condition_Rule_Reference [Choice]   Condition_RuleObject  [0..1]  Reference to the Condition Rule to use as the source for this Condition Item.   
Filter_Boolean [Choice]   boolean  [0..1]  Boolean value for Filter.   
Filter_Date [Choice]   date  [0..1]  Date value for Filter.   
Filter_DateTimeZone [Choice]   Filter_DateTimeZone_Data  [0..1]  DateTimeZone value for filter.   
Filter_Time [Choice]   time  [0..1]  Time value for filter.   
Filter_Number [Choice]   decimal (16, 4)   [0..1]  Numeric value for Filter Number.   
Filter_Text [Choice]   string  [0..1]  Text value for Filter.   
Target_External_Field_Reference [Choice]   External_FieldObject  [0..1]  Reference to Target External Field for this Condition Item..   
Target_Instance_Reference [Choice]   InstanceObject  [0..*]  Reference to specific object to be used in filter for this Condition Rule.   
Validation Description
Only the Filter Boolean attribute is as a Comparison Value allowed for this Condition Item. The other Comparison Values like Filter Date, Filter Number, Filter Text, Filter Time, Filter DateTimeZone, Target CRF Reference, and Target Instance References must be empty.   
Only the Filter Date attribute is allowed as a Comparison Value for this Condition Item. The other Comparison Values like Filter Boolean, Filter Number, Filter Text, Filter Time, Filter DateTimeZone, Target CRF Reference, and Target Instance References must be empty.   
Only the Filter Number attribute is allowed as a Comparison Value for this Condition Item. The other Comparison Values like Filter Boolean, Filter Date, Filter Text, Filter Time, Filter DateTimeZone, Target CRF Reference, and Target Instance References must be empty.   
Only the Filter Text attribute is allowed as a Comparison Value for this Condition Item. The other Comparison Values like Filter Boolean, Filter Date, Filter Number, Filter Time, Filter DateTimeZone, Target CRF Reference, and Target Instance References must be empty.   
Only the Target CRF Reference element is allowed as a Comparison Value for this Condition Item. The other Comparison Values like Filter Boolean, Filter Date, Filter Number, Filter Text, Filter Time, Filter DateTimeZone, and Target Instance References must be empty.   
Only the Target Instance References element is allowed as a Comparison Value for this Condition Item. The other Comparison Values like Filter Boolean, Filter Date, Filter Number, Filter Text, Filter Time, Filter DateTimeZone, and Target CRF Reference must be empty.   
The Target External Field Reference element is required for this Condition Item.   
The Target Instance Reference element is required for this Condition Item.   
Only the Filter Time attribute is a Comparison Value for this Condition Item. The other Comparison Values like Filter Date, Filter Number, Filter Text, Filter DateTimeZone, Target CRF Reference, and Target Instance References must be empty.   
Only the Filter DateTimeZone is a Comparison Value for this Condition Item. The other Comparison Values like Filter Date, Filter Number, Filter Text, Filter Time, Target CRF Reference, and Target Instance References must be empty.   
top
 

And_Or_OperatorsObject

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

And_Or_OperatorsObjectID

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

Relational_OperatorObject

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

Relational_OperatorObjectID

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

Condition_Entry_OptionObject

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

Condition_Entry_OptionObjectID

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

External_FieldObject

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

External_FieldObjectID

part of: External_FieldObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Calculated_Field_ID, Computed_Data_Source_Field_ID, Custom_Field_Data_Set_ID, Custom_Field_ID, Extension_Computed_Data_Field_Reference_ID, External_Analytics_Data_Source_Field_ID, WCP_Component_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
 

Condition_RuleObject

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

Condition_RuleObjectID

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

Filter_DateTimeZone_Data

part of: Condition_Item_Data_WWS
DateTimeZone value for filter.
 
Parameter name Type/Value Cardinality Description Validations
Filter_DateTime  dateTime  [0..1]  DateTime value for DateTimeZone Filter.   
Filter_TimeZone_Reference  Time_ZoneObject  [0..1]  Reference to TimeZone for DateTimeZone Filter.   
top
 

Time_ZoneObject

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

Time_ZoneObjectID

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

InstanceObject

part of: Condition_Item_Data_WWS
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code  [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
 

Qualification_Equivalence_RuleReferenceEnumeration

part of: Qualification_Equivalence_RuleObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

Condition_Rule_CategoryReferenceEnumeration

part of: Condition_Rule_CategoryObjectID
Base Type
string
top
 

And_Or_OperatorsReferenceEnumeration

part of: And_Or_OperatorsObjectID
Base Type
string
top
 

Relational_OperatorReferenceEnumeration

part of: Relational_OperatorObjectID
Base Type
string
top
 

Condition_Entry_OptionReferenceEnumeration

part of: Condition_Entry_OptionObjectID
Base Type
string
top
 

External_FieldReferenceEnumeration

part of: External_FieldObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

Time_ZoneReferenceEnumeration

part of: Time_ZoneObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top