Workday Adaptive Planning API Configuration

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "workday_adaptive",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "LOW",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "auth_mode": "PASSWORD",
    "client_id": "string",
    "host": "https://impl-services1.wd12.myworkday.com",
    "instance_code": "string",
    "isu": "string",
    "login": "string",
    "password": "string",
    "private_key": "string",
    "reports": [
      {
        "account_sync_mode": "SELECT_SPECIFIC_ACCOUNTS | SYNC_ALL_ACCOUNTS",
        "currency": "string",
        "dimensions": [
          "string"
        ],
        "include_zero_rows": true,
        "level_sync_mode": "SELECT_SPECIFIC_LEVELS | SYNC_ALL_LEVELS",
        "selected_accounts": [
          "string"
        ],
        "selected_levels": [
          "string"
        ],
        "sync_descendant_accounts": true,
        "sync_descendant_levels": true,
        "table": "string",
        "version_sync_strategy": "SYNC_SELECT_VERSIONS | SYNC_ALL_AND_NEW_VERSIONS",
        "versions": [
          "string"
        ]
      }
    ],
    "tenant": "string",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`auth_mode`	Authentication mode: PASSWORD (username/password) or TOKEN (key-based authentication)
`client_id`	Client ID for token authentication (required for TOKEN authentication)
`host`	Workday Adaptive host URL, including the scheme, required for TOKEN authentication
`instance_code`	Instance code for Workday Adaptive Planning.
`isu`	Integration System User (ISU) for token authentication (required for TOKEN authentication)
`login`	User email address (required for PASSWORD authentication)
`password`	User password (required for PASSWORD authentication)
`private_key`	PEM-formatted PKCS#8 private key, including BEGIN/END PRIVATE KEY markers, for token authentication
`reports`	Custom Report
`reports[0].account_sync_mode`	Account sync mode for the table. Options: `SYNC_ALL_ACCOUNTS` (sync all accounts) or `SELECT_SPECIFIC_ACCOUNTS` (sync selected accounts only).
`reports[0].currency`	List of currencies to sync for the table, if applicable.
`reports[0].dimensions`	List of dimensions to sync for the table, if applicable.
`reports[0].include_zero_rows`	Include zero rows in the table sync.
`reports[0].level_sync_mode`	Level sync mode for the table. Options: `SYNC_ALL_LEVELS` (sync all levels) or `SELECT_SPECIFIC_LEVELS` (sync selected levels only).
`reports[0].selected_accounts`	List of account IDs to sync when `accountSyncMode` is `SELECT_SPECIFIC_ACCOUNTS`. Each ID should be in the format: `<accountId>,<isAssumption>` (e.g., `1,false`).
`reports[0].selected_levels`	List of level IDs to sync when `levelSyncMode` is `SELECT_SPECIFIC_LEVELS`.
`reports[0].sync_descendant_accounts`	Flag to indicate if descendant accounts should be included for the selected accounts.
`reports[0].sync_descendant_levels`	Flag to indicate if descendant levels should be included for the selected levels.
`reports[0].table`	Table name to be synced.
`reports[0].version_sync_strategy`	Version sync strategy for the table, `SYNC_ALL_AND_NEW_VERSIONS` or `SYNC_SELECT_VERSIONS`.
`reports[0].versions`	List of versions to sync for the table, if versionSyncStrategy is `SYNC_SELECT_VERSIONS`.
`tenant`	Tenant identifier (required for TOKEN authentication)
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are three ways to authorize this connector type:

Username and Password: By specifying the auth_mode as "PASSWORD" and the values for the login and password parameters in the request.
POST https://api.fivetran.com/v1/connections
```
{
  "service": "workday_adaptive",
  "group_id": "group_id",
  "config": {
    "login": "string",
    "password": "string",
    "auth_mode": "PASSWORD"
  }
}
```

Token-Based: By specifying the auth_mode as "TOKEN" and the values for the client_id, private_key, host, tenant and isu parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "workday_adaptive",
  "group_id": "group_id",
  "config": {
    "client_id": "string",
    "private_key": "string",
    "host": "https://impl-services1.wd12.myworkday.com",
    "tenant": "string",
    "isu": "string",
    "auth_mode": "TOKEN"
  }
}

By using the Connect Card or the Fivetran dashboard.