API Changes by Release
2019.3
Introduction of API v22
- If your company transitions to Access Rules for security,
exportAccounts, exportActiveCurrencies, exportAttributes, exportDimensions, exportLevels, exportTime,
andexportVersions
will only validate on API v22. The response will contain only what the user indicated in thecredentials
element has access to. - Updated:
updateDimensions
includes the new optionalproperties
element for adimensionValue
that can contain up to fiveproperty
elements. Eachproperty
element includes aname
andvalue.
The value must be numeric. - Updated:
exportDimensions
response includes the newproperties
element. - Updated:
exportSheetDefinition
cube sheet response includes the accountcode
andname
within theaccount
element. - Updated:
exportSheetDefinition
cube sheet response includes the dimensionname
within thedimension
element. - Updated:
exportSheetDefinition
cube sheet response includes the attributename
within theattribute
element. - Updated:
exportConfigurableModelData
request includes the new optionalincludeAllColumns
in themodeled-sheet
element so that the response includes all columns. - Updated:
exportInstances
response now indicates if an instance allows Admin Publishing in theoptions
attribute. - Removed:
rootActuals
is no longer supported forexportVersions
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
includesworkdayTenantId
,workdayEnvironment
,workdayUiUrl
, andworkdayRestUrl
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 theautoCreate
boolean property to indicate if importing dimensions, levels, accounts, or attributes automatically creates new attribute values not found Adaptive Insights. - Updated:
exportInstances
includesworkdayTenantID, workdayEnvironment, workdayUiUrl, workdayRestUrl
for instances with Workday Power of One enabled. - Removed: Single-entity APIs for
createDimension
,updateDimension
,createDimensionValue
,updateDimensionValue
,createLevel
, andupdateLevel
. Use the metadata bulk APIs ofupdateDimensions
andupdateLevels
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 containsinaccessibleLevels
attribute in the request. See the newinaccessibleValues
. - Removed:
exportUsers
no longer contains options forhiddenVersions
andownedLevels
. - Removed:
exportAccounts
no longer contains theformula
attribute. - New:
exportAccounts, exportAttributes,
exportDimensions,
andexportLevels
include the newinaccessibleValues
attribute in the request so that only users with the appropriate permissions can view inaccessible values. - Updated:
exportAccounts, exportAttributes, exportDimensions,
andexportLevels
only show accessible values by default. Only users with appropriate permissions can view inaccessible values. - Updated:
exportAccounts,
exportDimensions,
andexportLevels include
elementversionName
andversionID
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 bycode.
- Updated:
exportTime version
elementoption
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 auserDefined
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 stratum code of each account in thetimeStratum
field - Updated:
eraseActuals
only accepts time periods at the same time stratum as the input account type for API v15 + - Updated:
eraseActuals
uses the phrasing "time stratum" instead of "granularity" - Updated: request format of
importModeledSheet
includes optionalstrata-code
- Updated: response format of
exportModeledSheet
includes optionalstrata-code
- Added:
inUse
andisDefault
property tostratum
element inexportTime
- Added: optional
leafStratumId
property to the request format ofexportTime
- 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,
andextraPeriodQuarter
attributes frominstance
element - Updated:
exportTime
significantly overhauled - Updated:
exportData
the behavior ofstart
andend
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 attributesstartVerFY, completedValuesThruYr, completedValuesThruMon, completedValuesThruPer, startScrollYr, startScrollMon, startScrollPer, endVerFY, lockLeadingYr, lockLeadingMon, lockLeadingPer, leftScrollFY, startPlanYr, startPlanMon, startPlanPer, endPlanFY
withstartVer, 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 theavailableStart
andavailableEnd
attributes output time period codes instead of MMM-YYYY date strings. - Updated:
eraseActuals
behavior of attributesstart
andend
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 elementsuppress-rollups
- New: API
exportModeledSheet
- New: API
importModeledSheet
2016.3
Introduction of API v13
- Updated:
exportAccounts
includes a new optional elementsheet
- Updated:
exportLevels
includes a new optional elementsheet
- Updated:
exportLevels
includes a new optional response elementhasChildren
- Updated:
exportVersions
includes a new optional elementinclude
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 attributeincludeContext.
2016.1
Introduction of API v11
- Removed:
canBeTree
attribute fromexportDimensions
- Updated:
exportInstances
includes newdatasources
attribute - Updated:
exportInstances
includes new potential valueINTEGRATION
toproducts
attribute in theinstance
element - Updated:
exportLevels
includes newattributeId
andvalueId
toattribute
element - Updated:
exportLevels
includes newisLinked
andisElimination
attributes tolevel
element - Updated:
exportDimensions
includes newattribute
andattributes
elements as descendants ofdimensionValue
element - Updated:
exportDimensions
includes newlistDimension, keepSorted
, anduseOnLevels
attributes todimension
element - Updated:
exportSheetDefinition
includes newrequired
attribute tolevels, text, dimension, text-selector, number, date, initial-balance, level-currency, display, timespan
elements ofmodeled-sheet
- Updated:
exportSheetDefinition
includes newattribute
element for cube sheets - Updated:
exportSheetDefinition
includes newsplit-column-title
andallow-splits
attributes tomodeled-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