Service Directory > v32.1 > Financial_Management > Put_Custom_Validation_Rule
 

Operation: Put_Custom_Validation_Rule

This web service operation will add or update Custom Validation Rule. A Custom Validation Rule contains a Label and Classification. Each Custom Valiation Rule can contain many Condition Rules, which are made up of Condition Items that make up the logic used in the Custom Validations for each Rule type.


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

Root element for the Request on the Put operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
Custom_Validation_Rule_Reference  Custom_Validation_ContextObject  [0..1]  Reference to an existing Custom Validation Rule for update-only purposes.   
Custom_Validation_Rule_Data  Custom_Validation_Rule_Data  [1..1]  Wrapper for data of the Custom Validation Rule.   
Validation Description
The Add Only option is not supported by the Custom Validation Rule web service   
top
 

Response Element: Put_Custom_Validation_Rule_Response

Root element for the Response on the Put operation.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Custom_Validation_Rule_Reference  Custom_Validation_ContextObject  [0..1]  Reference to the Custom Validation Rule that was added or updated in the operation.   
top
 

Custom_Validation_ContextObject

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

Custom_Validation_ContextObjectID

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

Custom_Validation_Rule_Data

part of: Put_Custom_Validation_Rule_Request
Wrapper for data of the Custom Validation Rule.
 
Parameter name Type/Value Cardinality Description Validations
Custom_Validation_Rule_ID  string  [1..1]  Text value for reference ID value for Custom Validation Rule.   
Custom_Validation_Rule_for_Transaction  string  [0..1]  Text value to be used for Label of Custom Validation Rule.   
Custom_Validation_Rule_Classification  string  [0..1]  Text value for Classification of Custom Validation Rule. Not used on "Put" operation.   
Custom_Validation_Data  Custom_Validation_Data  [0..*]  Validation Condition Rule and optional Notification Message Components   
top
 

Custom_Validation_Data

part of: Custom_Validation_Rule_Data
Validation Condition Rule and optional Notification Message Components
 
Parameter name Type/Value Cardinality Description Validations
Condition_Rule_Data  Condition_Rule_Data_WWS  [1..1]  Wrapper containing data for Condition Rule.   
Validation_Message_Data  Validation_Message_Data  [0..1]  Wrapper element for Validation Message Component element   
top
 

Condition_Rule_Data_WWS

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

Validation_Message_Data

part of: Custom_Validation_Data
Wrapper element for Validation Message Component element
 
Parameter name Type/Value Cardinality Description Validations
Message_Component_Data  Notification_Message_Component_Data  [0..*]  Element defining a component to be used in composing a message.   
top
 

Notification_Message_Component_Data

part of: Validation_Message_Data
Element defining a component to be used in composing a message.
 
Parameter name Type/Value Cardinality Description Validations
Order  string (6)   [1..1]  Order   
Text [Choice]   string  [1..1]  Static Text   
External_Field_Reference [Choice]   External_FieldObject  [1..1]  Dynamic content from External Field   
top
 

Custom_Validation_ContextReferenceEnumeration

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