Service Directory > v32.1 > Compensation > Get_Compensation_Scorecard_Results
 

Operation: Get_Compensation_Scorecard_Results

This operation allows the retrieval of one or more scorecard results


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

Contains the request details to retrieve one or more scorecard results.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Compensation_Scorecard_Result_Request_References  [0..1]  A container for one or more unique scorecard result identifiers.   
Request_Criteria [Choice]   Compensation_Scorecard_Result_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_Result_Response_Group  [0..1]  Contains additional response criteria to enhance the information returned.   
top
 

Response Element: Get_Compensation_Scorecard_Results_Response

Contains the response details to retrieve one or more scorecard results.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Compensation_Scorecard_Result_Request_References  [0..1]  A container for one or more unique scorecard result identifiers.   
Request_Criteria  Compensation_Scorecard_Result_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_Result_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_Result_Response_Data  [0..1]  Contains the scorecard result response information. This includes the unique scorecard result identifier and the detailed scorecard result data which was added or updated.   
top
 

Compensation_Scorecard_Result_Request_References

part of: Get_Compensation_Scorecard_Results_Request, Get_Compensation_Scorecard_Results_Response
A container for one or more unique scorecard result identifiers.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Scorecard_Result_Reference  Scoreset_ContainerObject  [1..*]  One or more unique scorecard result identifiers.   
top
 

Scoreset_ContainerObject

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

Scoreset_ContainerObjectID

part of: Scoreset_ContainerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Compensation_Performance_Scorecard_Result_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, Performance_Scorecard_ID  [1..1]  The unique identifier type of a parent object   
top
 

Compensation_Scorecard_Result_Request_Criteria

part of: Get_Compensation_Scorecard_Results_Request, Get_Compensation_Scorecard_Results_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_Scorecard_Results_Request, Get_Compensation_Scorecard_Results_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_Result_Response_Group

part of: Get_Compensation_Scorecard_Results_Request, Get_Compensation_Scorecard_Results_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_Scorecard_Results_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_Result_Response_Data

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

Compensation_Scorecard_Result

part of: Compensation_Scorecard_Result_Response_Data
Contains the scorecard result response information. This includes the unique scorecard result identifier and the detailed scorecard result data which was added or updated.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Scorecard_Result_Reference  Scoreset_ContainerObject  [0..1]  A unique scorecard result identifier.   
Compensation_Scorecard_Result_Data  Compensation_Scorecard_Result_Data  [0..*]  Contains the detailed scorecard result information.   
top
 

Compensation_Scorecard_Result_Data

part of: Compensation_Scorecard_Result
Contains the detailed scorecard result information.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  A unique scorecard result identifier.   
Evaluation_Date  date  [1..1]  The date the scorecard was scored with this result.   
Compensation_Scorecard_Reference  Default_ScorecardObject  [1..1]  A unique scorecard reference. 
Validation Description
Scorecard result must have the same goals as the scorecard.   
Scorecard result must have the same eligibility rules as the scorecard.   
 
Scorecard_Result_Data  Scorecard_Result_Data  [1..*]  Contains the set of goals and goal values for this result.   
Profile_Scorecard_Result_Data  Profile_Compensation_Scorecard_Result_Data  [0..*]  Contains a rule/profile delineated set of goals and goal values for this result.   
top
 

Default_ScorecardObject

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

Scorecard_Result_Data

part of: Compensation_Scorecard_Result_Data
Contains the set of goals and goal values for this result.
 
Parameter name Type/Value Cardinality Description Validations
Goal_Reference  Performance_CriteriaObject  [1..1]  A unique performance goal reference. 
Validation Description
[Goal] is an invalid goal for [Scorecard] scorecard.   
 
Achievement  decimal (12, 6) >0   [0..1]  A numeric value indicating the level of achievement against the related performance goal.   
top
 

Performance_CriteriaObject

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

Performance_CriteriaObjectID

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

Profile_Compensation_Scorecard_Result_Data

part of: Compensation_Scorecard_Result_Data
Contains a rule/profile delineated set of goals and goal values for this result.
 
Parameter name Type/Value Cardinality Description Validations
Eligibility_Rule_Reference  Condition_RuleObject  [1..1]  A unique eligibility rule reference. The rule delineates results by how a worker matches the rule evaluation. 
Validation Description
[condition rule] is an invalid eligibility rule for [default scorecard] scorecard.   
Scorecard result must have the same goals as the [scorecard] - [condition rule] scorecard.   
 
Scorecard_Result_Data  Profile_Scorecard_Result_Data  [1..*]  Contains the set of goals and goal values for this result.   
top
 

Condition_RuleObject

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

Profile_Scorecard_Result_Data

part of: Profile_Compensation_Scorecard_Result_Data
Contains the set of goals and goal values for this result.
 
Parameter name Type/Value Cardinality Description Validations
Goal_Reference  Performance_CriteriaObject  [1..1]  A unique performance goal reference. 
Validation Description
[Goal] is an invalid goal for [Scorecard] - [Condition Rule] scorecard   
 
Achievement  decimal (12, 6) >0   [0..1]  A numeric value indicating the level of achievement against the related performance goal.   
top
 

Scoreset_ContainerReferenceEnumeration

part of: Scoreset_ContainerObjectID
Base Type
string
top
 

Base Type
string

top
 

Default_ScorecardReferenceEnumeration

part of: Default_ScorecardObjectID
Base Type
string
top
 

Performance_CriteriaReferenceEnumeration

part of: Performance_CriteriaObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top