Service Directory > v31.2 > Financial_Management > Get_Allocation_Group_Sets
 

Operation: Get_Allocation_Group_Sets

This service will get Allocation Group Sets


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

Request element used to find and get Allocation Group Sets
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Allocation_Group_Set_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Allocation Group Set and its associated data.   
Request_Criteria [Choice]   Allocation_Group_Set_Request_Criteria  [0..1]  Use the following element to find allocation definitions in the Workday system.   
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  Allocation_Group_Set_Response_Group  [0..1]  Contains Allocation Group Set Definition Response Group.   
top
 

Response Element: Get_Allocation_Group_Sets_Response

Response element containing instances of Allocation Group Set and associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Allocation_Group_Set_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) of Allocation Group Set Definition a   
Request_Criteria  Allocation_Group_Set_Request_Criteria  [0..1]  Use the following element to find allocation group sets in the Workday system.   
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  Allocation_Group_Set_Response_Group  [0..1]  Contains Allocation Group Set Response Group.   
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  Allocation_Group_Set_Response_Data  [0..1]  Contains each Allocation Group Set based on the Request References or Request Criteria.   
top
 

Allocation_Group_Set_Request_References

part of: Get_Allocation_Group_Sets_Request, Get_Allocation_Group_Sets_Response
Utilize the Request References element to retrieve a specific instance(s) of Allocation Group Set Definition a
 
Parameter name Type/Value Cardinality Description Validations
Allocation_Group_Set_Reference  Allocation_Group_SetObject  [1..*]  A Reference to the Allocation Group Set Definition.   
top
 

Allocation_Group_SetObject

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

Allocation_Group_SetObjectID

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

Allocation_Group_Set_Request_Criteria

part of: Get_Allocation_Group_Sets_Request, Get_Allocation_Group_Sets_Response
Use the following element to find allocation group sets in the Workday system.
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Allocation_Group_Sets_Request, Get_Allocation_Group_Sets_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
 

Allocation_Group_Set_Response_Group

part of: Get_Allocation_Group_Sets_Request, Get_Allocation_Group_Sets_Response
Contains Allocation Group Set Response Group.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag to include the Allocation Group Set Reference ID.   
top
 

Response_Results

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

Allocation_Group_Set_Response_Data

part of: Get_Allocation_Group_Sets_Response
Contains each Allocation Group Set based on the Request References or Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
Allocation_Group_Set  Allocation_Group_Set  [0..*]  Encapsulating element containing all Allocation Group Set data.   
top
 

Allocation_Group_Set

part of: Allocation_Group_Set_Response_Data
Encapsulating element containing all Allocation Group Set data.
 
Parameter name Type/Value Cardinality Description Validations
Allocation_Group_Set_Reference  Allocation_Group_SetObject  [0..1]  A Reference to the Allocation Group Set instance   
Allocation_Group_Set_Data  Allocation_Group_Set_Data  [0..1]  Contains the detailed information about an Allocation Group Set 
Validation Description
Enter an Allocation Group Set Name that isn't already in use.  The allocation group set name has already been used. 
All companies on Allocation Group Set must share the same Fiscal Schedule.  All companies on Allocation Group Set must share the same Fiscal Schedule. 
Fiscal Schedule of the Fiscal Summary Schedule must match the Fiscal Schedule of the companies on the Allocation Group Set.   
Fiscal Summary Interval is not allowed unless the time frame is Summary.  Fiscal Summary Interval is not allowed unless the time frame is Summary. 
Fiscal Summary Schedule is required if Time Frame is summary.   
Enter the Actuals ledger or a financial budget structure for the company.   
Only one value is allowed when Actuals or Budget Structure with Custom Period is selected.   
Reference IDs for Allocation Groups must be unique.  Reference IDs for Allocation Groups must be unique. 
Dependent Allocation Groups must be part of the Allocation Group Set.  Dependent Allocation Groups must be part of the Allocation Group Set. 
 
top
 

Allocation_Group_Set_Data

part of: Allocation_Group_Set
Contains the detailed information about an Allocation Group Set
 
Parameter name Type/Value Cardinality Description Validations
Allocation_Group_Set_ID  string  [0..1]  The ID for Allocation Group Set   
Allocation_Group_Set_Name  string  [1..1]  Text attribute identifying Allocation Group Set Name   
Allocation_Group_Set_Description  string  [0..1]  Text attribute identifying Allocation Group Set description   
Organization_Reference  OrganizationObject  [1..*]  A Reference to the Organization used by the Group Set   
Allocation_Time_Frame_Reference  Financial_Time_FrameObject  [1..1]  A Reference to the Financial Time Frame used by the Group Set   
Fiscal_Summary_Schedule_Reference  Fiscal_Summary_ScheduleObject  [0..1]  A Reference to the Fiscal Summary Schedule used by the Group Set   
Ledger_or_Budget_Structure_Reference  Financial_Entry_TypeObject  [0..*]  A Reference to the Ledger or Budget Structure used by the Group Set   
Inactive  boolean  [0..1]  A flag to determine if this Allocation Group Set is active or not.   
Allocation_Group_Data  Allocation_Group_Subedit_Data  [0..*]  Encapsulates the Allocation Group Data 
Validation Description
The Allocation Group ID provided does not belong to the Allocation Group Set  The Allocation Group ID provided does not belong to the Allocation Group Set 
An Allocation Group cannot be dependent on itself.  An Allocation Group cannot be dependent on itself. 
Dependent allocation definitions must belong to the same allocation group.  Dependent allocation definitions must belong to the same allocation group. 
 
Validation Description
Enter an Allocation Group Set Name that isn't already in use.  The allocation group set name has already been used. 
All companies on Allocation Group Set must share the same Fiscal Schedule.  All companies on Allocation Group Set must share the same Fiscal Schedule. 
Fiscal Schedule of the Fiscal Summary Schedule must match the Fiscal Schedule of the companies on the Allocation Group Set.   
Fiscal Summary Interval is not allowed unless the time frame is Summary.  Fiscal Summary Interval is not allowed unless the time frame is Summary. 
Fiscal Summary Schedule is required if Time Frame is summary.   
Enter the Actuals ledger or a financial budget structure for the company.   
Only one value is allowed when Actuals or Budget Structure with Custom Period is selected.   
Reference IDs for Allocation Groups must be unique.  Reference IDs for Allocation Groups must be unique. 
Dependent Allocation Groups must be part of the Allocation Group Set.  Dependent Allocation Groups must be part of the Allocation Group Set. 
top
 

OrganizationObject

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

OrganizationObjectID

part of: OrganizationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Company_Reference_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Organization_Reference_ID, Region_Reference_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_Time_FrameObject

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

Financial_Time_FrameObjectID

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

Fiscal_Summary_ScheduleObject

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

Fiscal_Summary_ScheduleObjectID

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

Financial_Entry_TypeObject

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

Allocation_Group_Subedit_Data

part of: Allocation_Group_Set_Data
Encapsulates the Allocation Group Data
 
Parameter name Type/Value Cardinality Description Validations
Allocation_Group_ID  string  [0..1]  The ID for the Allocation Group   
Order  string (6)   [1..1]  Text Attribute identifying Allocation Group Set Order   
Allocation_Group_Set_Name  string  [1..1]  Text Attribute identifying Allocation Group Name   
Allocation_Group_Dependency_ID  string  [0..1]  Text Attribute Identifying Allocation Group Dependency ID   
Allocation_Group_Line_Data  Allocation_Group_Line_Subedit_Data  [0..*]  Encapsulates the Allocation Group Set Line Data 
Validation Description
Allocation Definition is not valid for Company : [company]   
Allocation Definitions can only be included on one active Allocation Group Set   
 
Validation Description
The Allocation Group ID provided does not belong to the Allocation Group Set  The Allocation Group ID provided does not belong to the Allocation Group Set 
An Allocation Group cannot be dependent on itself.  An Allocation Group cannot be dependent on itself. 
Dependent allocation definitions must belong to the same allocation group.  Dependent allocation definitions must belong to the same allocation group. 
top
 

Allocation_Group_Line_Subedit_Data

part of: Allocation_Group_Subedit_Data
Encapsulates Allocation Group Line Data
 
Parameter name Type/Value Cardinality Description Validations
Allocation_Group_Line_ID  string  [0..1]  The ID For the Line Allocation Group   
Display_Order  string (6)   [1..1]  Text attribute identifying the Order of the Allocation Group   
Allocation_Definition_Reference  Allocation_DefinitionObject  [1..1]  A Reference to the Allocation Definition used in the Allocation Group   
Dependent_Allocation_Definition_Reference  Allocation_DefinitionObject  [0..*]  A Reference to the Dependent Allocation Definition   
Budget_Structure_Reference  Budget_StructureObject  [0..1]  A Reference to the Budget Structure used by the Allocation Group Line   
Validation Description
Allocation Definition is not valid for Company : [company]   
Allocation Definitions can only be included on one active Allocation Group Set   
top
 

Allocation_DefinitionObject

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

Allocation_DefinitionObjectID

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

Budget_StructureObject

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

Budget_StructureObjectID

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

Allocation_Group_SetReferenceEnumeration

part of: Allocation_Group_SetObjectID
Base Type
string
top
 

OrganizationReferenceEnumeration

part of: OrganizationObjectID
Base Type
string
top
 

Financial_Time_FrameReferenceEnumeration

part of: Financial_Time_FrameObjectID
Base Type
string
top
 

Fiscal_Summary_ScheduleReferenceEnumeration

part of: Fiscal_Summary_ScheduleObjectID
Base Type
string
top
 

Financial_Entry_TypeReferenceEnumeration

part of: Financial_Entry_TypeObjectID
Base Type
string
top
 

Allocation_DefinitionReferenceEnumeration

part of: Allocation_DefinitionObjectID
Base Type
string
top
 

Budget_StructureReferenceEnumeration

part of: Budget_StructureObjectID
Base Type
string
top