Service Directory > v32.1 > Financial_Management > Put_Custom_Worktag
 

Operation: Put_Custom_Worktag

This service operation will add or update the Custom Worktags for the Custom Worktag Configuration. Custom Worktags are user-defined values that can be used to tag transactions with data that is not represented by the Workday-delivered transaction Worktags. Custom Worktags must be enabled and mapped to a Custom Worktag Configuration. Custom Worktag data includes the Configuration Reference, the Worktags Reference ID and Value for that Configuration.


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

Element containing Custom Worktag Configuration reference for update and all Custom Worktag data items
 
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_Worktag_Configuration_Reference  Custom_Worktag_ConfigurationObject  [0..1]  Custom Worktag Configuration Reference   
Custom_Worktag_Data  Custom_Worktag_Data  [1..1]  Custom Worktag Data 
Validation Description
The number of worktags for this Custom Worktag Type cannot be larger than the governor limit.   
 
Validation Description
The Web Service is set to Add Only; but the Custom Worktag Configuration already exists.   
top
 

Response Element: Put_Custom_Worktag_Response

Element containing Put Custom Worktag Response Data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Custom_Worktag_Configuration_Reference  Custom_Worktag_ConfigurationObject  [0..1]  Custom Worktag Configuration Reference   
top
 

Custom_Worktag_ConfigurationObject

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

Custom_Worktag_ConfigurationObjectID

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

part of: Put_Custom_Worktag_Request
Wrapper Element that includes Custom Worktag Configuration Reference ID and the Custom Worktag Values for that Custom Worktag Configuration
 
Parameter name Type/Value Cardinality Description Validations
Custom_Worktag_Configuration_ID  string  [0..1]  Custom Worktag Configuration ID   
Custom_Worktag_Values_Data  Custom_Worktag_Values_Data  [0..*]  Custom Worktag Values Data 
Validation Description
For web service version v26.0 and later, when the configuration in 'Maintain Related Worktag Usage' for this Taggable Type has any worktag types configured with 'Default Required', the 'Related Worktags Data' subelement must be included.   
 
Validation Description
The number of worktags for this Custom Worktag Type cannot be larger than the governor limit.   
top
 

Custom_Worktag_Values_Data

part of: Custom_Worktag_Data
Element containing Custom Worktag ID and Value
 
Parameter name Type/Value Cardinality Description Validations
Custom_Worktag_ID  string  [0..1]  Custom Worktag ID. This is the Custom Worktag unique identifier within the Worktag Configuration   
Worktag_Value  string  [1..1]  Worktag Value. The name the instance of a Custom Worktag instance.   
Inactive_Custom_Worktag  boolean  [0..1]  Inactive Custom Worktag. Mark an instance of Custom Worktag as inactive.   
Related_Worktags_Data  Related_Worktag_Widget_Data  [0..1]  Reference to the existing Allowed or Default Related Worktags. 
Validation Description
[missing required worktag types]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
 
Validation Description
For web service version v26.0 and later, when the configuration in 'Maintain Related Worktag Usage' for this Taggable Type has any worktag types configured with 'Default Required', the 'Related Worktags Data' subelement must be included.   
top
 

Related_Worktag_Widget_Data

part of: Custom_Worktag_Values_Data
Reference to the existing Allowed or Default Related Worktags.
 
Parameter name Type/Value Cardinality Description Validations
@Replace_All  boolean  [1..1]  All existing related worktags (both allowed and default) are replaced with the ones specified in the request. It will supersede any "remove all" or delete option set to True by worktag type. When True, a default value must be provided for all worktag types that are configured with 'Default Required' in the 'Maintain Related Worktag Usage'.   
Related_Worktags_by_Type_Data  Related_Worktags_by_Worktag_Type_Data  [0..*]  Allowed and Default Related Worktags Data by Worktag Type. 
Validation Description
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".   
Worktag Type: [AWT] is not allowed for Taggable Type: [TT]   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.   
 
Validation Description
[missing required worktag types]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
top
 

Related_Worktags_by_Worktag_Type_Data

part of: Related_Worktag_Widget_Data
Allowed and Default Related Worktags Data by Worktag Type.
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Type_Reference  Accounting_Worktag_TypeObject  [0..1]  The Worktag Type Reference ID cannot be duplicated within one request. Valid ID types for all worktag types that can be configured for a related worktag taggable type may include: BUSINESS_SITE, BUSINESS_UNIT, COST_CENTER, CUSTOM_ORGANIZATION_01-10, CUSTOM_WORKTAG_1-10, FUND, GIFT, GRANT, INVESTOR, OPPORTUNITY, PROGRAM, PROJECT, PROJECT_PHASE, PROJECT_TASK, REGION, SALES_ITEM.   
Required_On_Transaction  boolean  [0..1]  Boolean to indicate if the Worktag Type will be required on a transaction when a value for the worktag type that has related values is entered.   
Required_On_Transaction_For_Validation  boolean  [0..1]  Boolean to indicate if 'Required on Transaction' is enabled in either 'Maintain Related Worktag Usage' or on the Worktag instance. When you generate an EIB template with data, 'y' is returned when either boolean is true. This boolean is informational only in the 'Put' operation.   
Default_Worktag_Data  Default_Worktag_Data  [0..1]  Reference to existing Default Realted Worktag or Add new Default Related Worktag 
Validation Description
Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".   
Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.   
For [T-New Instance] '[TT]'[colon] [squote][T][squote]: Default value "[AWT]:[AW]" does not allow [Default Text Singular or Plural]: [Target Worktags].   
'[worktag value]' is not permitted as the default value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
 
Replace_All_Allowed_Values  boolean  [0..1]  Boolean to indicate that all existing allowed values are to be deleted. When set to true ('y' in EIB), if allowed values are also specified, they will become the new set of allowed values.   
Allowed_Worktag_Data  Allowed_Worktag_Data  [0..*]  Reference to existing Allowed Related Worktags or Add new Allowed Related Worktags 
Validation Description
Worktag Type of Allowed Worktag "[AW]" does not match the Worktag Type: "[WT]"   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], an allowed value must be specified when Delete Allowed Value = 'Y'.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], specified default value must match an existing allowed value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value   
'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
 
Validation Description
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote] you cannot specify allowed values as they are not enabled in ‘Maintain Related Worktag Usage’.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Default Worktag field is "Required".   
Worktag Type: [AWT] is not allowed for Taggable Type: [TT]   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Allowed Value cannot be 'Y' when all allowed values are being replaced.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value and allowed values are being replaced, allowed values in file must be empty or include default value specified in file.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when allowed values are being replaced but existing default value is not being replaced or deleted, allowed values in file must be empty or include existing default value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], you cannot have a 'Default Value' on more than one row.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when default value is being replaced, persisted allowed values must be empty or include default value specified in file.   
top
 

Accounting_Worktag_TypeObject

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

Accounting_Worktag_TypeObjectID

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

Default_Worktag_Data

part of: Related_Worktags_by_Worktag_Type_Data
Reference to existing Default Realted Worktag or Add new Default Related Worktag
 
Parameter name Type/Value Cardinality Description Validations
@Delete_Default_Value  boolean  [1..1]  Boolean to indicate if existing default value is to be deleted. The existing default value must be correctly specified. Do not set to true (or 'y' in EIB) to replace the existing default value.   
Default_Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.   
Validation Description
Worktag Type of Default Worktag "[AW]" does not match the Worktag Type: "[WT]".   
Worktag Aggregation Dimension: '[wt]' is not allowed in the default worktag field.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], Delete Default Value cannot be 'Y' when a default is required or the default value is not the existing value or if its blank.   
For [T-New Instance] '[TT]'[colon] [squote][T][squote]: Default value "[AWT]:[AW]" does not allow [Default Text Singular or Plural]: [Target Worktags].   
'[worktag value]' is not permitted as the default value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
top
 

Accounting_Worktag_and_Aggregation_DimensionObject

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

Accounting_Worktag_and_Aggregation_DimensionObjectID

part of: Accounting_Worktag_and_Aggregation_DimensionObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Level_ID, Academic_Period_ID, Academic_Person_ID, Academic_Unit_ID, Ad_hoc_Payee_ID, Alternate_Supplier_Contract_ID, Applicant_ID, Asset_Adjustment_Reason_Reference_ID, Asset_Adjustment_Type_Reference_ID, Asset_Impairment_Reason_ID, Bank_Account_ID, Business_Asset_Cost_Adjustment_Reason_ID, Business_Unit_Hierarchy_ID, Business_Unit_ID, Calculation_Compensation_Basis_ID, Cash_Activity_Category_ID, Catalog_Item_ID, Company_Reference_ID, Compensation_Basis_ID, Compensation_Grade_ID, Contingent_Worker_ID, Contingent_Worker_Type_ID, Corporate_Credit_Card_Account_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Customer_Category_ID, Customer_Contract_Alternate_Reference_ID, Customer_Contract_Reference_ID, Customer_Group_ID, Customer_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_Group_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_Hierarchy_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Internal_Service_Provider_ID, Internal_Service_Provider_Reference_ID, Investment_Pool_ID, Investment_Profile_ID, Investor_ID, Is_Manager_ID, Is_People_Manager, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, Job_Category_ID, Job_Family_Group_ID, Job_Family_ID, Job_Level_ID, Job_Profile_ID, Job_Requisition_ID, Lease_Expense_Recognition_ID, Loan_ID, Location_ID, Management_Level_ID, NI_Category_Letter, Object_Class_ID, Opportunity_Reference_ID, Organization_Reference_ID, Pay_Rate_Type_ID, Payroll_Federal_Authority_Tax_Code, Payroll_Income_Code, Payroll_Local_City_Authority_Tax_Code, Payroll_Local_County_Authority_Tax_Code, Payroll_Local_Other_Authority_Tax_Code, Payroll_Local_School_District_Authority_Tax_Code, Payroll_State_Authority_Tax_Code, Petty_Cash_Account_ID, Position_ID, Position_Time_Type_ID, Program_Hierarchy_ID, Program_ID, Program_of_Study_ID, Project_Hierarchy_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_Group_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Resource_Category_Hierarchy_ID, Revenue_Category_Hierarchy_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_Group_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Sponsor_Type_ID, Student_Application_Residency_Status_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Course_ID, Student_Course_Section_ID, Student_ID, Student_Recruiting_Campaign_ID, Student_Recruiting_Event_ID, Student_Sponsor_Contract_ID, Student_Waiver_Item_ID, Supplier_Category_ID, Supplier_Contract_ID, Supplier_Group_ID, Supplier_ID, Supplier_Reference_ID, Tax_Applicability_ID, Tax_Authority_ID, Tax_Authority_Reference_ID, Tax_Category_ID, Tax_Code_ID, Tax_Point_Date_Type_ID, Tax_Rate_ID, Tax_Recoverability_Object_ID, Third_Party_ID, Withholding_Order_Case_ID, Withholding_Tax_Code_ID, Withholding_Tax_Rate_ID, Work_Function_ID, Work_Shift_ID, Workday_Deduction_Code, Workday_Earning_Code, Worker_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
 

Allowed_Worktag_Data

part of: Related_Worktags_by_Worktag_Type_Data
Reference to existing Allowed Related Worktags or Add new Allowed Related Worktags
 
Parameter name Type/Value Cardinality Description Validations
@Delete_Allowed_Value  boolean  [1..1]  Boolean to indicate that specified allowed values are to be deleted. At least 1 existing allowed value must be specified When set to true (or 'y' in EIB). Cannot be set to true if 'Replace All Allowed Values' is set to true.   
Allowed_Worktag_Reference  Accounting_Worktag_and_Aggregation_DimensionObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' for this field in your EIB template to see values when you generate a template with data or to configure related worktags for multiple worktag types. The list of valid ID types for this column exceeds the size limit of an Excel validation list so ID types must be entered as text. Valid ID types for this column may include: Business_Unit_Hierarchy_ID, Business_Unit_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_1-5_ID, Custom_Worktag_06-15_ID, Fund_Hierarchy_ID, Fund_ID, Gift_Hierarchy_ID, Gift_Reference_ID, Grant_Hierarchy_ID, Grant_ID, Investor_ID, Location_ID, Opportunity_Reference_ID, Organization_Reference_ID, Program_Hierarchy_ID, Program_ID, Project_Hierarchy_ID, Project_ID, Project_Phase_Name_ID, Project_Task_Name_ID, Region_Reference_ID, Sales_Item_Group_ID, Sales_Item_ID.   
Validation Description
Worktag Type of Allowed Worktag "[AW]" does not match the Worktag Type: "[WT]"   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], an allowed value must be specified when Delete Allowed Value = 'Y'.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], specified default value must match an existing allowed value.   
For '[AWT]' on [T-New Instance] '[TT]'[colon] [squote][T][squote], when existing default value is being replaced, default value in file must match an allowed value in file or an existing allowed value   
'[worktag value]' is not permitted as an allowed value for worktag type: [worktag type] because it is inactive.   
[concatenated validation message for constraint provider]   
top
 

Custom_Worktag_ConfigurationReferenceEnumeration

part of: Custom_Worktag_ConfigurationObjectID
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

Accounting_Worktag_and_Aggregation_DimensionReferenceEnumeration

part of: Accounting_Worktag_and_Aggregation_DimensionObjectID
Base Type
string
top