Service Directory > v31.2 > Financial_Management > Get_Integration_Worktag_Mapping_Source_Systems
 

Operation: Get_Integration_Worktag_Mapping_Source_Systems

This service operation will get Source Systems. This service will return the Source System and its associated information. The request criteria can be for a single Source System based on Reference, or all of the Source Systems can be retrieved if no Reference is specified.


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

Contains request reference, criteria, filter and response group for getting Source System data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Integration_Worktag_Mapping_Source_System_Request_References  [0..1]  Get Mapping Source System Reference   
Response_Filter  Response_Filter  [0..1]  Get Mapping Source System Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Integration_Worktag_Mapping_Source_Systems_Response

Element containing Source System 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_Source_System_Request_References  [0..1]  Element containing reference instances for a Source System   
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_Source_System_Response_Data  [0..1]  Element containing all Mapping Source System Responsa Data   
top
 

Integration_Worktag_Mapping_Source_System_Request_References

part of: Get_Integration_Worktag_Mapping_Source_Systems_Request, Get_Integration_Worktag_Mapping_Source_Systems_Response
Element containing reference instances for a Source System
 
Parameter name Type/Value Cardinality Description Validations
Source_System_Reference  Integration_Worktag_Mapping_Source_SystemObject  [0..*]  Reference to an existing Mapping Source System   
top
 

Integration_Worktag_Mapping_Source_SystemObject

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

Response_Filter

part of: Get_Integration_Worktag_Mapping_Source_Systems_Request, Get_Integration_Worktag_Mapping_Source_Systems_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_Mapping_Source_Systems_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_Source_System_Response_Data

part of: Get_Integration_Worktag_Mapping_Source_Systems_Response
Element containing all Mapping Source System Responsa Data
 
Parameter name Type/Value Cardinality Description Validations
Source_System  Integration_Worktag_Mapping_Source_System  [0..*]  Element containing all Mapping Source System Data   
top
 

Integration_Worktag_Mapping_Source_System

part of: Integration_Worktag_Mapping_Source_System_Response_Data
Element containing the Mapping Source System Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Source_System_Reference  Integration_Worktag_Mapping_Source_SystemObject  [0..1]  Reference to an existing Mapping Source System   
Source_System_Data  Integration_Worktag_Mapping_Source_System_Data  [1..1]  Mapping Source System Data   
top
 

Integration_Worktag_Mapping_Source_System_Data

part of: Integration_Worktag_Mapping_Source_System
Element containing all Mapping Source System Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Mapping Source System Reference ID. This is the Mapping Source System unique identifier   
Source_System_Name  string  [1..1]  Source System Name 
Validation Description
Enter a Source System Name that does not already exist.   
 
Description  string  [0..1]  Source System Description   
Usage_Count  decimal (30, 10)   [0..1]  Value is derived by the system based on the number of times the Source System is used in the mapping.   
top
 

Integration_Worktag_Mapping_Source_SystemReferenceEnumeration

part of: Integration_Worktag_Mapping_Source_SystemObjectID
Base Type
string
top