---
canonical_url: "https://docs.composio.dev/toolkits/workday_adaptive_planning"
markdown_url: "https://docs.composio.dev/toolkits/workday_adaptive_planning.md"
product: "platform"
version: null
last_updated: null
---

# Workday Adaptive Planning

Workday Adaptive Planning provides XML APIs for planning data, model metadata, users, and transactions.

- **Category:** accounting
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 50
- **Triggers:** 0
- **Slug:** `WORKDAY_ADAPTIVE_PLANNING`
- **Version:** 00000000_00

## Tools

### Create Account

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_CREATE_ACCOUNT`

Create one GL, Custom, or Assumption account or account group. This administrative mutation may create unpublished model changes; proceed_with_warnings can override provider safety warnings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Alphanumeric/underscore account code. Must be empty for an account group. |
| `name` | string | Yes | Account name. |
| `is_group` | boolean | Yes | Create an account group rather than a leaf account. |
| `parent_id` | integer | Yes | Internal ID of the parent account. |
| `attributes` | array | No | Account attribute assignments. |
| `short_name` | string | No | Account short name. |
| `description` | string | No | Account description. |
| `data_privacy` | string ("PRIVATE" | "PUBLIC_TOP" | "PUBLIC_ALL") | No | Level visibility for account values. |
| `has_salary_detail` | boolean | No | Require salary-detail permission to view account splits. |
| `exchange_rate_type` | string | No | Configured exchange-rate type code for a currency account. |
| `is_breakback_eligible` | boolean | No | Make this assumption available as a breakback weight. |
| `proceed_with_warnings` | boolean | No | Proceed despite provider warnings that would otherwise halt creation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Users

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_CREATE_USERS`

Create 1 to 1000 Adaptive Planning users and return each user's creation status and immutable GUID. A password is required except for a Workday-connected instance with User Sync enabled that uses Workday SAML SSO. The operation is unavailable after Workday user synchronization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `users` | array | Yes | Users to create (1-1000). Every user requires email and name. Each user also requires a password unless the documented Workday User Sync plus SAML SSO passwordless exception applies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Report Values

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_CUSTOM_REPORT_VALUES`

Run a typed matrix report over explicit X, Y, and optional filter axes and return coordinates, cells, notes, and provider messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x_axis` | object | Yes | Report column axis; type must be X. |
| `y_axis` | object | Yes | Report row axis; type must be Y. |
| `filter_axis` | object | No | Optional global filter axis; type must be FILTER. |
| `cell_inclusions` | integer ("0" | "1" | "2") | No | Cell inclusion: 0 all, 1 data and zero, 2 data only. |
| `show_cell_notes` | boolean | No | Whether to return cell notes. |
| `suppress_zeroes` | integer ("0" | "1" | "2") | No | Row suppression: 0 all, 1 blank rows, 2 blank and zero rows. |
| `suppress_rollups` | boolean | No | Whether to suppress parent rollups whose children are present. |
| `include_element_code` | boolean | No | Whether calculation elements include their codes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete or Replace Transactions

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_DELETE_OR_REPLACE_TRANSACTIONS`

Irreversibly delete transactions matching any supplied date or transaction-type criterion, and optionally insert replacement rows in the same operation. A start date without an end date has no upper bound; an end date without a start date has no lower bound; transaction types without dates match all dates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Structured transaction-definition columns and rows. Use one row of empty values for delete-only, or populated rows to insert replacements after deletion. |
| `use_mappings` | boolean | No | Apply configured import mappings; false expects provider internal identifiers. |
| `allow_parallel` | boolean | No | Allow this import while another actuals or transaction import is running. |
| `delete_end_date` | string | No | Inclusive deletion end date in the connected credential locale's exact provider format, such as 12/31/2012 for en_US. The value is preserved exactly. Supplying it activates irreversible deletion; without delete_start_date, the lower date bound is unbounded. |
| `include_context` | boolean | No | Include row and column context in provider messages when appropriate. |
| `delete_start_date` | string | No | Inclusive deletion start date in the connected credential locale's exact provider format, such as 11/01/2012 for en_US. The value is preserved exactly. Supplying it activates irreversible deletion; without delete_end_date, the upper date bound is unbounded. |
| `display_name_enabled` | boolean | No | Use the display-name-aware transaction import column contract. |
| `delete_transaction_types` | array | No | Transaction types to irreversibly delete. Supplying this criterion activates deletion; without either date criterion, matching types are deleted across an unbounded date range. When omitted, every type within the supplied date bounds is deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Erase Actuals

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_ERASE_ACTUALS`

Irreversibly erase numeric actuals for every level in the selected account family and inclusive time range. This may also delete newly empty splits and, when requested, cell notes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Inclusive end time-period code at the selected account time stratum. |
| `start` | string | Yes | Inclusive start time-period code at the selected account time stratum. |
| `account_type` | string ("GL" | "CUSTOM" | "CUBE") | Yes | Account family whose numeric actuals will be irreversibly erased. |
| `cube_sheet_name` | string | No | Cube sheet name; required only for account_type CUBE. |
| `include_cell_notes` | boolean | Yes | Also irreversibly erase matching cell notes when true. |
| `actuals_version_name` | string | No | Actuals version name. Required by Workday when the instance has multiple actuals versions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Erase Data

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_ERASE_DATA`

Irreversibly erase numeric plan or actuals data in an inclusive time range. Filters match only explicitly listed accounts and levels, not their descendants; Erase Data overrides access rules and level ownership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Inclusive end time-period code. |
| `start` | string | Yes | Inclusive start time-period code. |
| `level_codes` | array | No | Level codes paired positionally with level_names when display names are enabled. |
| `level_names` | array | No | Exact level names to erase; child levels are not implied. |
| `account_type` | string ("GL" | "CUSTOM" | "CUBE") | Yes | Account family to erase. |
| `account_codes` | array | No | Exact account codes to erase; rollup descendants are not implied. |
| `cube_sheet_name` | string | No | Cube sheet name for CUBE erasure. |
| `plan_version_name` | string | No | Plan version to erase. |
| `include_cell_notes` | boolean | Yes | Also irreversibly erase matching cell notes. |
| `actuals_version_name` | string | No | Actuals version to erase. |
| `display_name_enabled` | boolean | No | Use display-name-aware level code selection when enabled for the instance. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Accounts

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_ACCOUNTS`

Return the complete Adaptive Planning account hierarchy and account metadata, optionally filtered by sheet and enriched with account attributes and inaccessible values. A version selector adds per-account importability metadata but does not filter the hierarchy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sheet_id` | integer | No | Restrict results to accounts available for this internal sheet ID. |
| `version_id` | integer | No | Include each account's isImportable flag for this internal version ID when version_name is absent; does not filter the returned hierarchy. |
| `version_name` | string | No | Include each account's isImportable flag for this exact version name; does not filter the returned account hierarchy and takes precedence over version_id. |
| `include_attributes` | boolean | No | Include non-blank account attribute mappings. |
| `show_account_group_codes` | boolean | No | Include account-group codes using the API v38 and newer response contract. |
| `include_inaccessible_values` | boolean | No | Include inaccessible accounts. This requires Modeling or Import to all levels permission. |
| `include_attribute_value_names` | boolean | No | Include account attribute value names. |
| `include_attribute_value_display_names` | boolean | No | Include account attribute value display names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Active Currencies

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_ACTIVE_CURRENCIES`

Return every currency configured in the Adaptive Planning instance.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Attributes

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_ATTRIBUTES`

Return Adaptive Planning account, level, and dimension attributes and their recursive values, optionally restricted to selected attribute IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attribute_ids` | array | No | Return only attributes with these internal attribute IDs. |
| `display_name_enabled` | boolean | No | Return display-name-aware value codes, display names, and descriptions. |
| `include_uncategorized` | boolean | No | Include accessible uncategorized phantom values used by Access Rules. |
| `include_inaccessible_values` | boolean | No | Include inaccessible values. This requires Modeling or Import to all levels permission. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Calendar

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_CALENDAR`

Return all Adaptive Planning calendars with their IDs, names, codes, and default status.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Configurable Model Data

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_CONFIGURABLE_MODEL_DATA`

Export typed, parsed CSV rows from a modeled sheet using either provider paging or the all-row streaming form.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job` | object | No | Paging state; required unless get_all_rows is true. |
| `level` | object | No | Optional organization-level filter. |
| `columns` | object | No | Optional v33+ modeled and system column selection. |
| `is_global` | boolean | No | True for a user-assigned sheet; false for a level-assigned sheet. |
| `time_span` | object | No | Optional inclusive leaf-period range for timespan columns. Omit it to export the version's full date range. |
| `sheet_name` | string | Yes | Modeled-sheet name. |
| `get_all_rows` | boolean | No | Return all rows using the streaming response form. |
| `version_name` | string | Yes | Version containing the modeled-sheet rows. |
| `include_codes` | boolean | No | Include level and dimension code columns. |
| `include_names` | boolean | No | Include level and dimension name columns. |
| `use_numeric_ids` | boolean | No | Return internal IDs without the S prefix. |
| `use_actual_value` | boolean | No | In all-row mode, return raw or calculated actual numeric values. |
| `include_all_columns` | boolean | No | Include all sheet columns. |
| `display_name_enabled` | boolean | No | Use the display-name-aware v31+ contract. |
| `include_display_names` | boolean | No | Include level and dimension display-name columns. |
| `use_account_precision` | boolean | No | In all-row mode, use each account's configured precision. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Customer Logo

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_CUSTOMER_LOGO`

Return the URL Workday exposes for the Adaptive Planning instance's customer logo.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Planning Data

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_DATA`

Export account values from one Adaptive Planning version for explicit account and time filters, returning parsed CSV rows and provider messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `levels` | array | No | Optional organization-level filters. |
| `stream` | boolean | No | Use the streaming response layout for large exports. |
| `use_ids` | boolean | No | Use internal IDs for account, level, and dimension-value filters and response labels. Slicing dimensions always use documented names. |
| `version` | object | Yes | Version whose values to export. |
| `accounts` | array | Yes | Account filters for the export. |
| `currency` | object | No | Optional currency output mode. |
| `time_span` | object | Yes | Inclusive leaf-period range to export. |
| `mark_blanks` | boolean | No | Render blanks as B instead of zero. |
| `time_rollups` | string ("false" | "true" | "single") | No | Return no time rollups, normal rollups, or one rollup for the whole span. |
| `include_codes` | boolean | No | Include level code columns. |
| `include_names` | boolean | No | Include level name columns. |
| `arbitrary_time` | object | No | Optional v40 arbitrary-rollup calendar. |
| `dimension_values` | array | No | Optional dimension-value filters. |
| `slice_dimensions` | array | No | Dimensions that split matching data into separate output rows. |
| `include_zero_rows` | boolean | No | Include rows containing only zeroes or blanks. |
| `use_internal_codes` | boolean | Yes | Return internal account and level codes instead of export mappings. |
| `mark_invalid_values` | boolean | No | Render invalid values with I instead of =NA(). |
| `display_name_enabled` | boolean | No | Use the display-name-aware level and dimension contract. |
| `include_display_names` | boolean | No | Include level display-name columns. |
| `include_rollup_levels` | boolean | No | Include level rollup values. |
| `include_unmapped_items` | boolean | No | Include items without export mappings when mappings are used. |
| `include_rollup_accounts` | boolean | No | Include account rollup values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Dimension Families

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_DIMENSION_FAMILIES`

Return the account and dimension sets associated with each Adaptive Planning sheet family.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Dimension Mapping

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_DIMENSION_MAPPING`

Return derived-dimension mapping targets and conditions for selected dimensions in a version, optionally filtered by keyword, level, or dimension values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | object | No | Optional criteria filters. |
| `version_name` | string | Yes | Version whose derived-dimension mappings to export. |
| `dimension_names` | array | Yes | Derived dimensions whose mapping criteria to export. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Dimensions

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_DIMENSIONS`

Return custom Adaptive Planning dimensions and optionally their hierarchical values, properties, and attribute mappings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `version_id` | integer | No | Filter values available to this internal version ID when version_name is absent. |
| `version_name` | string | No | Filter values available to this exact version name; takes precedence over version_id. |
| `dimension_ids` | array | No | Return only dimensions with these internal IDs. |
| `include_attributes` | boolean | No | Include attribute mappings for flat dimension values. |
| `display_name_enabled` | boolean | No | Return display-name-aware codes, display names, and descriptions. |
| `include_dimension_values` | boolean | No | Include the recursive dimension-value hierarchies. |
| `include_inaccessible_values` | boolean | No | Include inaccessible values. This requires Modeling or Import to all levels permission. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export User Groups

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_GROUPS`

Return every global and user-owned group defined in the Adaptive Planning instance.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Instances

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_INSTANCES`

Return the selected Adaptive Planning instance or every instance accessible to the connected user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accessible_instances` | boolean | No | Return every Adaptive Planning instance accessible to the user instead of only the selected instance. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Levels

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_LEVELS`

Return the accessible Adaptive Planning organization-level hierarchy, optionally filtered by version or sheet and enriched with groups, attributes, and inaccessible values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sheet_id` | integer | No | Restrict results to levels available to this internal sheet ID. |
| `version_id` | integer | No | Filter levels available to this internal version ID when version_name is absent. |
| `version_name` | string | No | Filter levels available to this exact version name; takes precedence over version_id. |
| `include_groups` | boolean | No | Include the IDs of level groups that contain each level. |
| `display_name_enabled` | boolean | No | Return display-name-aware level codes, display names, and descriptions. |
| `include_uncategorized` | boolean | No | Include accessible uncategorized phantom levels used by Access Rules. |
| `include_inaccessible_values` | boolean | No | Include inaccessible levels. This requires Organization Structure: All Levels or Import to all levels permission. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Locales

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_LOCALES`

Return every locale associated with the Adaptive Planning company.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Modeled Sheet

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_MODELED_SHEET`

Return the structured definition of one modeled sheet by name, including v40 display-column account codes and configured model columns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sheet_name` | string | Yes | Exact modeled-sheet name to export. |
| `display_name_enabled` | boolean | No | Respect display-name properties when the instance enables display names. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Permission Sets

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_PERMISSION_SETS`

Return every Adaptive Planning permission set and its assigned internal permission codes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Security Audit

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_SECURITY_AUDIT`

Return Adaptive Planning security events, optionally filtered by actor and UTC time range. Without a time range Workday returns the last 24 hours; the provider retains at most 30 days of audit data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `actor` | string | No | Username whose security events to return; omit for all users. |
| `date_time_to` | string | No | Inclusive UTC end timestamp. |
| `date_time_from` | string | No | Inclusive UTC start timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Sheet Definition

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_SHEET_DEFINITION`

Return the structured definition of one modeled or cube sheet by internal ID, including configured columns, dimensions, values, accounts, levels, and time settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sheet_id` | integer | Yes | Internal sheet ID from exportSheets. |
| `sheet_type` | string ("modeled" | "cube") | Yes | Type of sheet definition to export. |
| `display_name_enabled` | boolean | No | Use display-name properties for a modeled sheet when the instance enables them. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Sheets

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_SHEETS`

Return all standard, modeled, and cube sheets in the Adaptive Planning instance with their IDs, names, descriptions, and prefixes or codes.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Time

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_TIME`

Return Adaptive Planning calendar strata and periods, optionally scoped to a version, calendar hierarchy, leaf stratum, legacy fields, or all locale translations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `version` | object | No | Optional version-range selector. |
| `calendar_id` | integer | No | Calendar hierarchy ID; omit for the default hierarchy. |
| `leaf_stratum_id` | integer | No | Finest time stratum to include. |
| `include_all_locales` | boolean | No | Include localized labels for every locale. |
| `include_legacy_information` | boolean | No | Include legacy time IDs for a non-custom calendar. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Transaction Definition

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_TRANSACTION_DEFINITION`

Return the configured Adaptive Planning transaction fields and allowed selector values needed to construct valid transaction imports.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Users

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_USERS`

Return all users in the Adaptive Planning instance with identity, permission sets, profile, audit, lock, optional group, and subscription settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_groups` | boolean | No | Include each user's current Adaptive Planning group IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Versions

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_EXPORT_VERSIONS`

Return all Adaptive Planning versions and version folders visible to the connected user, optionally including scenarios and eligible currency versions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_scenarios` | boolean | No | Include private what-if scenario versions. |
| `include_currency_versions` | boolean | No | Include translated-currency versions when the Adaptive Planning instance is eligible for this v40 feature. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Configurable Model Data

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_IMPORT_CONFIGURABLE_MODEL_DATA`

Append modeled-sheet rows, update rows matched by an import key, or update matching rows and insert new ones. This action does not run a replacement mode.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Structured import-template columns and rows. |
| `mode` | string ("APPEND" | "UPDATE_BY_IMPORT_KEY" | "UPSERT_BY_IMPORT_KEY") | No | Import behavior. APPEND adds rows, UPDATE_BY_IMPORT_KEY updates matched rows, and UPSERT_BY_IMPORT_KEY updates matched rows and inserts new rows. |
| `version` | object | Yes | Destination version selected by exact name or as the current default. |
| `import_key` | string | No | Unique modeled-sheet column required only for UPDATE_BY_IMPORT_KEY and UPSERT_BY_IMPORT_KEY. |
| `sheet_name` | string | Yes | Exact modeled-sheet name. |
| `use_mappings` | boolean | No | Apply configured import mappings. False expects provider internal identifiers. |
| `allow_parallel` | boolean | No | Allow this import while another actuals or transaction import is running. |
| `include_context` | boolean | No | Include row and column context in provider messages. |
| `plan_or_actuals` | string ("Plan" | "Actuals") | Yes | Data type. The selected version takes precedence if it conflicts. |
| `display_name_enabled` | boolean | No | Use the display-name-aware import column contract. |
| `move_actuals_boundary` | boolean | No | Move the actuals availability pointer to the latest imported period. Must remain false for Plan. |
| `apply_validation_rules` | boolean | No | Apply modeled-sheet validation rules to imported data. |
| `is_user_assigned_sheet` | boolean | No | Whether the sheet is user-assigned rather than level-assigned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Cube Data

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_IMPORT_CUBE_DATA`

Update existing cube facts or insert new facts in APPEND mode without scoped replacement. Imported numeric zeroes still irreversibly erase their exact cube cells.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Structured import table; numeric zero values erase their exact cube cells even in APPEND mode. |
| `version` | object | Yes | Destination version. |
| `sheet_name` | string | Yes | Exact cube-sheet name. |
| `use_mappings` | boolean | No | Apply configured import mappings. |
| `allow_parallel` | boolean | No | Allow this import while another actuals or transaction import is running. |
| `include_context` | boolean | No | Include row and column context in provider messages. |
| `plan_or_actuals` | string ("Plan" | "Actuals") | Yes | Data type; the selected version takes precedence if they conflict. |
| `display_name_enabled` | boolean | No | Use the display-name-aware import column contract. |
| `move_actuals_boundary` | boolean | No | Move the actuals availability pointer; valid only for Actuals. |
| `is_user_assigned_sheet` | boolean | No | Whether the sheet is user-assigned rather than level-assigned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Dimension Mapping

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_IMPORT_DIMENSION_MAPPING`

Create or replace derived-dimension mapping criteria, or permanently delete criteria when delete=true. Derived values do not support virtual versions; duplicate conditions are rejected.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `version` | object | Yes | Non-virtual version selected by name or ID. |
| `dimensions` | array | Yes | Derived dimensions and their mapping criteria. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Groups

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_IMPORT_GROUPS`

Create or update Workday/external user groups. REPLACE_ALL permanently replaces all imported groups in the instance; UPDATE changes only supplied groups. This cannot update groups created in Adaptive Planning.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("REPLACE_ALL" | "UPDATE") | Yes | REPLACE_ALL replaces every imported group; UPDATE changes only supplied groups. |
| `groups` | array | Yes | Groups to import. |
| `data_source` | string ("WORKDAY" | "EXTERNAL") | Yes | System that owns the imported groups. |
| `user_identifier` | string ("userName" | "userGUID" | "wid") | Yes | Identifier attribute used for every supplied user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Modeled Sheet

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_IMPORT_MODELED_SHEET`

Create a modeled-sheet definition, including typed columns and API v39+ validation rules. This administrative, non-idempotent operation creates dimensions or level attributes referenced by the definition and requires Model permission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | No | Internal sheet ID from an exported definition, when present. |
| `code` | string | Yes | Unique modeled-sheet code, required by API v39+. |
| `name` | string | Yes | Modeled-sheet name, required by API v39+. |
| `state` | string | No | Provider sheet state code. |
| `columns` | array | Yes | Typed modeled-sheet columns in provider order. |
| `revision` | integer | No | Sheet definition revision. |
| `is_global` | boolean | No | Whether this is a global modeled sheet. |
| `strata_id` | integer | No | Internal time-stratum ID. |
| `description` | string | No | Modeled-sheet description. |
| `strata_code` | string | Yes | Sheet time-stratum code, such as month. |
| `allow_actuals` | boolean | No | Whether the sheet allows actuals. |
| `allow_allocation` | boolean | No | Whether the sheet allows allocation. |
| `validation_rules` | array | No | Modeled-sheet data-validation rules. |
| `breakback_pattern` | integer | No | Provider breakback-pattern code. |
| `has_salary_detail` | boolean | No | Whether the sheet contains salary detail. |
| `selected_plan_ids` | array | Yes | Selected plan IDs. |
| `frozen_column_count` | integer | No | Number of frozen columns. |
| `recalculate_on_demand` | boolean | No | Whether the sheet recalculates on demand. |
| `allow_edits_in_rollup_mode` | boolean | No | Whether rollup-mode edits are allowed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Standard Data

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_IMPORT_STANDARD_DATA`

Update existing standard-account facts or insert new facts in APPEND mode. This action does not delete unmatched facts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Structured import-template columns and rows. |
| `version` | object | Yes | Destination version. |
| `use_mappings` | boolean | No | Apply configured import mappings; false expects provider internal identifiers. |
| `allow_parallel` | boolean | No | Allow this import while another actuals or transaction import is running. |
| `include_context` | boolean | No | Include row and column context in provider messages when appropriate. |
| `plan_or_actuals` | string ("Plan" | "Actuals") | Yes | Data type. The selected version takes precedence if it conflicts. |
| `splits_to_unsplit` | boolean | No | Allow split rows to import into an unsplit location that already contains data. |
| `display_name_enabled` | boolean | No | Use the display-name-aware import column contract. |
| `move_actuals_boundary` | boolean | No | Move the actuals availability pointer to the latest imported period. Valid only for Actuals. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import Transactions

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_IMPORT_TRANSACTIONS`

Insert new transaction rows without deleting existing transactions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Structured transaction-definition columns and rows to insert. |
| `use_mappings` | boolean | No | Apply configured import mappings; false expects provider internal identifiers. |
| `allow_parallel` | boolean | No | Allow this import while another actuals or transaction import is running. |
| `include_context` | boolean | No | Include row and column context in provider messages when appropriate. |
| `display_name_enabled` | boolean | No | Use the display-name-aware transaction import column contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Publish Admin Changes

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_PUBLISH_CHANGES`

Permanently publish every pending administrative change in an admin-publishing-enabled instance. This affects all batched changes, cannot select individual changes, and requires Publish Admin Changes permission.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Recalculate Sheet

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_RECALCULATE_SHEET`

Recalculate Recalculate-on-Demand sheet data in a required version. Omitting sheet recalculates every on-demand sheet at the top level; a selected level includes its descendants.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `level` | object | No | Level whose subtree is recalculated for the selected sheet. |
| `sheet` | object | No | Specific on-demand sheet. Omit to recalculate every on-demand sheet at the top level. |
| `version` | object | Yes | Required version in which sheets are recalculated. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Configurable Model Data

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_REPLACE_CONFIGURABLE_MODEL_DATA`

Irreversibly delete and replace modeled-sheet rows. REPLACE_ALL deletes every existing row on all levels, REPLACE_SECURED_COORDINATES deletes and replaces rows at matching secured coordinates, and SCOPED_REPLACE deletes and replaces rows at input levels. Choose the replacement boundary explicitly before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Structured import-template columns and rows that replace the selected boundary. |
| `mode` | string ("REPLACE_ALL" | "REPLACE_SECURED_COORDINATES" | "SCOPED_REPLACE") | Yes | Required replacement boundary. REPLACE_ALL deletes every existing row on all levels. REPLACE_SECURED_COORDINATES replaces rows at matching level and secured-dimension coordinates. SCOPED_REPLACE replaces rows at input levels. |
| `version` | object | Yes | Destination version selected by exact name or as the current default. |
| `sheet_name` | string | Yes | Exact modeled-sheet name. |
| `use_mappings` | boolean | No | Apply configured import mappings. False expects provider internal identifiers. |
| `allow_parallel` | boolean | No | Allow this import while another actuals or transaction import is running. |
| `include_context` | boolean | No | Include row and column context in provider messages. |
| `plan_or_actuals` | string ("Plan" | "Actuals") | Yes | Data type. The selected version takes precedence if it conflicts. |
| `scoped_replace_mode` | string | No | Required only for SCOPED_REPLACE. INPUT limits replacement to input levels. |
| `display_name_enabled` | boolean | No | Use the display-name-aware import column contract. |
| `move_actuals_boundary` | boolean | No | Move the actuals availability pointer to the latest imported period. Must remain false for Plan. |
| `apply_validation_rules` | boolean | No | Apply modeled-sheet validation rules to imported data. |
| `is_user_assigned_sheet` | boolean | No | Whether the sheet is user-assigned rather than level-assigned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Cube Data

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_REPLACE_CUBE_DATA`

Irreversibly delete all existing cube facts inside the complete supplied time, account, and level scope that are absent from the payload, then replace that scope with the supplied facts. INPUT and ALL scopes can delete substantially more data than the visible rows; verify every boundary before calling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Structured import table used to replace all existing facts in replace_scope. |
| `version` | object | Yes | Destination version. |
| `sheet_name` | string | Yes | Exact cube-sheet name. |
| `use_mappings` | boolean | No | Apply configured import mappings. |
| `replace_scope` | object | Yes | Required destructive boundary. Existing facts in this entire time, account, and level scope that are absent from data are deleted. |
| `allow_parallel` | boolean | No | Allow this import while another actuals or transaction import is running. |
| `include_context` | boolean | No | Include row and column context in provider messages. |
| `plan_or_actuals` | string ("Plan" | "Actuals") | Yes | Data type; the selected version takes precedence if they conflict. |
| `display_name_enabled` | boolean | No | Use the display-name-aware import column contract. |
| `move_actuals_boundary` | boolean | No | Move the actuals availability pointer; valid only for Actuals. |
| `is_user_assigned_sheet` | boolean | No | Whether the sheet is user-assigned rather than level-assigned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Standard Data

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_REPLACE_STANDARD_DATA`

Irreversibly delete unmatched standard-account facts inside an explicit time, account, and level scope, then replace that scope with the supplied facts. Requires the provider's replacement permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Structured import-template columns and rows. |
| `version` | object | Yes | Destination version. |
| `use_mappings` | boolean | No | Apply configured import mappings; false expects provider internal identifiers. |
| `replace_scope` | object | Yes | Exact destructive boundary. Unmatched facts inside this time, account, and level scope are deleted before the supplied facts replace them. |
| `allow_parallel` | boolean | No | Allow this import while another actuals or transaction import is running. |
| `include_context` | boolean | No | Include row and column context in provider messages when appropriate. |
| `plan_or_actuals` | string ("Plan" | "Actuals") | Yes | Data type. The selected version takes precedence if it conflicts. |
| `splits_to_unsplit` | boolean | No | Allow split rows to import into an unsplit location that already contains data. |
| `display_name_enabled` | boolean | No | Use the display-name-aware import column contract. |
| `move_actuals_boundary` | boolean | No | Move the actuals availability pointer to the latest imported period. Valid only for Actuals. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Unpublished Changes Status

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_UNPUBLISHED_CHANGES_STATUS`

Read whether admin publishing is enabled and the number of unpublished changes without publishing them.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Access Rules

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_UPDATE_ACCESS_RULES`

Upload an official .xls/.xlsx access-rules template as an administrator. update replaces every rule for each listed user/group; replaceAll permanently deletes all existing access rules before installing only the spreadsheet rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `operation` | string ("update" | "replaceAll") | Yes | update replaces rules for listed users/groups; replaceAll deletes every existing rule and installs only the spreadsheet rules. |
| `spreadsheet` | object | Yes | Adaptive Planning access-rules template in .xls or .xlsx format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Account

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_UPDATE_ACCOUNT`

Update one existing GL, Custom, or Assumption account. This administrative mutation may create unpublished model changes; attribute value ID 0 removes that assignment and proceed_with_warnings overrides provider safety warnings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Internal ID of the GL, Custom, or Assumption account to update. |
| `code` | string | No | Replacement account code; omit for account groups. |
| `name` | string | No | Replacement account name. |
| `attributes` | array | No | Attribute assignments; value_id=0 removes an assignment. |
| `short_name` | string | No | Replacement short name; an empty string clears it. |
| `description` | string | No | Replacement description; an empty string clears it. |
| `data_privacy` | string ("PRIVATE" | "PUBLIC_TOP" | "PUBLIC_ALL") | No | Replacement level visibility policy. |
| `has_salary_detail` | boolean | No | Whether salary-detail permission is required for splits. |
| `exchange_rate_type` | string | No | Replacement configured exchange-rate type code. |
| `is_breakback_eligible` | boolean | No | Whether this assumption is breakback eligible. |
| `proceed_with_warnings` | boolean | No | Proceed despite provider warnings that would otherwise halt the update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Accounts

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_UPDATE_ACCOUNTS`

Create or update GL accounts, recursive account hierarchies, and account-attribute mappings in one ordered bulk request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accounts` | array | Yes | GL accounts to create or update in top-to-bottom order. |
| `display_name_enabled` | boolean | No | Use the v40 display-name-aware contract. |
| `proceed_with_warnings` | boolean | No | Allow Workday to correct incompatible inherited mappings during re-parenting. |
| `retain_existing_order` | boolean | No | Retain existing sibling order instead of payload order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Ownership Associations

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_UPDATE_ASSOCIATIONS`

Update level or custom-dimension ownership. Omitting users removes all owners from that value; replaceAll permanently deletes all existing ownership entries for the association type before saving the supplied entries. Unknown users are skipped by Workday.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `associations` | array | Yes | Ownership associations to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Attributes

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_UPDATE_ATTRIBUTES`

Create or update attributes and recursive attribute-value hierarchies in one ordered bulk request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `attributes` | array | Yes | Attributes to create or update. |
| `display_name_enabled` | boolean | No | Use the v40 display-name-aware contract. |
| `proceed_with_warnings` | boolean | No | Proceed with re-parenting that requires compatible account or level tagging corrections. |
| `retain_existing_order` | boolean | No | Retain existing value order instead of payload order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Dimensions

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_UPDATE_DIMENSIONS`

Create or update dimensions and recursive dimension-value hierarchies in one ordered bulk request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dimensions` | array | Yes | Dimensions and recursive values to create or update. |
| `display_name_enabled` | boolean | No | Use the v40 display-name-aware contract. |
| `retain_existing_order` | boolean | No | Retain existing order instead of payload order. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Levels

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_UPDATE_LEVELS`

Create or update levels and recursive organization hierarchies. Changing actuals ranges or re-parenting can cause Workday warnings and downstream compatibility changes. Setting delete_workflow_silently can delete workflow tasks, and setting delete_actuals_silently can delete actuals data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `levels` | array | Yes | Levels to create or update, either hierarchical or flat. |
| `display_name_enabled` | boolean | No | Use the v40 display-name-aware contract. |
| `retain_existing_order` | boolean | No | Retain existing level order instead of payload order. |
| `delete_actuals_silently` | boolean | No | Allow reducing a level's actuals range even when doing so deletes actuals data. |
| `delete_workflow_silently` | boolean | No | Allow disabling workflow even when doing so deletes the level's workflow tasks. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Users

**Slug:** `WORKDAY_ADAPTIVE_PLANNING_UPDATE_USERS`

Update one or more Adaptive Planning users. If successful, Workday returns a message for each updated user. This action does not update passwords or access rules and does not function after user synchronization from Workday.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `users` | array | Yes | Users to update. Each item requires a globally unique user GUID; all other user attributes are optional. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |