Service Directory > v31.2 > Financial_Management > Get_Integration_Worktag_Mappings
 

Operation: Get_Integration_Worktag_Mappings

This service operation will gets a Worktag Mapping. The service will return the Worktag Mapping and its associated Worktag Mapping Details. The request criteria can be for a single Worktag Mapping based on Reference which is required.


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

Contains request reference, criteria, filter and response group for getting Worktag Mapping data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Integration_Worktag_Mapping_Request_References  [0..1]  Element containing reference instances for a Worktag Mapping   
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. 
 
top
 

Response Element: Get_Integration_Worktag_Mappings_Response

Element containing Worktag Mapping response elements including received criteria, references, results filter and result summary.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Integration_Worktag_Mapping_Request_References  [0..1]  Element containing reference instances for a Worktag Mapping   
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_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  Integration_Worktag_Mapping_Response_Data  [0..1]  Element containing Worktag Mapping response elements including received criteria, references, results filter and result summary   
top
 

Integration_Worktag_Mapping_Request_References

part of: Get_Integration_Worktag_Mappings_Request, Get_Integration_Worktag_Mappings_Response
Element containing reference instances for a Worktag Mapping
 
Parameter name Type/Value Cardinality Description Validations
Integration_Worktag_Mapping_Reference  Integration_Worktag_MappingObject  [1..*]  Reference to an existing Worktag Mapping   
top
 

Integration_Worktag_MappingObject

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

Integration_Worktag_MappingObjectID

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

Response_Results

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

Integration_Worktag_Mapping_Response_Data

part of: Get_Integration_Worktag_Mappings_Response
Element containing Worktag Mapping response elements including received criteria, references, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
Integration_Worktag_Mapping  Integration_Worktag_Mapping  [0..*]  Wrapper Element that includes Worktag Mapping Instance and Data   
top
 

Integration_Worktag_Mapping

part of: Integration_Worktag_Mapping_Response_Data
Wrapper Element that includes Worktag Mapping Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Integration_Worktag_Mapping_Reference  Integration_Worktag_MappingObject  [0..1]  Reference to an existing Worktag Mapping   
Integration_Worktag_Mapping_Data  Integration_Worktag_Mapping_Data  [0..*]  Worktag Mapping Data 
Validation Description
The following external codes are not unique: [external codes]   
 
top
 

Integration_Worktag_Mapping_Data

part of: Integration_Worktag_Mapping
Element containing all Worktag Mapping Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Worktag Mapping Reference ID. This is the Worktag Mapping unique identifier.   
Mapping_Name  string  [1..1]  The unique Worktag Mapping Name 
Validation Description
Enter an Integration Worktag Mapping Name that does not already exist.   
 
Source_System_Reference  Integration_Worktag_Mapping_Source_SystemObject  [0..1]  Mapping Source System Reference   
Account_Set_Reference  Account_SetObject  [0..1]  Required if "Is Ledger Account" is set to true. This is the Account Set used to filter the Ledger Accounts used in the mapping   
Comment  string  [0..1]  Any comments for the mapping   
Mapping_Detail  Integration_Worktag_Mapping_Detail  [0..*]  Contains Worktag Mapping Details Data   
Validation Description
The following external codes are not unique: [external codes]   
top
 

Integration_Worktag_Mapping_Source_SystemObject

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

Integration_Worktag_Mapping_Source_SystemObjectID

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

Account_SetObject

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

Account_SetObjectID

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

Integration_Worktag_Mapping_Detail

part of: Integration_Worktag_Mapping_Data
Element for the Worktag Mapping Detail Data
 
Parameter name Type/Value Cardinality Description Validations
External_Code  string  [1..1]  The External Code coming from source system which will be mapped into workay worktag or ledger accounts   
Ledger_Account_Reference  Ledger_AccountObject  [0..1]  The mapped Ledger Account Reference 
Validation Description
Account Set was specified but no Ledger Account was provided on the mapping detail.   
Ledger Account mapped to [External Code] is not part of the Account Set [Account Set].   
Ledger Account mapped to [External Code] is retired.   
 
Worktag_Reference  Accounting_WorktagObject  [0..*]  The mapped Worktag Reference 
Validation Description
Only one worktag of each type is allowed   
 
Comment  string  [0..1]  Comments on the mapping   
top
 

Ledger_AccountObject

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

Ledger_AccountObjectID

part of: Ledger_AccountObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Ledger_Account_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Account_Set_ID  [1..1]  The unique identifier type of a parent object   
top
 

Accounting_WorktagObject

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

Integration_Worktag_MappingReferenceEnumeration

part of: Integration_Worktag_MappingObjectID
Base Type
string
top
 

Integration_Worktag_Mapping_Source_SystemReferenceEnumeration

part of: Integration_Worktag_Mapping_Source_SystemObjectID
Base Type
string
top
 

Account_SetReferenceEnumeration

part of: Account_SetObjectID
Base Type
string
top
 

Ledger_AccountReferenceEnumeration

part of: Ledger_AccountObjectID
Base Type
string
top
 

Base Type
string

top
 

Accounting_WorktagReferenceEnumeration

part of: Accounting_WorktagObjectID
Base Type
string
top