Service Directory > v31.2 > Financial_Management > Get_Program_Hierarchies
 

Operation: Get_Program_Hierarchies

This service operation will get Program Hierarchies. This service will return the Program Hierarchies and its associated information. The request criteria can be for a single transaction based on Reference, or all transactions can be retrieved if no Reference 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_Program_Hierarchies_Request

Contains request reference, criteria, filter and response group for getting Program Hierarchy data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Program_Hierarchy_Request_References  [0..1]  Get Program Hierarchies Request References   
Request_Criteria [Choice]   Program_Hierarchy_Request_Criteria  [0..1]  Get Program Hierarchies Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Program Hierarchies Response FIlter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Program_Hierarchies_Response

Element containing Program Hierarchy response elements including received criteria, references, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Program_Hierarchy_Request_References  [0..1]  Element containing reference instances for a Program Hierarchy   
Request_Criteria  Program_Hierarchy_Request_Criteria  [0..1]  Element containing Program Hierarchy request criteria   
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  Program_Hierarchy_Response_Data  [0..1]  Get Program Hierarchies Response Data   
top
 

Program_Hierarchy_Request_References

part of: Get_Program_Hierarchies_Request, Get_Program_Hierarchies_Response
Element containing reference instances for a Program Hierarchy
 
Parameter name Type/Value Cardinality Description Validations
Program_Hierarchy_Reference  Program_HierarchyObject  [1..*]  Reference to an existing Program Hierarchy   
top
 

Program_HierarchyObject

part of: Program_Hierarchy_Data, Program_Hierarchy_Request_References, Program_Hierarchy
 
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  Program_HierarchyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Program_HierarchyObjectID

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

Program_Hierarchy_Request_Criteria

part of: Get_Program_Hierarchies_Request, Get_Program_Hierarchies_Response
Element containing Program Hierarchy request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Program_Hierarchies_Request, Get_Program_Hierarchies_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_Program_Hierarchies_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
 

Program_Hierarchy_Response_Data

part of: Get_Program_Hierarchies_Response
Wrapper Element that includes Program Hierarchy Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Program_Hierarchy  Program_Hierarchy  [0..*]  Program Hierarchy Data   
top
 

Program_Hierarchy

part of: Program_Hierarchy_Response_Data
Wrapper Element that includes Program Hierarchy Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Program_Hierarchy_Reference  Program_HierarchyObject  [0..1]  Reference to an existing Program Hierarchy   
Program_Hierarchy_Data  Program_Hierarchy_Data  [0..*]  Program Hierarchy Data 
Validation Description
Programs cannot be used more than once in a single hierarchy. Please change the Parent or modify the Programs to Include. (Programs: [program])   
Parent Program Hierarchy is not valid because it is a descendent in the existing hierarchy. Please remove the parent hierarchy or select a new one.   
This Program Hierarchy cannot be inactivated because it has active subordinates.   
An inactive Program Hierarchy cannot be assigned as the superior of a Program Hierarchy.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Organization Subtype for this hierarchy.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the parent hierarchy.   
A top-level hierarchy structure exists and is enforced for this parent hierarchy. Please unenforce the top-level hierarchy structure first before selecting this as a parent hierarchy.   
 
top
 

Program_Hierarchy_Data

part of: Program_Hierarchy
Element containing all Program Hierarchy data
 
Parameter name Type/Value Cardinality Description Validations
Program_Hierarchy_ID  string  [0..1]  Program Hierarchy Reference ID. This is the Program Hierarchy unique identifier.   
Program_Hierarchy_Name  string  [1..1]  Program Hierarchy Name.   
Include_Program_Hierarchy_ID_In_Name  boolean  [0..1]  Boolean flag which when set to true will include the Program Hierarchy ID in the Program Hierarchy Name.   
Program_Hierarchy_is_Inactive  boolean  [0..1]  Boolean Flag which when set to true Inactivates the Program Hierarchy.   
Organization_Subtype_Reference  Organization_SubtypeObject  [0..1]  Reference to an existing Organization Subtype valid for Program Hierarchies. 
Validation Description
Organization Subtype is not valid for Organization Type  Organization Subtype needs to be valid for Organization Type. 
 
Parent_Program_Hierarchy_Reference  Program_HierarchyObject  [0..1]  Reference to an existing Program Hierarchy to add as the superior.   
Contains_Program_Reference  ProgramObject  [0..*]  Reference to existing Programs to add as the subordinates.   
Validation Description
Programs cannot be used more than once in a single hierarchy. Please change the Parent or modify the Programs to Include. (Programs: [program])   
Parent Program Hierarchy is not valid because it is a descendent in the existing hierarchy. Please remove the parent hierarchy or select a new one.   
This Program Hierarchy cannot be inactivated because it has active subordinates.   
An inactive Program Hierarchy cannot be assigned as the superior of a Program Hierarchy.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the Organization Subtype for this hierarchy.   
A top-level Hierarchy Structure exists and is enforced for this hierarchy. Please unenforce the top-level Hierarchy Structure first before changing the parent hierarchy.   
A top-level hierarchy structure exists and is enforced for this parent hierarchy. Please unenforce the top-level hierarchy structure first before selecting this as a parent hierarchy.   
top
 

Organization_SubtypeObject

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

Organization_SubtypeObjectID

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

ProgramObject

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

ProgramObjectID

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

Program_HierarchyReferenceEnumeration

part of: Program_HierarchyObjectID
Base Type
string
top
 

Organization_SubtypeReferenceEnumeration

part of: Organization_SubtypeObjectID
Base Type
string
top
 

ProgramReferenceEnumeration

part of: ProgramObjectID
Base Type
string
top