Service Directory > v31.2 > Human_Resources > Get_Academic_Unit_Hierarchies
 

Operation: Get_Academic_Unit_Hierarchies

This operation is used to retrieve Academic Unit Hierarchies.


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

Top-level request element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Academic_Unit_Hierarchy_Request_References  [0..1]  Element used to retrieve specific instances of Academic Unit Hierarchy.   
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. 
 
top
 

Response Element: Get_Academic_Unit_Hierarchies_Response

Top-level response element for the Get Academic Unit Hierarchies operation
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Academic_Unit_Hierarchy_Request_References  [0..1]  Wrapper element for reference(s) to specific Academic Unit Hierarchy instances to be retrieved   
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  Academic_Unit_Hierarchy_Response_Data  [0..1]  Wrapper element for the Academic Unit Hierarchies   
top
 

Academic_Unit_Hierarchy_Request_References

part of: Get_Academic_Unit_Hierarchies_Request, Get_Academic_Unit_Hierarchies_Response
Wrapper element for references to Academic Unit Hierarchies
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Hierarchy_Reference  Academic_Unit_HierarchyObject  [1..*]  Reference(s) to Academic Unit Hierarchy   
top
 

Academic_Unit_HierarchyObject

part of: Academic_Unit_Hierarchy_Request_References, Academic_Unit_Hierarchy_Data, Academic_Unit_Hierarchy_Data, Academic_Unit_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  Academic_Unit_HierarchyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Academic_Unit_HierarchyObjectID

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

Response_Filter

part of: Get_Academic_Unit_Hierarchies_Request, Get_Academic_Unit_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_Academic_Unit_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
 

Academic_Unit_Hierarchy_Response_Data

part of: Get_Academic_Unit_Hierarchies_Response
Wrapper element for the Academic Unit Hierarchies
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Hierarchy  Academic_Unit_Hierarchy  [0..*]  Wrapper element for the Academic Unit Hierarchy reference and associated data.\   
top
 

Academic_Unit_Hierarchy

part of: Academic_Unit_Hierarchy_Response_Data
Wrapper element for the Academic Unit Hierarchy reference and associated data.\
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Hierarchy_Reference  Academic_Unit_HierarchyObject  [0..1]  Reference to the Academic Unit Hierarchy   
Academic_Unit_Hierarchy_Data  Academic_Unit_Hierarchy_Data  [0..*]  Wrapper element for Academic Unit Hierarchy attributes and relationships.   
top
 

Academic_Unit_Hierarchy_Data

part of: Academic_Unit_Hierarchy
Wrapper element for Academic Unit Hierarchy attributes and relationships.
 
Parameter name Type/Value Cardinality Description Validations
Academic_Unit_Hierarchy_ID  string  [0..1]  Reference ID   
Name  string  [1..1]  Descriptive name   
Code  string  [0..1]  Code or abbreviation   
Include_Code_in_Name  boolean  [0..1]  Indicates whether or not the Code should be included in the display name   
Include_Leadership_Role_Incumbent_in_Name  boolean  [0..1]  Indicates whether or not the name of the person assigned to the leadership role should be included in the display name   
Include_Subtype_in_Name  boolean  [0..1]  Indicates whether or not the subtype should be included in the display name   
Type_Reference  Academic_Unit_SubtypeObject  [0..1]  Reference to the subtype   
External_URL_Reference  External_URLObject  [0..1]  Reference to an external URL   
Superior_Reference  Academic_Unit_HierarchyObject  [0..1]  Reference to the superior or parent Academic Unit Hierarchy   
Subordinate_Reference  Academic_Unit_HierarchyObject  [0..*]  Reference to the subordinate Academic Unit Hierarchies. This is for display only. The superior-subordinate relationship is set by using the superior reference   
Academic_Unit_Reference  Academic_UnitObject  [0..*]  Reference(s) to the Academic Unit included in this Academic Unit Hierarchy   
Inactive  boolean  [0..1]  Indicates the Academic Unit Hierarchy is not active.   
top
 

Academic_Unit_SubtypeObject

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

Academic_Unit_SubtypeObjectID

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

External_URLObject

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

External_URLObjectID

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

Academic_UnitObject

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

Academic_UnitObjectID

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

Academic_Unit_HierarchyReferenceEnumeration

part of: Academic_Unit_HierarchyObjectID
Base Type
string
top
 

Academic_Unit_SubtypeReferenceEnumeration

part of: Academic_Unit_SubtypeObjectID
Base Type
string
top
 

External_URLReferenceEnumeration

part of: External_URLObjectID
Base Type
string
top
 

Academic_UnitReferenceEnumeration

part of: Academic_UnitObjectID
Base Type
string
top