Workday Adaptive Planning API Configuration Beta
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": "NORMAL", "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 }, "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": "SOURCE_NAMING", "config": { "reports": [ { "include_zero_rows": true, "versions": [ "string" ], "version_sync_strategy": "SYNC_SELECT_VERSIONS | SYNC_ALL_AND_NEW_VERSIONS", "currency": "string", "accounts": [ { "flag": true, "id": "string" } ], "table": "string", "levels": [ { "flag": true, "id": "string" } ], "dimensions": [ "string" ] } ], "password": "string", "instance_code": "string", "login": "string", "schema": "schema_name" } }
Config parameters
| Name | Description |
|---|---|
reports | Custom Report |
reports[0].include_zero_rows | Include zero rows in the table sync |
reports[0].versions | List of versions to sync for the table, if versionSyncStrategy is SYNC_SELECT_VERSIONS |
reports[0].version_sync_strategy | Version sync strategy for the table, SYNC_ALL_AND_NEW_VERSIONS or SYNC_SELECT_VERSIONS |
reports[0].currency | List of currencies to sync for the table, if applicable |
reports[0].accounts | List of accounts to sync for the table, if applicable |
reports[0].accounts[0].flag | Flag to indicate if descendants are included or not |
reports[0].accounts[0].id | Account ID to sync |
reports[0].table | Table name to be synced |
reports[0].levels | List of levels to sync for the table, if applicable |
reports[0].levels[0].flag | Flag to indicate if descendants are included or not |
reports[0].levels[0].id | Level ID to sync |
reports[0].dimensions | List of dimensions to sync for the table, if applicable |
password | User password |
instance_code | Instance code for Workday Adaptive Planning |
login | User email address |
schema (required) | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
- By specifying the values for the
loginandpasswordparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "workday_adaptive", "group_id": "group_id", "config": { "login": "string", "password": "string" } } By using the Connect Card or the Fivetran dashboard.