Skip to main content
Adaptive Insights
Knowledge @ Adaptive Insights LLC, a Workday company.

exportConfigurableModelData

Supported in API v19 + 

Category

Data retrieval

Description

Returns a set of rows from the requested modeled sheet in the requested version and instance.

Permissions Required To Invoke

Read access to the sheet, version, and instance being requested.

Parameters Required On Request

Credentials, Modeled-Sheet, Version, Job

This method's request contains the parameters that will be used to determine which modeled rows will be returned. User must have read access to the sheet, version, and instance containing the modeled sheet.

Best Practice: Invoke exportSheets to retrieve the modeled sheet name and ID needed for your exportConfigurableModelData request.

Request Format

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportConfigurableModelData" callerName="me">
    <credentials login="user@example.com" password="password"/>
    <version name="Budget 2017"/>
    <job jobNumber="0" pageNumber="0"/>
    <modeled-sheet name="Capital Model" isGlobal="false"/>
    <filters>
        <timeSpan start="Mar-2016" end="Dec-2017"/>
        <levels>
            <level name="Hosting" includeDescendants="true"/>
        </levels>
    </filters>
</call>

 

credentials element

Tag Name

credentials

Description

All API calls must contain a single credentials element to identify the user invoking the API. The API call is then performed as this user (any audit trail or history of actions in the system will show that this user performed the action), and therefore the user must have the required permissions to perform the action in order for the API call to succeed.

Attributes of the Element

Attribute Name

Required?

Value

Example

login

Y

The login name of the user invoking the API method. This user must have a role containing the permissions required for the method being invoked.

sampleuser@company.com

password

Y

The password of the user invoking the API method.

my_password

Contents of the Element

(none)

 

version element

Tag Name

version

Description

Specifies which version to retrieve the modeled rows from.

Attributes of the Element

Attribute Name

Required?

Value

Example

Name Y The name of the version. Budget 2

Contents of the Element

Contains one or more level elements.

 

modeled-sheet element

Tag Name

modeled-sheet

Description

Specifies which modeled sheet to retrieve the modeled rows from. Uses the id or name of the model sheet as the identifier.

Attributes of the Element

Attribute Name

Required?

Value

Example

Name Y The name of the modeled sheet. Working Budget
isGlobal N Specifies if the sheet is  user assigned sheet or a level assigned sheet. If true the sheet is a user-assigned sheet. If false the sheet is a level assigned sheet. false

Contents of the Element

(none)

 

job element

Tag Name

job

Description

Specifies the API handler serial number for the API call job.

Attributes of the Element

Attribute Name

Required?

Value

Example

jobNumber Y

0 for the initial call. A job number returns in the response. Use this job number for every subsequent request.

The API handler will then create a sheet model which will load the sheet into memory. The sheet remains in memory until the request times out and gets garbage collected. The API then returns the first page along with the other parameters listed above.

2
pageNumber N

Specifies the page number being requested if more than one page exists. The page number index starts with "1."

The API handler is for the same user who makes subsequent call using the same request API and authentication.

The subsequent request must be within 3 minutes of the last response time.

1

Contents of the Element

(none)

 

filters element

Tag Name

filters

Description

Container for the all the filters related elements.

Attributes of the Element

Attribute Name

Required?

Value

Example

Contents of the Element

The levels element.

 

levels element

Tag Name

levels

Description

Container for one level element Specifies the level to retrieve rows from. 

Attributes of the Element

Attribute Name

Required?

Value

Example

Contents of the Element

One level elements.

 

level element

Tag Name

level

Description

Specifies a level by which to filter the request.

Attributes of the Element

Attribute Name

Required?

Value

Example

name

Y

The name of the level being requested.

HQ

includeDescendants N

Indicates whether the export should include all descendants of the specified level or not. If set to true, all children of this level will export, as will their children, and so on. If set to false, this level will be exported alone.

Indicating "false" allows exporting  levels indicated as level (only) in the Adaptive Insights web UI.

true

Contents of the Element

The level name

 

timeSpan element

Tag Name

timeSpan

Description

If the model sheet has a timeSpan element, the start and end specify the time range of data to export from the sheet. If timeSpan is not included, data from the version's full date range export.  Use an internal time period code (from the Time Administration UI) or localized time label from the sheet view to indicate a timeSpan start or end.

TimeSpan duplicates the functionality of the Display Options > Time settings for leaf time selections in Start and End for a modeled sheet in the Adaptive Insights UI.

Attributes of the Element

Attribute Name

Required?

Value

Example

start

N

The time code or localized time label visible in the sheet of the first time period in the range to export. The start time period must be a leaf time period. If start is not indicated, the start of the version is used.

Jan-2016

01/2016

end N

The time code or localized time label of the last time period in the range to export. The end time period must be a leaf time period. If end is not indicated, the end of the version is used.

Nov-2016

11/2016

timeSpan examples

Start of January 2016 and end April 2016. Jan-2016 is the internal time period code indicated by the Time Administration UI. 04/2016 is a sheet time label.

<timeSpan start="Jan-2016" end="04/2016"/>

Start of February 2016 and end at the version's end date. 02/2016 is a sheet time label.

<timeSpan start="02/2016"/>

Start with the version's start date and end November 2016. Nov-2016 is the internal time period code indicated by the Time Administration UI.

<timeSpan start="" end="Nov-2016"/>

 

Response Format

<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
    <output>
        <data jobNumber="3">
            <![CDATA["InternalID","Plan","CapitalAssetClass","Label","Price","Currency","Mar-2016","Q1-FY16","Apr-2016","May-2016","Jun-2016","Q2-FY16","Jul-2016","Aug-2016","Sep-2016","Q3-FY16","Oct-2016","Nov-2016","Dec-2016","Q4-FY16","FY2016","Jan-2017","Feb-2017","Mar-2017","Q1-FY17","Apr-2017","May-2017","Jun-2017","Q2-FY17","Jul-2017","Aug-2017","Sep-2017","Q3-FY17","Oct-2017","Nov-2017","Dec-2017","Q4-FY17","FY2017"
"S1325","Development","Furniture","Chairs","90","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""
"S1326","Development","Furniture","Desks","200","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""
"S1327","Development","Computers","EngineerWS","2500","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""
"S1328","Development","Computers","ManagerWS","1000","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""
"S1323","G & A","Facility","Garage","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""
"S1324","G & A","OtherEquipment","CD_Maker","","USD","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""]]>
        </data>
    </output>
</response>

 

response element

Tag Name

response

Attributes of the Element

Attribute Name

Required?

Value

Example

success

Y

Either true or false, indicating whether the API call was successful or not. Even successful calls may contain warning messages in their response.

true

Contents of the Element

A single optional messages element, and exactly one required output element.

 

messages element

Tag Name

messages

Description

Container for one or more message elements.

Attributes of the Element

(none)

Contents of the Element

One or more message elements.

 

message element

Tag Name

message

Description

Represents a message being sent from the system back to the caller. Messages are used for error messages when requests do not succeed, for warning messages when requests do succeed, and for confirmation messages upon success.

Attributes of the Element

Attribute Name

Required?

Value

Example

key

N

When given, a key is a way to identify a particular message or type of message, useful for purposes of automated error logging and recovery in client programs. Keys do not change under different locales of requests, even when the language of the message changes. Keys also are unlikely to change in the future due to wording adjustments or terminology changes.

invalid-attributevalueid

Contents of the Element

The text of the message. This text is in the language of the locale specified on the request (assuming that locale is supported). The text may also contain variable information such as the number of rows which were processed, or the particular column or value which caused an error.

 

job element

Tag Name

job

Description

Specifies the job and data paging information for the data returned so the user can make a series of calls to extract all the data for the filtered dataset from the model sheet.

Attributes of the Element

Attribute Name

Required?

Value

Example

jobNumber N The dedicated API handler serial number assigned by the server for the API call job. Used in all subsequent requests. 2
pageCount N The total number of pages of data available for the filter set. 3
pageNumber N The page number for the current dataset being returned. 0

Contents of the Element

One or more level elements. If the request includes inaccessible levels, there will be only one level element, which represents the top level of the organization.

 

output element

Tag Name

output

Description

The response returns a CDATA block containing a CSV-formatted data dump of the modeled rows being exported. The first row of the CDATA block is the "header row" of the CSV, and all following rows are data rows. If no rows match the filtering request, then only the header row is output.

The columns of the CSV begin with up to five hardcoded internal-focused columns. These columns can identify the row and some of its immutable properties. The  columns present on the sheet follow, regardless of whether:

  • The individual user may have hidden them in their display options
  • The columns are read-only or not.

All columns in the API response are the visible/defined columns for the sheet, with their declared column header being their label in the header row. This includes any attribute columns placed on the sheet. For the timespan account, the column headers are the months of the current version in the same format as the exportData API.

Attributes of the Element

Attribute Name

Required?

Value

Example

Level N The name of the level where this row or split/row resides. This appears regardless of whether the level being requested is a rollup level or not. Engineering

Contents of the Element

A CDATA block containing:

  • Rows formatted as valid CSV.
    • Strings are enclosed in double quotes.
    • Numbers are emitted in canonical form (not locale-sensitive format). Commas are removed
    • Dimensions and text selectors emit the selected value they have. If they have no value, they emit an empty string.
  • When emitting parent rows, any splittable columns are shown as blank in the CSV (they do not attempt to show any rollup or 'various' values).
  • When emitting child/split rows, any non-splittable columns will be shown as containing the value from their parent row. This is identical to how sheet behaves in the Adaptive Insights web UI.

 

  • Was this article helpful?