Service Directory > v31.2 > Talent > Get_Job_History_Companies
 

Operation: Get_Job_History_Companies

This operation retrieves companies in worker job history.


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

Element containing request data for a Job History Company.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Job_History_Company_Request_References  [0..1]  Contains the information to request a Job History Company.   
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_Job_History_Companies_Response

Contains the information necessary to get a Job History Company.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Job_History_Company_Request_References  [0..1]  Contains the information to request a Job History Company.   
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  Job_History_Company_Response_Data  [0..1]  Wrapper containing the response data.   
top
 

Job_History_Company_Request_References

part of: Get_Job_History_Companies_Request, Get_Job_History_Companies_Response
Contains the information to request a Job History Company.
 
Parameter name Type/Value Cardinality Description Validations
Job_History_Company_Reference  Job_History_CompanyObject  [1..*]  A reference to a Job History Company, used for editing.   
top
 

Job_History_CompanyObject

part of: Job_History_Company_Data, Job_History_Company_Request_References, Job_History_Company
 
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  Job_History_CompanyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Job_History_CompanyObjectID

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

Job_History_Company_Response_Data

part of: Get_Job_History_Companies_Response
Wrapper containing the response data.
 
Parameter name Type/Value Cardinality Description Validations
Job_History_Company  Job_History_Company  [0..*]  Response data containing the reference and data items.   
top
 

Job_History_Company

part of: Job_History_Company_Response_Data
Element containing the reference item and data element.
 
Parameter name Type/Value Cardinality Description Validations
Job_History_Company_Reference  Job_History_CompanyObject  [0..1]  The Job History Company instance being returned   
Job_History_Company_Data  Job_History_Company_Data  [0..1]  Element containing the data items for a Job History Company 
Validation Description
A Company can only be marked as a duplicate of another active Company.   
 
top
 

Job_History_Company_Data

part of: Job_History_Company
Data Element for Job History Company
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of the Job History Company.   
Name  string  [1..1]  The name of the Job History Company.   
Job_History_Industry_Reference  Job_History_IndustryObject  [0..*]  A reference to the Job History Industry the Job History company is within.   
Watched_Company  boolean  [0..1]  When true, Job History Company is being watched.   
Inactive  boolean  [0..1]  When true, the Job History Company is inactive.   
Duplicate_of_Company_Reference  Job_History_CompanyObject  [0..1]  The ID of the Job History Company that the Current Job History Company is a duplicate of.   
Validation Description
A Company can only be marked as a duplicate of another active Company.   
top
 

Job_History_IndustryObject

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

Job_History_IndustryObjectID

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

Job_History_CompanyReferenceEnumeration

part of: Job_History_CompanyObjectID
Base Type
string
top
 

Job_History_IndustryReferenceEnumeration

part of: Job_History_IndustryObjectID
Base Type
string
top