Service Directory > v33.1 > Resource_Management > Get_Worktag_Split_Templates
 

Operation: Get_Worktag_Split_Templates

This service operation will get Worktag Split Templates for the specified criteria.


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

Contains request reference, criteria, filter and response group for getting Worktag Split Template data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Worktag_Split_Template_Request_References  [0..1]  Get Worktag Split Template Request References   
Request_Criteria [Choice]   Worktag_Split_Template_Request_Criteria  [0..1]  Get Worktag Split Template Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Worktag Split Template Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Worktag_Split_Template_Response_Group  [0..1]  Get Worktag Split Template Response Group   
top
 

Response Element: Get_Worktag_Split_Templates_Response

Element containing Worktag Split Template 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  Worktag_Split_Template_Request_References  [0..1]  Get Worktag Split Template Request References   
Request_Criteria  Worktag_Split_Template_Request_Criteria  [0..1]  Get Worktag Split Template Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Worktag Split Template Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Worktag_Split_Template_Response_Group  [0..1]  Get Worktag Split Template Response Group   
Response_Results  Response_Results  [0..1]  Get Worktag Split Template Response Results   
Response_Data  Worktag_Split_Template_Response_Data  [0..1]  Get Worktag Split Template Response Data   
top
 

Worktag_Split_Template_Request_References

part of: Get_Worktag_Split_Templates_Request, Get_Worktag_Split_Templates_Response
Element containing reference instances for a Worktag Split Template
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template_Reference  Worktag_Split_TemplateObject  [1..*]  Reference to an existing Worktag Split Template   
top
 

Worktag_Split_TemplateObject

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

Worktag_Split_TemplateObjectID

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

part of: Get_Worktag_Split_Templates_Request, Get_Worktag_Split_Templates_Response
Element containing criteria for Worktag Split Template Request
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template_Name  string  [0..1]  Worktag Split Template Name for Request Criteria   
Inactive  boolean  [0..1]  Inactive status for Request Criteria   
Template_Criteria_Reference  Worktag_Split_Template_CriteriaObject  [0..1]  Template Criteria for Request Criteria   
top
 

Worktag_Split_Template_CriteriaObject

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

Worktag_Split_Template_CriteriaObjectID

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

Worktag_Split_Template_Response_Group

part of: Get_Worktag_Split_Templates_Request, Get_Worktag_Split_Templates_Response
Element containing Worktag Split Template response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Worktag_Split_Template_Response_Data

part of: Get_Worktag_Split_Templates_Response
Wrapper Element that includes Worktag Split Template Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template  Worktag_Split_Template  [0..*]  Worktag Split Template   
top
 

Worktag_Split_Template

part of: Worktag_Split_Template_Response_Data
Wrapper Element that includes Worktag Split Template Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template_Reference  Worktag_Split_TemplateObject  [0..1]  Reference to an existing Worktag Split Template   
Worktag_Split_Template_Data  Worktag_Split_Template_Data  [0..*]  Worktag Split Template Data 
Validation Description
Enter a Template Name that isn't already in use on the Worktag Split Template.   
You can’t have multiple Worktag Split Template Snapshots with the same Effective Date.   
You can’t reference the same Worktag Split Template Snapshot multiple times on a Worktag Split Template.   
You can only change the template name or active status when the Worktag Split Template is in use.   
 
top
 

Worktag_Split_Template_Data

part of: Worktag_Split_Template
Data for Worktag Split Template
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template_ID  string  [0..1]  Reference ID for Worktag Split Template Data   
Template_Name  string  [0..1]  Name for Worktag Split Template   
Inactive  boolean  [0..1]  Worktag Split Template Criteria Active or Inactive Status   
Worktag_Split_Template_Criteria_Reference  Worktag_Split_Template_CriteriaObject  [0..1]  Worktag Split Template filtered by Worktag Split Template Criteria   
Worktag_Split_Template_Sharing_Data  Worktag_Split_Template_Sharing_Data  [1..1]  Worktag Split Template Sharing Options 
Validation Description
You cannot modify access of the owner of this item.   
Select Share with Users and Groups to share the template with specific users or tenanted security groups.   
 
Worktag_Split_Template_Snapshot_Data  Worktag_Split_Template_Snapshot_Data  [0..*]  Worktag Split Template Snapshot Data 
Validation Description
You can not change the Worktag Split Template Snapshot if it is in use.   
A Worktag Split Detail exists for this Effective Date, either change the Worktag Split Detail associated with this effective date or enter a different date.   
Enter a Worktag Split Template Snapshot that isn't already in use on a Worktag Split Template.   
You can’t reference the same Worktag Split Template Item multiple times on a Worktag Split Template Snapshot.   
The sum of splits percentages does not equal 100.   
 
Validation Description
Enter a Template Name that isn't already in use on the Worktag Split Template.   
You can’t have multiple Worktag Split Template Snapshots with the same Effective Date.   
You can’t reference the same Worktag Split Template Snapshot multiple times on a Worktag Split Template.   
You can only change the template name or active status when the Worktag Split Template is in use.   
top
 

Worktag_Split_Template_Sharing_Data

part of: Worktag_Split_Template_Data
Worktag Split Template Sharing Data
 
Parameter name Type/Value Cardinality Description Validations
Not_Shared [Choice]   boolean  [1..1]  Is Worktag Split Template not shared   
Shared [Choice]   boolean  [1..1]  Is Worktag Split Template shared   
Share_with_Users_and_Groups [Choice]   boolean  [1..1]  Share Worktag Split Template with Users and Groups   
Specific_Users_for_Worktag_Template_Reference  System_UserObject  [0..*]  Specific Users for Worktag Split Template   
Security_Groups_for_Worktag_Template_Reference  Tenanted_Security_GroupObject  [0..*]  Security Groups for Worktag Split Template   
Owning_System_User_Reference  System_UserObject  [0..1]  Owning System User for Worktag Split Template   
Validation Description
You cannot modify access of the owner of this item.   
Select Share with Users and Groups to share the template with specific users or tenanted security groups.   
top
 

System_UserObject

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

System_UserObjectID

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

Tenanted_Security_GroupObject

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

Tenanted_Security_GroupObjectID

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

part of: Worktag_Split_Template_Data
Worktag Split Template Snapshot Data
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template_Snapshot_Reference  Worktag_Split_Template_SnapshotObject  [0..1]  Worktag Split Template Snapshot Reference   
Effective_Date  date  [1..1]  Worktag Split Template Snapshot Effective Date   
Worktag_Split_Template_Item_Data  Worktag_Split_Template_Item_Data  [1..*]  Worktag Split Template Item Data 
Validation Description
Enter a Worktag Split Template Item that isn't already in use on a Worktag Split Template Snapshot.   
Enter the Worktag Split Template Snapshot reference for each Worktag Split Template Item that has a reference.   
 
Validation Description
You can not change the Worktag Split Template Snapshot if it is in use.   
A Worktag Split Detail exists for this Effective Date, either change the Worktag Split Detail associated with this effective date or enter a different date.   
Enter a Worktag Split Template Snapshot that isn't already in use on a Worktag Split Template.   
You can’t reference the same Worktag Split Template Item multiple times on a Worktag Split Template Snapshot.   
The sum of splits percentages does not equal 100.   
top
 

Worktag_Split_Template_SnapshotObject

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

Worktag_Split_Template_SnapshotObjectID

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

part of: Worktag_Split_Template_Snapshot_Data
Worktag Split Template Item Data
 
Parameter name Type/Value Cardinality Description Validations
Worktag_Split_Template_Item_Reference  Worktag_Split_Template_ItemObject  [0..1]  Worktag Split Template Item Reference   
Line_Order  string  [0..1]  Line Order for Worktag Split Template Item   
Percentage_by_Amount_for_Distribution_Line  decimal (9, 6)   [1..1]  Distribution Percentage for Worktag Split Template Item   
Memo  string  [0..1]  Memo for Worktag Split Template Item   
Worktag_Reference  Accounting_WorktagObject  [0..*]  Reference to existing worktags. Worktags are a way to mark tasks and business objects to make them easier to access and summarize. 
Validation Description
You can't select Grants because they aren't currently a worktag dimension for Worktag Split Template Details.   
The worktag type doesn't apply to the Spend transactions [not allowed worktag types on Spend Transactions].   
Only one worktag for each type is allowed for each document line.   
[list of worktag types] not valid for this transaction.   
Enter worktag types [missing required worktag types on Spend Transactions] for the Spend transactions.   
The following Accounting Worktags are required but have not been assigned: [missing]   
[worktag value] is not permitted as an allowed value for worktag type: [worktag type], because it is inactive.   
 
Billable  boolean  [0..1]  Billable Flag at Worktag Split Template Item 
Validation Description
The Worktag Split Template Line can't be marked as Billable if the selected Worktag is not for a billable project   
 
Validation Description
Enter a Worktag Split Template Item that isn't already in use on a Worktag Split Template Snapshot.   
Enter the Worktag Split Template Snapshot reference for each Worktag Split Template Item that has a reference.   
top
 

Worktag_Split_Template_ItemObject

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

Worktag_Split_Template_ItemObjectID

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

Accounting_WorktagObject

part of: Worktag_Split_Template_Item_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_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, Admissions_Cohort_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, Exemption_Code, 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, Miscellaneous_Payee_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_Split_TemplateReferenceEnumeration

part of: Worktag_Split_TemplateObjectID
Base Type
string
top
 

Worktag_Split_Template_CriteriaReferenceEnumeration

part of: Worktag_Split_Template_CriteriaObjectID
Base Type
string
top
 

System_UserReferenceEnumeration

part of: System_UserObjectID
Base Type
string
top
 

Tenanted_Security_GroupReferenceEnumeration

part of: Tenanted_Security_GroupObjectID
Base Type
string
top
 

Worktag_Split_Template_SnapshotReferenceEnumeration

part of: Worktag_Split_Template_SnapshotObjectID
Base Type
string
top
 

Worktag_Split_Template_ItemReferenceEnumeration

part of: Worktag_Split_Template_ItemObjectID
Base Type
string
top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top