Skip to main content
Adaptive Planning
Laatst bijgewerkt: 2025-02-07
API Changes by Release

API Changes by Release

2025R1

(February 2025)
JSON Formatted REST APIs
  • Tasks Service
    • Tasks
      • /tasks?instanceCode=<instanceCode>
        (GET, POST)
        JSON based HTTP operations on integration tasks.

2024R2

(September 2024)
Introduction of API v40
  • Updated:
    importModeledSheet
    now supports the optional
    accountCode
    attribute within the
    DisplayColumns
    element. The
    code
    attribute of
    DisplayColumn
    now enables creating an editable unique identifier for the column. When
    accountCode
    isn't included in the request, we procedurally generate a unique
    code
    to link the column to a given account.
  • Updated:
    exportModeledSheet
    now supports the optional
    accountCode
    attribute within the
    DisplayColumns
    element. The
    code
    attribute of
    DisplayColumn
    now enables creating an editable unique identifier for the column.
  • updated:
    importConfigurableModelData
    corrected
    applyValidationRules
    description to indicate the default value is
    true
    , and has been since v38.
  • updated:
    importStandardData
    now supports
    splitsToUnsplit
    in the
    importDataOptions
    element, allowing splits to import into unsplit locations with existing data.
  • updated:
    exportCalendar
    now supports
    code
    in the
    calendar
    element.
  • updated:
    exportVersions
    now supports
    currencyVersions
    in the
    include
    element. This enables including currency versions for translated actuals in the response. You must contact your Named Support Contact to see if your instance is eligible for this feature.
JSON Formatted REST APIs
  • Modeling Service
    • Time
      • /updateTime
        the Calendar Object now supports
        code
        when codes are present.
    • Modeled Sheet Definition
      • /definition
        PATCH
        supports
        accountCode
        in the sheet column properties object to determine the modeled account for a display column. Only valid for display columns. The only valid values are accounts on the modeled sheet.
      • /definition
        PATCH
        supports
        code
        in the sheet column properties object to prefix account codes and a secondary identifier. Required when creating a new sheet. This functions the same as
        prefix
        and is the preferred property to match the user interface.

2024R1

(April 2024)
  • Regional authentication for non-US based tenants:
    If your instance uses non-US based, regional authentication, then your authorization URLs and API endpoints vary based on your region. See Reference: Regional Authentication URLs.
(March 2024)
Introduction of API v39
  • Updated:
    exportData
    no longer supports the
    sheet
    element in API v39 and above.
  • Updated:
    exportData
    supports:
    • All elements and attributes for the optimized path for performance and scalability for API v39 and above.
    • Accounts with weighted average rollup for performance and scalability for API v39 and above.
  • Updated:
    exportAttributes
    supports a
    code
    attribute for the
    attribute
    element. The
    code
    attribute is only available in API v39 and above.
  • Updated:
    updateAttributes
    supports a
    code
    attribute for the
    attribute
    element. The
    code
    attribute is only available in API v39 and above.
  • Updated:
    exportDimensions
    supports a
    code
    attribute for the
    dimension
    element. The
    code
    attribute is only available in API v39 and above.
  • Updated:
    updateDimensions
    supports a
    code
    attribute for the
    dimension
    element. The
    code
    attribute is only available in API v39 and above.
  • Updated:
    exportAccounts
    supports a new Boolean
    showAccountGroupCodes
    attribute in the
    include
    element. Setting this attribute to true in requests exports account group codes in the response. The
    showAccountGroupCodes
    attribute is only available in API v38 and above.
  • Updated:
    importModeledSheet
    requires a
    name
    and
    code
    attribute in the
    configurableModel
    element of requests. the
    name
    and
    code
    elements are only available in API v39 and above.
  • Updated:
    exportSheets
    we rename the
    prefix
    attribute to
    code
    in the
    modeled-sheet
    element. The
    code
    is only available in API v39 and above.
  • Updated:
    exportVersions
    supports the Boolean
    scenarios
    attribute in the
    include
    element of requests to return
    type="SCENARIO"
    for personal what-if scenarios in the response. Requires API v37 and above.
  • Updated:
    importGroups
    supports editing external user groups in the Adaptive Planning user interface when those user groups have
    dataSource=EXTERNAL
    .
  • Updated:
    createUser
    supports these attributes in the
    user
    element:
    • position
    • homepage
    • country
    • usState
    • netSuiteLogin
    • salesforceLogin
  • Updated:
    updateUser
    supports these attributes in the
    user
    element:
    • position
    • homepage
    • country
    • usState
    • perspective
    • perspectiveName
    • dashboard
    • dashboardName
    • netSuiteLogin
    • salesforceLogin
  • Updated:
    exportUsers
    supports these attributes in the
    user
    element:
    • alternateEmail
    • samlFedId
    • position
    • homepage
    • country
    • usState
    • perspective
    • perspectiveName
    • dashboard
    • dashboardName
    • nestuiteLogin
    • salesforceLogin
    • createdDate
    • lastLogin
    • failedAttempts
    • Locked
JSON Formatted REST APIs
  • Modeling Service
    • Modeled Sheet Definition
      • /sheet/modeled/definition
        PATCH
        supports
        delete
        as a property in the sheet column object to delete modeled sheet columns in Adaptive Planning. Delete can't delete:
        • Required columns.
        • Columns dependent on other columns that aren't flagged for deletion.
    • Cube Sheet Definition
      • /sheet/cube/definition
        (
        PATCH
        ,
        DELETE
        ) Insert, update, or delete a cube sheet definition in Adaptive Planning.
      • /sheet/cube/definition
        PATCH
        supports
        delete
        as a property in the sheet column object to delete cube sheet columns in Adaptive Planning. Delete can't delete:
        • Columns dependent on other columns that aren't flagged for deletion.
    • Introduction of APIs that only support deleting:
      • Accounts
        • /accounts/removeGLAccounts
          (
          POST
          ) Deletes general ledger accounts.
        • /accounts/removeAccounts
          (
          POST
          ) Deletes custom accounts.
      • Attribute
        • /attribute
          (
          DELETE
          ) Deletes an attribute and its attribute values.
      • Attribute Values
        • /removeAttributeValues
          (
          POST
          ) Deletes attribute values.
      • Dimension
        • /dimension
          (
          DELETE
          ) Deletes a dimension and its dimension values.
      • Dimension Values
        • /removeDimensionValues
          (
          POST
          ) Deletes dimension values.
      • Level
        • /removeLevels
          (
          POST
          ) Deletes levels.
  • Security Service
    • Groups:
      • /groups
        (
        GET
        ) Retrieve the complete list of all groups defined for the given instance.
  • Users
    • /users
      (
      DELETE
      ) Delete the user from Adaptive Planning.

2023R2

(December 8)
  • Updated:
    importConfigurableModelData
    supports
    applyValidationRules
    in the
    importDataOptions
    element for indicating if data imports validate against validation rules.
(September 9)
Introduction of API v37

2023R1

(March 11)
Introduction of API v36
  • Updated:
    importStandardData
    supports
    mode
    in the importDataOptions element for indicating
    REPLACE
    mode.
  • Updated:
    importStandardData
    requires the
    scope
    element when using
    replace
    mode to indicate the data being replaced. The
    scope
    element requires 1
    time
    element, 1
    accounts
    element with at least 1 child
    account
    element, and 1
    levels
    element.
  • Updated: Users making
    importStandardData
    requests require Erase Data permissions for API v36 to support
    REPLACE
    mode.
JSON Formatted APIs
  • Modeling Service:
    • Currency:
      • /currency
        (
        POST
        ,
        DELETE
        ) Create, update, or delete currencies in Adaptive Planning.
    • Exchange Rate Type:
      • /exchangeRateTypes
        (
        GET
        ,
        POST
        ,
        DELETE
        ) Insert, update, or delete exchange rate types in Adaptive Planning.
    • Sheet:
      • /sheet/modeled/definition
        (
        PATCH
        ,
        DELETE
        ) Insert, update, or delete a modeled sheet definition in Adaptive Planning.
    • Versions:
      • /versions
        (
        GET
        ,
        DELETE
        ,
        PATCH
        ,
        POST
        ) Retrieve, delete, update, or create versions in Adaptive Planning.
    • Time:
      • /updateTime
        (
        POST
        ) Reload, update, append the time structure in Adaptive Planning.

2022R2

(November 18, 2022)
Introduction of API v35
  • Updated:
    exportConfigurableModelData
    streaming supports
    useActualValue
    as an attribute in the request
    modeled-sheet
    element to return raw data instead of account precision. Calculated accounts return at 9-decimal precision.
  • Updated:
    exportConfigurableModelData
    supports a new
    status
    element in the
    response
    element. The
    status
    element includes a
    success
    Boolean attribute followed by
    rowCountSent
    to indicate rows sent when successful or not.
  • Updated:
    exportConfigurableModelData
    supports
    totalRowCount
    in the response output
    data
    element to indicate total rows in
    data
    .
  • Updated:
    exportConfigurableModelData
    automatically escapes double quotes in string values for dimension values and text fields in the response output.
  • Removed:
    success
    attribute in the
    response
    element of
    exportConfigurableModelData
    is removed by default for API v35 when streaming data (isGetAllRows="true").
  • Removed: The prefix
    s
    for
    parentId
    in the data output when
    useNumericIDs=true
    is removed for API v35 when streaming data (isGetAllRows="true").
(September 2022)
Introduction of API v34
  • Updated:
    updateAccounts
    supports tagging dimension values and attributes values by only using
    value
    . No longer supports
    valueName
    and
    valueCode
    with API v34.
  • Updated:
    updateDimensions
    supports tagging dimension values and attributes values by only using
    value
    . No longer supports
    valueName
    and
    valueCode
    with API v34.
  • Updated:
    updateLevels
    supports tagging dimension values and attributes values by only using
    value
    . No longer supports
    valueName
    and
    valueCode
    with API v34.
  • Updated:
    exportAccounts
    indicates tagged dimension values and attributes values with
    value
    . No longer supports
    valueName
    and
    valueCode
    with API v34.
  • Updated:
    exportDimensions
    indicates tagged dimension values and attributes values with
    value
    . No longer supports
    valueName
    and
    valueCode
    with API v34.
  • Updated:
    exportLevels
    indicates tagged dimension values and attributes values with
    value
    . No longer supports
    valueName
    and
    valueCode
    with API v34.
  • Updated:
    updateAccounts
    requests can set
    balanceType
    as either
    debit
    or
    credit
    . Child accounts can now use a different
    balanceType
    than their parent accounts to support contra accounts.
  • Updated:
    updateAccounts
    responses include a new boolean property for
    isContra
    to indicate if the account is a contra account.
  • Updated:
    createAccount
    responses include a new boolean property for
    isContra
    to indicate if the account is a contra account.
  • Updated:
    exportSheetDefinition
    returns
    horizontalAxis
    ,
    verticalAxis
    ,
    maxColumnWidth
    ,
    suppressZeroRows
    ,
    rearreangeGLAndCustomAccounts
    ,
    hideRollupTotals
    in the
    cube-sheet
    element.
  • Updated:
    exportSheetDefinition
    returns the
    users
    and
    user
    elements in the response if the calling user has the Model permission.
  • Updated:
    importCubeData
    supports
    mode
    in the
    importDataOptions
    element for indicating either
    APPEND
    or
    REPLACE
    import mode.
  • Updated:
    importCubeData
    supports the
    scope
    element when using
    REPLACE
    import mode to indicate the coordinates of the cube where data will be replaced.
(August 2022)
Introduction of API v33
  • New:
    exportCalendar
    supports exporting calendar metadata with the introduction of alternate calendars in 2022R2.
  • Updated:
    exportTime
    supports
    calendarId
    in the options element to retrieve the time values from any of your calendars with the introduction of alternate calendars in 2022R2.
  • Updated:
    exportConfigurableModelData
    now supports exporting only the columns of interest if you specify them in the
    filters
    element of the request.
  • Updated:
    exportConfigurableModelData
    now supports outputting number columns at the account decimal precision by setting
    useAccountPrecision=true
    for the
    modeled-sheet
    element when
    isGetAllRows=true
    .

2022R1

(May 2022)
  • Updated:
    updateLevels
    supports a flat input format allowing
    level
    tags to sit directly beneath a
    levels
    tag. This input format is only recommended for incremental changes to small portions of the levels hierarchy.
(March 2022)
  • New:
    importGroups
    : for importing a set of user groups.
Introduction of JSON formatted APIs Version 1
  • Modeling Service:
    • sheet/availability
      (
      GET
      ,
      POST
      ) Retrieve or update dimension or attribute value availability for a given sheet and column.
  • Security Service:
    • users/permissionSets
      (
      GET
      ,
      POST
      ) Assign permission sets to Adaptive Planning users.
    • users/instances
      (
      GET
      ,
      PATCH
      ,
      PUT
      ) Assign users to instances when using Adaptive Planning multi-instances in a parent-child hierarchy.
(February 2022)
Introduction of API v32
  • Updated:
    exportConfigurableModelData
    streams data for better performance.
  • Updated:
    updateLevels
    now supports
    valueCode
    and
    valueName
    in the
    dimension
    element when display names are enabled.
  • Updated:
    updateDimensions
    ,
    updateLevels
    , and
    updateAccounts
    now support
    valueCode
    and
    valueName
    in the
    attribute
    element when display names are enabled.
  • Updated:
    exportDimensions
    ,
    exportLevels
    , and
    exportAccounts
    now support
    valueCode
    ,
    valueName
    , and
    valueDisplayName
    in the
    attribute
    element when display names are enabled.

2021R2

(October 2021)
The following specific APIs now support level, dimension, and attribute codes for display names when:
  • You enable display names for your instance by opening a case in the Workday Customer Center.
  • You call API v30 or higher.
  • You enable
    displayNameEnabled
    per call (see each API documentation page for details).
  • Updated:
    updateLevels
    ,
    updateDimensions
    ,
    updateAttributes
    requests now accept
    code
    and
    name
    and continue to use
    id
    as the key.
    • code
      and
      name
      are required when you create dimension values, attribute values, and levels.
  • Updated:
    updateLevels
    ,
    updateDimensions
    ,
    updateAttributes
    responses now return
    name
    ,
    code
    ,
    displayName
    and
    displayNameType
    .
  • Updated:
    importDimensionMapping
    requests accept:
    • id
      and
      name
      for
      dimension
      .
    • id
      and
      code
      for levels and dimension values.
  • Updated:
    exportDimensionMapping
    requests filtering:
    • keyword
      value as a partial match on the display name.
    • level
      uses
      code
      instead of
      name
      .
    • dimensionValue
      uses
      code
      instead of
      name
      .
    • Attribute
      value
      refers to
      code
      , instead of
      name
      .
  • Updated:
    exportDimensionMapping
    responses return
    id
    ,
    name
    ,
    code
    ,
    display name
    for levels and dimension values.
  • Updated:
    exportLevels
    ,
    exportDimensions
    , and
    exportAttributes
    responses now return
    name
    ,
    code
    ,
    displayName
    ,
    displayNameType
    .
  • Updated:
    importStandardData
    ,
    importCubeData
    ,
    importConfigurableModelData
    , and
    importTransactions
    request:
    • Header row
      Level
      changes to
      Level Code
      .
    • Header row
      Account
      changes to
      Account Code
      .
    • Header row
      Dimensions
      change to
      "<dimension> Code"
      and
      "<dimension> Name"
      .
      "<dimension> Code"
      is required.
      "<dimension> Name"
      is only allowed when "Data import automatically creates dimension values" is enabled for a dimension.
    • Localization is supported in the column header for the text "Code", "Name", and "Display Name".
    • useMappings=false
      uses code in the system.
    • useMappings
      and
      displayNameEnabled
      can't be
      true
      at the same time.
  • Updated:
    exportConfigurableModelData
    (requires API v31) requests :
    • level
      element no longer supports
      name
      in API v31+.
    • level
      element adds support for
      code
      .
    • modeled-sheet
      element adds support for
      includeCodes
      ,
      includeNames
      , and
      includeDisplayNames
      with true/false options that apply to all
      dimension values
      and
      levels
      in the call. At least one of these three options must be true.
  • Updated:
    exportConfigurableModelData
    responses:
    • Includes columns for
      "<dimension> Code"
      ,
      "<dimension> Name"
      , and
      "<dimension> Display Name"
    • Localization is supported on the column header for the text "Code", "Name", and "Display Name".
  • Updated:
    exportData
    requests:
    • level
      element no longer supports
      name
      in API v30+.
    • level
      element adds support for
      code
      .
    • level
      will match code in the system.
    • dimensionValue
      element no longer supports
      name
      in API v30+.
    • dimensionValue
      adds support for
      code
      .
    • dimensionValue
      will match code in the system.
  • Updated:
    exportData
    responses:
    • Includes columns for
      "<dimension> Code"
      ,
      "<dimension> Name"
      , and
      "<dimension> Display Name"
    • Includes columns for
      "<level> Code"
      ,
      "<level> Name"
      , and
      "<level> Display Name"
    • Localization is supported on the column header for the text "Code", "Name", and "Display Name".
  • Updated:
    eraseData
    requests:
    • level
      element no longer supports
      name
      in API v30+.
    • level
      element adds support for
      code
      .
    • level
      will match code in the system.
Introduction of API v31
(September 2021)
  • Updated:
    importConfigurableModelData
    ,
    importTransactions
    ,
    importCubeData
    , and
    importStandardData
    error out when the number of pipe characters in the header and the data don't match.
  • Updated:
    updateAccessRules
    now requires the
    Users
    permission to invoke it, instead of the
    Admin
    permission.
  • Updated:
    updateAccounts
    now allows creating a new parent account between an existing parent and its child accounts.
(August 2021) Introduction of API v30

2021R1

(May 2021) Introduction of API v29
  • Updated:
    updateAccounts
    requests now allow creating new accounts with
    dataEntryType=CUBE
    .
    Adaptive Planning
    automatically calculates the
    dataEntryType
    for any non-leaf accounts. If the parent
    dataEntryType
    is
    CUBE
    , new accounts will default to
    dataEntryType=CUBE
    . Otherwise, new accounts default to
    dataEntryType=STANDARD
    . Changes to
    dataEntryType
    for non-leaf accounts are ignored.
  • Updated:
    UpdateAccounts
    responses indicate
    dataEntryType
    for all leaf accounts as either
    CUBE
    or
    STANDARD
    .
(April 2021) Introduction of API v28
  • Updated:
    exportVersions
    responses now include
    isPredictive=true
    in the
    version
    element to indicate predictive versions.
  • Updated:
    createUser
    requests now include
    alternateEmail
    and
    samlFedId
    . Use
    alternateEmail
    to set an alternate email, which we automatically select as the user's email in the User Details section. Use
    samlFedId
    to include the SAML federation ID for the user for single sign-on.
  • Updated:
    updateUser
    requests now include
    alternateEmail
    and
    samlFedId
    . Use
    alternateEmail
    to set an alternate email, which we automatically select as the user's email in the User Details section. Use
    samlFedId
    to include the SAML federation ID for the user for single sign-on.
(March 2021) Introduction of API v27
  • Updated:
    updateAttributes
    and
    updateDimensions
    requests include
    retainExistingOrder
    for indicating if the payload order is ignored to maintain the order
    Adaptive Planning
    already uses for hierarchies. If false, the order of the payload determines how Adaptive Planning will order elements.
  • Updated:
    updateLevels
    requests now set the default value of
    retainExistingOrder
    to 1.
  • Updated:
    updateAccounts
    requests now set the default value of
    retainExistingOrder
    to 1.
  • Updated:
    importModeledSheet
    requests now include
    requiredColumn
    for indicating if a dimension value must be provided for users to save the modeled sheet. You must ask
    Adaptive Planning
    support to enable
    requiredColumn
    for
    importModeledSheet
    requests.
  • Updated:
    exportModeledSheet
    responses now include
    requiredColumn
    for indicating if a dimension value must be provided for users to save the modeled sheet.
Introduction of API v26
  • Updated:
    updateAccounts
    and
    updateLevels
    requests include
    retainExistingOrder
    for indicating if the payload order is ignored to maintain the order
    Adaptive Planning
    already uses for hierarchies. If false, the order of the payload determines how Adaptive Planning will order elements.
  • Renamed: For all v26 APIs,
    permissionSetId
    replaces
    roleId
    with the renaming of Roles and Permissions to Permission Sets in
    Adaptive Planning
    .
  • New:
    updateAssociations
    for setting user dimension and level associations. Alternatively sets user level ownership for levels when
    code
    is not included in the Association element.
  • Removed:
    roleID
    is no longer supported in APIs v26 and newer. APIs v25 and older continue to support
    roleID
    .

2020R2

  • (February 2021) Updated: eraseData requests ignore the case of the
    Accounts
    and
    Levels
    tags.
  • (December 2020) Updated:
    updateDimensions
    request replaces newline characters found in the
    dimensionValue name
    of a payload with a blank space. Preceding or trailing newline characters in the name become spaces that get trimmed during payload processing.
  • (December 2020) Updated:
    updateDimensions
    request now handle multiple renames of the same entity in the same
    updateDimensions
    call. This helps resolve an issue when names swap more than once in a remote system between synchronizations into Adaptive Planning.
Introduction of API v25
  • Updated:
    exportData
    request no longer includes
    includeRollups
    . Request includes boolean
    includeRollupAccounts
    for account rollups and
    includeRollupLevels
    for level rollups.
Introduction of API v24
  • Updated:
    updateLevels
    request includes
    publishCurrency
    for indicating the currency when publishing a Financial Plan to Workday Core Financials.
  • Updated:
    exportLevels
    response includes
    publishCurrency
    for indicating the currency when publishing a Financial Plan to Workday Core Financials.
  • Updated:
    exportInstances
    response includes
    notificationType
    for indicating Workday tenant notification setting when
    Adaptive Planning
    is set up for Workday.
  • Updated:
    exportData
    request includes
    stratum
    for indicating the code of the time strata for the exported data. When specified, the start and end time periods must fall within the time strata. The time strata must be equal to or greater than the account with the highest time strata in the request.
  • Updated:
    exportData:
    When includeZeroRows=false, rows with a combination of only blanks and zeroes will not output in the response, even if markBlanks=true.
  • New:
    eraseData
    for erasing plan and actuals data. Provides the same capabilities as
    eraseActuals
    but also includes the ability to erase Plan data, with additional control over specific account-plan combinations that are targets.
  • New:
    updateAccessRules
    for updating access rules in-bulk by uploading a multipart xml document containing an .xslx formatted for the Access Rules template.

2020R1

Introduction of API v23
  • Updated:
    importConfigurableModelData
    request includes
    importKey
    for indicating the dimension or level to map import rows to the modeled sheet rows you want to update.
  • Updated:
    exportUsers
    and
    exportLevels
    requests can include the boolean
    groups
    so that responses include
    groupIds. GroupIds
    contain a comma-separated list of all groups the level or user belongs to. The
    groups
    attribute defaults to
    false
    .
  • New: (
    Available only with sales planning.
    )
    exportDimensionMapping
    export user-defined dimension mapping rules.
  • New: (
    Available only with sales planning.
    )
    importDimensionMapping
    update existing user-defined dimension mapping rules.

2019.3

Introduction of API v22
  • Updated:
    exportConfigurableModelData
    request includes the new optional property
    useNumericIDs
    to remove the
    S
    prefix from split IDs, returning only numeric values.
  • If your company Transition to Access Rules for security,
    exportAccounts, exportActiveCurrencies, exportAttributes, exportDimensions, exportLevels, exportTime,
    and
    exportVersions
    will only validate on API v22. The response will contain only what the user indicated in the
    credentials
    element has access to.
  • Updated:
    updateDimensions
    includes the new optional
    properties
    element for a
    dimensionValue
    that can contain up to five
    property
    elements. Each
    property
    element includes a
    name
    and
    value.
    The value must be numeric.
  • Updated:
    exportDimensions
    response includes the new
    properties
    element.
  • Updated:
    exportSheetDefinition
    cube sheet response includes the account
    code
    and
    name
    within the
    account
    element.
  • Updated:
    exportSheetDefinition
    cube sheet response includes the dimension
    name
    within the
    dimension
    element.
  • Updated:
    exportSheetDefinition
    cube sheet response includes the attribute
    name
    within the
    attribute
    element.
  • Updated:
    exportConfigurableModelData
    request includes the new optional
    includeAllColumns
    in the
    modeled-sheet
    element so that the response includes all columns.
  • Updated:
    exportConfigurableModelData
    response now indicates
    numberOfPages
    instead of
    pageCount
    in the
    job
    element.
  • Updated:
    exportInstances
    response now indicates if an instance allows Admin Publishing in the
    options
    attribute.
  • Removed:
    rootActuals
    is no longer supported for
    exportVersions
    regardless of API version.

2019.2

  • (September 2019) New:
    exportSecurityAudit
    returns a report of all security events in a specified time range.

2019.1

Introduction of API v20
  • Updated:
    exportInstances
    includes
    workdayTenantId
    ,
    workdayEnvironment
    ,
    workdayUiUrl
    , and
    workdayRestUrl
    information for instances with Workday Power of One enabled.
  • New:
    updateAccounts
    for updating/creating accounts in-bulk. Manage accounts and their properties. Allows reparenting of existing accounts.
  • New:
    updateAttributes
    for updating/creating attributes in-bulk. Manage attributes and their attribute values. Allows reparenting of existing attribute values.
  • Updated:
    exportAttributes
    includes the the
    autoCreate
    boolean property to indicate if importing dimensions, levels, accounts, or attributes automatically creates new attribute values not found
    Adaptive Planning
    .
  • Updated:
    exportInstances
    includes
    workdayTenantID, workdayEnvironment, workdayUiUrl, workdayRestUrl
    for instances with Workday Power of One enabled.
  • Removed: Single-entity APIs for
    createDimension
    ,
    updateDimension
    ,
    createDimensionValue
    ,
    updateDimensionValue
    ,
    createLevel
    , and
    updateLevel
    . Use the metadata bulk APIs of
    updateDimensions
    and
    updateLevels
    for single-entity creation or update in API v20 and beyond.

2018.3

Introduction of API v19
  • New:
    updateLevels
    for updating/creating levels in-bulk. Manage levels and their attribute values. Allows reparenting of existing levels.
  • New:
    exportConfigurableModelData
    for exporting modeled sheet rows.

2018.2

Introduction of API v18
  • Removed:
    exportLevels
    no longer contains
    inaccessibleLevels
    attribute in the request. See the new
    inaccessibleValues
    .
  • Removed:
    exportUsers
    no longer contains options for
    hiddenVersions
    and
    ownedLevels
    .
  • Removed:
    exportAccounts
    no longer contains the
    formula
    attribute.
  • New:
    exportAccounts, exportAttributes,
    exportDimensions,
    and
    exportLevels
    include the new
    inaccessibleValues
    attribute in the request so that only users with the appropriate permissions can view inaccessible values.
  • Updated:
    exportAccounts, exportAttributes, exportDimensions,
    and
    exportLevels
    only show accessible values by default. Only users with appropriate permissions can view inaccessible values.
  • Updated:
    exportAccounts,
    exportDimensions,
    and
    exportLevels include
    element
    versionName
    and
    versionID
    attribute in the request call will only succeed if the user has access to the version.
  • Updated:
    exportAccounts
    the name "
    GL
    " is now "
    GL Accounts
    " to match how reports named this account.
  • Updated:
    exportActiveCurrencies
    response is now ordered by
    code.
  • Updated:
    exportTime version
    element
    option
    attribute for a single version in the request will only succeed if the user has access to the version.

2018.1

Introduction of API v17
  • Removed:
    updateUser
    removed from all API versions March 2018
  • Updated:
    exportActiveCurrencies
    contains a
    userDefined
    attribute to identify which currencies are user-defined.
  • New: API
    updateDimensions
    for updating/creating dimensions in-bulk by uploading an XML document

2017.3

Introduction of API v16
  • Updated: response formats of
    exportAccounts
    ,
    createAccount
    ,
    updatedAccount
    display the time strata code of each account in the
    timeStratum
    field
  • Updated:
    eraseActuals
    only accepts time periods at the same time strata as the input account type for API v15 +
  • Updated:
    eraseActuals
    uses the phrasing "time stratum" instead of "granularity"
  • Updated: request format of
    importModeledSheet
    includes optional
    strata-code
  • Updated: response format of
    exportModeledSheet
    includes optional
    strata-code
  • Added:
    inUse
    and
    isDefault
    property to
    stratum
    element in
    exportTime
  • Added: optional
    leafStratumId
    property to the request format of
    exportTime
  • New: API
    recalculateSheet
    for recalculating sheets that have the
    Recalculate on demand
    property

2017.2

Introduction of API v15
Companies are only upgraded from API v14 to API v15 if they import a custom calendar in the Time Administration UI.
  • Removed: calendar-related attributes for
    exportInstances
    calendarType, q1FirstMonth, lastMonthIsFY, firstDayOfWeek, periodAlgorithm, leapWeekPeriod,
    and
    extraPeriodQuarter
    attributes from
    instance
    element
  • Updated:
    exportTime
    significantly overhauled
  • Updated:
    exportData
    the behavior of
    start
    and
    end
    attributes use time period codes instead of MMM-YYYY date strings.
  • Updated:
    exportData
    output date headers changed to time period codes.
  • Updated:
    exportVersions
    to replace attributes
    startVerFY, completedValuesThruYr, completedValuesThruMon, completedValuesThruPer, startScrollYr, startScrollMon, startScrollPer, endVerFY, lockLeadingYr, lockLeadingMon, lockLeadingPer, leftScrollFY, startPlanYr, startPlanMon, startPlanPer, endPlanFY
    with
    startVer, endVer, startScroll, completedValuesThru, leftScroll, startPlan, endPlan, lockLeading
  • Updated:
    importStandardData, importConfigurableModelData, importCubeData
    accept time period codes instead of MMM-YYYY date strings
  • Updated:
    exportLevels
    modified the format of the
    availableStart
    and
    availableEnd
    attributes output time period codes instead of MMM-YYYY date strings.
  • Updated:
    eraseActuals
    behavior of attributes
    start
    and
    end
    to use time period codes instead of MMM-YYYY date strings
  • New: API
    exportLocales
    for exporting the locales from the Time Administration UI.

2017.1

Introduction of API v14
  • Updated:
    customReportValues
    includes a new optional element
    suppress-rollups
  • New: API
    exportModeledSheet
  • New: API
    importModeledSheet

2016.3

Introduction of API v13
  • Updated:
    exportAccounts
    includes a new optional element
    sheet
  • Updated:
    exportLevels
    includes a new optional element
    sheet
  • Updated:
    exportLevels
    includes a new optional response element
    hasChildren
  • Updated:
    exportVersions
    includes a new optional element
    include

2016.2

Introduction of API v12
  • Updated:
    importCubeData, importStandardData, importConfigurableData, importTransactions
    context information that is part of their error messages can be disabled using the attribute
    includeContext.

2016.1

Introduction of API v11
  • Removed:
    canBeTree
    attribute from
    exportDimensions
  • Updated:
    exportInstances
    includes new
    datasources
    attribute
  • Updated:
    exportInstances
    includes new potential value
    INTEGRATION
    to
    products
    attribute in the
    instance
    element
  • Updated:
    exportLevels
    includes new
    attributeId
    and
    valueId
    to
    attribute
    element
  • Updated:
    exportLevels
    includes new
    isLinked
    and
    isElimination
    attributes to
    level
    element
  • Updated:
    exportDimensions
    includes new
    attribute
    and
    attributes
    elements as descendants of
    dimensionValue
    element
  • Updated:
    exportDimensions
    includes new
    listDimension, keepSorted
    , and
    useOnLevels
    attributes to
    dimension
    element
  • Updated:
    exportSheetDefinition
    includes new
    required
    attribute to
    levels, text, dimension, text-selector, number, date, initial-balance, level-currency, display, timespan
    elements of
    modeled-sheet
  • Updated:
    exportSheetDefinition
    includes new
    attribute
    element for cube sheets
  • Updated:
    exportSheetDefinition
    includes new
    split-column-title
    and
    allow-splits
    attributes to
    modeled-sheet
    element
  • Updated: Import data APIs (
    importCubeData, importStandardData, importConfigurableModelData,
    importTransactions
    ) now have context information as part of their error messages
  • New: API
    createDimension
  • New: API
    updateDimension
  • New: API
    updateDimensionValue
  • New: API
    createLevel
  • New: API
    updateLevel