Service Directory > v32.1 > Financial_Management > Get_Default_Values_for_Worktags
 

Operation: Get_Default_Values_for_Worktags

This service operation will get default values for related worktags. Only worktag types configured as allowed worktag types in the 'Maintain Related Worktag Usage' task will be returned. When moving data from one tenant to another, you may want to set 'Only Return Items with Default Values' boolean to True so that you only return instances and worktag types that have a default value or require a default value. Refer to the community page https://community.workday.com/services/tools/99774 for how to configure a Parameter Based Filter.


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

Contains request reference, criteria, filter and response group for getting Default Values for Worktags
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Default_Values_for_Worktag_Request_References  [0..1]  Related Worktag Request References   
Request_Criteria [Choice]   Default_Values_for_Worktag_Request_Criteria  [0..1]  Element containing Request Criteria for getting Default Values for Worktags   
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_Group  Default_Values_for_Worktag_Response_Group  [0..1]  Element containing Response grouping options for getting Default Values for Worktags   
top
 

Response Element: Get_Default_Values_for_Worktags_Response

Element containing Default Values for Worktags response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Default_Values_for_Worktag_Request_References  [0..1]  Related Worktag Request References   
Request_Criteria  Default_Values_for_Worktag_Request_Criteria  [0..1]  Element containing Request Criteria for getting Default Values for Worktags   
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_Group  Default_Values_for_Worktag_Response_Group  [0..1]  Element containing Response grouping options for getting Default Values for Worktags   
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  Default_Values_for_Worktag_Response_Data  [0..1]  Wrapper Element that includes the Data for the default values for the requested related worktags   
top
 

Default_Values_for_Worktag_Request_References

part of: Get_Default_Values_for_Worktags_Request, Get_Default_Values_for_Worktags_Response
Related Worktag Request References
 
Parameter name Type/Value Cardinality Description Validations
Related_Worktag_Reference  Worktag_with_Related_WorktagsObject  [0..*]  Taggable Related Worktag Request References   
top
 

Worktag_with_Related_WorktagsObject

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

Worktag_with_Related_WorktagsObjectID

part of: Worktag_with_Related_WorktagsObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, 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_ID, Customer_Reference_ID, Expense_Item_ID, Gift_Reference_ID, Grant_ID, Loan_ID, Organization_Reference_ID, Program_ID, Project_ID, Project_Plan_ID, Purchase_Item_ID, Region_Reference_ID, Revenue_Category_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Award_Item_ID, Student_Charge_Item_ID, Student_Waiver_Item_ID, Supplier_Change_ID, Supplier_History_ID, Supplier_ID, Supplier_Reference_ID, Workday_Project_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_Values_for_Worktag_Request_Criteria

part of: Get_Default_Values_for_Worktags_Request, Get_Default_Values_for_Worktags_Response
Element containing Request Criteria for getting Default Values for Worktags
 
Parameter name Type/Value Cardinality Description Validations
Taggable_Type_Reference  Worktag_Type_Configuration_SetObject  [0..*]  Taggable Type Reference   
Only_Return_Items_with_Default_Value  boolean  [0..1]  Only Return Items with Default Value   
top
 

Worktag_Type_Configuration_SetObject

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

Worktag_Type_Configuration_SetObjectID

part of: Worktag_Type_Configuration_SetObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Award_Credit_Definition_ID, Budget_Structure_ID, Financial_Headcount_Definition_ID, Plan_ID, Statistic_Definition_ID, Taggable_Type_ID, Time_Entry_Template_ID, Worktag_Type_Configuration_Set_for_Sales_Item_Fair_Value_Price_List_Singleton_Reference_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
 

Response_Filter

part of: Get_Default_Values_for_Worktags_Request, Get_Default_Values_for_Worktags_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, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to 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 (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Default_Values_for_Worktag_Response_Group

part of: Get_Default_Values_for_Worktags_Request, Get_Default_Values_for_Worktags_Response
Element containing Response grouping options for getting Default Values for Worktags
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Default_Values_for_Worktags_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 have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Default_Values_for_Worktag_Response_Data

part of: Get_Default_Values_for_Worktags_Response
Wrapper Element that includes the Data for the default values for the requested related worktags
 
Parameter name Type/Value Cardinality Description Validations
Default_Values_for_Worktag  Default_Values_for_Worktag  [0..*]  Element including Related Worktag Reference and Default Worktags   
top
 

Default_Values_for_Worktag

part of: Default_Values_for_Worktag_Response_Data
Element including Related Worktag Reference and Default Worktags
 
Parameter name Type/Value Cardinality Description Validations
Default_Values_for_Worktag_Data  Default_Values_for_Worktag_Data  [0..*]  Data Element with Related Worktag Reference and Default Worktags   
top
 

Default_Values_for_Worktag_Data

part of: Default_Values_for_Worktag
Data Element with Related Worktag Reference and Default Worktags
 
Parameter name Type/Value Cardinality Description Validations
Related_Worktag_Reference  Worktag_with_Related_WorktagsObject  [0..1]  IMPORTANT: You must check 'Separate Type Column' in EIB template to update default values for multiple taggable 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 may include: Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06-15_ID, Custom_Worktag_1-5_ID, Customer_ID, Customer_Reference_ID, Gift_Reference_ID, Grant_ID, Loan_ID, Organization_Reference_ID, Program_ID, Project_ID, Purchase_Item_ID, Region_Reference_ID, Revenue_Category_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_ID, Student_Charge_Item_ID.   
Default_Worktags  Related_Worktags_for_Webservices_Edit  [0..1]  To update default values for multiple worktag types, edit EIB template and select related action to Add Additional Columns. Hierarchies are not allowed as default values. The list of 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
[taggable type] does not allow worktag types: [worktag types].   
[non-allowed worktags message for the Taggable instance on Default Values for Worktags]   
For [taggable type]: [taggable] allowed values for worktag types: [worktag types] must contain the default values: [default worktags]   
For '[worktag types]' on '[taggable type]': '[taggable]', an inactive value is not allowed.   
[non-allowed worktags combinations from the Default Values in the Put Default Values for Worktags request]   
[Taggable type]: [taggable] does not allow a hierarchy as a default value for worktag types: [Worktag types].   
Validation Description
Only one worktag for each type is allowed for each document line.   
The following Related Worktags are required but have not been assigned: [missing].   
The following worktag(s) are invalid: [invalid]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
 
top
 

Related_Worktags_for_Webservices_Edit

part of: Default_Values_for_Worktag_Data
This contains the existing related worktags for the Cost Center or add new related worktags to the Cost Center
 
Parameter name Type/Value Cardinality Description Validations
Worktags_Reference  Accounting_WorktagObject  [0..*]  Add valid related worktags   
Validation Description
Only one worktag for each type is allowed for each document line.   
The following Related Worktags are required but have not been assigned: [missing].   
The following worktag(s) are invalid: [invalid]   
[One of Project OR Project Plan Phase OR Project Plan Task Allowed]   
top
 

Accounting_WorktagObject

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

Accounting_WorktagObjectID

part of: Accounting_WorktagObject
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_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_ID, Customer_Reference_ID, Deduction_Code, Deduction_Recipient_ID, Donor_ID, Earning_Code, Employee_ID, Employee_Type_ID, Ethnicity_ID, Expense_Item_ID, External_Committee_Member_ID, Financial_Aid_Award_Year_ID, Financial_Institution_ID, Financial_Institution_Reference_ID, Fund_ID, Funding_Source_Name, Gender_Code, Gift_Reference_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_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_ID, Program_of_Study_ID, Project_ID, Project_Plan_ID, Proposal_Grant_ID, Prospect_ID, Prospect_Reference_ID, Purchase_Item_ID, Receivable_Writeoff_Reason_ID, Region_Reference_ID, Revenue_Category_ID, Rubric_Value_ID, Run_Category_ID, Salary_Over_The_Cap_Type_ID, Sales_Item_ID, Spend_Category_ID, Sponsor_ID, Sponsor_Reference_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_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
 

Worktag_with_Related_WorktagsReferenceEnumeration

part of: Worktag_with_Related_WorktagsObjectID
Base Type
string
top
 

Worktag_Type_Configuration_SetReferenceEnumeration

part of: Worktag_Type_Configuration_SetObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top