Service Directory > v33.1 > Compensation > Get_Compensation_Survey_Job_Matches
 

Operation: Get_Compensation_Survey_Job_Matches

This service retrieves Compensation Survey Jobs with Matches from the system.


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

Request element for Get Compensation Survey Job Matches web service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Compensation_Survey_Jobs_Request_References  [1..1]  Compensation survey reference element.   
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_Group  Compensation_Survey_Job_Matches_Response_Group  [0..1]  Allows grouping results for Get Compensation Survey Job Matches web service.   
top
 

Response Element: Get_Compensation_Survey_Job_Matches_Response

Response element for Get Compensation Survey Job Matches web service.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Compensation_Survey_Jobs_Request_References  [0..1]  Compensation survey reference element.   
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_Group  Compensation_Survey_Job_Matches_Response_Group  [0..1]  Allows grouping results for Get Compensation Survey Job Matches web service.   
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  Compensation_Survey_Job_Matches_Response_Data  [0..1]  Response data element for Get Compensation Survey Job Matches web service.   
top
 

Compensation_Survey_Jobs_Request_References

part of: Get_Compensation_Survey_Job_Matches_Request, Get_Compensation_Survey_Job_Matches_Response
Compensation survey reference element
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Survey_Reference  Compensation_SurveyObject  [1..*]  The instance of compensation survey that the data will be applied to.   
top
 

Compensation_SurveyObject

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

Compensation_SurveyObjectID

part of: Compensation_SurveyObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Compensation_Survey_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_Compensation_Survey_Job_Matches_Request, Get_Compensation_Survey_Job_Matches_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, become effective (Also referred to as the Effective Moment). If you don't specify a date, this date defaults to today.{+4}   
As_Of_Entry_DateTime  dateTime  [0..1]  The date and time the data was entered into the system. (This field is also referred to as the Entry Moment). If the date isn't specified, the default date is the current date and time.   
Page  decimal (12, 0) >0   [0..1]  The numbered page of data Workday returns in the response. The default page is 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. Set a value between 1 and 999. The default value is 100.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Compensation_Survey_Job_Matches_Response_Group

part of: Get_Compensation_Survey_Job_Matches_Request, Get_Compensation_Survey_Job_Matches_Response
Allows grouping results for Get Compensation Survey Job Matches web service.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Indicates reference included.   
top
 

Response_Results

part of: Get_Compensation_Survey_Job_Matches_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 your request returned.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages requested. A page of data in a WWS has a 100 entry maximum.   
Page_Results  decimal (12, 0) >0   [0..1]  The number of results in the current page.   
Page  decimal (12, 0) >0   [0..1]  The page number of the data the WWS returned for your request.   
top
 

Compensation_Survey_Job_Matches_Response_Data

part of: Get_Compensation_Survey_Job_Matches_Response
Response data element for Get Compensation Survey Job Matches web service.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Survey_Job_Matches  Compensation_Survey_With_Matches  [0..*]  Compensation survey element.   
top
 

Compensation_Survey_With_Matches

part of: Compensation_Survey_Job_Matches_Response_Data
Compensation survey element.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Survey_Reference  Compensation_SurveyObject  [0..1]  The instance of compensation survey that the data will be applied to.   
Compensation_Survey_Job_Matches_Data  Compensation_Survey_With_Matches_Data  [0..1]  Element to specify the data for survey to put/update.   
top
 

Compensation_Survey_With_Matches_Data

part of: Compensation_Survey_With_Matches
Element to specify the data for survey to put/update.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Survey_ID  string  [0..1]  Retrieve the Reference ID of the compensation survey and optionally replace.   
Survey_Date  date  [0..1]  Date when the compensation survey is offered, often also the date when the job catalog is provided for the survey.   
Survey_Name  string  [0..1]  Name of a compensation survey, which may include survey year, vendor, and product.   
Survey_Eligibility_Rule_Reference  Condition_RuleObject  [0..*]  Eligibility rules for the compensation survey. The compensation survey applies only to workers, positions, or job requisitions that pass one of the eligibility rules.   
Survey_Product_Reference  Compensation_Survey_ProductObject  [0..1]  Product that a survey belongs to, such as technology survey or sales survey.   
Survey_Job  Compensation_Survey_Job_With_Matches  [1..*]  Data element for survey job and job code.   
top
 

Condition_RuleObject

part of: Compensation_Survey_With_Matches_Data, Compensation_Survey_Job_Match_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_Survey_ProductObject

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

Compensation_Survey_ProductObjectID

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

part of: Compensation_Survey_With_Matches_Data
Data element for survey job and job code.
 
Parameter name Type/Value Cardinality Description Validations
Job_Code  string  [1..1]  Job code of a job in a compensation survey. 
Validation Description
Job code [job_code] not found in this survey.   
 
Job_Detail  Compensation_Survey_Job_Detail_With_Matches_Data  [1..*]  Reference of the survey job with job title and possibly level, function, or family.   
top
 

Compensation_Survey_Job_Detail_With_Matches_Data

part of: Compensation_Survey_Job_With_Matches
Data element with survey job title, level, function, or family.
 
Parameter name Type/Value Cardinality Description Validations
Job_Detail_Reference  Compensation_Survey_Job_DetailObject  [1..1]  Reference ID for the survey job with job title and possibly level, function, or family.   
Job_Title  string  [0..1]  Job title of a job in a compensation survey.   
Level  string  [0..1]  Job level of a job in a compensation survey.   
Job_Description  string  [0..1]  Job description of a job in a compensation survey.   
Function  string  [0..1]  Functional area of a job in a compensation survey.   
Family  string  [0..1]  Job family of a job in the compensation survey, usually referring to the group of jobs with similar title but different levels.   
Job_Match  Compensation_Survey_Job_Match_Data  [0..*]  Data element for compensation survey job match. 
Validation Description
Duplicate job matches found for [job_detail_ref_id][job_sub_detail_ref_id]. Please remove duplicates.   
 
Job_Sub-Detail  Compensation_Survey_Job_Sub-Detail_With_Matches_Data  [0..*]  Survey job sub detail.   
top
 

Compensation_Survey_Job_DetailObject

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

Compensation_Survey_Job_DetailObjectID

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

part of: Compensation_Survey_Job_Sub-Detail_With_Matches_Data, Compensation_Survey_Job_Detail_With_Matches_Data
Data element for compensation survey job match.
 
Parameter name Type/Value Cardinality Description Validations
Job_Profile  Job_Profile_for_Compensation_Survey_Job_Match  [1..1]  Data element for job profile for compensation survey job match.   
Note  string  [0..1]  Note for the compensation survey job match.   
Eligibility_Rule_Reference  Condition_RuleObject  [0..*]  Eligibility rules for the compensation survey job match. Workday matches only workers, positions, or job requisitions passing one of the eligibility rules to the survey job.   
Do_Not_Send_to_Survey  boolean  [0..1]  Yes indicates that compensation data for this job match won't be sent to the compensation survey. No or blank indicates that data is sent to the compensation survey.   
Validation Description
Duplicate job matches found for [job_detail_ref_id][job_sub_detail_ref_id]. Please remove duplicates.   
top
 

Job_Profile_for_Compensation_Survey_Job_Match

part of: Compensation_Survey_Job_Match_Data
Data element for job profile for compensation survey job match.
 
Parameter name Type/Value Cardinality Description Validations
Job_Profile_Reference  Job_ProfileObject  [1..1]  Reference of job profile in Workday for the compensation survey job match.   
Job_Profile_Name  string  [0..1]  Name of job profile in Workday for the compensation survey job match.   
top
 

Job_ProfileObject

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

Compensation_Survey_Job_Sub-Detail_With_Matches_Data

part of: Compensation_Survey_Job_Detail_With_Matches_Data
Data element with further details of a survey job, such as specialty.
 
Parameter name Type/Value Cardinality Description Validations
Job_Sub-Detail_Reference  Compensation_Survey_Job_Sub-DetailObject  [1..1]  Reference of further details of a survey job, such as specialty.   
Specialty  string  [0..1]  Specialized area of a survey job.   
Job_Match  Compensation_Survey_Job_Match_Data  [0..*]  Data element for compensation survey job match. 
Validation Description
Duplicate job matches found for [job_detail_ref_id][job_sub_detail_ref_id]. Please remove duplicates.   
 
top
 

Compensation_Survey_Job_Sub-DetailObject

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

Compensation_Survey_Job_Sub-DetailObjectID

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

part of: Compensation_SurveyObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

Compensation_Survey_ProductReferenceEnumeration

part of: Compensation_Survey_ProductObjectID
Base Type
string
top
 

Compensation_Survey_Job_DetailReferenceEnumeration

part of: Compensation_Survey_Job_DetailObjectID
Base Type
string
top
 

Job_ProfileReferenceEnumeration

part of: Job_ProfileObjectID
Base Type
string
top
 

Compensation_Survey_Job_Sub-DetailReferenceEnumeration

part of: Compensation_Survey_Job_Sub-DetailObjectID
Base Type
string
top