Service Directory > v31.2 > Financial_Management > Get_Grant_Hierarchies
 

Operation: Get_Grant_Hierarchies

Returns Grant Hierarchies and its associated information. The request criteria can be for a single transaction based on Reference ID. If a Reference ID is not specified, the operation retrieves all transactions.


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

Contains request reference, criteria, filter and response group for getting Grant Hierarchy data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Grant_Hierarchy_Request_References  [0..1]  Get Grant Hierarchies using Reference IDs   
Request_Criteria [Choice]   Grant_Hierarchy_Request_Criteria  [0..1]  Get Grant Hierarchies using Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Grant Hierarchies using Request Filters 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Grant_Hierarchies_Response

Element containing Grant 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  Grant_Hierarchy_Request_References  [0..*]  Element containing reference instances for a Grant Hierarchy   
Request_Criteria  Grant_Hierarchy_Request_Criteria  [0..*]  Element containing Grant Hierarchy request criteria   
Response_Filter  Response_Filter  [0..*]  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..*]  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  Grant_Hierarchy_Response_Data  [0..*]  Grant Hierarchies Response Data   
top
 

Grant_Hierarchy_Request_References

part of: Get_Grant_Hierarchies_Request, Get_Grant_Hierarchies_Response
Element containing reference instances for a Grant Hierarchy
 
Parameter name Type/Value Cardinality Description Validations
Grant_Hierarchy_Reference  Grant_HierarchyObject  [1..*]  Get Grant Hierarchies using Reference IDs   
top
 

Grant_HierarchyObject

part of: Grant_Hierarchy_Request_References, Grant_Hierarchy, Grant_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  Grant_HierarchyObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Grant_HierarchyObjectID

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

Grant_Hierarchy_Request_Criteria

part of: Get_Grant_Hierarchies_Request, Get_Grant_Hierarchies_Response
Element containing Grant Hierarchy request criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Grant_Hierarchies_Request, Get_Grant_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_Grant_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
 

Grant_Hierarchy_Response_Data

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

Grant_Hierarchy

part of: Grant_Hierarchy_Response_Data
Wrapper Element that includes Grant Hierarchy Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Grant_Hierarchy_Reference  Grant_HierarchyObject  [0..1]  Reference to an existing Grant Hierarchy   
Grant_Hierarchy_Data  Grant_Hierarchy_Data  [0..*]  Element contains specific details about the grant hierarchy 
Validation Description
An inactive Grant Hierarchy cannot be assigned as the superior of a Grant Hierarchy.   
Superior Grant Hierarchy is not valid because it is a descendent in the existing hierarchy. Please remove the superior hierarchy or select a new one.   
This Grant Hierarchy cannot be inactivated because it has active subordinates.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
Organization Subtype does not match the Hierarchy Structure defined on top level organization.  Organization Subtype needs to be valid for the Hierarchy Structure on top level organization. 
Organization Subtype is required for the Hierarchy Structure on top level organization.   
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
 

Grant_Hierarchy_Data

part of: Grant_Hierarchy
Element containing all Grant Hierarchy data. Allows for grant hierarchy name and relevant information to be added
 
Parameter name Type/Value Cardinality Description Validations
Grant_Hierarchy_ID  string  [0..1]  Grant Hierarchy Reference ID. This is the Grant Hierarchy unique identifier.   
Grant_Hierarchy_Name  string  [1..1]  Grant Hierarchy Name   
Include_Grant_Hierarchy_ID_in_Name  boolean  [0..1]  Boolean flag which when set to true will include the Grant Hierarchy ID in the Grant Hierarchy Name.   
Grant_Hierarchy_is_Inactive  boolean  [0..1]  Boolean Flag which when set to true inactivates the Grant Hierarchy   
Organization_Subtype_Reference  Organization_SubtypeObject  [0..1]  Reference to an existing Organization Subtype valid for Grant Hierarchies. 
Validation Description
Organization Subtype is not valid for Organization Type  Organization Subtype needs to be valid for Organization Type. 
 
Superior_Grant_Hierarchy_Reference  Grant_HierarchyObject  [0..1]  Reference to an existing Grant Hierarchy to add as the superior.   
Included_Grant_Reference  GrantObject  [0..*]  Reference to existing Grants to add as the subordinates.   
Validation Description
An inactive Grant Hierarchy cannot be assigned as the superior of a Grant Hierarchy.   
Superior Grant Hierarchy is not valid because it is a descendent in the existing hierarchy. Please remove the superior hierarchy or select a new one.   
This Grant Hierarchy cannot be inactivated because it has active subordinates.   
A hierarchy structure is defined on this organization. Please delete the hierarchy structure before assigning any superior organization.   
Organization Subtype does not match the Hierarchy Structure defined on top level organization.  Organization Subtype needs to be valid for the Hierarchy Structure on top level organization. 
Organization Subtype is required for the Hierarchy Structure on top level organization.   
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: Grant_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
 

GrantObject

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

GrantObjectID

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

Grant_HierarchyReferenceEnumeration

part of: Grant_HierarchyObjectID
Base Type
string
top
 

Organization_SubtypeReferenceEnumeration

part of: Organization_SubtypeObjectID
Base Type
string
top
 

GrantReferenceEnumeration

part of: GrantObjectID
Base Type
string
top