Service Directory > v32.1 > Compensation > Get_Benchmark_Jobs
 

Operation: Get_Benchmark_Jobs

This operation allows the retrieval of benchmark job information.


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

Request element to get Benchmark Job
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Benchmark_Job_Request_References  [0..1]  Benchmark Job Request Reference   
Request_Criteria [Choice]   Benchmark_Job_Request_Criteria  [0..1]  Benchmark Job Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Benchmark_Job_Response_Group  [0..1]  Benchmark Job Response Group   
top
 

Response Element: Get_Benchmark_Jobs_Response

Get Benchmark Jobs Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Benchmark_Job_Request_References  [0..1]  Benchmark Job Request References   
Request_Criteria  Benchmark_Job_Request_Criteria  [0..1]  Benchmark Job Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Benchmark_Job_Response_Group  [0..1]  Benchmark Job Response Group   
Response_Results  Response_Results  [0..1]  Response Results   
Response_Data  Benchmark_Job_Response_Data  [0..1]  Benchmark Job Response Data   
top
 

Benchmark_Job_Request_References

part of: Get_Benchmark_Jobs_Request, Get_Benchmark_Jobs_Response
Benchmark Job Request References
 
Parameter name Type/Value Cardinality Description Validations
Benchmark_Job_Reference  Compensation_Benchmark_DefaultObject  [1..*]  Benchmark Job Reference   
top
 

Compensation_Benchmark_DefaultObject

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

Compensation_Benchmark_DefaultObjectID

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

Benchmark_Job_Request_Criteria

part of: Get_Benchmark_Jobs_Request, Get_Benchmark_Jobs_Response
Benchmark Job Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Include_Inactive  boolean  [0..1]  Include Inactive indicates the response will also include inactive Benchmark Jobs.   
top
 

Response_Filter

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

Benchmark_Job_Response_Group

part of: Get_Benchmark_Jobs_Request, Get_Benchmark_Jobs_Response
Benchmark Job Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Benchmark_Job_Response_Data

part of: Get_Benchmark_Jobs_Response
Benchmark Job Response Data
 
Parameter name Type/Value Cardinality Description Validations
Benchmark_Job  Benchmark_Job  [0..*]  Benchmark Job   
top
 

Benchmark_Job

part of: Benchmark_Job_Response_Data
Benchmark Job
 
Parameter name Type/Value Cardinality Description Validations
Benchmark_Job_Reference  Compensation_Benchmark_DefaultObject  [0..1]  Benchmark Job Reference   
Benchmark_Job_Data  Benchmark_Job_Data  [0..*]  Benchmark Job Data   
top
 

Benchmark_Job_Data

part of: Benchmark_Job
Benchmark Job Data
 
Parameter name Type/Value Cardinality Description Validations
Benchmark_Job_ID  string  [0..1]  Benchmark Job ID   
Effective_Date  date  [0..1]  Use this field to effective date your composite market data. If you "age" your survey data you will use this date to load in the new effective date with the updated amounts.   
Inactive  boolean  [0..1]  Inactive status indicator for Benchmark Job.   
Name  string  [0..1]  The name of the benchmark job. 
Validation Description
The Benchmark Job name provided has already been used.  The Benchmark Job name provided has already been used. 
The Benchmark Job name is required.  The Benchmark Job name is required. 
 
Survey_Date  date  [0..1]  This field is for informational purposes and represents the date specified by the provider for submitting data. This date is often displayed as the effective date of the report. For example, you may load market data as of 1/1/2010 but the survey data is based on 11/1/2009.   
Description  RichText  [0..1]  Enter a description of the Benchmark Job. You can define a summary of the skills required for the Benchmark Job.   
Job_Profile_Reference  Job_ProfileObject  [0..*]  Map Workday Job Profiles to the Benchmark Job. The system will present an error message when the spreadsheet is loaded if one or more Job Profiles is mapped to another Benchmark Job. 
Validation Description
One or more job profiles entered is mapped to another Benchmark Job. You must remove the job profile to save your changes.   
Job profile is a required field. You must enter at least one job profile for the Benchmark Job.  Job profile is a required field. You must enter at least one job profile for the Benchmark Job. 
 
Currency_Reference  CurrencyObject  [0..1]  This value will be applied to the Base Pay Composite and Total Cash Composite categories.   
Frequency_Reference  FrequencyObject  [0..1]  This value will be applied to the Base Pay Composite and Total Cash Composite categories.   
Benchmark_Job_Composite_Replacement_Data  Benchmark_Job_Composite_Data  [0..*]  Benchmark Job Composite Data   
Benchmark_Profile_Data  Compensation_Benchmark_Profile_Data  [0..*]  Benchmark Job Profile Data 
Validation Description
There are duplicate benchmark categories for this Benchmark Job. Please remove duplicate benchmark categories to save your changes.  Benchmark category duplicate validation. 
 
top
 

Job_ProfileObject

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

Job_ProfileObjectID

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

CurrencyObject

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

CurrencyObjectID

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

FrequencyObject

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

FrequencyObjectID

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

Benchmark_Job_Composite_Data

part of: Benchmark_Job_Data, Compensation_Benchmark_Profile_Data
Benchmark Job Composite Data
 
Parameter name Type/Value Cardinality Description Validations
@Delete  boolean  [1..1]  If True, the Benchmark Composite with the matching Category provided will be removed.   
Benchmark_Composite_Category_Reference  Compensation_Benchmark_Composite_CategoryObject  [1..1]  Valid options are "Base Pay Composite" or "Total Cash Composite".   
Competitive_Market_Target_Percentile_Reference  Compensation_Benchmark_PercentileObject  [0..1]  The value entered is what the system will consider your market target. For example, the Competitive Market Target is defined as the 50th percentile and the base salary for the 50th is defined as 45,000. If the Target Spread is 10%, any employee whose base salary is between 42,550 - 47,250 will be considered At Market for this Benchmark Job. 
Validation Description
Select 1 of the category [category] percentiles for the Competitive Market Target: [percentiles].   
 
Target_Spread__  decimal (18, 6) >0   [0..1]  The value entered is used to define what the range is for an employee to be considered At Market. The value entered will be applied to define the bottom and top of the range. For example, the Competitive Market Target is defined as the 50th percentile and the base salary for the 50th is defined as 45,000. If the Target Spread is 10%, any employee whose base salary is between 42,750 - 47,250 will be considered At Market for this Benchmark Job. 
Validation Description
Enter a Target Spread % for [composite] that isn't greater than 100%.   
 
Benchmark_Amount_Replacement_Data  Compensation_Benchmark_Amount_Replacment_Data  [1..*]  Benchmark Amount Data 
Validation Description
There are duplicate benchmark percentiles for this Benchmark Job. Please remove duplicate benchmark percentiles to save your changes.  Benchmark percentile duplicate validation. 
 
top
 

Compensation_Benchmark_Composite_CategoryObject

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

Compensation_Benchmark_Composite_CategoryObjectID

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

Compensation_Benchmark_PercentileObject

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

Compensation_Benchmark_PercentileObjectID

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

Compensation_Benchmark_Amount_Replacment_Data

part of: Benchmark_Job_Composite_Data
Benchmark Job Composite Data
 
Parameter name Type/Value Cardinality Description Validations
Percentile_Reference  Compensation_Benchmark_PercentileObject  [1..1]  Valid options include 5th to 95th percentile, in increments of 5's. For example, 5th, 10th, 15th, 20th, 25th, etc.   
Amount  decimal (26, 6)   [1..1]  The base salary amount that maps to a Benchmark Percentile.   
top
 

Compensation_Benchmark_Profile_Data

part of: Benchmark_Job_Data
Benchmark Job Data
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  You can specify certain criteria such as location to provide more granularity to the base pay or total cash composite for groups of employees.   
Currency_Reference  CurrencyObject  [0..1]  This value will be applied to the Base Pay Composite and Total Cash Composite categories.   
Frequency_Reference  FrequencyObject  [0..1]  This value will be applied to the Base Pay Composite and Total Cash Composite categories.   
Benchmark_Job_Composite_Replacement_Data  Benchmark_Job_Composite_Data  [0..*]  Benchmark Job Composite Data 
Validation Description
There are duplicate benchmark categories for this Benchmark Job. Please remove duplicate benchmark categories to save your changes.  Benchmark category duplicate validation. 
 
top
 

Condition_RuleObject

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

Condition_RuleObjectID

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

Compensation_Benchmark_DefaultReferenceEnumeration

part of: Compensation_Benchmark_DefaultObjectID
Base Type
string
top
 

RichText

part of: Benchmark_Job_Data
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

Compensation_Benchmark_Composite_CategoryReferenceEnumeration

part of: Compensation_Benchmark_Composite_CategoryObjectID
Base Type
string
top
 

Compensation_Benchmark_PercentileReferenceEnumeration

part of: Compensation_Benchmark_PercentileObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top