Service Directory > v32.1 > Human_Resources > Get_Worker_Event_History
 

Operation: Get_Worker_Event_History

This operation retrieves references to all Events (created through workflow) associated with a Worker based on the Event Type and Date parameters.


@ - 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: Worker_Event_History_Get

Utilize the following Reference element (and other optional attributes) to retrieve instances of Worker Events and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Reference  Worker_Reference  [1..1]  Reference element representing a unique instance of Worker (e.g. Employee or Contingent Worker).   
Event_Date_Range_Data  Effective_And_Updated_DateTime_Data  [0..1]  Element contains effective and updated date/time data. 
Validation Description
Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment! 
Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through! 
If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required! 
If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required! 
Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through! 
 
top
 

Response Element: Worker_Event_History

Response element containing an instance of Worker and his/her Worker Event History.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Reference  Worker_Reference  [0..1]  Reference element representing a unique instance of Worker (e.g. Employee or Contingent Worker).   
Worker_Event_History_Data  Worker_Event_History_Data  [0..1]  Encapsulating element containing Worker Event History data.   
top
 

Worker_Reference

part of: Worker_Event_History_Get, Worker_Event_History
Reference element representing a unique instance of Worker (e.g. Employee or Contingent Worker).
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference [Choice]   Employee_Reference  [1..1]  Reference element representing a unique instance of Employee. 
Validation Description
Employee Reference Integration ID does not exist!  A valid instance of Employee must exist for the given Integration ID Reference. 
 
Contingent_Worker_Reference [Choice]   Contingent_Worker_Reference_Data  [1..1]  Reference element representing a unique instance of Contingent Worker. 
Validation Description
Contingent Worker Reference Integration ID does not exist!  A valid instance of Contingent Worker must exist for the given Integration ID Reference. 
 
top
 

Employee_Reference

part of: Worker_Reference
Reference element representing a unique instance of Employee.
 
Parameter name Type/Value Cardinality Description Validations
Integration_ID_Reference  External_Integration_ID_Reference_Data  [1..1]  Integration ID reference is used as a unique identifier for integratable objects in the Workday system.   
Validation Description
Employee Reference Integration ID does not exist!  A valid instance of Employee must exist for the given Integration ID Reference. 
top
 

External_Integration_ID_Reference_Data

part of: Employee_Reference, Contingent_Worker_Reference_Data
Integration ID reference is used as a unique identifier for integratable objects in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display name inside the Workday system.   
ID  ID  [1..1]  External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.   
top
 

ID

part of: External_Integration_ID_Reference_Data
External ID that uniquely identifies the integratable object within the context of the integration system identified by the System ID attribute.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@System_ID  string  [1..1]  Integration system identifier, part of a two part key (including the text value of the ID element) that uniquely identify integratable object. 
Validation Description
Integration System ID does not exist.  A valid instance of Integration ID must exist for the given System ID. 
 
top
 

Contingent_Worker_Reference_Data

part of: Worker_Reference
Reference element representing a unique instance of Contingent Worker.
 
Parameter name Type/Value Cardinality Description Validations
Integration_ID_Reference  External_Integration_ID_Reference_Data  [1..1]  Integration ID reference is used as a unique identifier for integratable objects in the Workday system.   
Validation Description
Contingent Worker Reference Integration ID does not exist!  A valid instance of Contingent Worker must exist for the given Integration ID Reference. 
top
 

Effective_And_Updated_DateTime_Data

part of: Worker_Event_History_Get, Worker_Event_History_Data
Element contains effective and updated date/time data.
 
Parameter name Type/Value Cardinality Description Validations
Updated_From  dateTime  [0..1]  Defines the earliest moment (e.g. datetime) data was entered into the Workday system.   
Updated_Through  dateTime  [0..1]  Defines the latest moment (e.g. datetime) data was entered into the Workday system.   
Effective_From  dateTime  [0..1]  Defines the earliest Effective Date (e.g. As Of Date) data is marked within the Workday system.   
Effective_Through  dateTime  [0..1]  Defines the latest Effective Date (e.g. As Of Date) data is marked within the Workday system.   
Validation Description
Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment! 
Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through! 
If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required! 
If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required! 
Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through! 
top
 

Worker_Event_History_Data

part of: Worker_Event_History
Encapsulating element containing Worker Event History data.
 
Parameter name Type/Value Cardinality Description Validations
Event_Date_Range_Data  Effective_And_Updated_DateTime_Data  [0..1]  Element contains effective and updated date/time data. 
Validation Description
Updated Through must be less than or equal to Current Moment!  Updated Through must be less than or equal to Current Moment! 
Effective From must be less than or equal to Effective Through!  Effective From must be less than or equal to Effective Through! 
If one of Effective From or Effective Through contains a value, both are Required!  If one of Effective From or Effective Through contains a value, both are Required! 
If one of Updated From or Updated Through contains a value, both are Required!  If one of Updated From or Updated Through contains a value, both are Required! 
Updated From must be less than or equal to Updated Through!  Updated From must be less than or equal to Updated Through! 
 
Event_Data  Event_History_Data  [0..*]  Encapsulating element containing Event History data.   
top
 

Event_History_Data

part of: Worker_Event_History_Data
Encapsulating element containing Event History data.
 
Parameter name Type/Value Cardinality Description Validations
Event_ID  string  [0..1]  Text attribute identifying Event ID.   
Event_Type_Reference  Business_Process_Type_Reference_Data  [0..1]  Reference element representing a unique instance of Event Type (e.g. Hire Employee Event, Change Address Event, etc.). 
Validation Description
Business Process Type does not exist for Business Process Type Name!  Business Process Type does not exist for Business Process Type Name! 
 
Description  string  [0..1]  Text attribute identifying Event Description.   
Completed_DateTime  dateTime  [0..1]  Date the event completed.   
Effective_Date  date  [0..1]  Date the event was made effective (or completed if no Effective Date).   
top
 

Business_Process_Type_Reference_Data

part of: Event_History_Data
Reference element representing a unique instance of Event Type (e.g. Hire Employee Event, Change Address Event, etc.).
 
Parameter name Type/Value Cardinality Description Validations
Event_Type_Name  string  [1..1]  Testing WS Word Bucket edit   
Validation Description
Business Process Type does not exist for Business Process Type Name!  Business Process Type does not exist for Business Process Type Name! 
top