Skip to main content
Adaptive Insights
Knowledge and Support - Adaptive Insights

exportDimensionFamilies

Category

Metadata retrieval

Description

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

Permissions Required To Invoke

None (must be valid credentials for the instance)

Parameters Required On Request

Credentials

This method's request contains only a credentials tag to identify and authorize the calling user. Once verified, the method returns an XML document describing a set of dimension families, which describe how specific sets of dimensions are related to specific sets of accounts. Each family consists of a set of accounts and a set of dimensions, which indicates that those dimensions apply to those accounts, while other dimensions do not. Accounts and dimensions may belong to many families. Families are defined as follows:

  • Accounts on a modeled sheet belong to a family for that sheet, which contains all dimensions placed on that sheet and all organization dimensions.

  • Accounts on a cube sheet belong to a family for that sheet, which contains all dimensions placed on that sheet and all organization dimensions.

  • Accounts on a standard sheet with dimensions belong to a family for that sheet, which contains all dimensions placed on that sheet and all organization dimensions.

    Standard sheets that do not have dimensions placed on them do not have an associated dimension family.

 

Request Format

<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensionFamilies" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</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 his- tory 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

locale

N

Specify the locale to be used to interpret incoming numbers and dates, and to format outgoing numbers and dates (using the proper thousands separator, month names, and date formatting). The locale is also used to specify the language in which any system messages in the response should appear. If not specified, en_US (American English) is used.

fr_FR

instanceCode

N

If the user specified in the credentials has access to more than one instance of Adaptive Planning, 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.

MYINSTANCE1

Contents of the Element

(none)

Response Format 

<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
   <families>
     <family name="Personal" id="381" accounts="734-739, 744" dimensions="9321,9422, 9455, 9458" />
     <family name="Capital" id="382" accounts="853" dimensions="4" />
     <family name="Sales" id="386" accounts="769, 4112" dimensions="" />
     <family name="Balance" id="255" accounts="545, 66" dimensions="6,7" />
   </families>
 </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 suc- cessful or not. Even successful calls may contain warning mes- sages in their response.

true

obsolete

N

If present on the response tag and set to true, this attribute indi- cates that the version of the method or API which is being invoked has become obsolete and is officially deprecated by Adaptive Plan- ning. While it continues to function at this time, it may cease func- tioning in a short while. Typically, this attribute is not present.

false

Contents of the Element

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

 

output element

Tag Name

output

Attributes of the Element

(none)

Contents of the Element

A single accounts element. This output wrapper is standard on all API responses and encloses the valid output of any successful API call.

 

families element

Tag Name

families

Description

Container for one or more family elements.

Attributes of the Element

Attribute Name

Required?

Value

Example

(none)

Contents of the Element

One or more family elements.

 

family element

Tag Name

family

Description

Describes a single dimension family associated with a single modeled or cube sheet. A single family is also output for all non-modeled, non-cube assumptions and exchange rates. This catch-all family has id = 0.

Attributes of the Element

Attribute Name

Required?

Value

Example

name

Y

The name of the dimension family. The family comprised of all non-cube assumptions and exchange rate accounts (which have no dimen- sions) will have the name '*'. The dimension family for a standard sheet has the same name as the standard sheet, while the dimension fam- ily for a cube or modeled sheet uses the sheet's prefix as the family name.

Capital

id

Y

The id of the dimension family, which is the ID of the sheet this family is described by.

3

accounts

Y

The set of account ID numbers belonging to this family. IDs are the internal system IDs for the accounts, visible in the exportAccounts API call. IDs are comma-separated and may contain hyphenated ranges, which indicate that all IDs within the range are included.

734-739,744

dimensions

Y

The set of dimension ID numbers belonging to this family. IDs are the internal system IDs for the dimensions, visible in the exportDimen- sions API call. IDs are comma-separated and may contain hyphenated ranges, which indicate that all IDs within the range are included.

9321,9422,9455,9458

Contents of the Element

(none)

 

  • Was this article helpful?