Service Directory > v32.1 > Financial_Management > Put_Statistic_Definition
 

Operation: Put_Statistic_Definition

This service operation will add or update Statistic Definitions. Data includes: Name of the definition, Description, Fiscal Schedule, Required Dimensions, a boolean attribute that indicates whether or not the definition requires Company, Statistic Type and whether or not the definition is Inactive.


@ - 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: Put_Statistic_Definition_Request

Element for the Statistic Definition put request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Statistic_Definition_Reference  Statistic_DefinitionObject  [0..1]  A Unique reference ID for the Statistic Definition.   
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   
 
Validation Description
Statistic definition already exists.   
top
 

Response Element: Put_Statistic_Definition_Response

Element containing the response for a Statistic Definition
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Statistic_Definition_Reference  Statistic_DefinitionObject  [0..1]  Statistic Definition Reference   
top
 

Statistic_DefinitionObject

part of: Put_Statistic_Definition_Request, Put_Statistic_Definition_Response
 
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_Data

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