Service Directory > v31.2 > Compensation > Put_Compensation_Eligibility_Rule
 

Operation: Put_Compensation_Eligibility_Rule

This operation allows for the creation or update of a Compensation Eligibility Rule.


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

Incoming Put Compensation Eligibility Rule Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
@Delete  boolean  [1..1]  If True is entered, the Compensation Eligibility Rule will be deleted.   
Compensation_Eligibility_Rule_Reference  Condition_RuleObject  [0..1]  Compensation Eligibility Rule Reference   
Compensation_Eligibility_Rule_Data  Compensation_Eligibility_Rule_Data  [0..1]  Compensation Eligibility Rule Data 
Validation Description
The field(s) [fields] cannot be used in a Compensation Eligibility Rule.   
 
Validation Description
Compensation Eligibility Rule already exists.   
Element Content 'Compensation_Eligibility_Rule_Data' is required, on internal element 'Put Compensation Eligibility Rule Request' when a new rule is being added.   
Compensation Eligibility Rule cannot be deleted because it is in use.   
top
 

Response Element: Put_Compensation_Eligibility_Rule_Response

Put Compensation Eligibility Rule Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Compensation_Eligibility_Rule_Reference  Condition_RuleObject  [0..1]  Compensation Eligibility Rule Reference   
top
 

Condition_RuleObject

part of: Condition_Item_Data_WWS, Put_Compensation_Eligibility_Rule_Request, Put_Compensation_Eligibility_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  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
 

Compensation_Eligibility_Rule_Data

part of: Put_Compensation_Eligibility_Rule_Request
Data for this Compensation Eligibility Rule
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  The effective date for this change.   
Condition_Rule_Data  Condition_Rule_Data_WWS  [1..1]  Data defining the Compensation Eleigibility Rule logic.   
Compensation_Package_Reference  Compensation_PackageObject  [0..*]  Compensation Packages referencing this Compensation Eligibility Rule.   
Compensation_Grade_Reference  Compensation_GradeObject  [0..*]  Compensation Grades referencing this Compensation Eligibility Rule.   
Compensation_Grade_Profile_Reference  Compensation_Grade_ProfileObject  [0..*]  Compensation Grade Profiles refrerencing this Compensation Eligibility Rule.   
Compensation_Plan_Reference  Compensation_PlanObject  [0..*]  Compensation Plans referencing this Compensation Eligibility Rule.   
Validation Description
The field(s) [fields] cannot be used in a Compensation Eligibility Rule.   
top
 

Condition_Rule_Data_WWS

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

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
 

Compensation_PackageObject

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

Compensation_PackageObjectID

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

Compensation_GradeObject

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

Compensation_GradeObjectID

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

Compensation_Grade_ProfileObject

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

Compensation_Grade_ProfileObjectID

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

Compensation_PlanObject

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

Compensation_PlanObjectID

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

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

Time_ZoneReferenceEnumeration

part of: Time_ZoneObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

Compensation_PackageReferenceEnumeration

part of: Compensation_PackageObjectID
Base Type
string
top
 

Compensation_GradeReferenceEnumeration

part of: Compensation_GradeObjectID
Base Type
string
top
 

Compensation_Grade_ProfileReferenceEnumeration

part of: Compensation_Grade_ProfileObjectID
Base Type
string
top
 

Compensation_PlanReferenceEnumeration

part of: Compensation_PlanObjectID
Base Type
string
top