Help Desk

Submit a ticket My Tickets
Welcome
Login

Adaptive Insights Command Reference

A bi-directional connector to Adaptive Insights via their REST API. This BizApp enables exporting and importing data directly into sheets and cubes, as well as exporting metadata.

Connections

Adaptive Insights

Connector using basic authentication to the Adaptive Insights REST API

Inputs

Input Type Detail Notes
Username TextField 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.
Password TextField The password of the user invoking the API method
Instance Code TextField If the user specified in the credentials has access to more than one instance of Adaptive Insights, this attribute can be used to specify that the user is intending to access an instance other than their default instance. If not speciĀ­fied, the user's default instance will be used. To determine the available instance codes, use the exportInstances API

Commands

Export Accounts

Returns metadata for the complete list of all accounts in the system, including all account types: Assumptions, Cube Accounts, Custom Accounts, GL Accounts, Metric Accounts, and Modeled Accounts

Inputs

Input Type Detail Notes
Version Name TextField Indicates whether the response should include the isImportable attribute in the response for each account, indicating whether the account can accept imported data for the specified version. The default, if this element or its attribute is not present, is to not emit any isImportable attributes in the response. If both versionName and versionID attributes are specified on this element, the versionID is ignored. When specifying a version, the call will succeed only if the user has access to the version.
Include Attributes BooleanField Indicates whether the response should include the attributes for each account
Include Inaccessible Values BooleanField Indicates whether the response should include values inaccessible to the current user. Defaults to false. Only users with the "Modeling" or "Import to all levels" permissions may set this option to true

Outputs

Output Output Type Notes
Accounts (JSON) File
Accounts (CSV) File
Attributes (CSV) File

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating

Export Data

This is the basic method used to retrieve data from Adaptive Insights, and can be used to retrieve values from any accounts, including standard accounts, GL accounts, modeled accounts, cube accounts, custom accounts, metric accounts, assumptions, and exchange rates.

Inputs

Input Type Detail Notes
Version GroupField Indicates which version should be used to retrieve the requested data. A version must be provided.
Format GroupField Indicates the type of formatting that should be used on the individual fields of the data to be returned.
Account Filters GroupField Specifies an account to have its data exported. If more than one account element is placed within the accounts element, all accounts which match any of the account elements will be exported. If any given account element results in no accounts which match it, that element is ignored while the other elements still apply.
Dimension Value Filters GroupField Indicates that the exported data should contain only values which match the specified dimensionValue. If more than one dimensionValue element is within the dimensionValues element, then data must match all specified dimensions, but any of the specified dimension values within each dimension in order to be exported. For example, if a request specifies dimension values of Region=East, Region=West, and Product=Product_A, then data must match either East or West Region, but must also match Product_A Product in order to be exported.
Dimension Data GroupField Indicates that the exported data should be broken down, or sliced, by the specified dimension. Note that this tag is not a part of the filters tag and does not control filtering: it instead controls how many rows are exported for each account/level combination. For each dimension specified in the dimensions tag, each existing combination of values will be exported as a separate row of data. Each dimension present in the dimensions element also causes an extra column to appear in the output, labeled with that dimension name.
Level Filters GroupField Specifies an organization level to have its data exported in the exportData API call. If more than one level element is placed within the levels element, all specified levels will be exported. If any given level element has no matching levels in the instance, that element is ignored while the other elements still apply.
Rules GroupField Specifies some extra output rules that control which types of rows are emitted and how some field values will be rendered.
Time Span Filter GroupField Indicates which time periods should be returned in the response. Time periods between the specified range, inclusive, are included in the output as separate columns of data; they are not aggregated or rolled up.

Outputs

Output Output Type Notes
Data (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating

Export Dimension Families

Returns metadata describing the relationships between sets of accounts and sets of dimensions

Inputs

None

Outputs

Output Output Type Notes
Families (JSON) File
Families (CSV) File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating

Export Dimensions

Returns metadata for the complete list of all dimensions in the system

Inputs

Input Type Detail Notes
Version Name TextField Indicates whether the response should exclude dimension values which are unavailable for the requested version name. The default, if the element or its attribute is not present, is to return all dimensions and values. If a version name is specified, dimension values which are unavailable for the specified version will not be returned. If the specified version name is not found, this API returns an error. If both versionName and versionID attributes are passed, the versionID is ignored. When specifying a version, the call will succeed only if the user has access to the version.
Include Attributes BooleanField Indicates whether the response should include the attributes in the response for each flat dimension.
Include Inaccessible Values BooleanField Indicates whether the response should include values inaccessible to the current user. Defaults to false. Only users with the "Modeling" or "Import to all levels" permissions may set this option to true
Include Dimension Values BooleanField Indicates whether the response should return dimension values. If false, returns filtered dimensions only, and not the dimension values.
Dimension IDs TextField A list of ids which will appear result. This filters for a dimension, but not a dimension value.

Outputs

Output Output Type Notes
Dimensions (JSON) File
Dimensions (CSV) File
Dimensions (CSV) File

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating

Export Levels

Returns metadata for the complete list of all organization levels in the system

Inputs

Input Type Detail Notes
Version Name TextField Indicates whether the response should only include levels which are available for the requested version name. The default, if the element or its attribute is not present, is to return all levels. If a version name is specified, only levels which are available for the specified version will be returned.
Include Inaccessible Values BooleanField Whether the response should include levels to which the user has no access.
Sheet ID TextField Represents a sheet, where only levels available for that sheet will be included in the response.

Outputs

Output Output Type Notes
Levels (JSON) File
Levels (CSV) File
Attributes (CSV) File

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating

Export Modeled Sheet

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

Inputs

Input Type Detail Notes
Version Name TextField Specifies which version to retrieve the modeled rows from
Modeled Sheet GroupField Specifies which modeled sheet to retrieve the modeled rows from. Uses the id or name of the model sheet as the identifier
Time Span GroupField 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.
Level GroupField Specifies a level by which to filter the request

Outputs

Output Output Type Notes
Sheet Data File
Record Count Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating

Export Versions

Exports data describing the set of all versions defined in the instance which are not hidden from the requesting user

Inputs

Input Type Detail Notes
Root Actuals BooleanField Indicates whether the root actuals version should be included when actuals are hidden from the version selector.

Outputs

Output Output Type Notes
Versions (JSON) File
Versions (CSV) File

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating

Import Cube Data

Inserts or replaces data in a cube sheet. This method can also be used to delete data from a cube sheet by importing zeroes to locations in the cube. Importing a zero into a cube sheet will erase the data at the location of the zero.

Inputs

Input Type Detail Notes
Version GroupField Indicates which version should be used to receive the requested data. A version must be provided for each call
Modeled Sheet GroupField Indicates which sheet should receive the imported data. Each API call can target only one sheet's data
Import Options GroupField Specifies the options to be used when performing the import
Data FileField The CSV data that will be imported
Delimiter DropdownField The delimiter of the CSV file

Outputs

Output Output Type Notes
Record Count Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating

Import Modeled Sheet Data

Inserts or replaces data in a modeled sheet

Inputs

Input Type Detail Notes
Version GroupField Indicates which version should be used to receive the requested data. A version must be provided for each call
Modeled Sheet GroupField The modeled sheet to import the data into
Import Options GroupField Specifies the options to be used when performing the import
Data FileField The CSV data that will be imported
Delimiter DropdownField The delimiter of the CSV file

Outputs

Output Output Type Notes
Record Count Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating

Import Standard Data

Inserts or replaces data in standard accounts

Inputs

Input Type Detail Notes
Version GroupField Indicates which version should be used to receive the requested data. A version must be provided
Import Options GroupField Specifies the options to be used when performing the import
Data FileField The CSV data that will be imported
Delimiter DropdownField The delimiter of the CSV file

Outputs

Output Output Type Notes
Record Count Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating

Import Transactions

Inserts or replaces data in standard accounts

Inputs

Input Type Detail Notes
Import Options GroupField Specifies the options to be used when performing the import
Data FileField The CSV data that will be imported
Delimiter DropdownField The delimiter of the CSV file

Outputs

Output Output Type Notes
Record Count Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error Error running the command
2 Error Error authenticating
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.