Service Directory > v31.2 > Workforce_Planning > Get_Headcount_Plan_Structures__Do_Not_Use_
 

Operation: Get_Headcount_Plan_Structures__Do_Not_Use_

Returns the Headcount Plan Structures based on the references and criteria 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_Headcount_Plan_Structures_Request

Request element to get Headcount Plan Structures and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Headcount_Plan_Structure_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) or Headcount Plan Structure and its associated data.   
Response_Filter  Response_Filter  [0..1]  The "Response_Filter" element contains common WWS information that allows you control the response data that you will be provided including As_Of_Date, As_Of_Entry_Moment, and Page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Headcount_Plan_Structures_Response

Response element containing instances of Headcount Plan Structures and their associated data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Headcount_Plan_Structure_Request_References  [0..1]  Utilize the Request References element to retrieve a specific instance(s) or Headcount Plan Structure and its associated data.   
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_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  Headcount_Plan_Structure_Response_Data  [0..1]  Contains each Headcount Plan Structure based on the Request References.   
top
 

Headcount_Plan_Structure_Request_References

part of: Get_Headcount_Plan_Structures_Request, Get_Headcount_Plan_Structures_Response
Utilize the Request References element to retrieve a specific instance(s) or Headcount Plan Structure and its associated data.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Structure_Reference  Headcount_Plan_StructureObject  [1..*]  A unique identifier for a Headcount Plan Structure.   
top
 

Headcount_Plan_StructureObject

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

Headcount_Plan_StructureObjectID

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

Response_Filter

part of: Get_Headcount_Plan_Structures_Request, Get_Headcount_Plan_Structures_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
 

Response_Results

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

Headcount_Plan_Structure_Response_Data

part of: Get_Headcount_Plan_Structures_Response
Contains each Headcount Plan Structure based on the Request References.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Structure  Headcount_Plan_Structure  [0..*]  Contains data for a Headcount Plan Structure.   
top
 

Headcount_Plan_Structure

part of: Headcount_Plan_Structure_Response_Data
Contains the Headcount Plan Structure reference and data for the Headcount Plan Structure.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Structure_Reference  Headcount_Plan_StructureObject  [0..1]  Unique identifier for a Headcount Plan Structure.   
Headcount_Plan_Structure_Data  Headcount_Plan_Structure_Data  [0..*]  Contains data for a Headcount Plan Structure. 
Validation Description
Headcount Plan Structure Schedule Data is Required if Add Only is True.  Headcount Plan Structure Schedule Data is Required if Add Only is True. 
 
top
 

Headcount_Plan_Structure_Data

part of: Headcount_Plan_Structure
Contains the details of a Headcount Plan Structure.
 
Parameter name Type/Value Cardinality Description Validations
Headcount_Plan_Structure_ID  string  [0..1]  A unique identifier for a Headcount Plan Structure.   
Headcount_Plan_Structure_Name  string  [0..1]  The Name of the Headcount Plan Structure. 
Validation Description
Enter a unique Name. The name [name] is already in use.  The Headcount Plan Structure Name is already in use. 
Headcount Plan Name is Required if Add Only is True.  Headcount Plan Name is Required if Add Only is True. 
 
Link_to_Financial_Budget  boolean  [0..1]  Select this box if you would like to link your headcount plan to a financial budget. This will require you to use the existing fiscal schedule used for your financial budget and to select Company as a dimension for your headcount plan. 
Validation Description
In order to integrate with a financial budget, you need to select company as one of your dimensions.  In order to integrate with a financial budget, you need to select company as one of your dimensions. 
 
Statistic_Type_Reference  Budget_Statistic_TypeObject  [0..*]  The statistic types that the Headcount Plan Structure is planned by - FTE and/or Headcount. 
Validation Description
Statistic Type is Required if Add Only is True.  Statistic Type is Required if Add Only is True. 
 
Dimension_Reference  Worktag_and_Aggregation_TypeObject  [0..*]  Dimensions for the Headcount Plan Structure. 
Validation Description
The number of Dimensions chosen cannot be greater than 5.   
At least one of the Dimensions selected is invalid. If you are using Custom Organization Worktags or Custom Worktags as Dimensions, please verify that they are enabled for HR Usage.   
 
Headcount_Plan_Structure_Schedule_Data  Headcount_Plan_Structure_Schedule_Data  [0..*]  Contains the data for the Headcount Plan S 
Validation Description
Summary Schedule [summary schedule] not valid for Schedule [fiscal schedule]  Summary Schedule not valid for Schedule. 
Headcount Plan Structure is in use and cannot be updated  Headcount Plan Structure is in use and cannot be updated 
The current number of headcount plan periods ([number]) exceeds the maximum of 36. Reduce the number of periods by changing the entry interval or the plan time frame.   
 
Validation Description
Headcount Plan Structure Schedule Data is Required if Add Only is True.  Headcount Plan Structure Schedule Data is Required if Add Only is True. 
top
 

Budget_Statistic_TypeObject

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

Budget_Statistic_TypeObjectID

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

Worktag_and_Aggregation_TypeObject

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

Worktag_and_Aggregation_TypeObjectID

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

Headcount_Plan_Structure_Schedule_Data

part of: Headcount_Plan_Structure_Data
Contains the data for the Headcount Plan S
 
Parameter name Type/Value Cardinality Description Validations
Fiscal_Schedule_Reference  Fiscal_ScheduleObject  [0..1]  Contains the schedule data for a Headcount Plan Structure. 
Validation Description
Your fiscal schedule should be one that is associated with a company because you have chosen to integrate with financial business plan.  Your fiscal schedule should be one that is associated with a company because you have chosen to integrate with financial business plan. 
Schedule is Required if Add Only is True.  Schedule is Required if Add Only is True. 
 
Plan_by_Period [Choice]   boolean  [1..1]  Headcount Plans using this Headcount Plan Structure will be planned by Period.   
Fiscal_Summary_Schedule_Reference [Choice]   Fiscal_Summary_ScheduleObject  [1..1]  Headcount Plans using this Headcount Plan Structure will be planned by the Fiscal Summary Schedule Referenced.   
Plan_by_Duration [Choice]   boolean  [1..1]  Headcount Plans using this Headcount Plan Structure will be planned by Fiscal Year Duration.   
Number_of_Fiscal_Years_in_a_Plan [Choice]   decimal (12, 0) >0   [1..1]  Headcount Plans using this Headcount Plan Structure will have the duration of the Number of Fiscal Years in a Plan.   
Custom_Entry_Period [Choice]   boolean  [1..1]  Headcount Plans using this Headcount Plan Structure will have the duration specified by the Start/End Year and Start/End Entry Period.   
Validation Description
Summary Schedule [summary schedule] not valid for Schedule [fiscal schedule]  Summary Schedule not valid for Schedule. 
Headcount Plan Structure is in use and cannot be updated  Headcount Plan Structure is in use and cannot be updated 
The current number of headcount plan periods ([number]) exceeds the maximum of 36. Reduce the number of periods by changing the entry interval or the plan time frame.   
top
 

Fiscal_ScheduleObject

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

Fiscal_Summary_ScheduleObject

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

Headcount_Plan_StructureReferenceEnumeration

part of: Headcount_Plan_StructureObjectID
Base Type
string
top
 

Budget_Statistic_TypeReferenceEnumeration

part of: Budget_Statistic_TypeObjectID
Base Type
string
top
 

Worktag_and_Aggregation_TypeReferenceEnumeration

part of: Worktag_and_Aggregation_TypeObjectID
Base Type
string
top
 

Fiscal_ScheduleReferenceEnumeration

part of: Fiscal_ScheduleObjectID
Base Type
string
top
 

Fiscal_Summary_ScheduleReferenceEnumeration

part of: Fiscal_Summary_ScheduleObjectID
Base Type
string
top