Organization Single¶
flowtask.components.Workday.types.organization_single
¶
Get_Organization operation handler.
This module handles the Get_Organization operation which retrieves a specific organization by its ID (singular, not plural).
GetOrganization
¶
Bases: WorkdayTypeBase
Handler for Get_Organization operation.
Retrieves a specific organization by its ID.
execute
async
¶
Execute Get_Organization operation to retrieve a specific organization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
organization_id
|
str
|
The ID of the organization to retrieve |
required |
organization_id_type
|
str
|
The type of ID (Organization_Reference_ID, WID, etc.) |
'Organization_Reference_ID'
|
**kwargs
|
Additional parameters |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pandas DataFrame containing the organization data |
get_organization_by_custom_id
async
¶
Get organization by Custom_Organization_Reference_ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
custom_id
|
str
|
The Custom_Organization_Reference_ID |
required |
**kwargs
|
Additional parameters |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pandas DataFrame containing the organization data |
get_organization_by_reference_id
async
¶
Get organization by Organization_Reference_ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
reference_id
|
str
|
The Organization_Reference_ID |
required |
**kwargs
|
Additional parameters |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pandas DataFrame containing the organization data |
get_organization_by_wid
async
¶
Get organization by WID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
wid
|
str
|
The WID of the organization |
required |
**kwargs
|
Additional parameters |
{}
|
Returns:
| Type | Description |
|---|---|
DataFrame
|
pandas DataFrame containing the organization data |