Skip to main content

Workday Adaptive Planning API

Workday Adaptive Planning is a cloud-based enterprise planning platform that enables organizations to model, plan, and analyze business performance across finance, sales, workforce, and operations with collaborative planning capabilities.

Workday Adaptive Planning API icon

Power end-to-end data operations for your Workday Adaptive Planning API API with Nexla. Our bi-directional Workday Adaptive Planning API connector is purpose-built for Workday Adaptive Planning API, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Workday Adaptive Planning API or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Workday Adaptive Planning API workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Workday Adaptive Planning credential, you need to obtain your Username/Email and Password from your Workday Adaptive Planning account. Workday Adaptive Planning uses username and password authentication for all API requests.

To obtain your Workday Adaptive Planning credentials, follow these steps:

  1. Sign in to your Workday Adaptive Planning account using your administrator credentials.

  2. Navigate to your account settings or user profile in your Workday Adaptive Planning dashboard.

  3. Ensure that your user account has the required permissions to invoke API methods. The user must have the necessary API access permissions configured in Workday Adaptive Planning.

  4. Your Username/Email is typically your Workday Adaptive Planning login email address or username that you use to sign in to the system.

  5. Your Password is the password associated with your Workday Adaptive Planning account.

  6. Store both credentials securely, as you will need them to configure your Nexla credential. The Password is sensitive information and should be kept confidential.

The Username/Email and Password are used to authenticate API requests to the Workday Adaptive Planning API. The login name of the user invoking the API must have the required permissions to invoke methods. If your credentials are compromised, you should immediately change your password in your Workday Adaptive Planning account. For detailed information about API authentication, permissions, and available endpoints, refer to the Workday Adaptive Planning API documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
Username/EmailYesNoThe login name of the user invoking the API. This user must have the required permissions to invoke methods.
PasswordYesYesThe password of the user invoking the API.
API VersionYesNo

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Workday Adaptive Planning

WorkdayAPCred.png
  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  2. Enter your Username/Email in the Username/Email field. This is the login name of the user invoking the API. This user must have the required permissions to invoke methods. The Username/Email is typically your Workday Adaptive Planning login email address or username.

  3. Enter your Password in the Password field. This is the password of the user invoking the API. The Password is sensitive information and must be kept confidential.

  4. Enter your API Version in the API Version field. This should be the version of the Workday Adaptive Planning API you want to use (e.g., 39). The default value is 39. The API Version determines which version of the API will be used for requests.

    Your Workday Adaptive Planning credentials (Username/Email, Password) are the same credentials you use to sign in to your Workday Adaptive Planning account. The login name of the user invoking the API must have the required permissions to invoke methods.

    If your credentials are compromised, you should immediately change your password in your Workday Adaptive Planning account. The credentials provide access to your Workday Adaptive Planning account data and should be treated as sensitive information. Keep your credentials secure and do not share them publicly.

    For detailed information about API authentication, permissions, and available endpoints, see the Workday Adaptive Planning API documentation and Workday Adaptive Planning API overview.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Workday Adaptive Planning connector tile, then select the credential that will be used to connect to the Workday Adaptive Planning instance, and click Next; or, create a new Workday Adaptive Planning credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Workday Adaptive Planning endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Export Sheets

This endpoint template returns an XML document describing the complete set of all sheets found in the user's instance from your Workday Adaptive Planning account. Use this template when you need to access sheet information, sheet metadata, or sheet structures for analysis, reporting, or integration purposes.

  • This endpoint automatically returns an XML document describing the complete set of all sheets found in the user's instance from your Workday Adaptive Planning account. No additional configuration is required beyond selecting this endpoint template. The endpoint uses XML format for responses and includes sheet information, sheet metadata, and sheet structures.

This endpoint returns an XML document describing the complete set of all sheets found in the user's instance from your Workday Adaptive Planning account, including sheet IDs, names, structures, and other sheet metadata. The endpoint uses XML format for responses and provides comprehensive information about all sheets available in your Workday Adaptive Planning instance.

For detailed information about sheets, API response structures, and available sheet data, see the Workday Adaptive Planning API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Workday Adaptive Planning data sources can also be manually configured to ingest data from any valid Workday Adaptive Planning API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Workday Adaptive Planning API endpoints typically use XML format for requests and responses; manual configuration may require XML body templates and proper XML path configuration for data extraction. Use the POST method for retrieving data (most common for Workday Adaptive Planning data sources, as the API uses POST requests with an XML body). The API endpoint URL format typically follows https://api.adaptiveplanning.com/api/v{api_version}, where {api_version} is your API version.

For responses in XML format, enter the XPath that points to the object/array containing the relevant data (e.g., /response/output/sheets for sheet data). For responses in JSON format, enter the JSON path that points to the object or array (e.g., $.sheets[*]). For complete information about Workday Adaptive Planning API endpoints and response formats, see the Workday Adaptive Planning API documentation.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Workday Adaptive Planning data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.