Service Directory > v32.1 > Financial_Management > Get_Statistic_Definitions
 

Operation: Get_Statistic_Definitions

This service operation will get Statistic Definitions for the specified criteria. Statistics Definition data includes the Name of the definition, Description, Fiscal Schedule, Required Dimensions, whether or not the definition requires Company, Statistic Type and whether or not the definition is Inactive. The request criteria can be for a single object based on Reference, or all data will be retrieved if no criteria is specified.


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

Element for requesting a Statistic Definition
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Statistic_Definition_Request_References  [0..1]  Statistic Definition Request References   
Request_Criteria [Choice]   Statistic_Definition_Request_Criteria  [0..1]  Statistic Definition Request Criteria   
Response_Filter  Response_Filter  [0..1]  Statistic Definition Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Statistic_Definition_Response_Group  [0..1]  Statistic Definition Response Group   
top
 

Response Element: Get_Statistic_Definitions_Response

Element for Statistic Definitions response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Statistic_Definition_Request_References  [0..1]  Statistic Definition Request References   
Request_Criteria  Statistic_Definition_Request_Criteria  [0..1]  Statistic Definition Request Criteria   
Response_Filter  Response_Filter  [0..1]  Statistic Definition Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Statistic_Definition_Response_Group  [0..1]  Statistic Definition Response Group   
Response_Results  Response_Results  [0..1]  Statistic Definition Response Results   
Response_Data  Statistic_Definition_Response_Data  [0..1]  Statistic Definition Response Data   
top
 

Statistic_Definition_Request_References

part of: Get_Statistic_Definitions_Request, Get_Statistic_Definitions_Response
Element containing request references for a Statistic Definition
 
Parameter name Type/Value Cardinality Description Validations
Statistic_Definition_Reference  Statistic_DefinitionObject  [1..*]  Statistic Definition Reference   
top
 

Statistic_DefinitionObject

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

Statistic_DefinitionObjectID

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

Statistic_Definition_Request_Criteria

part of: Get_Statistic_Definitions_Request, Get_Statistic_Definitions_Response
Element containing Statistic Definition request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Statistic_Definitions_Request, Get_Statistic_Definitions_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
 

Statistic_Definition_Response_Group

part of: Get_Statistic_Definitions_Request, Get_Statistic_Definitions_Response
Element containing Statistic Definition response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Statistic_Definition_Response_Data

part of: Get_Statistic_Definitions_Response
Element containing instance and data for Statistic Definition
 
Parameter name Type/Value Cardinality Description Validations
Statistic_Definition  Statistic_Definition  [0..*]  Statistic Definition   
top
 

Statistic_Definition

part of: Statistic_Definition_Response_Data
Element for the statistic definition web service
 
Parameter name Type/Value Cardinality Description Validations
Statistic_Definition_Reference  Statistic_DefinitionObject  [0..1]  Statistic Definition Reference   
Statistic_Definition_Data  Statistic_Definition_Data  [0..1]  Statistic Definition Data 
Validation Description
The definition name must be unique for both Statistic Definitions and Financial Headcount Definitions.  The definition name must be unique for both Statistic Definitions and Financial Headcount Definitions. 
Required Dimensions and Optional Dimensions can't use the same values.   
Cannot remove dimensions when Statistic definition is in use   
 
top
 

Statistic_Definition_Data

part of: Statistic_Definition
Element containing data for a statistic definition
 
Parameter name Type/Value Cardinality Description Validations
Statistic_Definition_ID  string  [0..1]  Statistic Definition ID   
Statistic_Definition_Name  string  [1..1]  Statistic Definition Name   
Statistic_Definition_Description  string  [0..1]  Statistic Definition Description   
Fiscal_Schedule_Reference  Fiscal_ScheduleObject  [1..1]  Fiscal Schedule Reference 
Validation Description
Fiscal Schedule cannot be changed when Statistic Definition included in an Allocation Definition or has Statistics.  Fiscal Schedule cannot be changed when Statistic Definition included in an Allocation Definition or has Statistics. 
 
Required_Dimensions_Reference  Accounting_Worktag_TypeObject  [1..*]  Required Dimensions Reference 
Validation Description
Accounting Worktags set may not be changed once the statistic or headcount definition is associated with an allocation definition.   
At least one Accounting Worktag entered does not meet the criteria of either being an Enabled Worktag, or a Worktag allowed to be included in an Allocation.   
Financial Institution, Intercompany Affiliate, Bank Account and Petty Cash Account are invalid dimensions for allocations.   
You must select all Required Dimensions for the statistic definition.   
 
Optional_Dimensions_Reference  Accounting_Worktag_TypeObject  [0..*]  Optional Dimensions Reference 
Validation Description
Accounting Worktags set may not be changed once the statistic or headcount definition is associated with an allocation definition.  Accounting Worktags set may not be changed once the statistic or headcount definition is associated with an allocation definition. 
Financial Institution, Intercompany Affiliate, Bank Account and Petty Cash Account are invalid dimensions for allocations.  Financial Institution, Intercompany Affiliate, Bank Account and Petty Cash Account are invalid dimensions for allocations. 
At least one Accounting Worktag entered does not meet the criteria of either being an Enabled Worktag, or a Worktag allowed to be included in an Allocation.  At least one Accounting Worktag entered does not meet the criteria of either being an Enabled Worktag, or a Worktag allowed to be included in an Allocation. 
 
Ledger_Budget_Structure_Reference  Financial_Entry_TypeObject  [0..*]  Ledger / Budget Structure Reference 
Validation Description
Cannot remove Ledger Types when Statistic definition is in use   
Cannot remove Budget Structure when Statistic definition is in use   
Only Actuals Ledger type and Financial Budget structures that have the same schedule as fiscal schedule reference and the dimensions reference values as structured dimensions are allowed.   
 
Statistic_Definition_Requires_Company  boolean  [0..1]  Statistic Definition Requires Company 
Validation Description
Includes Company may not be changed if Statistic Definition is already associated with an Allocation.  Includes Company may not be changed if Statistic Definition is already associated with an Allocation. 
Includes Company may not be changed if Statistic Definition is already associated with a Statistic.  Includes Company may not be changed if Statistic Definition is already associated with a Statistic. 
 
Statistic_Type_Reference  Statistic_TypeObject  [1..1]  Statistic Type Reference 
Validation Description
Statistic Type may not be changed if Statistic Definition is associated with an Allocation.  Statistic Type may not be changed if Statistic Definition is associated with an Allocation. 
 
Inactive  boolean  [0..1]  Boolean attribute indicating whether the statistic definition is active or in use. True indicates the statistic definition is Inactive. 
Validation Description
Inactive status entered may not be changed if Statistic Definition is already associated with an Allocation.  Inactive status entered may not be changed if Statistic Definition is already associated with an Allocation. 
 
Validation Description
The definition name must be unique for both Statistic Definitions and Financial Headcount Definitions.  The definition name must be unique for both Statistic Definitions and Financial Headcount Definitions. 
Required Dimensions and Optional Dimensions can't use the same values.   
Cannot remove dimensions when Statistic definition is in use   
top
 

Fiscal_ScheduleObject

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

Fiscal_ScheduleObjectID

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

Accounting_Worktag_TypeObject

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

Accounting_Worktag_TypeObjectID

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

Financial_Entry_TypeObject

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

Financial_Entry_TypeObjectID

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

Statistic_TypeObject

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

Statistic_TypeObjectID

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

Statistic_DefinitionReferenceEnumeration

part of: Statistic_DefinitionObjectID
Base Type
string
top
 

Fiscal_ScheduleReferenceEnumeration

part of: Fiscal_ScheduleObjectID
Base Type
string
top
 

Accounting_Worktag_TypeReferenceEnumeration

part of: Accounting_Worktag_TypeObjectID
Base Type
string
top
 

Financial_Entry_TypeReferenceEnumeration

part of: Financial_Entry_TypeObjectID
Base Type
string
top
 

Statistic_TypeReferenceEnumeration

part of: Statistic_TypeObjectID
Base Type
string
top