Service Directory > v31.2 > Integrations > Get_Import_Processes
 

Operation: Get_Import_Processes

Get status and correlation information for Import Process load


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

Incoming element for Get Import Processes
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Import_Process_Request_References  [1..1]  Import Process Request References   
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_Import_Processes_Response

Get Import Processes Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Import_Process_Request_References  [0..1]  Import Process Request References   
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  Import_Process_Response_Data  [0..1]  Import Process Response Data   
top
 

Import_Process_Request_References

part of: Get_Import_Processes_Request, Get_Import_Processes_Response
Import Process Request References
 
Parameter name Type/Value Cardinality Description Validations
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [1..1]  Internal method binding only.. This is a reference to the job that was created as the result of a Import Process Document load.   
top
 

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

Import_Process_Response_Data

part of: Get_Import_Processes_Response
Import Process Response Data
 
Parameter name Type/Value Cardinality Description Validations
Import_Process  Import_Process  [0..*]  Import Process   
top
 

Import_Process

part of: Import_Process_Response_Data
Import Process
 
Parameter name Type/Value Cardinality Description Validations
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Import Process Instance   
Import_Process_Data  Import_Process_Data  [0..1]  Import Process Data   
top
 

Import_Process_Data

part of: Import_Process
Import Process Data
 
Parameter name Type/Value Cardinality Description Validations
Process_Description  string  [0..1]  Description of the Import Process event   
Percent_Complete  decimal (7, 4) >0   [0..1]  Percent Complete of the job   
Process_Completed_DateTime  dateTime  [0..1]  Date/Time representing the moment the job completed   
Import_Header_Reference  InstanceObject  [0..1]  Header instance associated to Import Process   
Status_Reference  Background_Process_Runtime_StatusObject  [0..1]  Returns status associated to Import Process   
Has_Messages  boolean  [0..1]  Indicated whether Import Process Event has messages associated with it   
Validate_Only  boolean  [0..1]  Indicates if this process was started with the "validate-only" option.   
top
 

InstanceObject

part of: Import_Process_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

Background_Process_Runtime_StatusObject

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

Background_Process_Runtime_StatusObjectID

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

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top
 

Background_Process_Runtime_StatusReferenceEnumeration

part of: Background_Process_Runtime_StatusObjectID
Base Type
string
top