Service Directory > v31.2 > Compensation > Get_Compensation_Scorecards
 

Operation: Get_Compensation_Scorecards

This operation allows the retrieval of one or more scorecards.


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

Contains the request details to retrieve one or more scorecards.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Compensation_Scorecard_Request_References  [0..1]  A container for one or more unique scorecard identifiers.   
Request_Criteria [Choice]   Compensation_Scorecard_Request_Criteria  [0..1]  Contains additional request criteria to limit the information returned. Currently no additional criteria is supported.   
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_Scorecard_Response_Group  [0..1]  Contains additional response criteria to enhance the information returned.   
top
 

Response Element: Get_Compensation_Scorecards_Response

Contains the response details to retrieve one or more scorecard.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Compensation_Scorecard_Request_References  [0..1]  A container for one or more unique scorecard identifiers.   
Request_Criteria  Compensation_Scorecard_Request_Criteria  [0..1]  Contains additional request criteria to limit the information returned. Currently no additional criteria is supported.   
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_Scorecard_Response_Group  [0..1]  Contains additional response criteria to enhance the information returned.   
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_Scorecard_Response_Data  [0..1]  Contains the scorecard response information. This includes the unique scorecard identifier and the detailed scorecard data which was added or updated.   
top
 

Compensation_Scorecard_Request_References

part of: Get_Compensation_Scorecards_Request, Get_Compensation_Scorecards_Response
A container for one or more unique scorecard identifiers.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Scorecard_Reference  Default_ScorecardObject  [1..*]  One or more unique scorecard identifiers.   
top
 

Default_ScorecardObject

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

Default_ScorecardObjectID

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

part of: Get_Compensation_Scorecards_Request, Get_Compensation_Scorecards_Response
Contains additional request criteria to limit the information returned. Currently no additional criteria is supported.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Compensation_Scorecards_Request, Get_Compensation_Scorecards_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
 

Compensation_Scorecard_Response_Group

part of: Get_Compensation_Scorecards_Request, Get_Compensation_Scorecards_Response
Contains additional response criteria to enhance the information returned.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  When True, unique reference identifiers will be returned for all relevant objects.   
top
 

Response_Results

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

Compensation_Scorecard_Response_Data

part of: Get_Compensation_Scorecards_Response
Contains the scorecard response information. This includes the unique scorecard identifier and the detailed scorecard data which was added or updated.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Scorecard  Compensation_Scorecard  [0..*]  Contains scorecard data.   
top
 

Compensation_Scorecard

part of: Compensation_Scorecard_Response_Data
Contains scorecard data.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Scorecard_Reference  Default_ScorecardObject  [0..1]  Reference to scorecard.   
Compensation_Scorecard_Data  Compensation_Scorecard_Data  [0..*]  Contains scorecard data. 
Validation Description
The sum of the goal weightings must equal 100%.   
 
top
 

Compensation_Scorecard_Data

part of: Compensation_Scorecard
Contains scorecard data.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  A unique scorecard identifier.   
Effective_Date  date  [1..1]  The effective date of the scorecard.   
Scorecard_Name  string  [1..1]  The name of the scorecard. 
Validation Description
Scorecard Name entered has already been used.  Scorecard Name already entered. 
 
Scorecard_Description  string  [0..1]  Description of the scorecard.   
Scorecard_Goals_Data  Performance_Criteria_Data  [1..*]  Performance criteria for scorecard.   
Scorecard_Profile_Data  Scorecard_Profile_Data  [0..*]  Contains a rule/profile delineated set of goals. 
Validation Description
The sum of the goal weightings must equal 100%.   
 
Validation Description
The sum of the goal weightings must equal 100%.   
top
 

Performance_Criteria_Data

part of: Compensation_Scorecard_Data
Contains information on scorecard.
 
Parameter name Type/Value Cardinality Description Validations
Goal_ID  string  [0..1]  Unique identifier   
Goal_Name  string  [1..1]  Name of criteria.   
Goal_Description  string  [0..1]  Description of criteria.   
Goal_Weight  decimal (10, 4)   [1..1]  Weight of criieria.   
top
 

Scorecard_Profile_Data

part of: Compensation_Scorecard_Data
Contains scorecard data.
 
Parameter name Type/Value Cardinality Description Validations
Scorecard_Profile_ID  string  [0..1]  Unique identifier   
Scorecard_Profile_Target__Rule_Reference  Condition_RuleObject  [1..1]  A unique eligibility rule reference. The rule delineates results by how a worker matches the rule evaluation.   
Scorecard_Profile_Goal_Data  Scorecard_Profile_Performance_Criteria_Data  [1..*]  Contains set of goals and goal values that apply to the eligibility rule.   
Validation Description
The sum of the goal weightings must equal 100%.   
top
 

Condition_RuleObject

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

Scorecard_Profile_Performance_Criteria_Data

part of: Scorecard_Profile_Data
Contains set of goals or criteria.
 
Parameter name Type/Value Cardinality Description Validations
Scorecard_Profile_Goal_ID  string  [0..1]  Unique identifier   
Scorecard_Profile_Goal_Name  string  [1..1]  Name of Ccriteria.   
Scorecard_Profile_Goal_Description  string  [0..1]  Description of criteria.   
Scorecard_Profile_Goal_Weight  decimal (10, 4)   [1..1]  Weight of criteria.   
top
 

Default_ScorecardReferenceEnumeration

part of: Default_ScorecardObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top