Location Hierarchy Assignments¶
flowtask.components.Workday.types.location_hierarchy_assignments
¶
Get_Location_Hierarchy_Organization_Assignments operation handler.
This module handles the Get_Location_Hierarchy_Organization_Assignments operation which retrieves organization assignments for location hierarchies.
LocationHierarchyAssignmentsType
¶
Bases: WorkdayTypeBase
Handler for Get_Location_Hierarchy_Organization_Assignments operation.
Retrieves organization assignments for location hierarchies.
:param component: Component instance :param max_retries: Maximum retry attempts (default: 5 for connection resilience) :param retry_delay: Delay between retries in seconds (default: 2.0 for API rate limiting) :param kwargs: Additional parameters
execute
async
¶
Execute Get_Location_Hierarchy_Organization_Assignments operation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Additional parameters including: - location_hierarchy_ids: List of location hierarchy IDs to fetch - location_hierarchy_id_type: Type of ID (WID, Organization_Reference_ID) - as_of_effective_date: Date for effective data - as_of_entry_datetime: Date/time for entry data - page: Page number for pagination - count: Number of results per page |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pandas DataFrame containing the location hierarchy organization assignments |
get_all_assignments
async
¶
Get all location hierarchy organization assignments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
**kwargs
|
Additional parameters for filtering |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with all location hierarchy organization assignments |
get_assignments_by_location_hierarchy
async
¶
Get organization assignments for a specific location hierarchy.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
location_hierarchy_id
|
str
|
The location hierarchy ID to fetch |
required |
id_type
|
str
|
Type of ID (WID, Organization_Reference_ID) |
'Organization_Reference_ID'
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
DataFrame with organization assignments for the location hierarchy |